keymanager

Documentation

Index

• type Key
• type KeyManager
• type KeyType
  • func (keyType KeyType) GenerateSigner() (crypto.Signer, error)
  • func (keyType KeyType) String() string
• type MultiKeyManager
• type Repository
  • func (repo *Repository) Clear()
  • func (repo *Repository) GetKeyManager() KeyManager
  • func (repo *Repository) SetKeyManager(keyManager KeyManager)
• type SVIDKeyManager
  • func ForSVID(km KeyManager) SVIDKeyManager
• type SingleKeyManager
• type V0
  • func (v0 *V0) GenerateKey(ctx context.Context) (crypto.Signer, error)
  • func (v0 *V0) GetKey(ctx context.Context) (crypto.Signer, error)
  • func (v0 *V0) Multi() (MultiKeyManager, bool)
  • func (v0 *V0) SetKey(ctx context.Context, key crypto.Signer) error
  • func (v0 *V0) Single() (SingleKeyManager, bool)
• type V1
  • 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)
  • func (v1 *V1) Multi() (MultiKeyManager, bool)
  • func (v1 *V1) Single() (SingleKeyManager, bool)

Types

type Key

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

	// Single returns the single key manager provided by the plugin or false
	// if not supported. A plugin will support either the single or the multi
	// key manager.
	Single() (SingleKeyManager, bool)

	// Multi returns the multi key manager provided by the plugin or false
	// if not supported. A plugin will support either the single or the multi
	// key manager.
	Multi() (MultiKeyManager, bool)
}

KeyManager provides either a single or multi-key key manager

type KeyType

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) GenerateSigner

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

GenerateSigner generates a new key for the given key type

func (KeyType) String

func (keyType KeyType) String() string

String returns the string representation of the key type

type MultiKeyManager

type MultiKeyManager 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)
}

MultiKeyManager manages multiple keys for the agent

type Repository

type Repository struct {
	KeyManager KeyManager
}

func (*Repository) Clear

func (repo *Repository) Clear()

func (*Repository) GetKeyManager

func (repo *Repository) GetKeyManager() KeyManager

func (*Repository) SetKeyManager

func (repo *Repository) SetKeyManager(keyManager KeyManager)

type SVIDKeyManager

type SVIDKeyManager interface {
	GenerateKey(ctx context.Context, currentKey Key) (Key, error)
	GetKeys(ctx context.Context) ([]Key, error)
	SetKey(ctx context.Context, key 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

func ForSVID(km KeyManager) SVIDKeyManager

type SingleKeyManager

type SingleKeyManager interface {
	catalog.PluginInfo

	// GenerateKey generates a temporary key. It will not be the key returned
	// by GetKey until after SetKey has been called.
	GenerateKey(ctx context.Context) (crypto.Signer, error)

	// GetKey returns a Key previously set with SetKey.
	GetKey(ctx context.Context) (crypto.Signer, error)

	// SetKey sets the key that is returned by GetKey.
	SetKey(ctx context.Context, key crypto.Signer) error
}

SingleKeyManager provides a signing key for the agent

type V0

type V0 struct {
	plugin.Facade
	keymanagerv0.KeyManagerPluginClient
}

func (*V0) GenerateKey

func (v0 *V0) GenerateKey(ctx context.Context) (crypto.Signer, error)

func (*V0) GetKey

func (v0 *V0) GetKey(ctx context.Context) (crypto.Signer, error)

func (*V0) Multi

func (v0 *V0) Multi() (MultiKeyManager, bool)

func (*V0) SetKey

func (v0 *V0) SetKey(ctx context.Context, key crypto.Signer) error

func (*V0) Single

func (v0 *V0) Single() (SingleKeyManager, bool)

type V1

type V1 struct {
	plugin.Facade

	keymanagerv1.KeyManagerPluginClient
}

func (V1) GenerateKey

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

func (V1) GetKey

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

func (V1) GetKeys

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

func (*V1) Multi

func (v1 *V1) Multi() (MultiKeyManager, bool)

func (*V1) Single

func (v1 *V1) Single() (SingleKeyManager, bool)