[gnome-software] Add GsAuth as a set of authorization parameters
- From: Richard Hughes <rhughes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-software] Add GsAuth as a set of authorization parameters
- Date: Fri, 10 Jun 2016 14:04:50 +0000 (UTC)
commit 8754ef09b853490425560777c9a322267e3c9a2a
Author: Richard Hughes <richard hughsie com>
Date: Fri Jun 10 14:37:22 2016 +0100
Add GsAuth as a set of authorization parameters
doc/api/gnome-software-docs.xml | 1 +
src/Makefile.am | 5 +
src/gnome-software.h | 1 +
src/gs-auth.c | 488 +++++++++++++++++++++++++++++++++++++++
src/gs-auth.h | 86 +++++++
5 files changed, 581 insertions(+), 0 deletions(-)
---
diff --git a/doc/api/gnome-software-docs.xml b/doc/api/gnome-software-docs.xml
index 2f473f7..df94c3f 100644
--- a/doc/api/gnome-software-docs.xml
+++ b/doc/api/gnome-software-docs.xml
@@ -623,6 +623,7 @@ gs_plugin_adopt_app (GsPlugin *plugin, GsApp *app)
<title>GNOME Software Plugin API</title>
<xi:include href="xml/gs-app-list.xml"/>
<xi:include href="xml/gs-app.xml"/>
+ <xi:include href="xml/gs-auth.xml"/>
<xi:include href="xml/gs-os-release.xml"/>
<xi:include href="xml/gs-plugin.xml"/>
<xi:include href="xml/gs-plugin-vfuncs.xml"/>
diff --git a/src/Makefile.am b/src/Makefile.am
index dbdf496..3fbb5fa 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -28,6 +28,7 @@ gnomesoftware_include_HEADERS = \
gnome-software.h \
gs-app.h \
gs-app-list.h \
+ gs-auth.h \
gs-category.h \
gs-os-release.h \
gs-plugin.h \
@@ -104,6 +105,7 @@ noinst_PROGRAMS = \
gnome_software_cmd_SOURCES = \
gs-app.c \
gs-app-list.c \
+ gs-auth.c \
gs-review.c \
gs-cmd.c \
gs-common.c \
@@ -138,6 +140,8 @@ gnome_software_SOURCES = \
gs-app-list.c \
gs-app-list.h \
gs-app-list-private.h \
+ gs-auth.c \
+ gs-auth.h \
gs-category.c \
gs-category.h \
gs-category-private.h \
@@ -321,6 +325,7 @@ check_PROGRAMS = \
gs_self_test_SOURCES = \
gs-app.c \
gs-app-list.c \
+ gs-auth.c \
gs-category.c \
gs-common.c \
gs-os-release.c \
diff --git a/src/gnome-software.h b/src/gnome-software.h
index d587c4a..fa15686 100644
--- a/src/gnome-software.h
+++ b/src/gnome-software.h
@@ -28,6 +28,7 @@
#include <gs-app.h>
#include <gs-app-list.h>
+#include <gs-auth.h>
#include <gs-category.h>
#include <gs-os-release.h>
#include <gs-plugin.h>
diff --git a/src/gs-auth.c b/src/gs-auth.c
new file mode 100644
index 0000000..167f4c6
--- /dev/null
+++ b/src/gs-auth.c
@@ -0,0 +1,488 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
+ *
+ * Copyright (C) 2016 Richard Hughes <richard hughsie com>
+ *
+ * Licensed under the GNU General Public License Version 2
+ *
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+/**
+ * SECTION:gs-auth
+ * @title: GsAuth
+ * @include: gnome-software.h
+ * @stability: Unstable
+ * @short_description: User data used for authentication
+ *
+ * This object represents user data used for authentication.
+ * This data is shared between all plugins.
+ */
+
+#include "config.h"
+
+#include "gs-auth.h"
+
+struct _GsAuth
+{
+ GObject parent_instance;
+
+ GsAuthFlags flags;
+ gchar *provider_id;
+ gchar *provider_name;
+ gchar *provider_logo;
+ gchar *provider_uri;
+ gchar *username;
+ gchar *password;
+ gchar *pin;
+ GHashTable *metadata;
+};
+
+enum {
+ PROP_0,
+ PROP_USERNAME,
+ PROP_PASSWORD,
+ PROP_PIN,
+ PROP_FLAGS,
+ PROP_LAST
+};
+
+G_DEFINE_TYPE (GsAuth, gs_auth, G_TYPE_OBJECT)
+
+/**
+ * gs_auth_get_provider_id:
+ * @auth: a #GsAuth
+ *
+ * Gets the authentication service name. This must match the string in
+ * gs_app_get_auth_provider() to be used.
+ *
+ * Returns: the string to use for searching, e.g. "UbuntuOne"
+ */
+const gchar *
+gs_auth_get_provider_id (GsAuth *auth)
+{
+ g_return_val_if_fail (GS_IS_AUTH (auth), NULL);
+ return auth->provider_id;
+}
+
+/**
+ * gs_auth_get_provider_name:
+ * @auth: a #GsAuth
+ *
+ * Gets the authentication service name.
+ *
+ * Returns: the string to show in the UI
+ */
+const gchar *
+gs_auth_get_provider_name (GsAuth *auth)
+{
+ g_return_val_if_fail (GS_IS_AUTH (auth), NULL);
+ return auth->provider_name;
+}
+
+/**
+ * gs_auth_set_provider_name:
+ * @auth: a #GsAuth
+ * @provider_name: a service name, e.g. "GNOME Online Accounts"
+ *
+ * Sets the name to be used for the authentication dialog.
+ */
+void
+gs_auth_set_provider_name (GsAuth *auth, const gchar *provider_name)
+{
+ g_return_if_fail (GS_IS_AUTH (auth));
+ g_free (auth->provider_name);
+ auth->provider_name = g_strdup (provider_name);
+}
+
+/**
+ * gs_auth_get_provider_logo:
+ * @auth: a #GsAuth
+ *
+ * Gets the authentication service image.
+ *
+ * Returns: the filename of an image, or %NULL
+ */
+const gchar *
+gs_auth_get_provider_logo (GsAuth *auth)
+{
+ g_return_val_if_fail (GS_IS_AUTH (auth), NULL);
+ return auth->provider_logo;
+}
+
+/**
+ * gs_auth_set_provider_logo:
+ * @auth: a #GsAuth
+ * @provider_logo: an image, e.g. "/usr/share/icons/gnome-online.png"
+ *
+ * Sets the image to be used for the authentication dialog.
+ */
+void
+gs_auth_set_provider_logo (GsAuth *auth, const gchar *provider_logo)
+{
+ g_return_if_fail (GS_IS_AUTH (auth));
+ g_free (auth->provider_logo);
+ auth->provider_logo = g_strdup (provider_logo);
+}
+
+/**
+ * gs_auth_get_provider_uri:
+ * @auth: a #GsAuth
+ *
+ * Gets the authentication service website.
+ *
+ * Returns: the URI, or %NULL
+ */
+const gchar *
+gs_auth_get_provider_uri (GsAuth *auth)
+{
+ g_return_val_if_fail (GS_IS_AUTH (auth), NULL);
+ return auth->provider_uri;
+}
+
+/**
+ * gs_auth_set_provider_uri:
+ * @auth: a #GsAuth
+ * @provider_uri: a URI, e.g. "http://www.gnome.org/sso";
+ *
+ * Sets the website to be used for the authentication dialog.
+ */
+void
+gs_auth_set_provider_uri (GsAuth *auth, const gchar *provider_uri)
+{
+ g_return_if_fail (GS_IS_AUTH (auth));
+ g_free (auth->provider_uri);
+ auth->provider_uri = g_strdup (provider_uri);
+}
+
+/**
+ * gs_auth_get_username:
+ * @auth: a #GsAuth
+ *
+ * Gets the auth username.
+ *
+ * Returns: the username to be used for the authentication
+ */
+const gchar *
+gs_auth_get_username (GsAuth *auth)
+{
+ g_return_val_if_fail (GS_IS_AUTH (auth), NULL);
+ return auth->username;
+}
+
+/**
+ * gs_auth_set_username:
+ * @auth: a #GsAuth
+ * @username: a username, e.g. "hughsie"
+ *
+ * Sets the username to be used for the authentication.
+ */
+void
+gs_auth_set_username (GsAuth *auth, const gchar *username)
+{
+ g_return_if_fail (GS_IS_AUTH (auth));
+ g_free (auth->username);
+ auth->username = g_strdup (username);
+}
+
+/**
+ * gs_auth_get_password:
+ * @auth: a #GsAuth
+ *
+ * Gets the password to be used for the authentication.
+ *
+ * Returns: the string, or %NULL
+ **/
+const gchar *
+gs_auth_get_password (GsAuth *auth)
+{
+ g_return_val_if_fail (GS_IS_AUTH (auth), NULL);
+ return auth->password;
+}
+
+/**
+ * gs_auth_set_password:
+ * @auth: a #GsAuth
+ * @password: password string, e.g. "p ssw0rd"
+ *
+ * Sets the password to be used for the authentication.
+ */
+void
+gs_auth_set_password (GsAuth *auth, const gchar *password)
+{
+ g_return_if_fail (GS_IS_AUTH (auth));
+ g_free (auth->password);
+ auth->password = g_strdup (password);
+}
+
+/**
+ * gs_auth_get_flags:
+ * @auth: a #GsAuth
+ *
+ * Gets any flags set on the authentication, for example if we should remember
+ * credentials.
+ *
+ * Returns: a #GsAuthFlags, e.g. %GS_AUTH_FLAG_REMEMBER
+ */
+GsAuthFlags
+gs_auth_get_flags (GsAuth *auth)
+{
+ g_return_val_if_fail (GS_IS_AUTH (auth), 0);
+ return auth->flags;
+}
+
+/**
+ * gs_auth_set_flags:
+ * @auth: a #GsAuth
+ * @flags: a #GsAuthFlags, e.g. %GS_AUTH_FLAG_REMEMBER
+ *
+ * Gets any flags set on the authentication.
+ */
+void
+gs_auth_set_flags (GsAuth *auth, GsAuthFlags flags)
+{
+ g_return_if_fail (GS_IS_AUTH (auth));
+ auth->flags = flags;
+}
+
+/**
+ * gs_auth_add_flags:
+ * @auth: a #GsAuth
+ * @flags: a #GsAuthFlags, e.g. %GS_AUTH_FLAG_REMEMBER
+ *
+ * Adds flags to an existing authentication without replacing the other flags.
+ */
+void
+gs_auth_add_flags (GsAuth *auth, GsAuthFlags flags)
+{
+ g_return_if_fail (GS_IS_AUTH (auth));
+ auth->flags |= flags;
+}
+
+/**
+ * gs_auth_has_flag:
+ * @auth: a #GsAuth
+ * @flags: a #GsAuthFlags, e.g. %GS_AUTH_FLAG_REMEMBER
+ *
+ * Finds ouf if the authentication has a flag.
+ *
+ * Returns: %TRUE if set
+ */
+gboolean
+gs_auth_has_flag (GsAuth *auth, GsAuthFlags flags)
+{
+ g_return_val_if_fail (GS_IS_AUTH (auth), FALSE);
+ return (auth->flags & flags) > 0;
+}
+
+/**
+ * gs_auth_get_pin:
+ * @auth: a #GsAuth
+ *
+ * Gets the PIN code.
+ *
+ * Returns: the 2 factor authentication PIN, or %NULL
+ **/
+const gchar *
+gs_auth_get_pin (GsAuth *auth)
+{
+ g_return_val_if_fail (GS_IS_AUTH (auth), NULL);
+ return auth->pin;
+}
+
+/**
+ * gs_auth_set_pin:
+ * @auth: a #GsAuth
+ * @pin: the PIN code, e.g. "12345"
+ *
+ * Sets the 2 factor authentication PIN, which can be left unset.
+ */
+void
+gs_auth_set_pin (GsAuth *auth, const gchar *pin)
+{
+ g_return_if_fail (GS_IS_AUTH (auth));
+ g_free (auth->pin);
+ auth->pin = g_strdup (pin);
+}
+
+/**
+ * gs_auth_get_metadata_item:
+ * @auth: a #GsAuth
+ * @key: a string
+ *
+ * Gets some metadata from a authentication object.
+ * It is left for the the plugin to use this method as required, but a
+ * typical use would be to retrieve some secure auth token.
+ *
+ * Returns: A string value, or %NULL for not found
+ */
+const gchar *
+gs_auth_get_metadata_item (GsAuth *auth, const gchar *key)
+{
+ g_return_val_if_fail (GS_IS_AUTH (auth), NULL);
+ g_return_val_if_fail (key != NULL, NULL);
+ return g_hash_table_lookup (auth->metadata, key);
+}
+
+/**
+ * gs_auth_add_metadata:
+ * @auth: a #GsAuth
+ * @key: a string
+ * @value: a string
+ *
+ * Adds metadata to the authentication object.
+ * It is left for the the plugin to use this method as required, but a
+ * typical use would be to store some secure auth token.
+ */
+void
+gs_auth_add_metadata (GsAuth *auth, const gchar *key, const gchar *value)
+{
+ g_return_if_fail (GS_IS_AUTH (auth));
+ g_hash_table_insert (auth->metadata, g_strdup (key), g_strdup (value));
+}
+
+static void
+gs_auth_get_property (GObject *object, guint prop_id,
+ GValue *value, GParamSpec *pspec)
+{
+ GsAuth *auth = GS_AUTH (object);
+
+ switch (prop_id) {
+ case PROP_USERNAME:
+ g_value_set_string (value, auth->username);
+ break;
+ case PROP_PASSWORD:
+ g_value_set_string (value, auth->password);
+ break;
+ case PROP_FLAGS:
+ g_value_set_uint64 (value, auth->flags);
+ break;
+ case PROP_PIN:
+ g_value_set_string (value, auth->pin);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+gs_auth_set_property (GObject *object, guint prop_id,
+ const GValue *value, GParamSpec *pspec)
+{
+ GsAuth *auth = GS_AUTH (object);
+
+ switch (prop_id) {
+ case PROP_USERNAME:
+ gs_auth_set_username (auth, g_value_get_string (value));
+ break;
+ case PROP_PASSWORD:
+ gs_auth_set_password (auth, g_value_get_string (value));
+ break;
+ case PROP_FLAGS:
+ gs_auth_set_flags (auth, g_value_get_uint64 (value));
+ break;
+ case PROP_PIN:
+ gs_auth_set_pin (auth, g_value_get_string (value));
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+gs_auth_finalize (GObject *object)
+{
+ GsAuth *auth = GS_AUTH (object);
+
+ g_free (auth->provider_id);
+ g_free (auth->provider_name);
+ g_free (auth->provider_logo);
+ g_free (auth->provider_uri);
+ g_free (auth->username);
+ g_free (auth->password);
+ g_free (auth->pin);
+ g_hash_table_unref (auth->metadata);
+
+ G_OBJECT_CLASS (gs_auth_parent_class)->finalize (object);
+}
+
+static void
+gs_auth_class_init (GsAuthClass *klass)
+{
+ GParamSpec *pspec;
+ GObjectClass *object_class = G_OBJECT_CLASS (klass);
+ object_class->finalize = gs_auth_finalize;
+ object_class->get_property = gs_auth_get_property;
+ object_class->set_property = gs_auth_set_property;
+
+ /**
+ * GsAuth:username:
+ */
+ pspec = g_param_spec_string ("username", NULL, NULL,
+ NULL,
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
+ g_object_class_install_property (object_class, PROP_USERNAME, pspec);
+
+ /**
+ * GsAuth:password:
+ */
+ pspec = g_param_spec_string ("password", NULL, NULL,
+ NULL,
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
+ g_object_class_install_property (object_class, PROP_PASSWORD, pspec);
+
+ /**
+ * GsAuth:flags:
+ */
+ pspec = g_param_spec_uint64 ("flags", NULL, NULL,
+ GS_AUTH_FLAG_NONE,
+ GS_AUTH_FLAG_LAST,
+ GS_AUTH_FLAG_NONE,
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
+ g_object_class_install_property (object_class, PROP_FLAGS, pspec);
+
+ /**
+ * GsAuth:pin:
+ */
+ pspec = g_param_spec_string ("pin", NULL, NULL,
+ NULL,
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
+ g_object_class_install_property (object_class, PROP_PIN, pspec);
+}
+
+static void
+gs_auth_init (GsAuth *auth)
+{
+ auth->metadata = g_hash_table_new_full (g_str_hash, g_str_equal,
+ g_free, g_free);
+}
+
+/**
+ * gs_auth_new:
+ * @provider_id: a provider ID used for mapping, e.g. "GnomeSSO"
+ *
+ * Return value: a new #GsAuth object.
+ **/
+GsAuth *
+gs_auth_new (const gchar *provider_id)
+{
+ GsAuth *auth;
+ auth = g_object_new (GS_TYPE_AUTH, NULL);
+ auth->provider_id = g_strdup (provider_id);
+ return GS_AUTH (auth);
+}
+
+/* vim: set noexpandtab: */
diff --git a/src/gs-auth.h b/src/gs-auth.h
new file mode 100644
index 0000000..9ce1e1f
--- /dev/null
+++ b/src/gs-auth.h
@@ -0,0 +1,86 @@
+ /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
+ *
+ * Copyright (C) 2016 Richard Hughes <richard hughsie com>
+ *
+ * Licensed under the GNU General Public License Version 2
+ *
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef __GS_AUTH_H
+#define __GS_AUTH_H
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define GS_TYPE_AUTH (gs_auth_get_type ())
+
+G_DECLARE_FINAL_TYPE (GsAuth, gs_auth, GS, AUTH, GObject)
+
+/**
+ * GsAuthFlags:
+ * @GS_AUTH_FLAG_NONE: No special flags set
+ * @GS_AUTH_FLAG_VALID: Authorisation is valid
+ * @GS_AUTH_FLAG_REMEMBER: Remember this authentication if possible
+ *
+ * The flags for the auth.
+ **/
+typedef enum {
+ GS_AUTH_FLAG_NONE = 0,
+ GS_AUTH_FLAG_VALID = 1 << 0,
+ GS_AUTH_FLAG_REMEMBER = 1 << 1,
+ /*< private >*/
+ GS_AUTH_FLAG_LAST
+} GsAuthFlags;
+
+GsAuth *gs_auth_new (const gchar *provider_id);
+const gchar *gs_auth_get_provider_id (GsAuth *auth);
+const gchar *gs_auth_get_provider_name (GsAuth *auth);
+void gs_auth_set_provider_name (GsAuth *auth,
+ const gchar *provider_name);
+const gchar *gs_auth_get_provider_logo (GsAuth *auth);
+void gs_auth_set_provider_logo (GsAuth *auth,
+ const gchar *provider_logo);
+const gchar *gs_auth_get_provider_uri (GsAuth *auth);
+void gs_auth_set_provider_uri (GsAuth *auth,
+ const gchar *provider_uri);
+const gchar *gs_auth_get_username (GsAuth *auth);
+void gs_auth_set_username (GsAuth *auth,
+ const gchar *username);
+const gchar *gs_auth_get_password (GsAuth *auth);
+void gs_auth_set_password (GsAuth *auth,
+ const gchar *password);
+const gchar *gs_auth_get_pin (GsAuth *auth);
+void gs_auth_set_pin (GsAuth *auth,
+ const gchar *pin);
+GsAuthFlags gs_auth_get_flags (GsAuth *auth);
+void gs_auth_set_flags (GsAuth *auth,
+ GsAuthFlags flags);
+void gs_auth_add_flags (GsAuth *auth,
+ GsAuthFlags flags);
+gboolean gs_auth_has_flag (GsAuth *auth,
+ GsAuthFlags flags);
+const gchar *gs_auth_get_metadata_item (GsAuth *auth,
+ const gchar *key);
+void gs_auth_add_metadata (GsAuth *auth,
+ const gchar *key,
+ const gchar *value);
+
+G_END_DECLS
+
+#endif /* __GS_AUTH_H */
+
+/* vim: set noexpandtab: */
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
