nacl

Documentation

Index

• Constants
• type Challenge
• type Nonce
  • func GenerateNonce() (Nonce, error)
  • func SolveChallenge(challenge []byte, nonce Nonce, selfPriv PrivateKey, peerPub PublicKey) ([]byte, Nonce, error)
• type PrivateKey
• type PublicKey
• type Service
  • func New() (Service, error)

Constants

const (
	// KeyLength is the length of keys (in bytes).
	KeyLength = 32

	// NonceLength is the the length of nonces (in bytes).
	NonceLength = 24
)

Types

type Challenge

type Challenge interface {
	ToSolve() ([]byte, Nonce)
	IsSolution([]byte, Nonce) bool
}

Challenge represents something that can be solved and solutions can be checked against.

type Nonce

type Nonce *[NonceLength]byte

Nonce represents a nonce.

func GenerateNonce

func GenerateNonce() (Nonce, error)

GenerateNonce generates a fixed number of random bytes.

func SolveChallenge

func SolveChallenge(challenge []byte, nonce Nonce, selfPriv PrivateKey, peerPub PublicKey) ([]byte, Nonce, error)

SolveChallenge attempts to solve a challenge with a given private key.

type PrivateKey

type PrivateKey *[KeyLength]byte

PrivateKey represents a private key.

type PublicKey

type PublicKey *[KeyLength]byte

PublicKey represents a public key.

type Service

type Service interface {
	PublicKey() PublicKey
	PrivateKey() PrivateKey
	NewChallengeForPeer(PublicKey) (Challenge, error)
}

Service represents an entity capable of issuing challenges for others to solve.

func New

func New() (Service, error)

New returns a newly initialized, default Service implementation.