sec

Documentation

Overview

sec is an implementation of Noise_IK_25519_ChaChaPoly_BLAKE2b protocol.

Trevor Perrin. 2016. The Noise Protocol Framework. https://noiseprotocol.org/noise.pdf

Noise test vectors can be found at https://raw.githubusercontent.com/centromere/cacophony/master/vectors/cacophony.txt

Index

• type AEAD
• type Handshake
  • func NewHandshake(prologue []byte, localStaticPrivateKey, remoteStaticPublicKey []byte, ...) Handshake
• type Role

Types

type AEAD

type AEAD interface {
	Seal(dst []byte, nonce uint64, plaintext, additionalData []byte) []byte
	Open(dst []byte, nonce uint64, ciphertext, additionalData []byte) ([]byte, error)
}

See The CipherState object section of Noise. This implementation delegates nonce concerns to the user.

type Handshake

type Handshake interface {
	ReadMessage(r io.Reader, payloadLen uint16) (payload []byte, err error)
	WriteMessage(w io.Writer, payload []byte) error
	Split() (c1 AEAD, c2 AEAD, handshakeHash []byte)
}

func NewHandshake

func NewHandshake(prologue []byte, localStaticPrivateKey, remoteStaticPublicKey []byte, rand io.Reader, role Role) Handshake

type Role

type Role int

const (
	InitiatorRole Role = 1
	ResponderRole Role = 2
)