keymanager

type Key ¶ added in v1.0.0

type Key interface {
	crypto.Signer

	// ID returns the ID of the key in the KeyManager.
	ID() string
}

Key is a KeyManager-backed key

type KeyManager ¶

type KeyManager interface {
	catalog.PluginInfo

	// GenerateKey generates a key with the given ID and key type. If a key
	// with that ID already exists, it is overwritten.
	GenerateKey(ctx context.Context, id string, keyType KeyType) (Key, error)

	// GetKey returns the key with the given ID. If a key with that ID does
	// not exist, a status of codes.NotFound is returned.
	GetKey(ctx context.Context, id string) (Key, error)

	// GetKeys returns all keys managed by the KeyManager.
	GetKeys(ctx context.Context) ([]Key, error)
}

KeyManager provides either a single or multi-key key manager

type KeyType ¶ added in v1.0.0

type KeyType int

KeyType represents the types of keys that are supported by the KeyManager.

const (
	KeyTypeUnset KeyType = iota
	ECP256
	ECP384
	RSA2048
	RSA4096
)

func (keyType KeyType) GenerateSigner() (crypto.Signer, error)

func (keyType KeyType) String() string

type Repository ¶ added in v1.0.0

type Repository struct {
	KeyManager KeyManager
}

func (repo *Repository) Clear()

func (repo *Repository) GetKeyManager() KeyManager

func (repo *Repository) SetKeyManager(keyManager KeyManager)

type SVIDKeyManager ¶ added in v1.0.0

type SVIDKeyManager interface {
	GenerateKey(ctx context.Context, currentKey Key) (Key, error)
	GetKeys(ctx context.Context) ([]Key, error)
}

SVIDKeyManager is a wrapper around the key manager specifically used for managing the agent SVID. This is more or less a short term shim until we can remove support for the v0 plugins and no longer have to adapt SVID storage to both the "single" and "multi" key manager.

func ForSVID(km KeyManager) SVIDKeyManager

type V1 ¶ added in v1.0.0

type V1 struct {
	plugin.Facade

	keymanagerv1.KeyManagerPluginClient
}

func (v1 V1) GenerateKey(ctx context.Context, id string, keyType KeyType) (Key, error)

func (v1 V1) GetKey(ctx context.Context, id string) (Key, error)

func (v1 V1) GetKeys(ctx context.Context) ([]Key, error)