client

package module

v0.0.25 Latest Latest Go to latest Published: Apr 1, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/docker/secrets-engine

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Client
- func New(options ...Option) (Client, error)
type DaemonVersion
type Envelope
type ID
type Option
type Pattern
type PluginInfo

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)

	ListPlugins(ctx context.Context) ([]PluginInfo, 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 timout 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
	Pattern      secrets.Pattern
	External     bool
	Configurable bool
}

Source Files ¶

View all Source files

client.go

Directories ¶

Path	Synopsis
realms 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.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL