keymanagerbase

Documentation

Index

• func SortKeyEntries(entries []*KeyEntry)
• type Base
  • func New(config Config) *Base
  • func (m *Base) GenerateKey(ctx context.Context, req *keymanagerv1.GenerateKeyRequest) (*keymanagerv1.GenerateKeyResponse, error)
  • func (m *Base) GetPublicKey(_ context.Context, req *keymanagerv1.GetPublicKeyRequest) (*keymanagerv1.GetPublicKeyResponse, error)
  • func (m *Base) GetPublicKeys(context.Context, *keymanagerv1.GetPublicKeysRequest) (*keymanagerv1.GetPublicKeysResponse, error)
  • func (m *Base) SetEntries(entries []*KeyEntry)
  • func (m *Base) SignData(_ context.Context, req *keymanagerv1.SignDataRequest) (*keymanagerv1.SignDataResponse, error)
• type Config
• type Generator
• type KeyEntry
  • func MakeKeyEntryFromKey(id string, privateKey crypto.PrivateKey) (*KeyEntry, error)

Functions

func SortKeyEntries

func SortKeyEntries(entries []*KeyEntry)

Types

type Base

type Base struct {
	keymanagerv1.UnsafeKeyManagerServer
	// contains filtered or unexported fields
}

Base is the base KeyManager implementation

func New

func New(config Config) *Base

New creates a new base key manager using the provided Funcs. Default implementations are provided for any that aren't set.

func (*Base) GenerateKey

func (m *Base) GenerateKey(ctx context.Context, req *keymanagerv1.GenerateKeyRequest) (*keymanagerv1.GenerateKeyResponse, error)

GenerateKey implements the KeyManager RPC of the same name.

func (*Base) GetPublicKey

func (m *Base) GetPublicKey(_ context.Context, req *keymanagerv1.GetPublicKeyRequest) (*keymanagerv1.GetPublicKeyResponse, error)

GetPublicKey implements the KeyManager RPC of the same name.

func (*Base) GetPublicKeys

func (m *Base) GetPublicKeys(context.Context, *keymanagerv1.GetPublicKeysRequest) (*keymanagerv1.GetPublicKeysResponse, error)

GetPublicKeys implements the KeyManager RPC of the same name.

func (*Base) SetEntries

func (m *Base) SetEntries(entries []*KeyEntry)

SetEntries is used to replace the set of managed entries. This is generally called by implementations when they are first loaded to set the initial set of entries.

func (*Base) SignData

func (m *Base) SignData(_ context.Context, req *keymanagerv1.SignDataRequest) (*keymanagerv1.SignDataResponse, error)

SignData implements the KeyManager RPC of the same name.

type Config

type Config struct {
	// Generator is an optional key generator.
	Generator Generator

	// WriteEntries is an optional callback used to persist key entries
	WriteEntries func(ctx context.Context, allEntries []*KeyEntry, newEntry *KeyEntry) error
}

Config is a collection of optional callbacks. Default implementations will be used when not provided.

type Generator

type Generator interface {
	GenerateRSA2048Key() (*rsa.PrivateKey, error)
	GenerateRSA4096Key() (*rsa.PrivateKey, error)
	GenerateEC256Key() (*ecdsa.PrivateKey, error)
	GenerateEC384Key() (*ecdsa.PrivateKey, error)
}

type KeyEntry

type KeyEntry struct {
	PrivateKey crypto.Signer
	*keymanagerv1.PublicKey
}

KeyEntry is an entry maintained by the key manager

func MakeKeyEntryFromKey

func MakeKeyEntryFromKey(id string, privateKey crypto.PrivateKey) (*KeyEntry, error)