nacl

Documentation

Index

• Constants
• Variables
• func CryptoBox(msg, nounce, pk, sk []byte) ([]byte, error)
• func CryptoBoxOpen(box, nounce, sk, pk []byte) ([]byte, error)
• func CryptoBoxOverhead() int
• func CryptoBoxPrivKeySize() int
• func CryptoBoxPubKeySize() int
• func CryptoSignDetached(msg, sk []byte) []byte
• func CryptoSignFucky(msg, sk []byte) []byte
• func CryptoSignPrivKeySize() int
• func CryptoSignPubKeySize() int
• func CryptoSignPublicLen() int
• func CryptoSignSecretLen() int
• func CryptoSignSeedLen() int
• func CryptoVerify(smsg, pk []byte) bool
• func CryptoVerifyDetached(msg, sig, pk []byte) bool
• func CryptoVerifyFucky(msg, sig, pk []byte) bool
• func GetBoxPubkey(sk []byte) []byte
• func GetSignPubkey(sk []byte) ([]byte, error)
• func NewBoxNounce() []byte
• func NounceLen() int
• func RandBytes(size int) []byte
• type Buffer
  • func Malloc(size int) *Buffer
  • func NewBuffer(buff []byte) *Buffer
  • func (self *Buffer) Bytes() []byte
  • func (self *Buffer) Data() []byte
  • func (self *Buffer) Free()
  • func (self *Buffer) Length() int
  • func (self *Buffer) String() string
• type CryptoConn
  • func (cc *CryptoConn) Close() (err error)
  • func (cc *CryptoConn) LocalAddr() net.Addr
  • func (cc *CryptoConn) Read(d []byte) (n int, err error)
  • func (cc *CryptoConn) RemoteAddr() net.Addr
  • func (cc *CryptoConn) SetDeadline(t time.Time) (err error)
  • func (cc *CryptoConn) SetReadDeadline(t time.Time) (err error)
  • func (cc *CryptoConn) SetWriteDeadline(t time.Time) (err error)
  • func (cc *CryptoConn) Write(d []byte) (n int, err error)
• type CryptoListener
  • func Server(l net.Listener, local_sk []byte, trust func(pk []byte) bool) (s *CryptoListener)
  • func (cl *CryptoListener) Accept() (c net.Conn, err error)
  • func (cl *CryptoListener) Close() (err error)
• type CryptoStream
  • func Client(stream io.ReadWriteCloser, local_sk, remote_pk []byte) (c *CryptoStream)
  • func (cs *CryptoStream) Close() (err error)
  • func (cs *CryptoStream) Handshake() (err error)
  • func (cs *CryptoStream) Read(data []byte) (n int, err error)
  • func (cs *CryptoStream) Write(data []byte) (n int, err error)
• type KeyPair
  • func GenBoxKeypair() *KeyPair
  • func GenSignKeypair() *KeyPair
  • func LoadBoxKey(sk []byte) *KeyPair
  • func LoadSignKey(seed []byte) *KeyPair
  • func SeedBoxKey(seed []byte) *KeyPair
  • func (self *KeyPair) Free()
  • func (self *KeyPair) Public() []byte
  • func (self *KeyPair) Secret() []byte
  • func (self *KeyPair) Seed() []byte
  • func (self *KeyPair) String() string

Constants

const DefaultMTU = 512

write boxes at 512 bytes at a time

Variables

var BadHandshake = errors.New("Bad handshake")

var Closed = errors.New("socket closed")

var ShortRead = errors.New("short read")

var ShortWrite = errors.New("short write")

Functions

func CryptoBox

func CryptoBox(msg, nounce, pk, sk []byte) ([]byte, error)

encrypts a message to a user given their public key is known returns an encrypted box

func CryptoBoxOpen

func CryptoBoxOpen(box, nounce, sk, pk []byte) ([]byte, error)

open an encrypted box

func CryptoBoxOverhead

func CryptoBoxOverhead() int

return how many bytes overhead does CryptoBox have

func CryptoBoxPrivKeySize

func CryptoBoxPrivKeySize() int

size of crypto_box private keys

func CryptoBoxPubKeySize

func CryptoBoxPubKeySize() int

size of crypto_box public keys

func CryptoSignDetached

func CryptoSignDetached(msg, sk []byte) []byte

sign data detached with secret key sk

func CryptoSignFucky

func CryptoSignFucky(msg, sk []byte) []byte

sign data with secret key sk return detached sig this uses crypto_sign instead pf crypto_sign_detached

func CryptoSignPrivKeySize

func CryptoSignPrivKeySize() int

size of crypto_sign private keys

func CryptoSignPubKeySize

func CryptoSignPubKeySize() int

size of crypto_sign public keys

func CryptoSignPublicLen

func CryptoSignPublicLen() int

func CryptoSignSecretLen

func CryptoSignSecretLen() int

func CryptoSignSeedLen

func CryptoSignSeedLen() int

func CryptoVerify

func CryptoVerify(smsg, pk []byte) bool

verify a signed message

func CryptoVerifyDetached

func CryptoVerifyDetached(msg, sig, pk []byte) bool

verfiy a detached signature return true on valid otherwise false

func CryptoVerifyFucky

func CryptoVerifyFucky(msg, sig, pk []byte) bool

verify a fucky detached sig

func GetBoxPubkey

func GetBoxPubkey(sk []byte) []byte

get public key from secret key

func GetSignPubkey

func GetSignPubkey(sk []byte) ([]byte, error)

get public key from secret key

func NewBoxNounce

func NewBoxNounce() []byte

generate a new nounce

func NounceLen

func NounceLen() int

length of a nounce

func RandBytes

func RandBytes(size int) []byte

Types

type Buffer

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

wrapper arround malloc/free

func Malloc

func Malloc(size int) *Buffer

wrapper arround nacl.malloc

func NewBuffer

func NewBuffer(buff []byte) *Buffer

create a new buffer copying from a byteslice

func (*Buffer) Bytes

func (self *Buffer) Bytes() []byte

get immutable byte slice

func (*Buffer) Data

func (self *Buffer) Data() []byte

get underlying byte slice

func (*Buffer) Free

func (self *Buffer) Free()

zero out memory and then free

func (*Buffer) Length

func (self *Buffer) Length() int

func (*Buffer) String

func (self *Buffer) String() string

type CryptoConn

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

func (*CryptoConn) Close

func (cc *CryptoConn) Close() (err error)

func (*CryptoConn) LocalAddr

func (cc *CryptoConn) LocalAddr() net.Addr

func (*CryptoConn) Read

func (cc *CryptoConn) Read(d []byte) (n int, err error)

func (*CryptoConn) RemoteAddr

func (cc *CryptoConn) RemoteAddr() net.Addr

func (*CryptoConn) SetDeadline

func (cc *CryptoConn) SetDeadline(t time.Time) (err error)

func (*CryptoConn) SetReadDeadline

func (cc *CryptoConn) SetReadDeadline(t time.Time) (err error)

func (*CryptoConn) SetWriteDeadline

func (cc *CryptoConn) SetWriteDeadline(t time.Time) (err error)

func (*CryptoConn) Write

func (cc *CryptoConn) Write(d []byte) (n int, err error)

type CryptoListener

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

func Server

func Server(l net.Listener, local_sk []byte, trust func(pk []byte) bool) (s *CryptoListener)

create a listener

func (*CryptoListener) Accept

func (cl *CryptoListener) Accept() (c net.Conn, err error)

accept inbound authenticated and trusted connections

func (*CryptoListener) Close

func (cl *CryptoListener) Close() (err error)

type CryptoStream

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

wrapper arround crypto_box provides an authenticated encrypted stream this is a TOY

func Client

func Client(stream io.ReadWriteCloser, local_sk, remote_pk []byte) (c *CryptoStream)

create a client

func (*CryptoStream) Close

func (cs *CryptoStream) Close() (err error)

func (*CryptoStream) Handshake

func (cs *CryptoStream) Handshake() (err error)

initiate protocol handshake

func (*CryptoStream) Read

func (cs *CryptoStream) Read(data []byte) (n int, err error)

implements io.Reader

func (*CryptoStream) Write

func (cs *CryptoStream) Write(data []byte) (n int, err error)

implements io.Writer

type KeyPair

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

func GenBoxKeypair

func GenBoxKeypair() *KeyPair

func GenSignKeypair

func GenSignKeypair() *KeyPair

generate a keypair

func LoadBoxKey

func LoadBoxKey(sk []byte) *KeyPair

load keypair from secret key

func LoadSignKey

func LoadSignKey(seed []byte) *KeyPair

make keypair from seed

func SeedBoxKey

func SeedBoxKey(seed []byte) *KeyPair

make keypair from seed

func (*KeyPair) Free

func (self *KeyPair) Free()

free this keypair from memory

func (*KeyPair) Public

func (self *KeyPair) Public() []byte

func (*KeyPair) Secret

func (self *KeyPair) Secret() []byte

func (*KeyPair) Seed

func (self *KeyPair) Seed() []byte

func (*KeyPair) String

func (self *KeyPair) String() string