🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.37.0 / . / credential.c
blob: f6389a50684a6e99bad1fe39b04a96fb99abc726 [file] [log] [blame]
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]1#include "cache.h"
Brandon Williamsb2141fc2017-06-14 18:07:36[diff] [blame]2#include "config.h"
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]3#include "credential.h"
4#include "string-list.h"
5#include "run-command.h"
Jeff Kingd3e847c2011-12-10 10:31:17[diff] [blame]6#include "url.h"
Jeff Kingd3c58b82011-12-10 10:40:54[diff] [blame]7#include "prompt.h"
Erik E Bradya0d51e82018-03-29 18:00:56[diff] [blame]8#include "sigchain.h"
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]9#include "urlmatch.h"
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]10
11void credential_init(struct credential *c)
12{
Ævar Arnfjörð Bjarmason5726a6b2021-07-01 10:51:26[diff] [blame]13 struct credential blank = CREDENTIAL_INIT;
14 memcpy(c, &blank, sizeof(*c));
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]15}
16
17void credential_clear(struct credential *c)
18{
19 free(c->protocol);
20 free(c->host);
21 free(c->path);
22 free(c->username);
23 free(c->password);
24 string_list_clear(&c->helpers, 0);
25
26 credential_init(c);
27}
28
Jeff King11825072011-12-10 10:31:24[diff] [blame]29int credential_match(const struct credential *want,
30 const struct credential *have)
31{
32#define CHECK(x) (!want->x || (have->x && !strcmp(want->x, have->x)))
33 return CHECK(protocol) &&
34 CHECK(host) &&
35 CHECK(path) &&
36 CHECK(username);
37#undef CHECK
38}
39
Johannes Schindelin9a121b02020-04-24 11:49:52[diff] [blame]40
41static int credential_from_potentially_partial_url(struct credential *c,
42 const char *url);
43
Jeff King11825072011-12-10 10:31:24[diff] [blame]44static int credential_config_callback(const char *var, const char *value,
45 void *data)
46{
47 struct credential *c = data;
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]48 const char *key;
Jeff King11825072011-12-10 10:31:24[diff] [blame]49
Jeff Kingcf4fff52014-06-18 19:44:19[diff] [blame]50 if (!skip_prefix(var, "credential.", &key))
Jeff King11825072011-12-10 10:31:24[diff] [blame]51 return 0;
52
53 if (!value)
54 return config_error_nonbool(var);
55
Jeff King24321372016-02-26 10:51:35[diff] [blame]56 if (!strcmp(key, "helper")) {
57 if (*value)
58 string_list_append(&c->helpers, value);
59 else
60 string_list_clear(&c->helpers, 0);
61 } else if (!strcmp(key, "username")) {
brian m. carlson82eb2492020-02-20 02:24:12[diff] [blame]62 if (!c->username_from_proto) {
63 free(c->username);
Jeff Kingd5742422011-12-10 10:31:30[diff] [blame]64 c->username = xstrdup(value);
brian m. carlson82eb2492020-02-20 02:24:12[diff] [blame]65 }
Jeff Kingd5742422011-12-10 10:31:30[diff] [blame]66 }
Jeff Kinga78fbb42011-12-10 10:31:34[diff] [blame]67 else if (!strcmp(key, "usehttppath"))
68 c->use_http_path = git_config_bool(var, value);
Jeff King11825072011-12-10 10:31:24[diff] [blame]69
70 return 0;
71}
72
Jeff Kinga78fbb42011-12-10 10:31:34[diff] [blame]73static int proto_is_http(const char *s)
74{
75 if (!s)
76 return 0;
77 return !strcmp(s, "https") || !strcmp(s, "http");
78}
79
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]80static void credential_describe(struct credential *c, struct strbuf *out);
81static void credential_format(struct credential *c, struct strbuf *out);
82
83static int select_all(const struct urlmatch_item *a,
84 const struct urlmatch_item *b)
85{
86 return 0;
87}
88
Johannes Schindelin12294992020-04-24 22:35:49[diff] [blame]89static int match_partial_url(const char *url, void *cb)
90{
91 struct credential *c = cb;
92 struct credential want = CREDENTIAL_INIT;
93 int matches = 0;
94
95 if (credential_from_potentially_partial_url(&want, url) < 0)
96 warning(_("skipping credential lookup for key: credential.%s"),
97 url);
98 else
99 matches = credential_match(&want, c);
100 credential_clear(&want);
101
102 return matches;
103}
104
Jeff King11825072011-12-10 10:31:24[diff] [blame]105static void credential_apply_config(struct credential *c)
106{
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]107 char *normalized_url;
Ævar Arnfjörð Bjarmason73ee4492021-10-01 10:27:33[diff] [blame]108 struct urlmatch_config config = URLMATCH_CONFIG_INIT;
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]109 struct strbuf url = STRBUF_INIT;
110
Jeff King8ba8ed52020-04-19 03:50:48[diff] [blame]111 if (!c->host)
112 die(_("refusing to work with credential missing host field"));
113 if (!c->protocol)
114 die(_("refusing to work with credential missing protocol field"));
115
Jeff King11825072011-12-10 10:31:24[diff] [blame]116 if (c->configured)
117 return;
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]118
119 config.section = "credential";
120 config.key = NULL;
121 config.collect_fn = credential_config_callback;
122 config.cascade_fn = NULL;
123 config.select_fn = select_all;
Johannes Schindelin12294992020-04-24 22:35:49[diff] [blame]124 config.fallback_match_fn = match_partial_url;
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]125 config.cb = c;
126
127 credential_format(c, &url);
128 normalized_url = url_normalize(url.buf, &config.url);
129
130 git_config(urlmatch_config_entry, &config);
Mike Hommey5146c2f2021-08-20 08:44:13[diff] [blame]131 string_list_clear(&config.vars, 1);
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]132 free(normalized_url);
Ævar Arnfjörð Bjarmasona41e8e72022-03-04 18:32:07[diff] [blame]133 urlmatch_config_release(&config);
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]134 strbuf_release(&url);
135
Jeff King11825072011-12-10 10:31:24[diff] [blame]136 c->configured = 1;
Jeff Kinga78fbb42011-12-10 10:31:34[diff] [blame]137
138 if (!c->use_http_path && proto_is_http(c->protocol)) {
Ævar Arnfjörð Bjarmason6a83d902017-06-15 23:15:46[diff] [blame]139 FREE_AND_NULL(c->path);
Jeff Kinga78fbb42011-12-10 10:31:34[diff] [blame]140 }
Jeff King11825072011-12-10 10:31:24[diff] [blame]141}
142
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]143static void credential_describe(struct credential *c, struct strbuf *out)
144{
145 if (!c->protocol)
146 return;
147 strbuf_addf(out, "%s://", c->protocol);
148 if (c->username && *c->username)
149 strbuf_addf(out, "%s@", c->username);
150 if (c->host)
151 strbuf_addstr(out, c->host);
152 if (c->path)
153 strbuf_addf(out, "/%s", c->path);
154}
155
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]156static void credential_format(struct credential *c, struct strbuf *out)
157{
158 if (!c->protocol)
159 return;
160 strbuf_addf(out, "%s://", c->protocol);
161 if (c->username && *c->username) {
brian m. carlsonb44d0112020-04-27 01:18:08[diff] [blame]162 strbuf_add_percentencode(out, c->username, STRBUF_ENCODE_SLASH);
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]163 strbuf_addch(out, '@');
164 }
165 if (c->host)
166 strbuf_addstr(out, c->host);
167 if (c->path) {
168 strbuf_addch(out, '/');
brian m. carlsonb44d0112020-04-27 01:18:08[diff] [blame]169 strbuf_add_percentencode(out, c->path, 0);
brian m. carlson46fd7b32020-02-20 02:24:13[diff] [blame]170 }
171}
172
Jeff Kingce77aa42011-12-10 10:41:23[diff] [blame]173static char *credential_ask_one(const char *what, struct credential *c,
174 int flags)
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]175{
176 struct strbuf desc = STRBUF_INIT;
177 struct strbuf prompt = STRBUF_INIT;
178 char *r;
179
180 credential_describe(c, &desc);
181 if (desc.len)
182 strbuf_addf(&prompt, "%s for '%s': ", what, desc.buf);
183 else
184 strbuf_addf(&prompt, "%s: ", what);
185
Jeff Kingce77aa42011-12-10 10:41:23[diff] [blame]186 r = git_prompt(prompt.buf, flags);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]187
188 strbuf_release(&desc);
189 strbuf_release(&prompt);
190 return xstrdup(r);
191}
192
193static void credential_getpass(struct credential *c)
194{
195 if (!c->username)
Jeff Kingce77aa42011-12-10 10:41:23[diff] [blame]196 c->username = credential_ask_one("Username", c,
197 PROMPT_ASKPASS|PROMPT_ECHO);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]198 if (!c->password)
Jeff Kingce77aa42011-12-10 10:41:23[diff] [blame]199 c->password = credential_ask_one("Password", c,
200 PROMPT_ASKPASS);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]201}
202
203int credential_read(struct credential *c, FILE *fp)
204{
205 struct strbuf line = STRBUF_INIT;
206
Nikita Leonov356c4732020-10-03 13:29:12[diff] [blame]207 while (strbuf_getline(&line, fp) != EOF) {
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]208 char *key = line.buf;
209 char *value = strchr(key, '=');
210
211 if (!line.len)
212 break;
213
214 if (!value) {
215 warning("invalid credential line: %s", key);
216 strbuf_release(&line);
217 return -1;
218 }
219 *value++ = '\0';
220
221 if (!strcmp(key, "username")) {
222 free(c->username);
223 c->username = xstrdup(value);
brian m. carlson82eb2492020-02-20 02:24:12[diff] [blame]224 c->username_from_proto = 1;
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]225 } else if (!strcmp(key, "password")) {
226 free(c->password);
227 c->password = xstrdup(value);
228 } else if (!strcmp(key, "protocol")) {
229 free(c->protocol);
230 c->protocol = xstrdup(value);
231 } else if (!strcmp(key, "host")) {
232 free(c->host);
233 c->host = xstrdup(value);
234 } else if (!strcmp(key, "path")) {
235 free(c->path);
236 c->path = xstrdup(value);
Jeff King9c183a72012-07-18 12:06:26[diff] [blame]237 } else if (!strcmp(key, "url")) {
238 credential_from_url(c, value);
Jeff King59b38652014-12-04 03:46:48[diff] [blame]239 } else if (!strcmp(key, "quit")) {
240 c->quit = !!git_config_bool("quit", value);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]241 }
242 /*
243 * Ignore other lines; we don't know what they mean, but
244 * this future-proofs us when later versions of git do
245 * learn new lines, and the helpers are updated to match.
246 */
247 }
248
249 strbuf_release(&line);
250 return 0;
251}
252
Jeff King8ba8ed52020-04-19 03:50:48[diff] [blame]253static void credential_write_item(FILE *fp, const char *key, const char *value,
254 int required)
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]255{
Jeff King8ba8ed52020-04-19 03:50:48[diff] [blame]256 if (!value && required)
257 BUG("credential value for %s is missing", key);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]258 if (!value)
259 return;
Jeff King9a6bbee2020-03-11 21:53:41[diff] [blame]260 if (strchr(value, '\n'))
261 die("credential value for %s contains newline", key);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]262 fprintf(fp, "%s=%s\n", key, value);
263}
264
Matthieu Moy2d6dc182012-06-24 11:40:00[diff] [blame]265void credential_write(const struct credential *c, FILE *fp)
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]266{
Jeff King8ba8ed52020-04-19 03:50:48[diff] [blame]267 credential_write_item(fp, "protocol", c->protocol, 1);
268 credential_write_item(fp, "host", c->host, 1);
269 credential_write_item(fp, "path", c->path, 0);
270 credential_write_item(fp, "username", c->username, 0);
271 credential_write_item(fp, "password", c->password, 0);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]272}
273
274static int run_credential_helper(struct credential *c,
275 const char *cmd,
276 int want_output)
277{
René Scharfed3180272014-08-19 19:09:35[diff] [blame]278 struct child_process helper = CHILD_PROCESS_INIT;
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]279 FILE *fp;
280
Junio C Hamanoafbdba32020-08-26 22:25:03[diff] [blame]281 strvec_push(&helper.args, cmd);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]282 helper.use_shell = 1;
283 helper.in = -1;
284 if (want_output)
285 helper.out = -1;
286 else
287 helper.no_stdout = 1;
288
289 if (start_command(&helper) < 0)
290 return -1;
291
292 fp = xfdopen(helper.in, "w");
Erik E Bradya0d51e82018-03-29 18:00:56[diff] [blame]293 sigchain_push(SIGPIPE, SIG_IGN);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]294 credential_write(c, fp);
295 fclose(fp);
Erik E Bradya0d51e82018-03-29 18:00:56[diff] [blame]296 sigchain_pop(SIGPIPE);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]297
298 if (want_output) {
299 int r;
300 fp = xfdopen(helper.out, "r");
301 r = credential_read(c, fp);
302 fclose(fp);
303 if (r < 0) {
304 finish_command(&helper);
305 return -1;
306 }
307 }
308
309 if (finish_command(&helper))
310 return -1;
311 return 0;
312}
313
314static int credential_do(struct credential *c, const char *helper,
315 const char *operation)
316{
317 struct strbuf cmd = STRBUF_INIT;
318 int r;
319
320 if (helper[0] == '!')
321 strbuf_addstr(&cmd, helper + 1);
322 else if (is_absolute_path(helper))
323 strbuf_addstr(&cmd, helper);
324 else
325 strbuf_addf(&cmd, "git credential-%s", helper);
326
327 strbuf_addf(&cmd, " %s", operation);
328 r = run_credential_helper(c, cmd.buf, !strcmp(operation, "get"));
329
330 strbuf_release(&cmd);
331 return r;
332}
333
334void credential_fill(struct credential *c)
335{
336 int i;
337
338 if (c->username && c->password)
339 return;
340
Jeff King11825072011-12-10 10:31:24[diff] [blame]341 credential_apply_config(c);
342
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]343 for (i = 0; i < c->helpers.nr; i++) {
344 credential_do(c, c->helpers.items[i].string, "get");
345 if (c->username && c->password)
346 return;
Jeff King59b38652014-12-04 03:46:48[diff] [blame]347 if (c->quit)
348 die("credential helper '%s' told us to quit",
349 c->helpers.items[i].string);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]350 }
351
352 credential_getpass(c);
353 if (!c->username && !c->password)
354 die("unable to get password from user");
355}
356
357void credential_approve(struct credential *c)
358{
359 int i;
360
361 if (c->approved)
362 return;
363 if (!c->username || !c->password)
364 return;
365
Jeff King11825072011-12-10 10:31:24[diff] [blame]366 credential_apply_config(c);
367
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]368 for (i = 0; i < c->helpers.nr; i++)
369 credential_do(c, c->helpers.items[i].string, "store");
370 c->approved = 1;
371}
372
373void credential_reject(struct credential *c)
374{
375 int i;
376
Jeff King11825072011-12-10 10:31:24[diff] [blame]377 credential_apply_config(c);
378
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]379 for (i = 0; i < c->helpers.nr; i++)
380 credential_do(c, c->helpers.items[i].string, "erase");
381
Ævar Arnfjörð Bjarmason88ce3ef2017-06-15 23:15:49[diff] [blame]382 FREE_AND_NULL(c->username);
383 FREE_AND_NULL(c->password);
Jeff Kingabca9272011-12-10 10:31:11[diff] [blame]384 c->approved = 0;
385}
Jeff Kingd3e847c2011-12-10 10:31:17[diff] [blame]386
Jeff Kingc716fe42020-03-12 05:31:11[diff] [blame]387static int check_url_component(const char *url, int quiet,
388 const char *name, const char *value)
389{
390 if (!value)
391 return 0;
392 if (!strchr(value, '\n'))
393 return 0;
394
395 if (!quiet)
396 warning(_("url contains a newline in its %s component: %s"),
397 name, url);
398 return -1;
399}
400
Johannes Schindelin6828e592020-04-24 11:49:51[diff] [blame]401/*
402 * Potentially-partial URLs can, but do not have to, contain
403 *
404 * - a protocol (or scheme) of the form "<protocol>://"
405 *
406 * - a host name (the part after the protocol and before the first slash after
407 * that, if any)
408 *
409 * - a user name and potentially a password (as "<user>[:<password>]@" part of
410 * the host name)
411 *
412 * - a path (the part after the host name, if any, starting with the slash)
413 *
414 * Missing parts will be left unset in `struct credential`. Thus, `https://`
415 * will have only the `protocol` set, `example.com` only the host name, and
416 * `/git` only the path.
417 *
418 * Note that an empty host name in an otherwise fully-qualified URL (e.g.
419 * `cert:///path/to/cert.pem`) will be treated as unset if we expect the URL to
420 * be potentially partial, and only then (otherwise, the empty string is used).
421 *
422 * The credential_from_url() function does not allow partial URLs.
423 */
424static int credential_from_url_1(struct credential *c, const char *url,
425 int allow_partial_url, int quiet)
Jeff Kingd3e847c2011-12-10 10:31:17[diff] [blame]426{
427 const char *at, *colon, *cp, *slash, *host, *proto_end;
428
429 credential_clear(c);
430
431 /*
432 * Match one of:
433 * (1) proto://<host>/...
434 * (2) proto://<user>@<host>/...
435 * (3) proto://<user>:<pass>@<host>/...
436 */
437 proto_end = strstr(url, "://");
Johannes Schindelin6828e592020-04-24 11:49:51[diff] [blame]438 if (!allow_partial_url && (!proto_end || proto_end == url)) {
Jonathan Niederc44088e2020-04-19 03:54:13[diff] [blame]439 if (!quiet)
440 warning(_("url has no scheme: %s"), url);
441 return -1;
442 }
Johannes Schindelin6828e592020-04-24 11:49:51[diff] [blame]443 cp = proto_end ? proto_end + 3 : url;
Jeff Kingd3e847c2011-12-10 10:31:17[diff] [blame]444 at = strchr(cp, '@');
445 colon = strchr(cp, ':');
Jeff King4c5971e2020-04-14 21:43:04[diff] [blame]446
447 /*
448 * A query or fragment marker before the slash ends the host portion.
449 * We'll just continue to call this "slash" for simplicity. Notably our
450 * "trim leading slashes" part won't skip over this part of the path,
451 * but that's what we'd want.
452 */
453 slash = cp + strcspn(cp, "/?#");
Jeff Kingd3e847c2011-12-10 10:31:17[diff] [blame]454
455 if (!at || slash <= at) {
456 /* Case (1) */
457 host = cp;
458 }
459 else if (!colon || at <= colon) {
460 /* Case (2) */
461 c->username = url_decode_mem(cp, at - cp);
brian m. carlson82eb2492020-02-20 02:24:12[diff] [blame]462 if (c->username && *c->username)
463 c->username_from_proto = 1;
Jeff Kingd3e847c2011-12-10 10:31:17[diff] [blame]464 host = at + 1;
465 } else {
466 /* Case (3) */
467 c->username = url_decode_mem(cp, colon - cp);
brian m. carlson82eb2492020-02-20 02:24:12[diff] [blame]468 if (c->username && *c->username)
469 c->username_from_proto = 1;
Jeff Kingd3e847c2011-12-10 10:31:17[diff] [blame]470 c->password = url_decode_mem(colon + 1, at - (colon + 1));
471 host = at + 1;
472 }
473
Johannes Schindelin6828e592020-04-24 11:49:51[diff] [blame]474 if (proto_end && proto_end - url > 0)
475 c->protocol = xmemdupz(url, proto_end - url);
476 if (!allow_partial_url || slash - host > 0)
477 c->host = url_decode_mem(host, slash - host);
Jeff Kingd3e847c2011-12-10 10:31:17[diff] [blame]478 /* Trim leading and trailing slashes from path */
479 while (*slash == '/')
480 slash++;
481 if (*slash) {
482 char *p;
483 c->path = url_decode(slash);
484 p = c->path + strlen(c->path) - 1;
485 while (p > c->path && *p == '/')
486 *p-- = '\0';
487 }
Jeff Kingc716fe42020-03-12 05:31:11[diff] [blame]488
489 if (check_url_component(url, quiet, "username", c->username) < 0 ||
490 check_url_component(url, quiet, "password", c->password) < 0 ||
491 check_url_component(url, quiet, "protocol", c->protocol) < 0 ||
492 check_url_component(url, quiet, "host", c->host) < 0 ||
493 check_url_component(url, quiet, "path", c->path) < 0)
494 return -1;
495
496 return 0;
497}
498
Johannes Schindelin9a121b02020-04-24 11:49:52[diff] [blame]499static int credential_from_potentially_partial_url(struct credential *c,
500 const char *url)
501{
502 return credential_from_url_1(c, url, 1, 0);
503}
504
Johannes Schindelin6828e592020-04-24 11:49:51[diff] [blame]505int credential_from_url_gently(struct credential *c, const char *url, int quiet)
506{
507 return credential_from_url_1(c, url, 0, quiet);
508}
509
Jeff Kingc716fe42020-03-12 05:31:11[diff] [blame]510void credential_from_url(struct credential *c, const char *url)
511{
Jeff Kingfe29a9b2020-04-19 03:53:09[diff] [blame]512 if (credential_from_url_gently(c, url, 0) < 0)
513 die(_("credential url cannot be parsed: %s"), url);
Jeff Kingd3e847c2011-12-10 10:31:17[diff] [blame]514}