key

Documentation

Index

• Constants
• func Len(a kes.KeyAlgorithm) int
• type Key
  • func New(algorithm kes.KeyAlgorithm, key []byte, owner kes.Identity) (Key, error)
  • func Parse(b []byte) (Key, error)
  • func Random(algorithm kes.KeyAlgorithm, owner kes.Identity) (Key, error)
  • func (k *Key) Algorithm() kes.KeyAlgorithm
  • func (k *Key) Clone() Key
  • func (k *Key) CreatedAt() time.Time
  • func (k *Key) CreatedBy() kes.Identity
  • func (k *Key) Equal(other Key) bool
  • func (k *Key) ID() string
  • func (k Key) MarshalBinary() ([]byte, error)
  • func (k Key) MarshalText() ([]byte, error)
  • func (k *Key) UnmarshalBinary(b []byte) error
  • func (k *Key) UnmarshalText(text []byte) error
  • func (k *Key) Unwrap(ciphertext, associatedData []byte) ([]byte, error)
  • func (k *Key) Wrap(plaintext, associatedData []byte) ([]byte, error)

Constants

const (
	// MaxSize is the maximum byte size of an encoded key.
	MaxSize = 1 << 20

	// Size is the byte size of a cryptographic key.
	Size = 256 / 8
)

Functions

func Len

func Len(a kes.KeyAlgorithm) int

Len returns the length of keys for the given Algorithm in bytes.

Types

type Key

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

Key is a symmetric cryptographic key.

func New

func New(algorithm kes.KeyAlgorithm, key []byte, owner kes.Identity) (Key, error)

New returns an new Key for the given cryptographic algorithm. The key len must match algorithm's key size. The returned key is owned to the specified identity.

func Parse

func Parse(b []byte) (Key, error)

Parse parses b as encoded Key.

func Random

func Random(algorithm kes.KeyAlgorithm, owner kes.Identity) (Key, error)

Random generates a new random Key for the cryptographic algorithm. The returned key is owned to the specified identity.

func (*Key) Algorithm

func (k *Key) Algorithm() kes.KeyAlgorithm

Algorithm returns the cryptographic algorithm for which the key can be used.

func (*Key) Clone

func (k *Key) Clone() Key

Clone returns a deep copy of the key.

func (*Key) CreatedAt

func (k *Key) CreatedAt() time.Time

CreatedAt returns the point in time when the key has been created.

func (*Key) CreatedBy

func (k *Key) CreatedBy() kes.Identity

CreatedBy returns the identity that created the key.

func (*Key) Equal

func (k *Key) Equal(other Key) bool

Equal returns true if and only if both keys are identical.

func (*Key) ID

func (k *Key) ID() string

ID returns the k's key ID.

func (Key) MarshalBinary

func (k Key) MarshalBinary() ([]byte, error)

MarshalBinary returns the Key's binary representation.

func (Key) MarshalText

func (k Key) MarshalText() ([]byte, error)

MarshalText returns the key's text representation.

func (*Key) UnmarshalBinary

func (k *Key) UnmarshalBinary(b []byte) error

UnmarshalBinary unmarshals the Key's binary representation.

func (*Key) UnmarshalText

func (k *Key) UnmarshalText(text []byte) error

UnmarshalText parses and decodes text as encoded key.

func (*Key) Unwrap

func (k *Key) Unwrap(ciphertext, associatedData []byte) ([]byte, error)

Unwrap decrypts the ciphertext and returns the resulting plaintext.

It verifies that the associatedData matches the value used when the ciphertext has been generated.

func (*Key) Wrap

func (k *Key) Wrap(plaintext, associatedData []byte) ([]byte, error)

Wrap encrypts the given plaintext and binds the associatedData to the returned ciphertext.

To unwrap the ciphertext the same associatedData has to be provided again.