[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->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)
{
	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);
	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;
		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;
}

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
	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
	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
	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
	44	if (!skip_prefix(var, "credential.", &key))
	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
	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")) {
	73	if (!c->username)
	74	c->username = xstrdup(value);
	75	}
	76	else if (!strcmp(key, "usehttppath"))
	77	c->use_http_path = git_config_bool(var, value);
	78
	79	return 0;
	80	}
	81
	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
	89	static void credential_apply_config(struct credential *c)
	90	{
	91	if (c->configured)
	92	return;
	93	git_config(credential_config_callback, c);
	94	c->configured = 1;
	95
	96	if (!c->use_http_path && proto_is_http(c->protocol)) {
	97	FREE_AND_NULL(c->path);
	98	}
	99	}
	100
	101	static void credential_describe(struct credential c, struct strbuf out)
	102	{
	103	if (!c->protocol)
	104	return;
	105	strbuf_addf(out, "%s://", c->protocol);
	106	if (c->username && *c->username)
	107	strbuf_addf(out, "%s@", c->username);
	108	if (c->host)
	109	strbuf_addstr(out, c->host);
	110	if (c->path)
	111	strbuf_addf(out, "/%s", c->path);
	112	}
	113
	114	static char credential_ask_one(const char what, struct credential *c,
	115	int flags)
	116	{
	117	struct strbuf desc = STRBUF_INIT;
	118	struct strbuf prompt = STRBUF_INIT;
	119	char *r;
	120
	121	credential_describe(c, &desc);
	122	if (desc.len)
	123	strbuf_addf(&prompt, "%s for '%s': ", what, desc.buf);
	124	else
	125	strbuf_addf(&prompt, "%s: ", what);
	126
	127	r = git_prompt(prompt.buf, flags);
	128
	129	strbuf_release(&desc);
	130	strbuf_release(&prompt);
	131	return xstrdup(r);
	132	}
	133
	134	static void credential_getpass(struct credential *c)
	135	{
	136	if (!c->username)
	137	c->username = credential_ask_one("Username", c,
	138	PROMPT_ASKPASS\|PROMPT_ECHO);
	139	if (!c->password)
	140	c->password = credential_ask_one("Password", c,
	141	PROMPT_ASKPASS);
	142	}
	143
	144	int credential_read(struct credential c, FILE fp)
	145	{
	146	struct strbuf line = STRBUF_INIT;
	147
	148	while (strbuf_getline_lf(&line, fp) != EOF) {
	149	char *key = line.buf;
	150	char *value = strchr(key, '=');
	151
	152	if (!line.len)
	153	break;
	154
	155	if (!value) {
	156	warning("invalid credential line: %s", key);
	157	strbuf_release(&line);
	158	return -1;
	159	}
	160	*value++ = '\0';
	161
	162	if (!strcmp(key, "username")) {
	163	free(c->username);
	164	c->username = xstrdup(value);
	165	} else if (!strcmp(key, "password")) {
	166	free(c->password);
	167	c->password = xstrdup(value);
	168	} else if (!strcmp(key, "protocol")) {
	169	free(c->protocol);
	170	c->protocol = xstrdup(value);
	171	} else if (!strcmp(key, "host")) {
	172	free(c->host);
	173	c->host = xstrdup(value);
	174	} else if (!strcmp(key, "path")) {
	175	free(c->path);
	176	c->path = xstrdup(value);
	177	} else if (!strcmp(key, "url")) {
	178	credential_from_url(c, value);
	179	} else if (!strcmp(key, "quit")) {
	180	c->quit = !!git_config_bool("quit", value);
	181	}
	182	/*
	183	* Ignore other lines; we don't know what they mean, but
	184	* this future-proofs us when later versions of git do
	185	* learn new lines, and the helpers are updated to match.
	186	*/
	187	}
	188
	189	strbuf_release(&line);
	190	return 0;
	191	}
	192
	193	static void credential_write_item(FILE fp, const char key, const char *value)
	194	{
	195	if (!value)
	196	return;
	197	if (strchr(value, '\n'))
	198	die("credential value for %s contains newline", key);
	199	fprintf(fp, "%s=%s\n", key, value);
	200	}
	201
	202	void credential_write(const struct credential c, FILE fp)
	203	{
	204	credential_write_item(fp, "protocol", c->protocol);
	205	credential_write_item(fp, "host", c->host);
	206	credential_write_item(fp, "path", c->path);
	207	credential_write_item(fp, "username", c->username);
	208	credential_write_item(fp, "password", c->password);
	209	}
	210
	211	static int run_credential_helper(struct credential *c,
	212	const char *cmd,
	213	int want_output)
	214	{
	215	struct child_process helper = CHILD_PROCESS_INIT;
	216	const char *argv[] = { NULL, NULL };
	217	FILE *fp;
	218
	219	argv[0] = cmd;
	220	helper.argv = argv;
	221	helper.use_shell = 1;
	222	helper.in = -1;
	223	if (want_output)
	224	helper.out = -1;
	225	else
	226	helper.no_stdout = 1;
	227
	228	if (start_command(&helper) < 0)
	229	return -1;
	230
	231	fp = xfdopen(helper.in, "w");
	232	credential_write(c, fp);
	233	fclose(fp);
	234
	235	if (want_output) {
	236	int r;
	237	fp = xfdopen(helper.out, "r");
	238	r = credential_read(c, fp);
	239	fclose(fp);
	240	if (r < 0) {
	241	finish_command(&helper);
	242	return -1;
	243	}
	244	}
	245
	246	if (finish_command(&helper))
	247	return -1;
	248	return 0;
	249	}
	250
	251	static int credential_do(struct credential c, const char helper,
	252	const char *operation)
	253	{
	254	struct strbuf cmd = STRBUF_INIT;
	255	int r;
	256
	257	if (helper[0] == '!')
	258	strbuf_addstr(&cmd, helper + 1);
	259	else if (is_absolute_path(helper))
	260	strbuf_addstr(&cmd, helper);
	261	else
	262	strbuf_addf(&cmd, "git credential-%s", helper);
	263
	264	strbuf_addf(&cmd, " %s", operation);
	265	r = run_credential_helper(c, cmd.buf, !strcmp(operation, "get"));
	266
	267	strbuf_release(&cmd);
	268	return r;
	269	}
	270
	271	void credential_fill(struct credential *c)
	272	{
	273	int i;
	274
	275	if (c->username && c->password)
	276	return;
	277
	278	credential_apply_config(c);
	279
	280	for (i = 0; i < c->helpers.nr; i++) {
	281	credential_do(c, c->helpers.items[i].string, "get");
	282	if (c->username && c->password)
	283	return;
	284	if (c->quit)
	285	die("credential helper '%s' told us to quit",
	286	c->helpers.items[i].string);
	287	}
	288
	289	credential_getpass(c);
	290	if (!c->username && !c->password)
	291	die("unable to get password from user");
	292	}
	293
	294	void credential_approve(struct credential *c)
	295	{
	296	int i;
	297
	298	if (c->approved)
	299	return;
	300	if (!c->username \|\| !c->password)
	301	return;
	302
	303	credential_apply_config(c);
	304
	305	for (i = 0; i < c->helpers.nr; i++)
	306	credential_do(c, c->helpers.items[i].string, "store");
	307	c->approved = 1;
	308	}
	309
	310	void credential_reject(struct credential *c)
	311	{
	312	int i;
	313
	314	credential_apply_config(c);
	315
	316	for (i = 0; i < c->helpers.nr; i++)
	317	credential_do(c, c->helpers.items[i].string, "erase");
	318
	319	FREE_AND_NULL(c->username);
	320	FREE_AND_NULL(c->password);
	321	c->approved = 0;
	322	}
	323
	324	void credential_from_url(struct credential c, const char url)
	325	{
	326	const char at, colon, cp, slash, host, proto_end;
	327
	328	credential_clear(c);
	329
	330	/*
	331	* Match one of:
	332	* (1) proto://<host>/...
	333	* (2) proto://<user>@<host>/...
	334	* (3) proto://<user>:<pass>@<host>/...
	335	*/
	336	proto_end = strstr(url, "://");
	337	if (!proto_end)
	338	return;
	339	cp = proto_end + 3;
	340	at = strchr(cp, '@');
	341	colon = strchr(cp, ':');
	342	slash = strchrnul(cp, '/');
	343
	344	if (!at \|\| slash <= at) {
	345	/* Case (1) */
	346	host = cp;
	347	}
	348	else if (!colon \|\| at <= colon) {
	349	/* Case (2) */
	350	c->username = url_decode_mem(cp, at - cp);
	351	host = at + 1;
	352	} else {
	353	/* Case (3) */
	354	c->username = url_decode_mem(cp, colon - cp);
	355	c->password = url_decode_mem(colon + 1, at - (colon + 1));
	356	host = at + 1;
	357	}
	358
	359	if (proto_end - url > 0)
	360	c->protocol = xmemdupz(url, proto_end - url);
	361	if (slash - host > 0)
	362	c->host = url_decode_mem(host, slash - host);
	363	/* Trim leading and trailing slashes from path */
	364	while (*slash == '/')
	365	slash++;
	366	if (*slash) {
	367	char *p;
	368	c->path = url_decode(slash);
	369	p = c->path + strlen(c->path) - 1;
	370	while (p > c->path && *p == '/')
	371	*p-- = '\0';
	372	}
	373	}