client

package module

v0.1.2 Latest Latest Go to latest Published: Sep 23, 2026 License: Apache-2.0 Imports: 15 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 AccessControlModuleMetadata
type AuthorizeResponse
type Client
- func New(options ...Option) (Client, error)
type DaemonVersion
type Envelope
type ID
type Option
type Pattern
type PluginInfo
type PluginManagement
- func PluginManagementFromClient(c Client) (PluginManagement, error)
type SecretsProviderMetadata

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ParseID     = secrets.ParseID
	MustParseID = secrets.MustParseID

	ParsePattern     = secrets.ParsePattern
	MustParsePattern = secrets.MustParsePattern

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

Functions ¶

This section is empty.

Types ¶

type AccessControlModuleMetadata ¶ added in v0.0.30

type AccessControlModuleMetadata struct{}

type AuthorizeResponse ¶ added in v0.1.0

type AuthorizeResponse = secrets.AuthorizeResponse

type Client ¶ added in v0.0.17

type Client interface {
	secrets.Resolver
	secrets.Authorizer

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

	// HubAuth returns a Docker Hub authentication accessor backed by this client.
	HubAuth(opts ...dockerhub.Option) dockerhub.ClientAuth
}

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

func New ¶

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

New creates a client that connects to api.StandaloneSocketPath by default. To connect to Docker Desktop, use WithSocketPath(api.DesktopSocketPath()).

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. By default no timeout is applied, because a request may block on user interaction. 0 means no timeout; negative durations return 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
	AccessControlModule *AccessControlModuleMetadata
}

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

client.go

Directories ¶

Path	Synopsis
dockerhub Package dockerhub reads Docker Hub access tokens and account profiles from the secrets engine.	Package dockerhub reads Docker Hub access tokens and account profiles from the secrets engine.
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