Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( ParseID = secrets.ParseID MustParseID = secrets.MustParseID ParsePattern = secrets.ParsePattern MustParsePattern = secrets.MustParsePattern NewVersion = api.NewVersion MustNewVersion = api.MustNewVersion ErrSecretNotFound = secrets.ErrNotFound )
var ErrNotFound = secrets.ErrNotFound
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Envelope ¶ added in v0.0.8
Envelope is a type alias for secrets.Envelope, representing a secret envelope.
type ExternalPlugin ¶ added in v0.0.19
type ExternalPlugin interface {
Resolver
}
type Logger ¶ added in v0.0.8
Logger is a type alias for logging.Logger, used for logging within plugins.
type ManualLaunchOption ¶
type ManualLaunchOption func(c *cfg) error
ManualLaunchOption to apply to a plugin during its creation when it's manually launched (not by the secrets runtime).
func WithConnection ¶
func WithConnection(conn net.Conn) ManualLaunchOption
WithConnection sets an existing secrets runtime connection to use.
func WithPluginName ¶
func WithPluginName(name string) ManualLaunchOption
WithPluginName sets the name to use in plugin registration.
func WithRegistrationTimeout ¶
func WithRegistrationTimeout(timeout time.Duration) ManualLaunchOption
WithRegistrationTimeout sets custom registration timeout.
type Pattern ¶ added in v0.0.8
Pattern is a type alias for secrets.Pattern, used to match secret IDs.
type Resolver ¶ added in v0.0.8
Resolver is a type alias for secrets.Resolver, used to resolve secrets.
type Stub ¶
type Stub interface {
// Run starts the plugin then waits for the plugin service to exit, either due to a
// critical error or by cancelling the context. Calling Run() while the plugin is running,
// will result in an error. After the plugin service exits, Run() can safely be called again.
Run(context.Context) error
// RegistrationTimeout returns the registration timeout for the stub.
// This is the default timeout if the plugin has not been started or
// the timeout received in the Configure request otherwise.
RegistrationTimeout() time.Duration
// RequestTimeout returns the request timeout for the stub.
// This is the default timeout if the plugin has not been started or
// the timeout received in the Configure request otherwise.
RequestTimeout() time.Duration
}
Stub is the interface the stub provides for the plugin implementation.
func New ¶
func New(p ExternalPlugin, config Config, opts ...ManualLaunchOption) (Stub, error)
New creates a stub with the given plugin and options. ManualLaunchOption only apply when the plugin is launched manually. If launched by the secrets runtime, they are ignored. If logger is nil, a default logger will be created and used.
Source Files