Add secret-tool command

* See usage for details on how to use it

.gitignore

@@ -70,3 +70,4 @@ stamp*
 !/library/tests/test-*.js
 !/library/tests/test-*.py
 
+/tool/secret-tool

Makefile.am

@@ -3,7 +3,7 @@ include $(top_srcdir)/Makefile.decl
 
 ACLOCAL_AMFLAGS = -I build/m4 ${ACLOCAL_FLAGS}
 
-SUBDIRS = build egg library po docs
+SUBDIRS = build egg library tool po docs
 
 DISTCHECK_CONFIGURE_FLAGS = \
 	--enable-debug=yes \

configure.ac

@@ -238,6 +238,7 @@ AC_CONFIG_FILES([
 	library/Makefile
 	library/libsecret.pc
 	library/tests/Makefile
+	tool/Makefile
 ])
 AC_OUTPUT
 

tool/Makefile.am

@@ -0,0 +1,15 @@
+include $(top_srcdir)/Makefile.decl
+
+INCLUDES = \
+	-I$(top_srcdir) \
+	-I$(top_srcdir)/library \
+	-DSECRET_COMPILATION \
+	$(NULL)
+
+bin_PROGRAMS = secret-tool
+
+secret_tool_SOURCES = \
+	secret-tool.c
+
+secret_tool_LDADD = \
+	$(top_builddir)/library/libsecret-0.la

tool/secret-tool.c

@@ -0,0 +1,356 @@
+/* libsecret - GLib wrapper for Secret Service
+ *
+ * Copyright 2012 Red Hat Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published
+ * by the Free Software Foundation; either version 2 of the licence or (at
+ * your option) any later version.
+ *
+ * See the included COPYING file for more information.
+ *
+ * Author: Stef Walter <stefw@gnome.org>
+ */
+
+#include "config.h"
+
+#include "secret-password.h"
+#include "secret-service.h"
+#include "secret-value.h"
+
+#include <glib/gi18n.h>
+
+#include <errno.h>
+#include <limits.h>
+#include <stdlib.h>
+
+#define SECRET_ALIAS_PREFIX "/org/freedesktop/secrets/aliases/"
+
+static gchar **attribute_args = NULL;
+static gchar *store_label = NULL;
+static gchar *store_collection = NULL;
+
+/* secret-tool store --label="blah" --collection="xxxx" name:xxxx name:yyyy */
+static const GOptionEntry STORE_OPTIONS[] = {
+	{ "label", 'l', 0, G_OPTION_ARG_STRING, &store_label,
+	  N_("the label for the new stored item"), NULL },
+	{ "collection", 'c', 0, G_OPTION_ARG_STRING, &store_collection,
+	  N_("the collection in which to place the stored item"), NULL },
+	{ G_OPTION_REMAINING, 0, 0, G_OPTION_ARG_STRING_ARRAY, &attribute_args,
+	  N_("attribute value pairs of item to lookup"), NULL },
+	{ NULL }
+};
+
+/* secret-tool lookup name:xxxx yyyy:zzzz */
+static const GOptionEntry LOOKUP_OPTIONS[] = {
+	{ G_OPTION_REMAINING, 0, 0, G_OPTION_ARG_STRING_ARRAY, &attribute_args,
+	  N_("attribute value pairs of item to lookup"), NULL },
+	{ NULL }
+};
+
+/* secret-tool remove name:xxxx yyyy:zzzz */
+static const GOptionEntry REMOVE_OPTIONS[] = {
+	{ G_OPTION_REMAINING, 0, 0, G_OPTION_ARG_STRING_ARRAY, &attribute_args,
+	  N_("attribute value pairs which match item to remove"), NULL },
+	{ NULL }
+};
+
+typedef int       (* SecretToolAction)          (int argc, char *argv[]);
+
+static void       usage                         (void) G_GNUC_NORETURN;
+
+static void
+usage (void)
+{
+	g_printerr ("usage: secret-tool store --label='label' attribute value ...\n");
+	g_printerr ("       secret-tool lookup attribute value ...\n");
+	g_printerr ("       secret-tool remove attribute value ...\n");
+	exit (2);
+}
+
+static gboolean
+is_password_value (SecretValue *value)
+{
+	const gchar *content_type;
+	const gchar *data;
+	gsize length;
+
+	content_type = secret_value_get_content_type (value);
+	if (content_type && g_str_equal (content_type, "text/plain"))
+		return TRUE;
+
+	data = secret_value_get (value, &length);
+	/* gnome-keyring-daemon used to return passwords like this, so support this, but validate */
+	if (!content_type || g_str_equal (content_type, "application/octet-stream"))
+		return g_utf8_validate (data, length, NULL);
+
+	return FALSE;
+}
+
+static GHashTable *
+attributes_from_arguments (gchar **args)
+{
+	GHashTable *attributes;
+
+	if (args == NULL || args[0] == NULL) {
+		g_printerr ("%s: must specfy attribute and value pairs\n", g_get_prgname ());
+		usage ();
+	}
+
+	attributes = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
+
+	while (args[0] != NULL) {
+		if (args[1] == NULL) {
+			g_printerr ("%s: must specfy attributes and values in pairs\n", g_get_prgname ());
+			usage ();
+		}
+
+		g_hash_table_insert (attributes, g_strdup (args[0]), g_strdup (args[1]));
+		args += 2;
+	}
+
+	return attributes;
+}
+
+static int
+secret_tool_action_remove (int argc,
+                           char *argv[])
+{
+	GError *error = NULL;
+	GOptionContext *context;
+	SecretService *service;
+	GHashTable *attributes;
+
+	context = g_option_context_new ("attribute value ...");
+	g_option_context_add_main_entries (context, REMOVE_OPTIONS, GETTEXT_PACKAGE);
+	if (!g_option_context_parse (context, &argc, &argv, &error)) {
+		g_printerr ("%s\n", error->message);
+		usage();
+	}
+
+	g_option_context_free (context);
+
+	attributes = attributes_from_arguments (attribute_args);
+	g_strfreev (attribute_args);
+
+	service = secret_service_get_sync (SECRET_SERVICE_NONE, NULL, &error);
+	if (error == NULL)
+		secret_service_removev_sync (service, NULL, attributes, NULL, &error);
+
+	g_object_unref (service);
+	g_hash_table_unref (attributes);
+
+	if (error != NULL) {
+		g_printerr ("%s: %s\n", g_get_prgname (), error->message);
+		return 1;
+	}
+
+	return 0;
+}
+
+static void
+write_password_stdout (SecretValue *value)
+{
+	const gchar *at;
+	gsize length;
+	int r;
+
+	if (!is_password_value (value)) {
+		g_printerr ("%s: secret does not contain a textual password\n", g_get_prgname ());
+		exit (1);
+	}
+
+	at = secret_value_get (value, &length);
+
+	while (length > 0) {
+		r = write (1, at, length);
+		if (r == -1) {
+			if (errno != EAGAIN && errno != EINTR) {
+				g_printerr ("%s: couldn't write password: %s\n",
+				            g_get_prgname (), g_strerror (errno));
+				exit (1);
+			}
+		} else {
+			at += r;
+			length -= r;
+		}
+	}
+
+	/* Add a new line if we're writing out to a tty */
+	if (isatty (1))
+		write (1, "\n", 1);
+}
+
+static int
+secret_tool_action_lookup (int argc,
+                           char *argv[])
+{
+	GError *error = NULL;
+	GOptionContext *context;
+	SecretService *service;
+	GHashTable *attributes;
+	SecretValue *value;
+
+	context = g_option_context_new ("attribute value ...");
+	g_option_context_add_main_entries (context, LOOKUP_OPTIONS, GETTEXT_PACKAGE);
+	if (!g_option_context_parse (context, &argc, &argv, &error)) {
+		g_printerr ("%s\n", error->message);
+		usage();
+	}
+
+	g_option_context_free (context);
+
+	attributes = attributes_from_arguments (attribute_args);
+	g_strfreev (attribute_args);
+
+	service = secret_service_get_sync (SECRET_SERVICE_NONE, NULL, &error);
+	if (error == NULL)
+		value = secret_service_lookupv_sync (service, NULL, attributes, NULL, &error);
+
+	g_object_unref (service);
+	g_hash_table_unref (attributes);
+
+	if (error != NULL) {
+		g_printerr ("%s: %s\n", g_get_prgname (), error->message);
+		return 1;
+	}
+
+	if (value == NULL)
+		return 1;
+
+	write_password_stdout (value);
+	secret_value_unref (value);
+	return 0;
+}
+
+static SecretValue *
+read_password_stdin (void)
+{
+	gchar *password;
+	gchar *at;
+	gsize length = 0;
+	gsize remaining = 8192;
+	int r;
+
+	at = password = g_malloc0 (remaining + 1);
+
+	for (;;) {
+		r = read (0, at, remaining);
+		if (r == 0) {
+			break;
+		} else if (r < 0) {
+			if (errno != EAGAIN && errno != EINTR) {
+				g_printerr ("%s: couldn't read password: %s\n",
+				            g_get_prgname (), g_strerror (errno));
+				exit (1);
+			}
+		} else {
+			/* TODO: This restriction is due purely to laziness. */
+			if (r == remaining)
+				g_printerr ("%s: password is too long\n", g_get_prgname ());
+			at += r;
+			remaining -= r;
+			length += r;
+		}
+	}
+
+	/* TODO: Verify that the password really is utf-8 text. */
+	return secret_value_new_full (password, length, "text/plain",
+	                              (GDestroyNotify)secret_password_free);
+}
+
+static SecretValue *
+read_password_tty (void)
+{
+	gchar *password;
+
+	password = getpass ("Password: ");
+	return secret_value_new_full (password, -1, "text/plain",
+	                              (GDestroyNotify)secret_password_clear);
+}
+
+static int
+secret_tool_action_store (int argc,
+                          char *argv[])
+{
+	GError *error = NULL;
+	GOptionContext *context;
+	SecretService *service;
+	GHashTable *attributes;
+	SecretValue *value;
+	gchar *collection = NULL;
+
+	context = g_option_context_new ("attribute value ...");
+	g_option_context_add_main_entries (context, STORE_OPTIONS, GETTEXT_PACKAGE);
+	if (!g_option_context_parse (context, &argc, &argv, &error)) {
+		g_printerr ("%s\n", error->message);
+		usage();
+	}
+
+	g_option_context_free (context);
+
+	if (store_label == NULL) {
+		g_printerr ("%s: must specify a label for the new item\n", g_get_prgname ());
+		usage ();
+	}
+
+	attributes = attributes_from_arguments (attribute_args);
+	g_strfreev (attribute_args);
+
+	if (store_collection) {
+		/* TODO: Verify that the collection is a valid path or path element */
+		if (g_str_has_prefix (store_collection, "/"))
+			collection = g_strdup (store_collection);
+		else
+			collection = g_strconcat (SECRET_ALIAS_PREFIX, store_collection, NULL);
+	}
+
+	service = secret_service_get_sync (SECRET_SERVICE_NONE, NULL, &error);
+	if (error == NULL) {
+		if (isatty (0))
+			value = read_password_tty ();
+		else
+			value = read_password_stdin ();
+
+		secret_service_storev_sync (service, NULL, attributes, collection, store_label, value, NULL, &error);
+		secret_value_unref (value);
+	}
+
+	g_object_unref (service);
+	g_hash_table_unref (attributes);
+	g_free (store_label);
+	g_free (store_collection);
+	g_free (collection);
+
+	if (error != NULL) {
+		g_printerr ("%s: %s\n", g_get_prgname (), error->message);
+		return 1;
+	}
+
+	return 0;
+}
+
+int
+main (int argc,
+      char *argv[])
+{
+	SecretToolAction action;
+
+	g_type_init ();
+
+	if (argc < 2)
+		usage();
+
+	if (g_str_equal (argv[1], "store")) {
+		action = secret_tool_action_store;
+	} else if (g_str_equal (argv[1], "lookup")) {
+		action = secret_tool_action_lookup;
+	} else if (g_str_equal (argv[1], "remove")) {
+		action = secret_tool_action_remove;
+	} else {
+		usage ();
+	}
+
+	argv[1] = argv[0];
+	return (action) (argc - 1, argv + 1);
+}