[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"
#include "sigchain.h"
#include "urlmatch.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;

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

	if (!value)
		return config_error_nonbool(var);

	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_from_proto) {
			free(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_describe(struct credential *c, struct strbuf *out);
static void credential_format(struct credential *c, struct strbuf *out);

static int select_all(const struct urlmatch_item *a,
		      const struct urlmatch_item *b)
{
	return 0;
}

static void credential_apply_config(struct credential *c)
{
	char *normalized_url;
	struct urlmatch_config config = { STRING_LIST_INIT_DUP };
	struct strbuf url = STRBUF_INIT;

	if (c->configured)
		return;

	config.section = "credential";
	config.key = NULL;
	config.collect_fn = credential_config_callback;
	config.cascade_fn = NULL;
	config.select_fn = select_all;
	config.cb = c;

	credential_format(c, &url);
	normalized_url = url_normalize(url.buf, &config.url);

	git_config(urlmatch_config_entry, &config);
	free(normalized_url);
	strbuf_release(&url);

	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 void credential_format(struct credential *c, struct strbuf *out)
{
	if (!c->protocol)
		return;
	strbuf_addf(out, "%s://", c->protocol);
	if (c->username && *c->username) {
		strbuf_add_percentencode(out, c->username);
		strbuf_addch(out, '@');
	}
	if (c->host)
		strbuf_addstr(out, c->host);
	if (c->path) {
		strbuf_addch(out, '/');
		strbuf_add_percentencode(out, 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);
			c->username_from_proto = 1;
		} 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;
	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");
	sigchain_push(SIGPIPE, SIG_IGN);
	credential_write(c, fp);
	fclose(fp);
	sigchain_pop(SIGPIPE);

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