client

package module
v0.0.28 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 13, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ParseID     = secrets.ParseID
	MustParseID = secrets.MustParseID

	ParsePattern     = secrets.ParsePattern
	MustParsePattern = secrets.MustParsePattern

	ErrSecretNotFound            = secrets.ErrNotFound
	ErrSecretsEngineNotAvailable = errors.New("secrets engine is not available")
)

Functions

This section is empty.

Types

type Client added in v0.0.17 

type Client interface {
	secrets.Resolver

	// Version returns the name and version reported by the daemon.
	Version(ctx context.Context) (DaemonVersion, error)
}

Client is the interface for interacting with the secrets engine daemon.

func New 

func New(options ...Option) (Client, error)

type DaemonVersion added in v0.0.25 

type DaemonVersion = api.DaemonVersion

type Envelope 

type Envelope = secrets.Envelope

type ID 

type ID = secrets.ID

type Option 

type Option func(c *config) error

func WithDialContext added in v0.0.12 

func WithDialContext(dialContext func(ctx context.Context, network, addr string) (net.Conn, error)) Option

func WithResponseTimeout added in v0.0.19 

func WithResponseTimeout(responseTimeout time.Duration) Option

WithResponseTimeout overrides the response header timeout of the client.

It is useful to set if there are long-lived user interactions required when the Secrets Engine requests secrets from a plugin.

A responseTimeout of 0 means no response header timeout will be applied. Negative durations are not allowed and will result in an error.

func WithSocketPath 

func WithSocketPath(path string) Option

func WithTimeout 

func WithTimeout(timeout time.Duration) Option

WithTimeout overrides the request timeout of the client.

It is useful to set if there are hard-limits to when the client must wait for the server to accept the request.

A timeout of 0 means no request timeout will be applied. Negative durations are not allowed and will result in an error.

type Pattern added in v0.0.9 

type Pattern = secrets.Pattern

type PluginInfo added in v0.0.17 

type PluginInfo struct {
	Name            api.Name
	Version         api.Version
	Disabled        bool
	External        bool
	Configurable    bool
	RunStatus       pluginsv1.RunStatus
	StatusMessage   string
	SecretsProvider *SecretsProviderMetadata
}

type PluginManagement added in v0.0.26 

type PluginManagement interface {
	ListPlugins(ctx context.Context) ([]PluginInfo, error)
	EnablePlugin(ctx context.Context, name string) error
	DisablePlugin(ctx context.Context, name string) error
}

func PluginManagementFromClient added in v0.0.26 

func PluginManagementFromClient(c Client) (PluginManagement, error)

type SecretsProviderMetadata added in v0.0.26 

type SecretsProviderMetadata struct {
	Pattern secrets.Pattern
}

Source Files

View all Source files

Directories

Path Synopsis
Package realms exposes the canonical set of Docker realm patterns that clients use to scope secret queries.
 Package realms exposes the canonical set of Docker realm patterns that clients use to scope secret queries.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.