keys

Documentation

Index

• Constants
• Variables
• type Keypair
  • func New(keytype int) (*Keypair, error)
• type PrivateKey
• type PublicKey
• type SymmetricKey
  • func NewSymmetricKey() (*SymmetricKey, error)

Constants

const (
	TypeEC = iota
	TypeRSA
)

Type of Themis key.

const (
	KEYTYPE_EC  = TypeEC
	KEYTYPE_RSA = TypeRSA
)

Type of Themis key.

Deprecated: Since 0.11. Use "keys.Type..." constants instead.

Variables

var (
	ErrGetKeySize      = errors.New("failed to get needed key sizes")
	ErrGenerateKeypair = errors.New("failed to generate key pair")
	ErrInvalidType     = errors.NewWithCode(errors.InvalidParameter, "invalid key type specified")
	ErrOutOfMemory     = errors.NewWithCode(errors.NoMemory, "key generator cannot allocate enough memory")
	// Deprecated: Since 0.14. Use ErrOutOfMemory instead.
	ErrOverflow = ErrOutOfMemory
)

Errors returned by key generation.

var (
	ErrGetSymmetricKeySize  = errors.New("failed to get symmetric key size")
	ErrGenerateSymmetricKey = errors.New("failed to generate symmetric key")
)

Errors returned by key generation.

Types

type Keypair

type Keypair struct {
	Private *PrivateKey
	Public  *PublicKey
}

Keypair stores a ECDSA or RSA key pair.

func New

func New(keytype int) (*Keypair, error)

New generates a new random pair of keys of the specified type.

type PrivateKey

type PrivateKey struct {
	Value []byte
}

PrivateKey stores a ECDSA or RSA private key.

type PublicKey

type PublicKey struct {
	Value []byte
}

PublicKey stores a ECDSA or RSA public key.

type SymmetricKey

type SymmetricKey struct {
	Value []byte
}

SymmetricKey stores a master key for Secure Cell.

func NewSymmetricKey

func NewSymmetricKey() (*SymmetricKey, error)

NewSymmetricKey generates a new random symmetric key.