age

Documentation

Index

• func GenerateKey(path string) error
• func GenerateKeyForce(path string) error
• func PublicKeyFrom(keyFile string) (string, error)
• type AgeArmorDecryptor
  • func (d AgeArmorDecryptor) Decrypt(path string) ([]byte, error)
  • func (d AgeArmorDecryptor) Encrypt(path string, plaintext []byte) error

Functions

func GenerateKey

func GenerateKey(path string) error

GenerateKey generates a new age key at path. No-op if the file already exists.

func GenerateKeyForce

func GenerateKeyForce(path string) error

GenerateKeyForce generates a new age key at path, overwriting any existing file.

func PublicKeyFrom

func PublicKeyFrom(keyFile string) (string, error)

PublicKeyFrom reads the public key from an age key file.

Types

type AgeArmorDecryptor

type AgeArmorDecryptor struct {
	KeyFile string
}

AgeArmorDecryptor encrypts and decrypts .ward files as opaque age-armored blobs. The entire file is the ciphertext — no YAML structure is exposed.

func (AgeArmorDecryptor) Decrypt

func (d AgeArmorDecryptor) Decrypt(path string) ([]byte, error)

Decrypt returns the plaintext of path. Plain (unencrypted) files pass through as-is.

func (AgeArmorDecryptor) Encrypt

func (d AgeArmorDecryptor) Encrypt(path string, plaintext []byte) error

Encrypt encrypts plaintext with the key in KeyFile and writes the armored result to path.