encrypt

Documentation

Index

• Constants
• func MakeRandomAESKey() ([]byte, error)
• func NewEncryptedContainer(container stow.Container, mode Mode, key []byte) stow.Container
• func ValidAESKey(key []byte) error
• type Mode
  • func ModeFromName(name string) Mode
  • func (m Mode) AlgoName() string
  • func (m Mode) NewReader(rdr io.Reader, key, initVect []byte) (io.Reader, error)
  • func (m Mode) NewWriter(wtr io.WriteCloser, key []byte) (encryptor io.WriteCloser, initVect []byte, err error)
  • func (m Mode) String() string

Constants

const (
	ModeIdentity Mode = iota
	ModeUnknown
	ModeAESCTR
	ModeAESCFB
	ModeAESOFB
	ModeAESRec = ModeAESCTR

	ModeIdentityName = "identity"
	ModeAESCTRName   = "aes-ctr"
	ModeAESCFBName   = "aes-cfb"
	ModeAESOFBName   = "aes-ofb"
	ModeAESRecName   = "aes-rec"
	ModeUknownName   = "unknown"
)

Enumerate available modes and their textual names

Functions

func MakeRandomAESKey

func MakeRandomAESKey() ([]byte, error)

MakeRandomAESKey generates AES-256 (32 byte) key securely by using a cryptographic entropy source

func NewEncryptedContainer

func NewEncryptedContainer(container stow.Container, mode Mode, key []byte) stow.Container

NewEncryptedContainer wraps the provided container in transparent encryption and decryption

func ValidAESKey

func ValidAESKey(key []byte) error

ValidAESKey confirms the provided key is the correct length for AES/128/224/256 and is not all zeros

Types

type Mode

type Mode uint8

Mode represents an encryption mode

func ModeFromName

func ModeFromName(name string) Mode

ModeFromName constructs a Mode from a textual name

func (Mode) AlgoName

func (m Mode) AlgoName() string

AlgoName returns the textual name of a Mode

func (Mode) NewReader

func (m Mode) NewReader(rdr io.Reader, key, initVect []byte) (io.Reader, error)

NewReader constructs a reader wrapper that applies this mode's decryption

func (Mode) NewWriter

func (m Mode) NewWriter(wtr io.WriteCloser, key []byte) (encryptor io.WriteCloser, initVect []byte, err error)

NewWriter constructs a writer wrapper that applies this mode's encryption

func (Mode) String

func (m Mode) String() string

String is a synonym for AlgoName