[thirdparty/git.git] / credential.c

#include "cache.h"
#include "config.h"
#include "credential.h"
#include "string-list.h"
#include "run-command.h"
#include "url.h"
#include "prompt.h"

void credential_init(struct credential *c)
{
	memset(c, 0, sizeof(*c));
	c->helpers.strdup_strings = 1;
}

void credential_clear(struct credential *c)
{
	free(c->protocol);
	free(c->host);
	free(c->path);
	free(c->username);
	free(c->password);
	string_list_clear(&c->helpers, 0);

	credential_init(c);
}

int credential_match(const struct credential *want,
		     const struct credential *have)
{
#define CHECK(x) (!want->x || (have->x && !strcmp(want->x, have->x)))
	return CHECK(protocol) &&
	       CHECK(host) &&
	       CHECK(path) &&
	       CHECK(username);
#undef CHECK
}

static int credential_config_callback(const char *var, const char *value,
				      void *data)
{
	struct credential *c = data;
	const char *key, *dot;

	if (!skip_prefix(var, "credential.", &key))
		return 0;

	if (!value)
		return config_error_nonbool(var);

	dot = strrchr(key, '.');
	if (dot) {
		struct credential want = CREDENTIAL_INIT;
		char *url = xmemdupz(key, dot - key);
		int matched;

		credential_from_url(&want, url);
		matched = credential_match(&want, c);

		credential_clear(&want);
		free(url);

		if (!matched)
			return 0;
		key = dot + 1;
	}

	if (!strcmp(key, "helper")) {
		if (*value)
			string_list_append(&c->helpers, value);
		else
			string_list_clear(&c->helpers, 0);
	} else if (!strcmp(key, "username")) {
		if (!c->username)
			c->username = xstrdup(value);
	}
	else if (!strcmp(key, "usehttppath"))
		c->use_http_path = git_config_bool(var, value);

	return 0;
}

static int proto_is_http(const char *s)
{
	if (!s)
		return 0;
	return !strcmp(s, "https") || !strcmp(s, "http");
}

static void credential_apply_config(struct credential *c)
{
	if (!c->host)
		die(_("refusing to work with credential missing host field"));
	if (!c->protocol)
		die(_("refusing to work with credential missing protocol field"));

	if (c->configured)
		return;
	git_config(credential_config_callback, c);
	c->configured = 1;

	if (!c->use_http_path && proto_is_http(c->protocol)) {
		FREE_AND_NULL(c->path);
	}
}

static void credential_describe(struct credential *c, struct strbuf *out)
{
	if (!c->protocol)
		return;
	strbuf_addf(out, "%s://", c->protocol);
	if (c->username && *c->username)
		strbuf_addf(out, "%s@", c->username);
	if (c->host)
		strbuf_addstr(out, c->host);
	if (c->path)
		strbuf_addf(out, "/%s", c->path);
}

static char *credential_ask_one(const char *what, struct credential *c,
				int flags)
{
	struct strbuf desc = STRBUF_INIT;
	struct strbuf prompt = STRBUF_INIT;
	char *r;

	credential_describe(c, &desc);
	if (desc.len)
		strbuf_addf(&prompt, "%s for '%s': ", what, desc.buf);
	else
		strbuf_addf(&prompt, "%s: ", what);

	r = git_prompt(prompt.buf, flags);

	strbuf_release(&desc);
	strbuf_release(&prompt);
	return xstrdup(r);
}

static void credential_getpass(struct credential *c)
{
	if (!c->username)
		c->username = credential_ask_one("Username", c,
						 PROMPT_ASKPASS|PROMPT_ECHO);
	if (!c->password)
		c->password = credential_ask_one("Password", c,
						 PROMPT_ASKPASS);
}

int credential_read(struct credential *c, FILE *fp)
{
	struct strbuf line = STRBUF_INIT;

	while (strbuf_getline_lf(&line, fp) != EOF) {
		char *key = line.buf;
		char *value = strchr(key, '=');

		if (!line.len)
			break;

		if (!value) {
			warning("invalid credential line: %s", key);
			strbuf_release(&line);
			return -1;
		}
		*value++ = '\0';

		if (!strcmp(key, "username")) {
			free(c->username);
			c->username = xstrdup(value);
		} else if (!strcmp(key, "password")) {
			free(c->password);
			c->password = xstrdup(value);
		} else if (!strcmp(key, "protocol")) {
			free(c->protocol);
			c->protocol = xstrdup(value);
		} else if (!strcmp(key, "host")) {
			free(c->host);
			c->host = xstrdup(value);
		} else if (!strcmp(key, "path")) {
			free(c->path);
			c->path = xstrdup(value);
		} else if (!strcmp(key, "url")) {
			credential_from_url(c, value);
		} else if (!strcmp(key, "quit")) {
			c->quit = !!git_config_bool("quit", value);
		}
		/*
		 * Ignore other lines; we don't know what they mean, but
		 * this future-proofs us when later versions of git do
		 * learn new lines, and the helpers are updated to match.
		 */
	}

	strbuf_release(&line);
	return 0;
}

static void credential_write_item(FILE *fp, const char *key, const char *value,
				  int required)
{
	if (!value && required)
		BUG("credential value for %s is missing", key);
	if (!value)
		return;
	if (strchr(value, '\n'))
		die("credential value for %s contains newline", key);
	fprintf(fp, "%s=%s\n", key, value);
}

void credential_write(const struct credential *c, FILE *fp)
{
	credential_write_item(fp, "protocol", c->protocol, 1);
	credential_write_item(fp, "host", c->host, 1);
	credential_write_item(fp, "path", c->path, 0);
	credential_write_item(fp, "username", c->username, 0);
	credential_write_item(fp, "password", c->password, 0);
}

static int run_credential_helper(struct credential *c,
				 const char *cmd,
				 int want_output)
{
	struct child_process helper = CHILD_PROCESS_INIT;
	const char *argv[] = { NULL, NULL };
	FILE *fp;

	argv[0] = cmd;
	helper.argv = argv;
	helper.use_shell = 1;
	helper.in = -1;
	if (want_output)
		helper.out = -1;
	else
		helper.no_stdout = 1;

	if (start_command(&helper) < 0)
		return -1;

	fp = xfdopen(helper.in, "w");
	credential_write(c, fp);
	fclose(fp);

	if (want_output) {
		int r;
		fp = xfdopen(helper.out, "r");
		r = credential_read(c, fp);
		fclose(fp);
		if (r < 0) {
			finish_command(&helper);
			return -1;
		}
	}

	if (finish_command(&helper))
		return -1;
	return 0;
}

static int credential_do(struct credential *c, const char *helper,
			 const char *operation)
{
	struct strbuf cmd = STRBUF_INIT;
	int r;

	if (helper[0] == '!')
		strbuf_addstr(&cmd, helper + 1);
	else if (is_absolute_path(helper))
		strbuf_addstr(&cmd, helper);
	else
		strbuf_addf(&cmd, "git credential-%s", helper);

	strbuf_addf(&cmd, " %s", operation);
	r = run_credential_helper(c, cmd.buf, !strcmp(operation, "get"));

	strbuf_release(&cmd);
	return r;
}

void credential_fill(struct credential *c)
{
	int i;

	if (c->username && c->password)
		return;

	credential_apply_config(c);

	for (i = 0; i < c->helpers.nr; i++) {
		credential_do(c, c->helpers.items[i].string, "get");
		if (c->username && c->password)
			return;
		if (c->quit)
			die("credential helper '%s' told us to quit",
			    c->helpers.items[i].string);
	}

	credential_getpass(c);
	if (!c->username && !c->password)
		die("unable to get password from user");
}

void credential_approve(struct credential *c)
{
	int i;

	if (c->approved)
		return;
	if (!c->username || !c->password)
		return;

	credential_apply_config(c);

	for (i = 0; i < c->helpers.nr; i++)
		credential_do(c, c->helpers.items[i].string, "store");
	c->approved = 1;
}

void credential_reject(struct credential *c)
{
	int i;

	credential_apply_config(c);

	for (i = 0; i < c->helpers.nr; i++)
		credential_do(c, c->helpers.items[i].string, "erase");

	FREE_AND_NULL(c->username);
	FREE_AND_NULL(c->password);
	c->approved = 0;
}

static int check_url_component(const char *url, int quiet,
			       const char *name, const char *value)
{
	if (!value)
		return 0;
	if (!strchr(value, '\n'))
		return 0;

	if (!quiet)
		warning(_("url contains a newline in its %s component: %s"),
			name, url);
	return -1;
}

int credential_from_url_gently(struct credential *c, const char *url,
			       int quiet)
{
	const char *at, *colon, *cp, *slash, *host, *proto_end;

	credential_clear(c);

	/*
	 * Match one of:
	 *   (1) proto://<host>/...
	 *   (2) proto://<user>@<host>/...
	 *   (3) proto://<user>:<pass>@<host>/...
	 */
	proto_end = strstr(url, "://");
	if (!proto_end)
		return 0;
	cp = proto_end + 3;
	at = strchr(cp, '@');
	colon = strchr(cp, ':');
	slash = strchrnul(cp, '/');

	if (!at || slash <= at) {
		/* Case (1) */
		host = cp;
	}
	else if (!colon || at <= colon) {
		/* Case (2) */
		c->username = url_decode_mem(cp, at - cp);
		host = at + 1;
	} else {
		/* Case (3) */
		c->username = url_decode_mem(cp, colon - cp);
		c->password = url_decode_mem(colon + 1, at - (colon + 1));
		host = at + 1;
	}

	if (proto_end - url > 0)
		c->protocol = xmemdupz(url, proto_end - url);
	c->host = url_decode_mem(host, slash - host);
	/* Trim leading and trailing slashes from path */
	while (*slash == '/')
		slash++;
	if (*slash) {
		char *p;
		c->path = url_decode(slash);
		p = c->path + strlen(c->path) - 1;
		while (p > c->path && *p == '/')
			*p-- = '\0';
	}

	if (check_url_component(url, quiet, "username", c->username) < 0 ||
	    check_url_component(url, quiet, "password", c->password) < 0 ||
	    check_url_component(url, quiet, "protocol", c->protocol) < 0 ||
	    check_url_component(url, quiet, "host", c->host) < 0 ||
	    check_url_component(url, quiet, "path", c->path) < 0)
		return -1;

	return 0;
}

void credential_from_url(struct credential *c, const char *url)
{
	if (credential_from_url_gently(c, url, 0) < 0) {
		warning(_("skipping credential lookup for url: %s"), url);
		credential_clear(c);
	}
}
Commit	Line	Data
abca927d	1	#include "cache.h"
b2141fc1	2	#include "config.h"
abca927d JK	3	#include "credential.h"
	4	#include "string-list.h"
	5	#include "run-command.h"
d3e847c1	6	#include "url.h"
d3c58b83	7	#include "prompt.h"
abca927d JK	8
	9	void credential_init(struct credential *c)
	10	{
	11	memset(c, 0, sizeof(*c));
	12	c->helpers.strdup_strings = 1;
	13	}
	14
	15	void credential_clear(struct credential *c)
	16	{
	17	free(c->protocol);
	18	free(c->host);
	19	free(c->path);
	20	free(c->username);
	21	free(c->password);
	22	string_list_clear(&c->helpers, 0);
	23
	24	credential_init(c);
	25	}
	26
11825072 JK	27	int credential_match(const struct credential *want,
	28	const struct credential *have)
	29	{
	30	#define CHECK(x) (!want->x \|\| (have->x && !strcmp(want->x, have->x)))
	31	return CHECK(protocol) &&
	32	CHECK(host) &&
	33	CHECK(path) &&
	34	CHECK(username);
	35	#undef CHECK
	36	}
	37
	38	static int credential_config_callback(const char var, const char value,
	39	void *data)
	40	{
	41	struct credential *c = data;
	42	const char key, dot;
	43
cf4fff57	44	if (!skip_prefix(var, "credential.", &key))
11825072 JK	45	return 0;
	46
	47	if (!value)
	48	return config_error_nonbool(var);
	49
	50	dot = strrchr(key, '.');
	51	if (dot) {
	52	struct credential want = CREDENTIAL_INIT;
	53	char *url = xmemdupz(key, dot - key);
	54	int matched;
	55
	56	credential_from_url(&want, url);
	57	matched = credential_match(&want, c);
	58
	59	credential_clear(&want);
	60	free(url);
	61
	62	if (!matched)
	63	return 0;
	64	key = dot + 1;
	65	}
	66
24321375 JK	67	if (!strcmp(key, "helper")) {
	68	if (*value)
	69	string_list_append(&c->helpers, value);
	70	else
	71	string_list_clear(&c->helpers, 0);
	72	} else if (!strcmp(key, "username")) {
d5742425 JK	73	if (!c->username)
	74	c->username = xstrdup(value);
	75	}
a78fbb4f JK	76	else if (!strcmp(key, "usehttppath"))
a78fbb4f JK	77	c->use_http_path = git_config_bool(var, value);
11825072 JK	78
	79	return 0;
	80	}
	81
a78fbb4f JK	82	static int proto_is_http(const char *s)
	83	{
	84	if (!s)
	85	return 0;
	86	return !strcmp(s, "https") \|\| !strcmp(s, "http");
	87	}
	88
11825072 JK	89	static void credential_apply_config(struct credential *c)
11825072 JK	90	{
8ba8ed56 JK	91	if (!c->host)
	92	die(_("refusing to work with credential missing host field"));
	93	if (!c->protocol)
	94	die(_("refusing to work with credential missing protocol field"));
	95
11825072 JK	96	if (c->configured)
	97	return;
	98	git_config(credential_config_callback, c);
	99	c->configured = 1;
a78fbb4f JK	100
a78fbb4f JK	101	if (!c->use_http_path && proto_is_http(c->protocol)) {
6a83d902	102	FREE_AND_NULL(c->path);
a78fbb4f	103	}
11825072 JK	104	}
11825072 JK	105
abca927d JK	106	static void credential_describe(struct credential c, struct strbuf out)
	107	{
	108	if (!c->protocol)
	109	return;
	110	strbuf_addf(out, "%s://", c->protocol);
	111	if (c->username && *c->username)
	112	strbuf_addf(out, "%s@", c->username);
	113	if (c->host)
	114	strbuf_addstr(out, c->host);
	115	if (c->path)
	116	strbuf_addf(out, "/%s", c->path);
	117	}
	118
ce77aa48 JK	119	static char credential_ask_one(const char what, struct credential *c,
ce77aa48 JK	120	int flags)
abca927d JK	121	{
	122	struct strbuf desc = STRBUF_INIT;
	123	struct strbuf prompt = STRBUF_INIT;
	124	char *r;
	125
	126	credential_describe(c, &desc);
	127	if (desc.len)
	128	strbuf_addf(&prompt, "%s for '%s': ", what, desc.buf);
	129	else
	130	strbuf_addf(&prompt, "%s: ", what);
	131
ce77aa48	132	r = git_prompt(prompt.buf, flags);
abca927d JK	133
	134	strbuf_release(&desc);
	135	strbuf_release(&prompt);
	136	return xstrdup(r);
	137	}
	138
	139	static void credential_getpass(struct credential *c)
	140	{
	141	if (!c->username)
ce77aa48 JK	142	c->username = credential_ask_one("Username", c,
ce77aa48 JK	143	PROMPT_ASKPASS\|PROMPT_ECHO);
abca927d	144	if (!c->password)
ce77aa48 JK	145	c->password = credential_ask_one("Password", c,
ce77aa48 JK	146	PROMPT_ASKPASS);
abca927d JK	147	}
	148
	149	int credential_read(struct credential c, FILE fp)
	150	{
	151	struct strbuf line = STRBUF_INIT;
	152
8f309aeb	153	while (strbuf_getline_lf(&line, fp) != EOF) {
abca927d JK	154	char *key = line.buf;
	155	char *value = strchr(key, '=');
	156
	157	if (!line.len)
	158	break;
	159
	160	if (!value) {
	161	warning("invalid credential line: %s", key);
	162	strbuf_release(&line);
	163	return -1;
	164	}
	165	*value++ = '\0';
	166
	167	if (!strcmp(key, "username")) {
	168	free(c->username);
	169	c->username = xstrdup(value);
	170	} else if (!strcmp(key, "password")) {
	171	free(c->password);
	172	c->password = xstrdup(value);
	173	} else if (!strcmp(key, "protocol")) {
	174	free(c->protocol);
	175	c->protocol = xstrdup(value);
	176	} else if (!strcmp(key, "host")) {
	177	free(c->host);
	178	c->host = xstrdup(value);
	179	} else if (!strcmp(key, "path")) {
	180	free(c->path);
	181	c->path = xstrdup(value);
9c183a70 JK	182	} else if (!strcmp(key, "url")) {
9c183a70 JK	183	credential_from_url(c, value);
59b38652 JK	184	} else if (!strcmp(key, "quit")) {
59b38652 JK	185	c->quit = !!git_config_bool("quit", value);
abca927d JK	186	}
	187	/*
	188	* Ignore other lines; we don't know what they mean, but
	189	* this future-proofs us when later versions of git do
	190	* learn new lines, and the helpers are updated to match.
	191	*/
	192	}
	193
	194	strbuf_release(&line);
	195	return 0;
	196	}
	197
8ba8ed56 JK	198	static void credential_write_item(FILE fp, const char key, const char *value,
8ba8ed56 JK	199	int required)
abca927d	200	{
8ba8ed56 JK	201	if (!value && required)
8ba8ed56 JK	202	BUG("credential value for %s is missing", key);
abca927d JK	203	if (!value)
abca927d JK	204	return;
9a6bbee8 JK	205	if (strchr(value, '\n'))
9a6bbee8 JK	206	die("credential value for %s contains newline", key);
abca927d JK	207	fprintf(fp, "%s=%s\n", key, value);
	208	}
	209
2d6dc182	210	void credential_write(const struct credential c, FILE fp)
abca927d	211	{
8ba8ed56 JK	212	credential_write_item(fp, "protocol", c->protocol, 1);
	213	credential_write_item(fp, "host", c->host, 1);
	214	credential_write_item(fp, "path", c->path, 0);
	215	credential_write_item(fp, "username", c->username, 0);
	216	credential_write_item(fp, "password", c->password, 0);
abca927d JK	217	}
	218
	219	static int run_credential_helper(struct credential *c,
	220	const char *cmd,
	221	int want_output)
	222	{
d3180279	223	struct child_process helper = CHILD_PROCESS_INIT;
abca927d JK	224	const char *argv[] = { NULL, NULL };
	225	FILE *fp;
	226
abca927d JK	227	argv[0] = cmd;
	228	helper.argv = argv;
	229	helper.use_shell = 1;
	230	helper.in = -1;
	231	if (want_output)
	232	helper.out = -1;
	233	else
	234	helper.no_stdout = 1;
	235
	236	if (start_command(&helper) < 0)
	237	return -1;
	238
	239	fp = xfdopen(helper.in, "w");
	240	credential_write(c, fp);
	241	fclose(fp);
	242
	243	if (want_output) {
	244	int r;
	245	fp = xfdopen(helper.out, "r");
	246	r = credential_read(c, fp);
	247	fclose(fp);
	248	if (r < 0) {
	249	finish_command(&helper);
	250	return -1;
	251	}
	252	}
	253
	254	if (finish_command(&helper))
	255	return -1;
	256	return 0;
	257	}
	258
	259	static int credential_do(struct credential c, const char helper,
	260	const char *operation)
	261	{
	262	struct strbuf cmd = STRBUF_INIT;
	263	int r;
	264
	265	if (helper[0] == '!')
	266	strbuf_addstr(&cmd, helper + 1);
	267	else if (is_absolute_path(helper))
	268	strbuf_addstr(&cmd, helper);
	269	else
	270	strbuf_addf(&cmd, "git credential-%s", helper);
	271
	272	strbuf_addf(&cmd, " %s", operation);
	273	r = run_credential_helper(c, cmd.buf, !strcmp(operation, "get"));
	274
	275	strbuf_release(&cmd);
	276	return r;
	277	}
	278
	279	void credential_fill(struct credential *c)
	280	{
	281	int i;
	282
	283	if (c->username && c->password)
	284	return;
	285
11825072 JK	286	credential_apply_config(c);
11825072 JK	287
abca927d JK	288	for (i = 0; i < c->helpers.nr; i++) {
	289	credential_do(c, c->helpers.items[i].string, "get");
	290	if (c->username && c->password)
	291	return;
59b38652 JK	292	if (c->quit)
	293	die("credential helper '%s' told us to quit",
	294	c->helpers.items[i].string);
abca927d JK	295	}
	296
	297	credential_getpass(c);
	298	if (!c->username && !c->password)
	299	die("unable to get password from user");
	300	}
	301
	302	void credential_approve(struct credential *c)
	303	{
	304	int i;
	305
	306	if (c->approved)
	307	return;
	308	if (!c->username \|\| !c->password)
	309	return;
	310
11825072 JK	311	credential_apply_config(c);
11825072 JK	312
abca927d JK	313	for (i = 0; i < c->helpers.nr; i++)
	314	credential_do(c, c->helpers.items[i].string, "store");
	315	c->approved = 1;
	316	}
	317
	318	void credential_reject(struct credential *c)
	319	{
	320	int i;
	321
11825072 JK	322	credential_apply_config(c);
11825072 JK	323
abca927d JK	324	for (i = 0; i < c->helpers.nr; i++)
	325	credential_do(c, c->helpers.items[i].string, "erase");
	326
88ce3ef6 ÆAB	327	FREE_AND_NULL(c->username);
88ce3ef6 ÆAB	328	FREE_AND_NULL(c->password);
abca927d JK	329	c->approved = 0;
abca927d JK	330	}
d3e847c1	331
c716fe4b JK	332	static int check_url_component(const char *url, int quiet,
	333	const char name, const char value)
	334	{
	335	if (!value)
	336	return 0;
	337	if (!strchr(value, '\n'))
	338	return 0;
	339
	340	if (!quiet)
	341	warning(_("url contains a newline in its %s component: %s"),
	342	name, url);
	343	return -1;
	344	}
	345
	346	int credential_from_url_gently(struct credential c, const char url,
	347	int quiet)
d3e847c1 JK	348	{
	349	const char at, colon, cp, slash, host, proto_end;
	350
	351	credential_clear(c);
	352
	353	/*
	354	* Match one of:
	355	* (1) proto://<host>/...
	356	* (2) proto://<user>@<host>/...
	357	* (3) proto://<user>:<pass>@<host>/...
	358	*/
	359	proto_end = strstr(url, "://");
	360	if (!proto_end)
c716fe4b	361	return 0;
d3e847c1 JK	362	cp = proto_end + 3;
	363	at = strchr(cp, '@');
	364	colon = strchr(cp, ':');
	365	slash = strchrnul(cp, '/');
	366
	367	if (!at \|\| slash <= at) {
	368	/* Case (1) */
	369	host = cp;
	370	}
	371	else if (!colon \|\| at <= colon) {
	372	/* Case (2) */
	373	c->username = url_decode_mem(cp, at - cp);
	374	host = at + 1;
	375	} else {
	376	/* Case (3) */
	377	c->username = url_decode_mem(cp, colon - cp);
	378	c->password = url_decode_mem(colon + 1, at - (colon + 1));
	379	host = at + 1;
	380	}
	381
	382	if (proto_end - url > 0)
	383	c->protocol = xmemdupz(url, proto_end - url);
24036686	384	c->host = url_decode_mem(host, slash - host);
d3e847c1 JK	385	/* Trim leading and trailing slashes from path */
	386	while (*slash == '/')
	387	slash++;
	388	if (*slash) {
	389	char *p;
	390	c->path = url_decode(slash);
	391	p = c->path + strlen(c->path) - 1;
	392	while (p > c->path && *p == '/')
	393	*p-- = '\0';
	394	}
c716fe4b JK	395
	396	if (check_url_component(url, quiet, "username", c->username) < 0 \|\|
	397	check_url_component(url, quiet, "password", c->password) < 0 \|\|
	398	check_url_component(url, quiet, "protocol", c->protocol) < 0 \|\|
	399	check_url_component(url, quiet, "host", c->host) < 0 \|\|
	400	check_url_component(url, quiet, "path", c->path) < 0)
	401	return -1;
	402
	403	return 0;
	404	}
	405
	406	void credential_from_url(struct credential c, const char url)
	407	{
	408	if (credential_from_url_gently(c, url, 0) < 0) {
	409	warning(_("skipping credential lookup for url: %s"), url);
	410	credential_clear(c);
	411	}
d3e847c1	412	}