plugins

Documentation

Index

• Constants
• type SecretsPlugin
• type SecretsProtocol

Constants

const PluginInterface = "secrets"

PluginInterface for the 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.

Types

type SecretsPlugin

type SecretsPlugin interface {
	plugins.Plugin
	SecretsProtocol
}

SecretsPlugin is the interface used to wrap a secrets plugin. It is not meant to be used directly.

type SecretsProtocol

type SecretsProtocol interface {
	// Resolve a credential's value from 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
	// - keyName=key, keyValue=conn-string
	// - keyName=path, keyValue=/tmp/connstring.txt
	Resolve(keyName string, keyValue string) (string, error)
}

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