crypt

README

go-crypt

go-crypt provides a simple interface for AES encryption and decryption of files in Go. It uses AES-GCM for encryption and HKDF for key derivation from a passphrase and a random salt.

Features

• Simple Load and Save methods for file-based encryption.
• io.Reader and io.Writer interfaces for streaming data.
• Key derivation using HKDF-SHA256 with a random salt.
• AES-256-GCM encryption.
• Versioned storage for forward compatibility.

Authors

• Christophe Lambin

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Documentation

Index

• type Crypt
  • func New(filePath string, passphrase string) Crypt
  • func (c Crypt) Load() ([]byte, error)
  • func (c Crypt) Reader() io.Reader
  • func (c Crypt) Save(body []byte) (err error)
  • func (c Crypt) Writer() io.WriteCloser
• type ErrDecryptionFailed
  • func (e *ErrDecryptionFailed) Error() string
  • func (e *ErrDecryptionFailed) Unwrap() error

Examples

• Crypt.Save
• Crypt.Writer

Types

type Crypt

type Crypt struct {
	// contains filtered or unexported fields
}

func New

func New(filePath string, passphrase string) Crypt

func (Crypt) Load

func (c Crypt) Load() ([]byte, error)

func (Crypt) Reader

func (c Crypt) Reader() io.Reader

func (Crypt) Save

func (c Crypt) Save(body []byte) (err error)

Example

c := New(filepath.Join(os.TempDir(), "test-crypt.json"), "my-passphrase")
_ = c.Save([]byte("hello world"))
output, _ := c.Load()
fmt.Println(string(output))

Output:
hello world

func (Crypt) Writer

func (c Crypt) Writer() io.WriteCloser

Example

type record struct {
	Name string `json:"name"`
}

c := New(filepath.Join(os.TempDir(), "test-crypt.json"), "my-passphrase")
input := record{Name: "john doe"}

w := c.Writer()
// encrypt
_ = json.NewEncoder(w).Encode(input)
// write to file
_ = w.Close()

// read using io.Reader
var output record
_ = json.NewDecoder(c.Reader()).Decode(&output)
fmt.Println(output.Name)

Output:
john doe

type ErrDecryptionFailed

type ErrDecryptionFailed struct {
	Err error
}

func (*ErrDecryptionFailed) Error

func (e *ErrDecryptionFailed) Error() string

func (*ErrDecryptionFailed) Unwrap

func (e *ErrDecryptionFailed) Unwrap() error