keys

Documentation

Overview

Package keys contains implementations of Master Keys and generic key errors.

Index

• Variables
• type BaseKey
  • func NewBaseKey(metadata model.KeyMeta) BaseKey
  • func (mk *BaseKey) KeyID() string
  • func (mk *BaseKey) Metadata() model.KeyMeta
  • func (mk *BaseKey) OwnsDataKey(key model.Key) bool

Variables

var ErrDecryptKey = errors.New("unable to decrypt data key")

ErrDecryptKey is returned when the data key cannot be decrypted.

var ErrEncryptKey = errors.New("unable to encrypt data key")

ErrEncryptKey is returned when the data key cannot be encrypted.

var ErrGenerateDataKey = errors.New("unable to generate data key")

ErrGenerateDataKey is returned when the data key cannot be generated.

Types

type BaseKey

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

BaseKey is implementation of model.MasterKeyBase that methods can be reused or overridden by other master key implementations.

func NewBaseKey

func NewBaseKey(metadata model.KeyMeta) BaseKey

NewBaseKey returns a new instance of BaseKey.

func (*BaseKey) KeyID

func (mk *BaseKey) KeyID() string

KeyID returns the key ID of the master key.

func (*BaseKey) Metadata

func (mk *BaseKey) Metadata() model.KeyMeta

Metadata returns the model.KeyMeta metadata of the master key.

func (*BaseKey) OwnsDataKey

func (mk *BaseKey) OwnsDataKey(key model.Key) bool

OwnsDataKey returns true if key is owned by the master key. In other words, the key was encrypted with the master key.

Raw Master Key and KMS MRK Master Key implementations are using a different logic to determine if the key is owned by the master key.