3 #include "credential.h"
4 #include "string-list.h"
5 #include "run-command.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)
24 string_list_clear(&c->helpers, 0);
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) &&
40 static int credential_config_callback(const char *var, const char *value,
43 struct credential *c = data;
46 if (!skip_prefix(var, "credential.", &key))
50 return config_error_nonbool(var);
52 if (!strcmp(key, "helper")) {
54 string_list_append(&c->helpers, value);
56 string_list_clear(&c->helpers, 0);
57 } else if (!strcmp(key, "username")) {
58 if (!c->username_from_proto) {
60 c->username = xstrdup(value);
63 else if (!strcmp(key, "usehttppath"))
64 c->use_http_path = git_config_bool(var, value);
69 static int proto_is_http(const char *s)
73 return !strcmp(s, "https") || !strcmp(s, "http");
76 static void credential_describe(struct credential *c, struct strbuf *out);
77 static void credential_format(struct credential *c, struct strbuf *out);
79 static int select_all(const struct urlmatch_item *a,
80 const struct urlmatch_item *b)
85 static void credential_apply_config(struct credential *c)
88 struct urlmatch_config config = { STRING_LIST_INIT_DUP };
89 struct strbuf url = STRBUF_INIT;
94 config.section = "credential";
96 config.collect_fn = credential_config_callback;
97 config.cascade_fn = NULL;
98 config.select_fn = select_all;
101 credential_format(c, &url);
102 normalized_url = url_normalize(url.buf, &config.url);
104 git_config(urlmatch_config_entry, &config);
105 free(normalized_url);
106 strbuf_release(&url);
110 if (!c->use_http_path && proto_is_http(c->protocol)) {
111 FREE_AND_NULL(c->path);
115 static void credential_describe(struct credential *c, struct strbuf *out)
119 strbuf_addf(out, "%s://", c->protocol);
120 if (c->username && *c->username)
121 strbuf_addf(out, "%s@", c->username);
123 strbuf_addstr(out, c->host);
125 strbuf_addf(out, "/%s", c->path);
128 static void credential_format(struct credential *c, struct strbuf *out)
132 strbuf_addf(out, "%s://", c->protocol);
133 if (c->username && *c->username) {
134 strbuf_add_percentencode(out, c->username);
135 strbuf_addch(out, '@');
138 strbuf_addstr(out, c->host);
140 strbuf_addch(out, '/');
141 strbuf_add_percentencode(out, c->path);
145 static char *credential_ask_one(const char *what, struct credential *c,
148 struct strbuf desc = STRBUF_INIT;
149 struct strbuf prompt = STRBUF_INIT;
152 credential_describe(c, &desc);
154 strbuf_addf(&prompt, "%s for '%s': ", what, desc.buf);
156 strbuf_addf(&prompt, "%s: ", what);
158 r = git_prompt(prompt.buf, flags);
160 strbuf_release(&desc);
161 strbuf_release(&prompt);
165 static void credential_getpass(struct credential *c)
168 c->username = credential_ask_one("Username", c,
169 PROMPT_ASKPASS|PROMPT_ECHO);
171 c->password = credential_ask_one("Password", c,
175 int credential_read(struct credential *c, FILE *fp)
177 struct strbuf line = STRBUF_INIT;
179 while (strbuf_getline_lf(&line, fp) != EOF) {
180 char *key = line.buf;
181 char *value = strchr(key, '=');
187 warning("invalid credential line: %s", key);
188 strbuf_release(&line);
193 if (!strcmp(key, "username")) {
195 c->username = xstrdup(value);
196 c->username_from_proto = 1;
197 } else if (!strcmp(key, "password")) {
199 c->password = xstrdup(value);
200 } else if (!strcmp(key, "protocol")) {
202 c->protocol = xstrdup(value);
203 } else if (!strcmp(key, "host")) {
205 c->host = xstrdup(value);
206 } else if (!strcmp(key, "path")) {
208 c->path = xstrdup(value);
209 } else if (!strcmp(key, "url")) {
210 credential_from_url(c, value);
211 } else if (!strcmp(key, "quit")) {
212 c->quit = !!git_config_bool("quit", value);
215 * Ignore other lines; we don't know what they mean, but
216 * this future-proofs us when later versions of git do
217 * learn new lines, and the helpers are updated to match.
221 strbuf_release(&line);
225 static void credential_write_item(FILE *fp, const char *key, const char *value)
229 if (strchr(value, '\n'))
230 die("credential value for %s contains newline", key);
231 fprintf(fp, "%s=%s\n", key, value);
234 void credential_write(const struct credential *c, FILE *fp)
236 credential_write_item(fp, "protocol", c->protocol);
237 credential_write_item(fp, "host", c->host);
238 credential_write_item(fp, "path", c->path);
239 credential_write_item(fp, "username", c->username);
240 credential_write_item(fp, "password", c->password);
243 static int run_credential_helper(struct credential *c,
247 struct child_process helper = CHILD_PROCESS_INIT;
248 const char *argv[] = { NULL, NULL };
253 helper.use_shell = 1;
258 helper.no_stdout = 1;
260 if (start_command(&helper) < 0)
263 fp = xfdopen(helper.in, "w");
264 sigchain_push(SIGPIPE, SIG_IGN);
265 credential_write(c, fp);
267 sigchain_pop(SIGPIPE);
271 fp = xfdopen(helper.out, "r");
272 r = credential_read(c, fp);
275 finish_command(&helper);
280 if (finish_command(&helper))
285 static int credential_do(struct credential *c, const char *helper,
286 const char *operation)
288 struct strbuf cmd = STRBUF_INIT;
291 if (helper[0] == '!')
292 strbuf_addstr(&cmd, helper + 1);
293 else if (is_absolute_path(helper))
294 strbuf_addstr(&cmd, helper);
296 strbuf_addf(&cmd, "git credential-%s", helper);
298 strbuf_addf(&cmd, " %s", operation);
299 r = run_credential_helper(c, cmd.buf, !strcmp(operation, "get"));
301 strbuf_release(&cmd);
305 void credential_fill(struct credential *c)
309 if (c->username && c->password)
312 credential_apply_config(c);
314 for (i = 0; i < c->helpers.nr; i++) {
315 credential_do(c, c->helpers.items[i].string, "get");
316 if (c->username && c->password)
319 die("credential helper '%s' told us to quit",
320 c->helpers.items[i].string);
323 credential_getpass(c);
324 if (!c->username && !c->password)
325 die("unable to get password from user");
328 void credential_approve(struct credential *c)
334 if (!c->username || !c->password)
337 credential_apply_config(c);
339 for (i = 0; i < c->helpers.nr; i++)
340 credential_do(c, c->helpers.items[i].string, "store");
344 void credential_reject(struct credential *c)
348 credential_apply_config(c);
350 for (i = 0; i < c->helpers.nr; i++)
351 credential_do(c, c->helpers.items[i].string, "erase");
353 FREE_AND_NULL(c->username);
354 FREE_AND_NULL(c->password);
358 static int check_url_component(const char *url, int quiet,
359 const char *name, const char *value)
363 if (!strchr(value, '\n'))
367 warning(_("url contains a newline in its %s component: %s"),
372 int credential_from_url_gently(struct credential *c, const char *url,
375 const char *at, *colon, *cp, *slash, *host, *proto_end;
381 * (1) proto://<host>/...
382 * (2) proto://<user>@<host>/...
383 * (3) proto://<user>:<pass>@<host>/...
385 proto_end = strstr(url, "://");
389 at = strchr(cp, '@');
390 colon = strchr(cp, ':');
391 slash = strchrnul(cp, '/');
393 if (!at || slash <= at) {
397 else if (!colon || at <= colon) {
399 c->username = url_decode_mem(cp, at - cp);
400 if (c->username && *c->username)
401 c->username_from_proto = 1;
405 c->username = url_decode_mem(cp, colon - cp);
406 if (c->username && *c->username)
407 c->username_from_proto = 1;
408 c->password = url_decode_mem(colon + 1, at - (colon + 1));
412 if (proto_end - url > 0)
413 c->protocol = xmemdupz(url, proto_end - url);
414 if (slash - host > 0)
415 c->host = url_decode_mem(host, slash - host);
416 /* Trim leading and trailing slashes from path */
417 while (*slash == '/')
421 c->path = url_decode(slash);
422 p = c->path + strlen(c->path) - 1;
423 while (p > c->path && *p == '/')
427 if (check_url_component(url, quiet, "username", c->username) < 0 ||
428 check_url_component(url, quiet, "password", c->password) < 0 ||
429 check_url_component(url, quiet, "protocol", c->protocol) < 0 ||
430 check_url_component(url, quiet, "host", c->host) < 0 ||
431 check_url_component(url, quiet, "path", c->path) < 0)
437 void credential_from_url(struct credential *c, const char *url)
439 if (credential_from_url_gently(c, url, 0) < 0) {
440 warning(_("skipping credential lookup for url: %s"), url);