[thirdparty/git.git] / credential.c

#include "cache.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"))
		string_list_append(&c->helpers, value);
	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->configured)
		return;
	git_config(credential_config_callback, c);
	c->configured = 1;

	if (!c->use_http_path && proto_is_http(c->protocol)) {
		free(c->path);
		c->path = NULL;
	}
}

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(&line, fp, '\n') != 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);
		}
		/*
		 * 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)
{
	if (!value)
		return;
	fprintf(fp, "%s=%s\n", key, value);
}

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

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;
	}

	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(c->username);
	c->username = NULL;
	free(c->password);
	c->password = NULL;
	c->approved = 0;
}

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