vault

Documentation

Index

• Variables
• func Commands() []*cobra.Command
• func RegisterCommand(cmd *cobra.Command)
• func RegisterVault(name string, newFunc newVaultFunc)
• type Factory
  • func Registry() Factory
• type FactoryFunc
  • func (f FactoryFunc) New(ctx context.Context, name string, conf *yaml.Node) (Vault, error)
• type Importer
• type ReadinessChecker
• type StoredKey
• type StoredKeysIterator
• type Unlocker
• type Vault
• type VaultNamer

Variables

var (
	ErrDone = errors.New("done")
	ErrKey  = errors.New("unsupported key type")
)

ErrDone is the error returned by iterator when the iteration is done.

Functions

func Commands

func Commands() []*cobra.Command

func RegisterCommand

func RegisterCommand(cmd *cobra.Command)

func RegisterVault

func RegisterVault(name string, newFunc newVaultFunc)

Types

type Factory

type Factory interface {
	New(ctx context.Context, name string, conf *yaml.Node) (Vault, error)
}

func Registry

func Registry() Factory

type FactoryFunc

type FactoryFunc func(ctx context.Context, name string, conf *yaml.Node) (Vault, error)

func (FactoryFunc) New

func (f FactoryFunc) New(ctx context.Context, name string, conf *yaml.Node) (Vault, error)

type Importer

type Importer interface {
	Vault
	Import(ctx context.Context, pk crypt.PrivateKey, opt utils.Options) (StoredKey, error)
}

Importer interface representing an importer backend

type ReadinessChecker

type ReadinessChecker interface {
	Ready(ctx context.Context) (bool, error)
}

ReadinessChecker is an optional interface implemented by a backend

type StoredKey

type StoredKey interface {
	PublicKey() crypt.PublicKey
	ID() string
}

StoredKey represents a public key which has a private counterpart stored on the backend side

type StoredKeysIterator

type StoredKeysIterator interface {
	Next() (StoredKey, error)
}

StoredKeysIterator is used to iterate over stored public keys

type Unlocker

type Unlocker interface {
	Vault
	Unlock(ctx context.Context) error
}

Unlocker interface representing an unlocker backend

type Vault

type Vault interface {
	GetPublicKey(ctx context.Context, id string) (StoredKey, error)
	ListPublicKeys(ctx context.Context) StoredKeysIterator
	SignMessage(ctx context.Context, msg []byte, key StoredKey) (crypt.Signature, error)
	Name() string
}

Vault interface that represent a secure key store

type VaultNamer

type VaultNamer interface {
	VaultName() string
}

VaultNamer might be implemented by some backends which can handle multiple vaults under single account