[git/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;

	key = skip_prefix(var, "credential.");
	if (!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)
{
	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);

	/* FIXME: for usernames, we should do something less magical that
	 * actually echoes the characters. However, we need to read from
	 * /dev/tty and not stdio, which is not portable (but getpass will do
	 * it for us). http.c uses the same workaround. */
	r = git_getpass(prompt.buf);

	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);
	if (!c->password)
		c->password = credential_ask_one("Password", c);
}

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);
		}
		/*
		 * 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);
}

static 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;
	const char *argv[] = { NULL, NULL };
	FILE *fp;

	memset(&helper, 0, sizeof(helper));
	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
	43	key = skip_prefix(var, "credential.");
	44	if (!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	string_list_append(&c->helpers, value);
d5742425 JK	69	else if (!strcmp(key, "username")) {
	70	if (!c->username)
	71	c->username = xstrdup(value);
	72	}
a78fbb4f JK	73	else if (!strcmp(key, "usehttppath"))
a78fbb4f JK	74	c->use_http_path = git_config_bool(var, value);
11825072 JK	75
	76	return 0;
	77	}
	78
a78fbb4f JK	79	static int proto_is_http(const char *s)
	80	{
	81	if (!s)
	82	return 0;
	83	return !strcmp(s, "https") \|\| !strcmp(s, "http");
	84	}
	85
11825072 JK	86	static void credential_apply_config(struct credential *c)
	87	{
	88	if (c->configured)
	89	return;
	90	git_config(credential_config_callback, c);
	91	c->configured = 1;
a78fbb4f JK	92
	93	if (!c->use_http_path && proto_is_http(c->protocol)) {
	94	free(c->path);
	95	c->path = NULL;
	96	}
11825072 JK	97	}
11825072 JK	98
abca927d JK	99	static void credential_describe(struct credential c, struct strbuf out)
	100	{
	101	if (!c->protocol)
	102	return;
	103	strbuf_addf(out, "%s://", c->protocol);
	104	if (c->username && *c->username)
	105	strbuf_addf(out, "%s@", c->username);
	106	if (c->host)
	107	strbuf_addstr(out, c->host);
	108	if (c->path)
	109	strbuf_addf(out, "/%s", c->path);
	110	}
	111
	112	static char credential_ask_one(const char what, struct credential *c)
	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
	124	/* FIXME: for usernames, we should do something less magical that
	125	* actually echoes the characters. However, we need to read from
	126	* /dev/tty and not stdio, which is not portable (but getpass will do
	127	* it for us). http.c uses the same workaround. */
	128	r = git_getpass(prompt.buf);
	129
	130	strbuf_release(&desc);
	131	strbuf_release(&prompt);
	132	return xstrdup(r);
	133	}
	134
	135	static void credential_getpass(struct credential *c)
	136	{
	137	if (!c->username)
	138	c->username = credential_ask_one("Username", c);
	139	if (!c->password)
	140	c->password = credential_ask_one("Password", c);
	141	}
	142
	143	int credential_read(struct credential c, FILE fp)
	144	{
	145	struct strbuf line = STRBUF_INIT;
	146
	147	while (strbuf_getline(&line, fp, '\n') != EOF) {
	148	char *key = line.buf;
	149	char *value = strchr(key, '=');
	150
	151	if (!line.len)
	152	break;
	153
	154	if (!value) {
	155	warning("invalid credential line: %s", key);
	156	strbuf_release(&line);
	157	return -1;
	158	}
	159	*value++ = '\0';
	160
	161	if (!strcmp(key, "username")) {
	162	free(c->username);
163	c->username = xstrdup(value);
164	} else if (!strcmp(key, "password")) {
165	free(c->password);
166	c->password = xstrdup(value);
167	} else if (!strcmp(key, "protocol")) {
168	free(c->protocol);
169	c->protocol = xstrdup(value);
170	} else if (!strcmp(key, "host")) {
171	free(c->host);
172	c->host = xstrdup(value);
173	} else if (!strcmp(key, "path")) {
174	free(c->path);
175	c->path = xstrdup(value);
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
195	static void credential_write(const struct credential c, FILE fp)
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	{
208	struct child_process helper;
209	const char *argv[] = { NULL, NULL };
210	FILE *fp;
211
212	memset(&helper, 0, sizeof(helper));
213	argv[0] = cmd;
214	helper.argv = argv;
215	helper.use_shell = 1;
216	helper.in = -1;
217	if (want_output)
218	helper.out = -1;
219	else
220	helper.no_stdout = 1;
221
222	if (start_command(&helper) < 0)
223	return -1;
224
225	fp = xfdopen(helper.in, "w");
226	credential_write(c, fp);
227	fclose(fp);
228
229	if (want_output) {
230	int r;
231	fp = xfdopen(helper.out, "r");
232	r = credential_read(c, fp);
233	fclose(fp);
234	if (r < 0) {
235	finish_command(&helper);
236	return -1;
237	}
238	}
239
240	if (finish_command(&helper))
241	return -1;
242	return 0;
243	}
244
245	static int credential_do(struct credential c, const char helper,
246	const char *operation)
247	{
248	struct strbuf cmd = STRBUF_INIT;
249	int r;
250
251	if (helper[0] == '!')
252	strbuf_addstr(&cmd, helper + 1);
253	else if (is_absolute_path(helper))
254	strbuf_addstr(&cmd, helper);
255	else
256	strbuf_addf(&cmd, "git credential-%s", helper);
257
258	strbuf_addf(&cmd, " %s", operation);
259	r = run_credential_helper(c, cmd.buf, !strcmp(operation, "get"));
260
261	strbuf_release(&cmd);
262	return r;
263	}
264
265	void credential_fill(struct credential *c)
266	{
267	int i;
268
269	if (c->username && c->password)
270	return;
271
11825072 JK	272	credential_apply_config(c);
11825072 JK	273
abca927d JK	274	for (i = 0; i < c->helpers.nr; i++) {
	275	credential_do(c, c->helpers.items[i].string, "get");
	276	if (c->username && c->password)
	277	return;
	278	}
	279
	280	credential_getpass(c);
	281	if (!c->username && !c->password)
	282	die("unable to get password from user");
	283	}
	284
	285	void credential_approve(struct credential *c)
	286	{
	287	int i;
	288
	289	if (c->approved)
	290	return;
	291	if (!c->username \|\| !c->password)
	292	return;
	293
11825072 JK	294	credential_apply_config(c);
11825072 JK	295
abca927d JK	296	for (i = 0; i < c->helpers.nr; i++)
	297	credential_do(c, c->helpers.items[i].string, "store");
	298	c->approved = 1;
	299	}
	300
	301	void credential_reject(struct credential *c)
	302	{
	303	int i;
	304
11825072 JK	305	credential_apply_config(c);
11825072 JK	306
abca927d JK	307	for (i = 0; i < c->helpers.nr; i++)
	308	credential_do(c, c->helpers.items[i].string, "erase");
	309
	310	free(c->username);
	311	c->username = NULL;
	312	free(c->password);
	313	c->password = NULL;
	314	c->approved = 0;
	315	}
d3e847c1 JK	316
	317	void credential_from_url(struct credential c, const char url)
	318	{
	319	const char at, colon, cp, slash, host, proto_end;
	320
	321	credential_clear(c);
	322
	323	/*
	324	* Match one of:
	325	* (1) proto://<host>/...
	326	* (2) proto://<user>@<host>/...
	327	* (3) proto://<user>:<pass>@<host>/...
	328	*/
	329	proto_end = strstr(url, "://");
	330	if (!proto_end)
	331	return;
	332	cp = proto_end + 3;
	333	at = strchr(cp, '@');
	334	colon = strchr(cp, ':');
	335	slash = strchrnul(cp, '/');
	336
	337	if (!at \|\| slash <= at) {
	338	/* Case (1) */
	339	host = cp;
	340	}
	341	else if (!colon \|\| at <= colon) {
	342	/* Case (2) */
	343	c->username = url_decode_mem(cp, at - cp);
	344	host = at + 1;
	345	} else {
	346	/* Case (3) */
	347	c->username = url_decode_mem(cp, colon - cp);
	348	c->password = url_decode_mem(colon + 1, at - (colon + 1));
	349	host = at + 1;
	350	}
	351
	352	if (proto_end - url > 0)
	353	c->protocol = xmemdupz(url, proto_end - url);
	354	if (slash - host > 0)
	355	c->host = url_decode_mem(host, slash - host);
	356	/* Trim leading and trailing slashes from path */
	357	while (*slash == '/')
	358	slash++;
	359	if (*slash) {
	360	char *p;
	361	c->path = url_decode(slash);
	362	p = c->path + strlen(c->path) - 1;
	363	while (p > c->path && *p == '/')
	364	*p-- = '\0';
	365	}
	366	}