everglade

README

Everglade

An encryption framework

Overview

Everglade handles file discovery and encryption with ease.

Directory Enumeration

Everglade has the capability to:

1. Recursively map directories
2. Search a directory recursively for a file
3. Search a directory recursively for all files of a given type

Documentation

Index

• func DiscoverFilesInDirectory(dir string) ([]string, error)
• func FindFileInDirectory(dir, fn string) (string, error)
• func FindFilesByTypeInDirectory(dir, ex string) ([]string, error)
• func Hash(pt []byte) []byte
• type Everglade
  • func New(l int) (*Everglade, error)
  • func (e *Everglade) Add(path string) error
  • func (e *Everglade) Decrypt() error
  • func (e *Everglade) Encrypt() error
  • func (e *Everglade) Sign() ([]Signature, error)
  • func (e *Everglade) Verify(sig, pt []byte) bool
• type Signature

Examples

• Everglade.Encrypt

Functions

func DiscoverFilesInDirectory

func DiscoverFilesInDirectory(dir string) ([]string, error)

DiscoverFilesInDirectory automates discovery of files in directory and returns []string

func FindFileInDirectory

func FindFileInDirectory(dir, fn string) (string, error)

FindFileInDirectory takes a directory and a filename and returns the relative path of that file if exists

func FindFilesByTypeInDirectory

func FindFilesByTypeInDirectory(dir, ex string) ([]string, error)

FindFilesByTypeInDirectory returns the path of all files in the directory of a specific extension

func Hash

func Hash(pt []byte) []byte

Types

type Everglade

type Everglade struct {
	Blind  blind.Blind
	Paths  []string
	Layers int
}

func New

func New(l int) (*Everglade, error)

func (*Everglade) Add

func (e *Everglade) Add(path string) error

func (*Everglade) Decrypt

func (e *Everglade) Decrypt() error

func (*Everglade) Encrypt

func (e *Everglade) Encrypt() error

Example

// File to encrypt in this test
fn := "everglade.go"

// e.blind houses your keys and can be exported to/from if needed.
e, err := New(1)
if err != nil {
	panic(err)
}

// Add the files to encrypt to this list
err = e.Add(fn)
if err != nil {
	panic(err)
}

// Encrypt the files that were added with AES-CBC-128.
// This includes a random nonce and IV.
err = e.Encrypt()
if err != nil {
	panic(err)
}

func (*Everglade) Sign

func (e *Everglade) Sign() ([]Signature, error)

func (*Everglade) Verify

func (e *Everglade) Verify(sig, pt []byte) bool

type Signature

type Signature []byte