mirror of
https://github.com/docker/cli.git
synced 2026-11-09 14:33:06 -04:00
Alano Terblanche
0c2d0f700c
Add the Docker secrets engine client, used to read the Docker Desktop session for Docker Hub. It brings in github.com/docker/secrets-engine/x v0.8.5 and connectrpc.com/connect v1.19.1. The client module requires go1.26.10, which raises the go directive in vendor.mod from 1.26.0. Signed-off-by: Alano Terblanche <18033717+Benehiko@users.noreply.github.com>
82 lines
3.3 KiB
Go
82 lines
3.3 KiB
Go
// Copyright 2025-2026 Docker, Inc.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package api
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"time"
|
|
)
|
|
|
|
const (
|
|
// PluginLaunchedByEngineVar is used to inform engine-launched plugins about their name.
|
|
PluginLaunchedByEngineVar = "DOCKER_SECRETS_ENGINE_PLUGIN_LAUNCH_CFG"
|
|
// DefaultPluginRegistrationTimeout is the default timeout for plugin registration.
|
|
DefaultPluginRegistrationTimeout = 5 * time.Second
|
|
// DefaultClientRequestTimeout is the default timeout for clients to handle a request.
|
|
DefaultClientRequestTimeout = time.Duration(0) // 0 means no limit
|
|
// DefaultClientResponseHeaderTimeout is the default timeout for response
|
|
// headers, excluding the body. No limit by default: a request may block
|
|
// on user interaction daemon-side. Use [client.WithResponseTimeout] or a
|
|
// context deadline for a hard bound.
|
|
DefaultClientResponseHeaderTimeout = time.Duration(0) // 0 means no limit
|
|
// DefaultClientTLSHandshakeTimeout is the default timeout for clients to handle
|
|
// tls handshakes. It should usually be short.
|
|
DefaultClientTLSHandshakeTimeout = time.Second
|
|
// DefaultClientIdleConnTimeout is the time a connection may stay alive for.
|
|
// Clients that are long-lived take advantage of re-using the same connection
|
|
// when making subsequent requests. This reduces latency.
|
|
DefaultClientIdleConnTimeout = 90 * time.Second
|
|
// DefaultClientMaxConnsPerHost is the maximum number of open connections
|
|
// to the same host.
|
|
DefaultClientMaxConnsPerHost = 100
|
|
// DefaultClientMaxIdleConnsPerHost is the maximum number of idle connections
|
|
// to the same host. Long-lived clients can re-use a connection from the
|
|
// connection pool.
|
|
DefaultClientMaxIdleConnsPerHost = 10
|
|
)
|
|
|
|
// DesktopSocketPath returns the Secrets Engine socket path used by Docker Desktop.
|
|
//
|
|
// - Linux: $XDG_CACHE_HOME/docker-secrets-engine/engine.sock, or
|
|
// $HOME/.cache/docker-secrets-engine/engine.sock when XDG_CACHE_HOME is unset.
|
|
// - macOS: $HOME/Library/Caches/docker-secrets-engine/engine.sock.
|
|
// - Windows: %LOCALAPPDATA%\docker-secrets-engine\engine.sock.
|
|
//
|
|
// If the user cache directory cannot be determined, it returns
|
|
// <temp>/docker-secrets-engine/engine.sock, where <temp> is the directory returned
|
|
// by [os.TempDir].
|
|
func DesktopSocketPath() string {
|
|
if dir, err := os.UserCacheDir(); err == nil {
|
|
return filepath.Join(dir, "docker-secrets-engine", "engine.sock")
|
|
}
|
|
return filepath.Join(os.TempDir(), "docker-secrets-engine", "engine.sock")
|
|
}
|
|
|
|
// DefaultSocketPath returns the Secrets Engine socket path used by Docker Desktop.
|
|
//
|
|
// Deprecated: Use [DesktopSocketPath] instead.
|
|
func DefaultSocketPath() string {
|
|
return DesktopSocketPath()
|
|
}
|
|
|
|
func DefaultSecretsEngineDirectory() (string, error) {
|
|
dir, err := os.UserConfigDir()
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
return filepath.Join(dir, "docker-secrets-engine"), nil
|
|
}
|