[thirdparty/git.git] / contrib / credential / libsecret / git-credential-libsecret.c

/*
 * Copyright (C) 2011 John Szakmeister <john@szakmeister.net>
 *               2012 Philipp A. Hartmann <pah@qo.cx>
 *               2016 Mantas Mikulėnas <grawity@gmail.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

/*
 * Credits:
 * - GNOME Keyring API handling originally written by John Szakmeister
 * - ported to credential helper API by Philipp A. Hartmann
 */

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <glib.h>
#include <libsecret/secret.h>

/*
 * This credential struct and API is simplified from git's credential.{h,c}
 */
struct credential {
	char *protocol;
	char *host;
	unsigned short port;
	char *path;
	char *username;
	char *password;
};

#define CREDENTIAL_INIT { 0 }

typedef int (*credential_op_cb)(struct credential *);

struct credential_operation {
	char *name;
	credential_op_cb op;
};

#define CREDENTIAL_OP_END { NULL, NULL }

/* ----------------- Secret Service functions ----------------- */

static char *make_label(struct credential *c)
{
	if (c->port)
		return g_strdup_printf("Git: %s://%s:%hu/%s",
					c->protocol, c->host, c->port, c->path ? c->path : "");
	else
		return g_strdup_printf("Git: %s://%s/%s",
					c->protocol, c->host, c->path ? c->path : "");
}

static GHashTable *make_attr_list(struct credential *c)
{
	GHashTable *al = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, g_free);

	if (c->username)
		g_hash_table_insert(al, "user", g_strdup(c->username));
	if (c->protocol)
		g_hash_table_insert(al, "protocol", g_strdup(c->protocol));
	if (c->host)
		g_hash_table_insert(al, "server", g_strdup(c->host));
	if (c->port)
		g_hash_table_insert(al, "port", g_strdup_printf("%hu", c->port));
	if (c->path)
		g_hash_table_insert(al, "object", g_strdup(c->path));

	return al;
}

static int keyring_get(struct credential *c)
{
	SecretService *service = NULL;
	GHashTable *attributes = NULL;
	GError *error = NULL;
	GList *items = NULL;

	if (!c->protocol || !(c->host || c->path))
		return EXIT_FAILURE;

	service = secret_service_get_sync(0, NULL, &error);
	if (error != NULL) {
		g_critical("could not connect to Secret Service: %s", error->message);
		g_error_free(error);
		return EXIT_FAILURE;
	}

	attributes = make_attr_list(c);
	items = secret_service_search_sync(service,
					   SECRET_SCHEMA_COMPAT_NETWORK,
					   attributes,
					   SECRET_SEARCH_LOAD_SECRETS | SECRET_SEARCH_UNLOCK,
					   NULL,
					   &error);
	g_hash_table_unref(attributes);
	if (error != NULL) {
		g_critical("lookup failed: %s", error->message);
		g_error_free(error);
		return EXIT_FAILURE;
	}

	if (items != NULL) {
		SecretItem *item;
		SecretValue *secret;
		const char *s;

		item = items->data;
		secret = secret_item_get_secret(item);
		attributes = secret_item_get_attributes(item);

		s = g_hash_table_lookup(attributes, "user");
		if (s) {
			g_free(c->username);
			c->username = g_strdup(s);
		}

		s = secret_value_get_text(secret);
		if (s) {
			g_free(c->password);
			c->password = g_strdup(s);
		}

		g_hash_table_unref(attributes);
		secret_value_unref(secret);
		g_list_free_full(items, g_object_unref);
	}

	return EXIT_SUCCESS;
}


static int keyring_store(struct credential *c)
{
	char *label = NULL;
	GHashTable *attributes = NULL;
	GError *error = NULL;

	/*
	 * Sanity check that what we are storing is actually sensible.
	 * In particular, we can't make a URL without a protocol field.
	 * Without either a host or pathname (depending on the scheme),
	 * we have no primary key. And without a username and password,
	 * we are not actually storing a credential.
	 */
	if (!c->protocol || !(c->host || c->path) ||
	    !c->username || !c->password)
		return EXIT_FAILURE;

	label = make_label(c);
	attributes = make_attr_list(c);
	secret_password_storev_sync(SECRET_SCHEMA_COMPAT_NETWORK,
				    attributes,
				    NULL,
				    label,
				    c->password,
				    NULL,
				    &error);
	g_free(label);
	g_hash_table_unref(attributes);

	if (error != NULL) {
		g_critical("store failed: %s", error->message);
		g_error_free(error);
		return EXIT_FAILURE;
	}

	return EXIT_SUCCESS;
}

static int keyring_erase(struct credential *c)
{
	GHashTable *attributes = NULL;
	GError *error = NULL;

	/*
	 * Sanity check that we actually have something to match
	 * against. The input we get is a restrictive pattern,
	 * so technically a blank credential means "erase everything".
	 * But it is too easy to accidentally send this, since it is equivalent
	 * to empty input. So explicitly disallow it, and require that the
	 * pattern have some actual content to match.
	 */
	if (!c->protocol && !c->host && !c->path && !c->username)
		return EXIT_FAILURE;

	attributes = make_attr_list(c);
	secret_password_clearv_sync(SECRET_SCHEMA_COMPAT_NETWORK,
				    attributes,
				    NULL,
				    &error);
	g_hash_table_unref(attributes);

	if (error != NULL) {
		g_critical("erase failed: %s", error->message);
		g_error_free(error);
		return EXIT_FAILURE;
	}

	return EXIT_SUCCESS;
}

/*
 * Table with helper operation callbacks, used by generic
 * credential helper main function.
 */
static struct credential_operation const credential_helper_ops[] = {
	{ "get",   keyring_get },
	{ "store", keyring_store },
	{ "erase", keyring_erase },
	CREDENTIAL_OP_END
};

/* ------------------ credential functions ------------------ */

static void credential_init(struct credential *c)
{
	memset(c, 0, sizeof(*c));
}

static void credential_clear(struct credential *c)
{
	g_free(c->protocol);
	g_free(c->host);
	g_free(c->path);
	g_free(c->username);
	g_free(c->password);

	credential_init(c);
}

static int credential_read(struct credential *c)
{
	char *buf = NULL;
	size_t alloc;
	ssize_t line_len;
	char *key;
	char *value;

	while ((line_len = getline(&buf, &alloc, stdin)) > 0) {
		key = buf;

		if (buf[line_len-1] == '\n')
			buf[--line_len] = '\0';

		if (!line_len)
			break;

		value = strchr(buf, '=');
		if (!value) {
			g_warning("invalid credential line: %s", key);
			g_free(buf);
			return -1;
		}
		*value++ = '\0';

		if (!strcmp(key, "protocol")) {
			g_free(c->protocol);
			c->protocol = g_strdup(value);
		} else if (!strcmp(key, "host")) {
			g_free(c->host);
			c->host = g_strdup(value);
			value = strrchr(c->host, ':');
			if (value) {
				*value++ = '\0';
				c->port = atoi(value);
			}
		} else if (!strcmp(key, "path")) {
			g_free(c->path);
			c->path = g_strdup(value);
		} else if (!strcmp(key, "username")) {
			g_free(c->username);
			c->username = g_strdup(value);
		} else if (!strcmp(key, "password")) {
			g_free(c->password);
			c->password = g_strdup(value);
			while (*value)
				*value++ = '\0';
		}
		/*
		 * 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.
		 */
	}

	free(buf);

	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)
{
	/* only write username/password, if set */
	credential_write_item(stdout, "username", c->username);
	credential_write_item(stdout, "password", c->password);
}

static void usage(const char *name)
{
	struct credential_operation const *try_op = credential_helper_ops;
	const char *basename = strrchr(name, '/');

	basename = (basename) ? basename + 1 : name;
	fprintf(stderr, "usage: %s <", basename);
	while (try_op->name) {
		fprintf(stderr, "%s", (try_op++)->name);
		if (try_op->name)
			fprintf(stderr, "%s", "|");
	}
	fprintf(stderr, "%s", ">\n");
}

int main(int argc, char *argv[])
{
	int ret = EXIT_SUCCESS;

	struct credential_operation const *try_op = credential_helper_ops;
	struct credential cred = CREDENTIAL_INIT;

	if (!argv[1]) {
		usage(argv[0]);
		exit(EXIT_FAILURE);
	}

	g_set_application_name("Git Credential Helper");

	/* lookup operation callback */
	while (try_op->name && strcmp(argv[1], try_op->name))
		try_op++;

	/* unsupported operation given -- ignore silently */
	if (!try_op->name || !try_op->op)
		goto out;

	ret = credential_read(&cred);
	if (ret)
		goto out;

	/* perform credential operation */
	ret = (*try_op->op)(&cred);

	credential_write(&cred);

out:
	credential_clear(&cred);
	return ret;
}
Commit	Line	Data
87d1353a MM	1	/*
	2	* Copyright (C) 2011 John Szakmeister <john@szakmeister.net>
	3	* 2012 Philipp A. Hartmann <pah@qo.cx>
	4	* 2016 Mantas Mikulėnas <grawity@gmail.com>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
48425792	17	* along with this program; if not, see <http://www.gnu.org/licenses/>.
87d1353a MM	18	*/
	19
	20	/*
	21	* Credits:
	22	* - GNOME Keyring API handling originally written by John Szakmeister
	23	* - ported to credential helper API by Philipp A. Hartmann
	24	*/
	25
	26	#include <stdio.h>
	27	#include <string.h>
	28	#include <stdlib.h>
	29	#include <glib.h>
	30	#include <libsecret/secret.h>
	31
	32	/*
	33	* This credential struct and API is simplified from git's credential.{h,c}
	34	*/
	35	struct credential {
	36	char *protocol;
	37	char *host;
	38	unsigned short port;
	39	char *path;
	40	char *username;
	41	char *password;
	42	};
	43
9865b6e6	44	#define CREDENTIAL_INIT { 0 }
87d1353a MM	45
	46	typedef int (credential_op_cb)(struct credential );
	47
	48	struct credential_operation {
	49	char *name;
	50	credential_op_cb op;
	51	};
	52
	53	#define CREDENTIAL_OP_END { NULL, NULL }
	54
	55	/* ----------------- Secret Service functions ----------------- */
	56
	57	static char make_label(struct credential c)
	58	{
	59	if (c->port)
	60	return g_strdup_printf("Git: %s://%s:%hu/%s",
	61	c->protocol, c->host, c->port, c->path ? c->path : "");
	62	else
	63	return g_strdup_printf("Git: %s://%s/%s",
	64	c->protocol, c->host, c->path ? c->path : "");
	65	}
	66
	67	static GHashTable make_attr_list(struct credential c)
	68	{
	69	GHashTable *al = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, g_free);
	70
	71	if (c->username)
	72	g_hash_table_insert(al, "user", g_strdup(c->username));
	73	if (c->protocol)
	74	g_hash_table_insert(al, "protocol", g_strdup(c->protocol));
	75	if (c->host)
	76	g_hash_table_insert(al, "server", g_strdup(c->host));
	77	if (c->port)
	78	g_hash_table_insert(al, "port", g_strdup_printf("%hu", c->port));
	79	if (c->path)
	80	g_hash_table_insert(al, "object", g_strdup(c->path));
	81
	82	return al;
	83	}
	84
	85	static int keyring_get(struct credential *c)
	86	{
	87	SecretService *service = NULL;
	88	GHashTable *attributes = NULL;
	89	GError *error = NULL;
	90	GList *items = NULL;
	91
	92	if (!c->protocol \|\| !(c->host \|\| c->path))
	93	return EXIT_FAILURE;
	94
	95	service = secret_service_get_sync(0, NULL, &error);
	96	if (error != NULL) {
	97	g_critical("could not connect to Secret Service: %s", error->message);
	98	g_error_free(error);
	99	return EXIT_FAILURE;
	100	}
	101
	102	attributes = make_attr_list(c);
	103	items = secret_service_search_sync(service,
	104	SECRET_SCHEMA_COMPAT_NETWORK,
	105	attributes,
9c109e9b	106	SECRET_SEARCH_LOAD_SECRETS \| SECRET_SEARCH_UNLOCK,
87d1353a MM	107	NULL,
	108	&error);
	109	g_hash_table_unref(attributes);
	110	if (error != NULL) {
	111	g_critical("lookup failed: %s", error->message);
	112	g_error_free(error);
	113	return EXIT_FAILURE;
	114	}
	115
	116	if (items != NULL) {
	117	SecretItem *item;
	118	SecretValue *secret;
	119	const char *s;
	120
	121	item = items->data;
	122	secret = secret_item_get_secret(item);
	123	attributes = secret_item_get_attributes(item);
	124
	125	s = g_hash_table_lookup(attributes, "user");
	126	if (s) {
	127	g_free(c->username);
	128	c->username = g_strdup(s);
	129	}
	130
	131	s = secret_value_get_text(secret);
	132	if (s) {
	133	g_free(c->password);
	134	c->password = g_strdup(s);
	135	}
	136
	137	g_hash_table_unref(attributes);
	138	secret_value_unref(secret);
	139	g_list_free_full(items, g_object_unref);
	140	}
	141
	142	return EXIT_SUCCESS;
	143	}
	144
	145
	146	static int keyring_store(struct credential *c)
	147	{
	148	char *label = NULL;
	149	GHashTable *attributes = NULL;
	150	GError *error = NULL;
	151
	152	/*
	153	* Sanity check that what we are storing is actually sensible.
	154	* In particular, we can't make a URL without a protocol field.
	155	* Without either a host or pathname (depending on the scheme),
	156	* we have no primary key. And without a username and password,
	157	* we are not actually storing a credential.
	158	*/
	159	if (!c->protocol \|\| !(c->host \|\| c->path) \|\|
	160	!c->username \|\| !c->password)
	161	return EXIT_FAILURE;
	162
	163	label = make_label(c);
	164	attributes = make_attr_list(c);
	165	secret_password_storev_sync(SECRET_SCHEMA_COMPAT_NETWORK,
	166	attributes,
	167	NULL,
	168	label,
	169	c->password,
	170	NULL,
171	&error);
172	g_free(label);
173	g_hash_table_unref(attributes);
174
175	if (error != NULL) {
176	g_critical("store failed: %s", error->message);
177	g_error_free(error);
178	return EXIT_FAILURE;
179	}
180
181	return EXIT_SUCCESS;
182	}
183
184	static int keyring_erase(struct credential *c)
185	{
186	GHashTable *attributes = NULL;
187	GError *error = NULL;
188
189	/*
190	* Sanity check that we actually have something to match
191	* against. The input we get is a restrictive pattern,
192	* so technically a blank credential means "erase everything".
193	* But it is too easy to accidentally send this, since it is equivalent
194	* to empty input. So explicitly disallow it, and require that the
195	* pattern have some actual content to match.
196	*/
197	if (!c->protocol && !c->host && !c->path && !c->username)
198	return EXIT_FAILURE;
199
200	attributes = make_attr_list(c);
201	secret_password_clearv_sync(SECRET_SCHEMA_COMPAT_NETWORK,
202	attributes,
203	NULL,
204	&error);
205	g_hash_table_unref(attributes);
206
207	if (error != NULL) {
208	g_critical("erase failed: %s", error->message);
209	g_error_free(error);
210	return EXIT_FAILURE;
211	}
212
213	return EXIT_SUCCESS;
214	}
215
216	/*
217	* Table with helper operation callbacks, used by generic
218	* credential helper main function.
219	*/
220	static struct credential_operation const credential_helper_ops[] = {
221	{ "get", keyring_get },
222	{ "store", keyring_store },
223	{ "erase", keyring_erase },
224	CREDENTIAL_OP_END
225	};
226
227	/* ------------------ credential functions ------------------ */
228
229	static void credential_init(struct credential *c)
230	{
231	memset(c, 0, sizeof(*c));
232	}
233
234	static void credential_clear(struct credential *c)
235	{
236	g_free(c->protocol);
237	g_free(c->host);
238	g_free(c->path);
239	g_free(c->username);
240	g_free(c->password);
241
242	credential_init(c);
243	}
244
245	static int credential_read(struct credential *c)
246	{
64f1e658 TB	247	char *buf = NULL;
	248	size_t alloc;
	249	ssize_t line_len;
87d1353a MM	250	char *key;
	251	char *value;
	252
64f1e658 TB	253	while ((line_len = getline(&buf, &alloc, stdin)) > 0) {
64f1e658 TB	254	key = buf;
87d1353a	255
64f1e658	256	if (buf[line_len-1] == '\n')
87d1353a MM	257	buf[--line_len] = '\0';
	258
	259	if (!line_len)
	260	break;
	261
	262	value = strchr(buf, '=');
	263	if (!value) {
	264	g_warning("invalid credential line: %s", key);
	265	g_free(buf);
	266	return -1;
	267	}
	268	*value++ = '\0';
	269
	270	if (!strcmp(key, "protocol")) {
	271	g_free(c->protocol);
	272	c->protocol = g_strdup(value);
	273	} else if (!strcmp(key, "host")) {
	274	g_free(c->host);
	275	c->host = g_strdup(value);
	276	value = strrchr(c->host, ':');
	277	if (value) {
	278	*value++ = '\0';
	279	c->port = atoi(value);
	280	}
	281	} else if (!strcmp(key, "path")) {
	282	g_free(c->path);
	283	c->path = g_strdup(value);
	284	} else if (!strcmp(key, "username")) {
	285	g_free(c->username);
	286	c->username = g_strdup(value);
	287	} else if (!strcmp(key, "password")) {
	288	g_free(c->password);
	289	c->password = g_strdup(value);
	290	while (*value)
	291	*value++ = '\0';
	292	}
	293	/*
	294	* Ignore other lines; we don't know what they mean, but
	295	* this future-proofs us when later versions of git do
	296	* learn new lines, and the helpers are updated to match.
	297	*/
	298	}
	299
64f1e658	300	free(buf);
87d1353a MM	301
	302	return 0;
	303	}
	304
	305	static void credential_write_item(FILE fp, const char key, const char *value)
	306	{
	307	if (!value)
	308	return;
	309	fprintf(fp, "%s=%s\n", key, value);
	310	}
	311
	312	static void credential_write(const struct credential *c)
	313	{
	314	/* only write username/password, if set */
	315	credential_write_item(stdout, "username", c->username);
	316	credential_write_item(stdout, "password", c->password);
	317	}
	318
	319	static void usage(const char *name)
	320	{
	321	struct credential_operation const *try_op = credential_helper_ops;
	322	const char *basename = strrchr(name, '/');
	323
	324	basename = (basename) ? basename + 1 : name;
	325	fprintf(stderr, "usage: %s <", basename);
	326	while (try_op->name) {
	327	fprintf(stderr, "%s", (try_op++)->name);
	328	if (try_op->name)
	329	fprintf(stderr, "%s", "\|");
	330	}
	331	fprintf(stderr, "%s", ">\n");
	332	}
	333
	334	int main(int argc, char *argv[])
	335	{
	336	int ret = EXIT_SUCCESS;
	337
	338	struct credential_operation const *try_op = credential_helper_ops;
	339	struct credential cred = CREDENTIAL_INIT;
	340
	341	if (!argv[1]) {
	342	usage(argv[0]);
	343	exit(EXIT_FAILURE);
	344	}
	345
	346	g_set_application_name("Git Credential Helper");
	347
	348	/* lookup operation callback */
	349	while (try_op->name && strcmp(argv[1], try_op->name))
	350	try_op++;
	351
	352	/* unsupported operation given -- ignore silently */
	353	if (!try_op->name \|\| !try_op->op)
	354	goto out;
	355
	356	ret = credential_read(&cred);
	357	if (ret)
	358	goto out;
	359
	360	/* perform credential operation */
	361	ret = (*try_op->op)(&cred);
	362
	363	credential_write(&cred);
	364
365	out:
366	credential_clear(&cred);
367	return ret;
368	}