plugins

Documentation

Index

• Constants
• Variables
• type SecretsProtocol

Constants

const (
	// PluginInterface for secrets. This first part of the
	// three-part plugin key is only seen/used by the plugins when the host is
	// communicating with the plugin and is not exposed to users.
	PluginInterface = "secrets"

	// PluginProtocolVersion is the currently supported plugin protocol version for secrets.
	PluginProtocolVersion = 2
)

Variables

var (
	// ErrNotImplemented is the error to be returned if a method is not implemented
	// in a secret plugin
	ErrNotImplemented = errors.New("not implemented")
)

Types

type SecretsProtocol

type SecretsProtocol interface {
	// Resolve a secret value from a secret store
	// - keyName is name of the key where the secret can be found.
	// - keyValue is the value of the key.
	// if keyName can not be reolved by a plugin implementation, the plugin will
	// fall back to use the host plugin.
	// Examples:
	// - keyName=env, keyValue=CONN_STRING
	// - keyName=key, keyValue=conn-string
	// - keyName=path, keyValue=/tmp/connstring.txt
	Resolve(ctx context.Context, keyName string, keyValue string) (string, error)

	// Create stores a secret value in a secret store.
	// - keyName is name of the key where the secret can be found.
	// - keyValue is the value of the key.
	// Examples:
	// - keyName=env, keyValue=CONN_STRING, value=redis://foo
	// - keyName=key, keyValue=conn-string, value=redis://foo
	// - keyName=path, keyValue=/tmp/connstring.txt, value=redis://foo
	Create(ctx context.Context, keyName string, keyValue string, value string) error
}

SecretsProtocol is the interface that secrets plugins must implement. This defines the protocol used to communicate with secrets plugins.