Documentation
¶
Index ¶
- Variables
- func GetAllCredentials(sys *types.SystemContext) (map[string]types.DockerAuthConfig, error)
- func GetAuthentication(sys *types.SystemContext, registry string) (string, string, error)deprecated
- func GetCredentials(sys *types.SystemContext, registry string) (types.DockerAuthConfig, error)
- func RemoveAllAuthentication(sys *types.SystemContext) error
- func RemoveAuthentication(sys *types.SystemContext, registry string) error
- func SetAuthentication(sys *types.SystemContext, registry, username, password string) error
- func SetCredentials(sys *types.SystemContext, registry, username, password string) (string, error)
Constants ¶
This section is empty.
Variables ¶
var ( // ErrNotLoggedIn is returned for users not logged into a registry // that they are trying to logout of ErrNotLoggedIn = errors.New("not logged in") // ErrNotSupported is returned for unsupported methods ErrNotSupported = errors.New("not supported") )
Functions ¶
func GetAllCredentials ¶ added in v5.5.0
func GetAllCredentials(sys *types.SystemContext) (map[string]types.DockerAuthConfig, error)
GetAllCredentials returns the registry credentials for all registries stored in any of the configured credential helpers.
func GetAuthentication
deprecated
GetAuthentication returns the registry credentials stored in the registry-specific credential helpers or in the default global credentials helpers with falling back to using either auth.json file or .docker/config.json
Deprecated: This API only has support for username and password. To get the support for oauth2 in docker registry authentication, we added the new GetCredentials API. The new API should be used and this API is kept to maintain backward compatibility.
func GetCredentials ¶ added in v5.3.0
func GetCredentials(sys *types.SystemContext, registry string) (types.DockerAuthConfig, error)
GetCredentials returns the registry credentials stored in the registry-specific credential helpers or in the default global credentials helpers with falling back to using either auth.json file or .docker/config.json, including support for OAuth2 and IdentityToken. If an entry is not found, an empty struct is returned.
func RemoveAllAuthentication ¶
func RemoveAllAuthentication(sys *types.SystemContext) error
RemoveAllAuthentication deletes all the credentials stored in credential helpers and auth files.
func RemoveAuthentication ¶
func RemoveAuthentication(sys *types.SystemContext, registry string) error
RemoveAuthentication removes credentials for `registry` from all possible sources such as credential helpers and auth files.
func SetAuthentication ¶
func SetAuthentication(sys *types.SystemContext, registry, username, password string) error
SetAuthentication stores the username and password in the credential helper or file
func SetCredentials ¶ added in v5.13.0
func SetCredentials(sys *types.SystemContext, registry, username, password string) (string, error)
SetCredentials stores the username and password in the credential helper or file and returns path to file or helper name in format (helper:%s). Returns a human-redable description of the location that was updated. NOTE: The return value is only intended to be read by humans; its form is not an API, it may change (or new forms can be added) any time.
Types ¶
This section is empty.
Source Files