Fourth batch
[git.git] / credential.c
blobd8d226b97e34805735cc14bdc3e549d012b33f8d
1 #include "cache.h"
2 #include "config.h"
3 #include "credential.h"
4 #include "string-list.h"
5 #include "run-command.h"
6 #include "url.h"
7 #include "prompt.h"
8 #include "sigchain.h"
9 #include "urlmatch.h"
11 void credential_init(struct credential *c)
13 memset(c, 0, sizeof(*c));
14 c->helpers.strdup_strings = 1;
17 void credential_clear(struct credential *c)
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);
26 credential_init(c);
29 int credential_match(const struct credential *want,
30 const struct credential *have)
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
41 static int credential_from_potentially_partial_url(struct credential *c,
42 const char *url);
44 static int credential_config_callback(const char *var, const char *value,
45 void *data)
47 struct credential *c = data;
48 const char *key;
50 if (!skip_prefix(var, "credential.", &key))
51 return 0;
53 if (!value)
54 return config_error_nonbool(var);
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")) {
62 if (!c->username_from_proto) {
63 free(c->username);
64 c->username = xstrdup(value);
67 else if (!strcmp(key, "usehttppath"))
68 c->use_http_path = git_config_bool(var, value);
70 return 0;
73 static int proto_is_http(const char *s)
75 if (!s)
76 return 0;
77 return !strcmp(s, "https") || !strcmp(s, "http");
80 static void credential_describe(struct credential *c, struct strbuf *out);
81 static void credential_format(struct credential *c, struct strbuf *out);
83 static int select_all(const struct urlmatch_item *a,
84 const struct urlmatch_item *b)
86 return 0;
89 static int match_partial_url(const char *url, void *cb)
91 struct credential *c = cb;
92 struct credential want = CREDENTIAL_INIT;
93 int matches = 0;
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);
102 return matches;
105 static void credential_apply_config(struct credential *c)
107 char *normalized_url;
108 struct urlmatch_config config = { STRING_LIST_INIT_DUP };
109 struct strbuf url = STRBUF_INIT;
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"));
116 if (c->configured)
117 return;
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;
124 config.fallback_match_fn = match_partial_url;
125 config.cb = c;
127 credential_format(c, &url);
128 normalized_url = url_normalize(url.buf, &config.url);
130 git_config(urlmatch_config_entry, &config);
131 free(normalized_url);
132 strbuf_release(&url);
134 c->configured = 1;
136 if (!c->use_http_path && proto_is_http(c->protocol)) {
137 FREE_AND_NULL(c->path);
141 static void credential_describe(struct credential *c, struct strbuf *out)
143 if (!c->protocol)
144 return;
145 strbuf_addf(out, "%s://", c->protocol);
146 if (c->username && *c->username)
147 strbuf_addf(out, "%s@", c->username);
148 if (c->host)
149 strbuf_addstr(out, c->host);
150 if (c->path)
151 strbuf_addf(out, "/%s", c->path);
154 static void credential_format(struct credential *c, struct strbuf *out)
156 if (!c->protocol)
157 return;
158 strbuf_addf(out, "%s://", c->protocol);
159 if (c->username && *c->username) {
160 strbuf_add_percentencode(out, c->username, STRBUF_ENCODE_SLASH);
161 strbuf_addch(out, '@');
163 if (c->host)
164 strbuf_addstr(out, c->host);
165 if (c->path) {
166 strbuf_addch(out, '/');
167 strbuf_add_percentencode(out, c->path, 0);
171 static char *credential_ask_one(const char *what, struct credential *c,
172 int flags)
174 struct strbuf desc = STRBUF_INIT;
175 struct strbuf prompt = STRBUF_INIT;
176 char *r;
178 credential_describe(c, &desc);
179 if (desc.len)
180 strbuf_addf(&prompt, "%s for '%s': ", what, desc.buf);
181 else
182 strbuf_addf(&prompt, "%s: ", what);
184 r = git_prompt(prompt.buf, flags);
186 strbuf_release(&desc);
187 strbuf_release(&prompt);
188 return xstrdup(r);
191 static void credential_getpass(struct credential *c)
193 if (!c->username)
194 c->username = credential_ask_one("Username", c,
195 PROMPT_ASKPASS|PROMPT_ECHO);
196 if (!c->password)
197 c->password = credential_ask_one("Password", c,
198 PROMPT_ASKPASS);
201 int credential_read(struct credential *c, FILE *fp)
203 struct strbuf line = STRBUF_INIT;
205 while (strbuf_getline_lf(&line, fp) != EOF) {
206 char *key = line.buf;
207 char *value = strchr(key, '=');
209 if (!line.len)
210 break;
212 if (!value) {
213 warning("invalid credential line: %s", key);
214 strbuf_release(&line);
215 return -1;
217 *value++ = '\0';
219 if (!strcmp(key, "username")) {
220 free(c->username);
221 c->username = xstrdup(value);
222 c->username_from_proto = 1;
223 } else if (!strcmp(key, "password")) {
224 free(c->password);
225 c->password = xstrdup(value);
226 } else if (!strcmp(key, "protocol")) {
227 free(c->protocol);
228 c->protocol = xstrdup(value);
229 } else if (!strcmp(key, "host")) {
230 free(c->host);
231 c->host = xstrdup(value);
232 } else if (!strcmp(key, "path")) {
233 free(c->path);
234 c->path = xstrdup(value);
235 } else if (!strcmp(key, "url")) {
236 credential_from_url(c, value);
237 } else if (!strcmp(key, "quit")) {
238 c->quit = !!git_config_bool("quit", value);
241 * Ignore other lines; we don't know what they mean, but
242 * this future-proofs us when later versions of git do
243 * learn new lines, and the helpers are updated to match.
247 strbuf_release(&line);
248 return 0;
251 static void credential_write_item(FILE *fp, const char *key, const char *value,
252 int required)
254 if (!value && required)
255 BUG("credential value for %s is missing", key);
256 if (!value)
257 return;
258 if (strchr(value, '\n'))
259 die("credential value for %s contains newline", key);
260 fprintf(fp, "%s=%s\n", key, value);
263 void credential_write(const struct credential *c, FILE *fp)
265 credential_write_item(fp, "protocol", c->protocol, 1);
266 credential_write_item(fp, "host", c->host, 1);
267 credential_write_item(fp, "path", c->path, 0);
268 credential_write_item(fp, "username", c->username, 0);
269 credential_write_item(fp, "password", c->password, 0);
272 static int run_credential_helper(struct credential *c,
273 const char *cmd,
274 int want_output)
276 struct child_process helper = CHILD_PROCESS_INIT;
277 const char *argv[] = { NULL, NULL };
278 FILE *fp;
280 argv[0] = cmd;
281 helper.argv = argv;
282 helper.use_shell = 1;
283 helper.in = -1;
284 if (want_output)
285 helper.out = -1;
286 else
287 helper.no_stdout = 1;
289 if (start_command(&helper) < 0)
290 return -1;
292 fp = xfdopen(helper.in, "w");
293 sigchain_push(SIGPIPE, SIG_IGN);
294 credential_write(c, fp);
295 fclose(fp);
296 sigchain_pop(SIGPIPE);
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;
309 if (finish_command(&helper))
310 return -1;
311 return 0;
314 static int credential_do(struct credential *c, const char *helper,
315 const char *operation)
317 struct strbuf cmd = STRBUF_INIT;
318 int r;
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);
327 strbuf_addf(&cmd, " %s", operation);
328 r = run_credential_helper(c, cmd.buf, !strcmp(operation, "get"));
330 strbuf_release(&cmd);
331 return r;
334 void credential_fill(struct credential *c)
336 int i;
338 if (c->username && c->password)
339 return;
341 credential_apply_config(c);
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;
347 if (c->quit)
348 die("credential helper '%s' told us to quit",
349 c->helpers.items[i].string);
352 credential_getpass(c);
353 if (!c->username && !c->password)
354 die("unable to get password from user");
357 void credential_approve(struct credential *c)
359 int i;
361 if (c->approved)
362 return;
363 if (!c->username || !c->password)
364 return;
366 credential_apply_config(c);
368 for (i = 0; i < c->helpers.nr; i++)
369 credential_do(c, c->helpers.items[i].string, "store");
370 c->approved = 1;
373 void credential_reject(struct credential *c)
375 int i;
377 credential_apply_config(c);
379 for (i = 0; i < c->helpers.nr; i++)
380 credential_do(c, c->helpers.items[i].string, "erase");
382 FREE_AND_NULL(c->username);
383 FREE_AND_NULL(c->password);
384 c->approved = 0;
387 static int check_url_component(const char *url, int quiet,
388 const char *name, const char *value)
390 if (!value)
391 return 0;
392 if (!strchr(value, '\n'))
393 return 0;
395 if (!quiet)
396 warning(_("url contains a newline in its %s component: %s"),
397 name, url);
398 return -1;
402 * Potentially-partial URLs can, but do not have to, contain
404 * - a protocol (or scheme) of the form "<protocol>://"
406 * - a host name (the part after the protocol and before the first slash after
407 * that, if any)
409 * - a user name and potentially a password (as "<user>[:<password>]@" part of
410 * the host name)
412 * - a path (the part after the host name, if any, starting with the slash)
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.
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).
422 * The credential_from_url() function does not allow partial URLs.
424 static int credential_from_url_1(struct credential *c, const char *url,
425 int allow_partial_url, int quiet)
427 const char *at, *colon, *cp, *slash, *host, *proto_end;
429 credential_clear(c);
432 * Match one of:
433 * (1) proto://<host>/...
434 * (2) proto://<user>@<host>/...
435 * (3) proto://<user>:<pass>@<host>/...
437 proto_end = strstr(url, "://");
438 if (!allow_partial_url && (!proto_end || proto_end == url)) {
439 if (!quiet)
440 warning(_("url has no scheme: %s"), url);
441 return -1;
443 cp = proto_end ? proto_end + 3 : url;
444 at = strchr(cp, '@');
445 colon = strchr(cp, ':');
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.
453 slash = cp + strcspn(cp, "/?#");
455 if (!at || slash <= at) {
456 /* Case (1) */
457 host = cp;
459 else if (!colon || at <= colon) {
460 /* Case (2) */
461 c->username = url_decode_mem(cp, at - cp);
462 if (c->username && *c->username)
463 c->username_from_proto = 1;
464 host = at + 1;
465 } else {
466 /* Case (3) */
467 c->username = url_decode_mem(cp, colon - cp);
468 if (c->username && *c->username)
469 c->username_from_proto = 1;
470 c->password = url_decode_mem(colon + 1, at - (colon + 1));
471 host = at + 1;
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);
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';
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;
496 return 0;
499 static int credential_from_potentially_partial_url(struct credential *c,
500 const char *url)
502 return credential_from_url_1(c, url, 1, 0);
505 int credential_from_url_gently(struct credential *c, const char *url, int quiet)
507 return credential_from_url_1(c, url, 0, quiet);
510 void credential_from_url(struct credential *c, const char *url)
512 if (credential_from_url_gently(c, url, 0) < 0)
513 die(_("credential url cannot be parsed: %s"), url);