symmetric

Documentation

Index

• Constants
• type Key
  • func FromBytes(k []byte) (*Key, error)
  • func FromString(k string) (*Key, error)
  • func New() *Key
  • func NewRandom() (*Key, error)
  • func (k *Key) Bytes() []byte
  • func (k *Key) Decrypt(ciphertext []byte) ([]byte, error)
  • func (k *Key) Encrypt(plaintext []byte) ([]byte, error)
  • func (k *Key) MarshalBinary() ([]byte, error)
  • func (k *Key) String() string

Constants

const (
	// NonceBytes is the length of GCM nonce.
	NonceBytes = 12

	// KeyBytes is the length of GCM key.
	KeyBytes = 32
)

Types

type Key

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

Key is a wrapper for a symmetric key.

func FromBytes

func FromBytes(k []byte) (*Key, error)

FromBytes returns a key by decoding bytes.

func FromString

func FromString(k string) (*Key, error)

FromString returns a key by decoding a base32-encoded string.

func New

func New() *Key

New returns Key if err is nil and panics otherwise.

func NewRandom

func NewRandom() (*Key, error)

NewRandom returns a random key.

func (*Key) Bytes

func (k *Key) Bytes() []byte

Bytes returns raw key bytes.

func (*Key) Decrypt

func (k *Key) Decrypt(ciphertext []byte) ([]byte, error)

Decrypt uses key to perform AES-256 GCM decryption on ciphertext.

func (*Key) Encrypt

func (k *Key) Encrypt(plaintext []byte) ([]byte, error)

Encrypt performs AES-256 GCM encryption on plaintext.

func (*Key) MarshalBinary

func (k *Key) MarshalBinary() ([]byte, error)

MarshalBinary implements BinaryMarshaler.

func (*Key) String

func (k *Key) String() string

String returns the base32-encoded string representation of raw key bytes.