git-credential
Retrieve and store user credentials
SYNOPSIS
git credential <fill|approve|reject>
DESCRIPTION
TYPICAL USE OF GIT CREDENTIAL
" 1." 4.2 Generate a credential description based on the context . For example, if we want a password for https://example.com/foo .git ,we might generate the following credential description (don forget the blank line at the end; it tells gitcredential that the application finished feeding all the information it has): .RS 4
protocol=https host=example .com path=foo .git .RE '-04' 2. '+01' .sp -1
" 2." 4.2 Ask git -credential to give us a username and password for this description . This is done by running gitcredential fill ,feeding the description from step (1) to its standard input . The complete credential description (including the credential per se, i .e . the login and password) will be produced on standard output, like: .RS 4
protocol=https host=example .com username=bob password=secr3t .RE In most cases, this means the attributes given in the input will be repeated in the output, but Git may also modify the credential description, for example by removing the path attribute when the protocol is HTTP(s) and credential.useHttpPath is false . If the gitcredential knew about the password, this step may not have involved the user actually typing this password (the user may have typed a password to unlock the keychain instead, or no user interaction was done if the keychain was already unlocked) before it returned password=secr3t . '-04' 3. '+01' .sp -1
" 3." 4.2 Use the credential (e .g ., access the URL with the username and password from step (2)), and see if it accepted . '-04' 4. '+01' .sp -1
" 4." 4.2 Report on the success or failure of the password . If the credential allowed the operation to complete successfully, then it can be marked with an "approve" action to tell gitcredential to reuse it in its next invocation . If the credential was rejected during the operation, use the "reject" action so that gitcredential will ask for a new password in its next invocation . In either case, gitcredential should be fed with the credential description obtained from step (2) (which also contain the ones provided in step (1)) .
INPUT/OUTPUT FORMAT
protocol The protocol over which the credential will be used (e .g ., https ).
host The remote hostname for a network credential .
path The path with which the credential will be used . E .g ., for accessing a remote https repository, this will be the repository path on the server .
username The credential username, if we already have one (e .g ., from a URL, from the user, or from a previously run helper) .
password The credential password, if we are asking it to be stored .
url When this special attribute is read by gitcredential ,the value is parsed as a URL and treated as if its constituent parts were read (e .g ., url=https://example.com would behave as if protocol=https and host=example.com had been provided) . This can help callers avoid parsing URLs themselves . Note that any components which are missing from the URL (e .g ., there is no username in the example above) will be set to empty; if you want to provide a URL and override some attributes, provide the URL attribute first, followed by any overrides .
NOTES
" 1." 4 the Git credential API file:///usr/share/doc/git-doc/technical/api-credentials.html