nacl

Documentation

Index

• Variables
• type Box
• type MultiSecretBox
  • func NewMultiSecretBox(boxes ...*SecretBox) *MultiSecretBox
  • func (m *MultiSecretBox) GetSecretKeySig() string
  • func (m *MultiSecretBox) Open(encrypted []byte) (message []byte, err error)
  • func (m *MultiSecretBox) Seal(message []byte) ([]byte, error)
• type SecretBox
  • func NewSecretBox(key *[32]byte, nonceReader io.Reader) *SecretBox
  • func (s *SecretBox) GetSecretKeySig() string
  • func (s *SecretBox) Open(encrypted []byte) ([]byte, error)
  • func (s *SecretBox) Seal(message []byte) ([]byte, error)
• type Signer
  • func NewMultiSigner(signers ...Signer) Signer
  • func NewSigner(key *[32]byte) Signer

Variables

var (
	// ErrNonceRead is returned when the provided reader fails to generate a nonce.
	ErrNonceRead = errors.New("failed to read nonce value")

	// ErrDecrypt is returned when opening an encrypted message fails.
	ErrDecrypt = errors.New("failed to decrypt value")

	// ErrEncryptedMsgTooShort is returned when the encrypted message is shorter than 24 bytes
	ErrEncryptedMsgTooShort = errors.New("failed to read encrypted message: minimum length = 24")
)

Types

type Box

type Box interface {
	Seal(message []byte) ([]byte, error)
	Open(encrypted []byte) ([]byte, error)
	GetSecretKeySig() string
}

Box opens and seals secrets.

type MultiSecretBox

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

MultiSecretBox wraps multiple SecretBox.

func NewMultiSecretBox

func NewMultiSecretBox(boxes ...*SecretBox) *MultiSecretBox

NewMultiSecretBox creates a MultiSecretBox which wraps the provided SecretBox.

func (*MultiSecretBox) GetSecretKeySig

func (m *MultiSecretBox) GetSecretKeySig() string

GetSecretKeySig returns the md5 hash sum of the key

func (*MultiSecretBox) Open

func (m *MultiSecretBox) Open(encrypted []byte) (message []byte, err error)

Open attempts to decrypt the provided message with all available SecretBox.

func (*MultiSecretBox) Seal

func (m *MultiSecretBox) Seal(message []byte) ([]byte, error)

Seal encrypts the provided message with the first SecretBox.

type SecretBox

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

SecretBox provides nacl secretbox encryption.

func NewSecretBox

func NewSecretBox(key *[32]byte, nonceReader io.Reader) *SecretBox

NewSecretBox creates a new SecretBox with the provided secret key and optional nonce reader.

func (*SecretBox) GetSecretKeySig

func (s *SecretBox) GetSecretKeySig() string

GetSecretKeySig returns the md5 hash sum of the key

func (*SecretBox) Open

func (s *SecretBox) Open(encrypted []byte) ([]byte, error)

Open decrypts the provided message.

func (*SecretBox) Seal

func (s *SecretBox) Seal(message []byte) ([]byte, error)

Seal encrypts the provided message.

type Signer

type Signer interface {
	Sign(data []byte) []byte
	Verify(data, sum []byte) bool
}

Signer allows you to sign and verify data.

func NewMultiSigner

func NewMultiSigner(signers ...Signer) Signer

NewMultiSigner allows you to create multiple signers which is useful for doing cred rolls.

func NewSigner

func NewSigner(key *[32]byte) Signer

NewSigner creates a single signer with the given key.