config

Documentation

Index

• Variables
• func GetAllCredentials(sys *types.SystemContext) (map[string]types.DockerAuthConfig, error)
• func GetAuthentication(sys *types.SystemContext, key string) (string, string, error)
• func GetCredentials(sys *types.SystemContext, key string) (types.DockerAuthConfig, error)
• func GetCredentialsForRef(sys *types.SystemContext, ref reference.Named) (types.DockerAuthConfig, error)
• func RemoveAllAuthentication(sys *types.SystemContext) error
• func RemoveAuthentication(sys *types.SystemContext, key string) error
• func SetAuthentication(sys *types.SystemContext, key, username, password string) error
• func SetCredentials(sys *types.SystemContext, key, username, password string) (string, error)

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

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

func GetAuthentication(sys *types.SystemContext, key string) (string, string, error)

GetAuthentication returns the registry credentials matching key, appropriate for sys and the users’ configuration. If an entry is not found, an empty struct is returned. A valid key is a repository, a namespace within a registry, or a registry hostname.

Deprecated: This API only has support for username and password. To get the support for oauth2 in container registry authentication, we added the new GetCredentialsForRef and GetCredentials API. The new API should be used and this API is kept to maintain backward compatibility.

func GetCredentials

func GetCredentials(sys *types.SystemContext, key string) (types.DockerAuthConfig, error)

GetCredentials returns the registry credentials matching key, appropriate for sys and the users’ configuration. If an entry is not found, an empty struct is returned. A valid key is a repository, a namespace within a registry, or a registry hostname.

GetCredentialsForRef should almost always be used in favor of this API.

func GetCredentialsForRef

func GetCredentialsForRef(sys *types.SystemContext, ref reference.Named) (types.DockerAuthConfig, error)

GetCredentialsForRef returns the registry credentials necessary for accessing ref on the registry ref points to, appropriate for sys and the users’ configuration. 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, key string) error

RemoveAuthentication removes credentials for `key` from all possible sources such as credential helpers and auth files. A valid key is a repository, a namespace within a registry, or a registry hostname; using forms other than just a registry may fail depending on configuration.

func SetAuthentication

func SetAuthentication(sys *types.SystemContext, key, username, password string) error

SetAuthentication stores the username and password in the credential helper or file See the documentation of SetCredentials for format of "key"

func SetCredentials

func SetCredentials(sys *types.SystemContext, key, username, password string) (string, error)

SetCredentials stores the username and password in a location appropriate for sys and the users’ configuration. A valid key is a repository, a namespace within a registry, or a registry hostname; using forms other than just a registry may fail depending on configuration. 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.