crypt

Documentation

Index

• Constants
• type Key
  • func NewKey(str string) (key Key, err error)
  • func (key Key) MarshalJSON() ([]byte, error)
  • func (key Key) MarshalYAML() (interface{}, error)
  • func (key Key) String() string
  • func (key *Key) UnmarshalJSON(data []byte) error
  • func (key *Key) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (key Key) Valid() bool
• type KeyPair
  • func GenerateKeyPair() KeyPair
  • func (pair *KeyPair) Decrypt(peerPublicKey Key, data []byte) ([]byte, error)
  • func (pair *KeyPair) Encrypt(peerPublicKey Key, data []byte) []byte
• type Nonce

Constants

const (
	// KeySize is the size of an encryption key in bytes
	KeySize = 32
	// NonceSize is the size of a nonce in bytes
	NonceSize = 24
)

Types

type Key

type Key [KeySize]byte

Key is a public or private encryption key

func NewKey

func NewKey(str string) (key Key, err error)

NewKey creates a new key from a base58 string

func (Key) MarshalJSON

func (key Key) MarshalJSON() ([]byte, error)

func (Key) MarshalYAML

func (key Key) MarshalYAML() (interface{}, error)

func (Key) String

func (key Key) String() string

func (*Key) UnmarshalJSON

func (key *Key) UnmarshalJSON(data []byte) error

func (*Key) UnmarshalYAML

func (key *Key) UnmarshalYAML(unmarshal func(interface{}) error) error

func (Key) Valid

func (key Key) Valid() bool

type KeyPair

type KeyPair struct {
	Public, Private Key
}

A KeyPair is a public, private key pair

func GenerateKeyPair

func GenerateKeyPair() KeyPair

GenerateKeyPair generates a (public, private) encryption key

func (*KeyPair) Decrypt

func (pair *KeyPair) Decrypt(peerPublicKey Key, data []byte) ([]byte, error)

Decrypt decrypts a message using a peer's public key and the local private key

func (*KeyPair) Encrypt

func (pair *KeyPair) Encrypt(peerPublicKey Key, data []byte) []byte

Encrypt encrypts a message using a peer's public key and the local private key

type Nonce

type Nonce = [NonceSize]byte

Nonce is a number used once