nacl

Documentation

Index

• Constants
• type Challenge
• type Nonce
  • func GenerateNonce() (Nonce, error)
  • func SolveChallenge(challenge []byte, nonce Nonce, peersPublicKey *PublicKey, ...) ([]byte, Nonce, error)
• type PrivateKey
  • func GenerateKey() (*PrivateKey, error)
  • func ParsePrivateKey(raw []byte) (*PrivateKey, error)
  • func ParsePrivateKeyB64(b64 string) (*PrivateKey, error)
  • func (p *PrivateKey) B64() string
  • func (p *PrivateKey) Public() *PublicKey
  • func (p *PrivateKey) Raw() *[KeyLength]byte
• type PublicKey
  • func MustParsePublicKey(raw []byte) *PublicKey
  • func ParsePublicKey(raw []byte) (*PublicKey, error)
  • func ParsePublicKeyB64(b64 string) (*PublicKey, error)
  • func (p *PublicKey) B64() string
  • func (p *PublicKey) Raw() *[KeyLength]byte
• type Service
  • func New(privateKey *PrivateKey) (Service, error)

Constants

const KeyLength = 32

KeyLength is the length of keys (in bytes).

const NonceLength = 24

NonceLength is the the length of nonces (in bytes).

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, peersPublicKey *PublicKey, privateKey *PrivateKey) ([]byte, Nonce, error)

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

type PrivateKey

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

PrivateKey represents a private key.

func GenerateKey

func GenerateKey() (*PrivateKey, error)

GenerateKey generates a new PrivateKey.

func ParsePrivateKey

func ParsePrivateKey(raw []byte) (*PrivateKey, error)

ParsePrivateKey parses raw bytes onto a PrivateKey.

func ParsePrivateKeyB64

func ParsePrivateKeyB64(b64 string) (*PrivateKey, error)

ParsePrivateKeyB64 parses base64-encoded bytes onto a PrivateKey.

func (*PrivateKey) B64

func (p *PrivateKey) B64() string

B64 returns the base64-encoded private key bytes.

func (*PrivateKey) Public

func (p *PrivateKey) Public() *PublicKey

Public returns the public key corresponding to the private key.

func (*PrivateKey) Raw

func (p *PrivateKey) Raw() *[KeyLength]byte

Raw returns the address of the raw private key bytes.

type PublicKey

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

PublicKey represents a public key.

func MustParsePublicKey

func MustParsePublicKey(raw []byte) *PublicKey

MustParsePublicKey parses raw bytes onto a PublicKey or panics on error.

func ParsePublicKey

func ParsePublicKey(raw []byte) (*PublicKey, error)

ParsePublicKey parses raw bytes onto a PublicKey.

func ParsePublicKeyB64

func ParsePublicKeyB64(b64 string) (*PublicKey, error)

ParsePublicKeyB64 parses base64-encoded bytes onto a PublicKey.

func (*PublicKey) B64

func (p *PublicKey) B64() string

B64 returns the base64-encoded public key bytes.

func (*PublicKey) Raw

func (p *PublicKey) Raw() *[KeyLength]byte

Raw returns the address of the raw public key bytes.

type Service

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

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

func New

func New(privateKey *PrivateKey) (Service, error)

New returns a newly initialized, default Service implementation.