plugins

Documentation

Index

• Constants
• Variables
• type SigningProtocol

Constants

const (
	// PluginInterface for signing. 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 = "signing"

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

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 SigningProtocol

type SigningProtocol interface {
	Connect(ctx context.Context) error

	// Resolve a secret value from a secret store
	// - ref is OCI reference to verify
	Sign(ctx context.Context, ref string) error

	// Verify attempts to verify the signature of a given reference
	// - ref is OCI reference to verify
	Verify(ctx context.Context, ref string) error
}

SigningProtocol is the interface that signing plugins must implement. This defines the protocol used to communicate with signing plugins.