man1/git-credential.1

   1 '\" t
   2 .\"     Title: git-credential
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-04-30
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.45.0.31.gd4cc1ec35f
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-CREDENTIAL" "1" "2024\-04\-30" "Git 2\&.45\&.0\&.31\&.gd4cc1ec" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-credential \- Retrieve and store user credentials
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \*(Aqgit credential\*(Aq (fill|approve|reject)
  36 .fi
  37 .sp
  38 .SH "DESCRIPTION"
  39 .sp
  40 Git has an internal interface for storing and retrieving credentials from system\-specific helpers, as well as prompting the user for usernames and passwords\&. The git\-credential command exposes this interface to scripts which may want to retrieve, store, or prompt for credentials in the same manner as Git\&. The design of this scriptable interface models the internal C API; see credential\&.h for more background on the concepts\&.
  41 .sp
  42 git\-credential takes an "action" option on the command\-line (one of \fBfill\fR, \fBapprove\fR, or \fBreject\fR) and reads a credential description on stdin (see INPUT/OUTPUT FORMAT)\&.
  43 .sp
  44 If the action is \fBfill\fR, git\-credential will attempt to add "username" and "password" attributes to the description by reading config files, by contacting any configured credential helpers, or by prompting the user\&. The username and password attributes of the credential description are then printed to stdout together with the attributes already provided\&.
  45 .sp
  46 If the action is \fBapprove\fR, git\-credential will send the description to any configured credential helpers, which may store the credential for later use\&.
  47 .sp
  48 If the action is \fBreject\fR, git\-credential will send the description to any configured credential helpers, which may erase any stored credentials matching the description\&.
  49 .sp
  50 If the action is \fBapprove\fR or \fBreject\fR, no output should be emitted\&.
  51 .SH "TYPICAL USE OF GIT CREDENTIAL"
  52 .sp
  53 An application using git\-credential will typically use \fBgit credential\fR following these steps:
  54 .sp
  55 .RS 4
  56 .ie n \{\
  57 \h'-04' 1.\h'+01'\c
  58 .\}
  59 .el \{\
  60 .sp -1
  61 .IP "  1." 4.2
  62 .\}
  63 Generate a credential description based on the context\&.
  64 .sp
  65 For example, if we want a password for
  66 \fBhttps://example\&.com/foo\&.git\fR, we might generate the following credential description (don\(cqt forget the blank line at the end; it tells
  67 \fBgit credential\fR
  68 that the application finished feeding all the information it has):
  69 .sp
  70 .if n \{\
  71 .RS 4
  72 .\}
  73 .nf
  74 protocol=https
  75 host=example\&.com
  76 path=foo\&.git
  77 .fi
  78 .if n \{\
  79 .RE
  80 .\}
  81 .RE
  82 .sp
  83 .RS 4
  84 .ie n \{\
  85 \h'-04' 2.\h'+01'\c
  86 .\}
  87 .el \{\
  88 .sp -1
  89 .IP "  2." 4.2
  90 .\}
  91 Ask git\-credential to give us a username and password for this description\&. This is done by running
  92 \fBgit credential fill\fR, 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:
  93 .sp
  94 .if n \{\
  95 .RS 4
  96 .\}
  97 .nf
  98 protocol=https
  99 host=example\&.com
 100 username=bob
 101 password=secr3t
 102 .fi
 103 .if n \{\
 104 .RE
 105 .\}
 106 .sp
 107 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
 108 \fBpath\fR
 109 attribute when the protocol is HTTP(s) and
 110 \fBcredential\&.useHttpPath\fR
 111 is false\&.
 112 .sp
 113 If the
 114 \fBgit credential\fR
 115 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
 116 \fBpassword=secr3t\fR\&.
 117 .RE
 118 .sp
 119 .RS 4
 120 .ie n \{\
 121 \h'-04' 3.\h'+01'\c
 122 .\}
 123 .el \{\
 124 .sp -1
 125 .IP "  3." 4.2
 126 .\}
 127 Use the credential (e\&.g\&., access the URL with the username and password from step (2)), and see if it\(cqs accepted\&.
 128 .RE
 129 .sp
 130 .RS 4
 131 .ie n \{\
 132 \h'-04' 4.\h'+01'\c
 133 .\}
 134 .el \{\
 135 .sp -1
 136 .IP "  4." 4.2
 137 .\}
 138 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
 139 \fBgit credential\fR
 140 to reuse it in its next invocation\&. If the credential was rejected during the operation, use the "reject" action so that
 141 \fBgit credential\fR
 142 will ask for a new password in its next invocation\&. In either case,
 143 \fBgit credential\fR
 144 should be fed with the credential description obtained from step (2) (which also contains the fields provided in step (1))\&.
 145 .RE
 146 .SH "INPUT/OUTPUT FORMAT"
 147 .sp
 148 \fBgit credential\fR reads and/or writes (depending on the action used) credential information in its standard input/output\&. This information can correspond either to keys for which \fBgit credential\fR will obtain the login information (e\&.g\&. host, protocol, path), or to the actual credential data to be obtained (username/password)\&.
 149 .sp
 150 The credential is split into a set of named attributes, with one attribute per line\&. Each attribute is specified by a key\-value pair, separated by an \fB=\fR (equals) sign, followed by a newline\&.
 151 .sp
 152 The key may contain any bytes except \fB=\fR, newline, or NUL\&. The value may contain any bytes except newline or NUL\&.
 153 .sp
 154 Attributes with keys that end with C\-style array brackets \fB[]\fR can have multiple values\&. Each instance of a multi\-valued attribute forms an ordered list of values \- the order of the repeated attributes defines the order of the values\&. An empty multi\-valued attribute (\fBkey[]=\en\fR) acts to clear any previous entries and reset the list\&.
 155 .sp
 156 In all cases, all bytes are treated as\-is (i\&.e\&., there is no quoting, and one cannot transmit a value with newline or NUL in it)\&. The list of attributes is terminated by a blank line or end\-of\-file\&.
 157 .sp
 158 Git understands the following attributes:
 159 .PP
 160 \fBprotocol\fR
 161 .RS 4
 162 The protocol over which the credential will be used (e\&.g\&.,
 163 \fBhttps\fR)\&.
 164 .RE
 165 .PP
 166 \fBhost\fR
 167 .RS 4
 168 The remote hostname for a network credential\&. This includes the port number if one was specified (e\&.g\&., "example\&.com:8088")\&.
 169 .RE
 170 .PP
 171 \fBpath\fR
 172 .RS 4
 173 The path with which the credential will be used\&. E\&.g\&., for accessing a remote https repository, this will be the repository\(cqs path on the server\&.
 174 .RE
 175 .PP
 176 \fBusername\fR
 177 .RS 4
 178 The credential\(cqs username, if we already have one (e\&.g\&., from a URL, the configuration, the user, or from a previously run helper)\&.
 179 .RE
 180 .PP
 181 \fBpassword\fR
 182 .RS 4
 183 The credential\(cqs password, if we are asking it to be stored\&.
 184 .RE
 185 .PP
 186 \fBpassword_expiry_utc\fR
 187 .RS 4
 188 Generated passwords such as an OAuth access token may have an expiry date\&. When reading credentials from helpers,
 189 \fBgit credential fill\fR
 190 ignores expired passwords\&. Represented as Unix time UTC, seconds since 1970\&.
 191 .RE
 192 .PP
 193 \fBoauth_refresh_token\fR
 194 .RS 4
 195 An OAuth refresh token may accompany a password that is an OAuth access token\&. Helpers must treat this attribute as confidential like the password attribute\&. Git itself has no special behaviour for this attribute\&.
 196 .RE
 197 .PP
 198 \fBurl\fR
 199 .RS 4
 200 When this special attribute is read by
 201 \fBgit credential\fR, the value is parsed as a URL and treated as if its constituent parts were read (e\&.g\&.,
 202 \fBurl=https://example\&.com\fR
 203 would behave as if
 204 \fBprotocol=https\fR
 205 and
 206 \fBhost=example\&.com\fR
 207 had been provided)\&. This can help callers avoid parsing URLs themselves\&.
 208 .sp
 209 Note that specifying a protocol is mandatory and if the URL doesn\(cqt specify a hostname (e\&.g\&., "cert:///path/to/file") the credential will contain a hostname attribute whose value is an empty string\&.
 210 .sp
 211 Components which are missing from the URL (e\&.g\&., there is no username in the example above) will be left unset\&.
 212 .RE
 213 .PP
 214 \fBwwwauth[]\fR
 215 .RS 4
 216 When an HTTP response is received by Git that includes one or more
 217 \fIWWW\-Authenticate\fR
 218 authentication headers, these will be passed by Git to credential helpers\&.
 219 .sp
 220 Each
 221 \fIWWW\-Authenticate\fR
 222 header value is passed as a multi\-valued attribute
 223 \fIwwwauth[]\fR, where the order of the attributes is the same as they appear in the HTTP response\&. This attribute is
 224 \fIone\-way\fR
 225 from Git to pass additional information to credential helpers\&.
 226 .RE
 227 .sp
 228 Unrecognised attributes are silently discarded\&.
 229 .SH "GIT"
 230 .sp
 231 Part of the \fBgit\fR(1) suite