Documentation
¶
Index ¶
- Variables
- func Erase(helper Helper, reader io.Reader) error
- func Get(helper Helper, reader io.Reader, writer io.Writer) error
- func HandleCommand(helper Helper, key string, in io.Reader, out io.Writer) error
- func IsErrCredentialsNotFound(err error) bool
- func IsErrCredentialsNotFoundMessage(err string) bool
- func List(helper Helper, writer io.Writer) error
- func NewErrCredentialsNotFound() error
- func Serve(helper Helper)
- func SetCredsLabel(label string)
- func Store(helper Helper, reader io.Reader) error
- type Credentials
- type Helper
Constants ¶
This section is empty.
Variables ¶
var CredsLabel = "Docker Credentials"
Docker credentials should be labeled as such in credentials stores that allow labelling. That label allows to filter out non-Docker credentials too at lookup/search in macOS keychain, Windows credentials manager and Linux libsecret. Default value is "Docker Credentials"
Functions ¶
func Erase ¶ added in v0.3.0
Erase removes credentials from the store. The reader must contain the server URL to remove.
func Get ¶ added in v0.3.0
Get retrieves the credentials for a given server url. The reader must contain the server URL to search. The writer is used to write the JSON serialization of the credentials.
func HandleCommand ¶ added in v0.3.0
HandleCommand uses a helper and a key to run a credential action.
func IsErrCredentialsNotFound ¶ added in v0.3.0
IsErrCredentialsNotFound returns true if the error was caused by not having a set of credentials in a store.
func IsErrCredentialsNotFoundMessage ¶ added in v0.3.0
IsErrCredentialsNotFoundMessage returns true if the error was caused by not having a set of credentials in a store.
This function helps to check messages returned by an external program via its standard output.
func List ¶ added in v0.4.0
List returns all the serverURLs of keys in the OS store as a list of strings
func NewErrCredentialsNotFound ¶ added in v0.3.0
func NewErrCredentialsNotFound() error
NewErrCredentialsNotFound creates a new error for when the credentials are not in the store.
func Serve ¶
func Serve(helper Helper)
Serve initializes the credentials helper and parses the action argument. This function is designed to be called from a command line interface. It uses os.Args[1] as the key for the action. It uses os.Stdin as input and os.Stdout as output. This function terminates the program with os.Exit(1) if there is an error.
func SetCredsLabel ¶ added in v0.5.0
func SetCredsLabel(label string)
Types ¶
type Credentials ¶
Credentials holds the information shared between docker and the credentials store.
type Helper ¶
type Helper interface {
// Add appends credentials to the store.
Add(*Credentials) error
// Delete removes credentials from the store.
Delete(serverURL string) error
// Get retrieves credentials from the store.
// It returns username and secret as strings.
Get(serverURL string) (string, string, error)
// List returns the stored serverURLs and their associated usernames.
List() (map[string]string, error)
}
Helper is the interface a credentials store helper must implement.
Source Files