NetworkManager/src/nm-secrets-provider-interface.c

/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/* NetworkManager -- Network link manager
 *
 * 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.
 *
 * Copyright (C) 2009 Red Hat, Inc.
 */

#include <string.h>

#include "nm-marshal.h"
#include "nm-secrets-provider-interface.h"

#include <nm-setting-8021x.h>
#include <nm-setting-wireless-security.h>
#include "nm-logging.h"

static void
nm_secrets_provider_interface_init (gpointer g_iface)
{
	GType iface_type = G_TYPE_FROM_INTERFACE (g_iface);
	static gboolean initialized = FALSE;

	if (initialized)
		return;
	initialized = TRUE;

	/* Signals */
	g_signal_new ("manager-get-secrets",
	              iface_type,
	              G_SIGNAL_RUN_LAST,
	              G_STRUCT_OFFSET (NMSecretsProviderInterface, manager_get_secrets),
	              NULL, NULL,
	              _nm_marshal_BOOLEAN__POINTER_STRING_BOOLEAN_UINT_STRING_STRING,
	              G_TYPE_BOOLEAN, 6,
	              G_TYPE_POINTER, G_TYPE_STRING, G_TYPE_BOOLEAN, G_TYPE_UINT, G_TYPE_STRING, G_TYPE_STRING);

	g_signal_new ("manager-cancel-secrets",
	              iface_type,
	              G_SIGNAL_RUN_FIRST,
	              G_STRUCT_OFFSET (NMSecretsProviderInterface, manager_cancel_secrets),
	              NULL, NULL,
	              g_cclosure_marshal_VOID__VOID,
	              G_TYPE_NONE, 0);
}


GType
nm_secrets_provider_interface_get_type (void)
{
	static GType interface_type = 0;

	if (!interface_type) {
		const GTypeInfo interface_info = {
			sizeof (NMSecretsProviderInterface), /* class_size */
			nm_secrets_provider_interface_init,   /* base_init */
			NULL,		/* base_finalize */
			NULL,
			NULL,		/* class_finalize */
			NULL,		/* class_data */
			0,
			0,              /* n_preallocs */
			NULL
		};

		interface_type = g_type_register_static (G_TYPE_INTERFACE,
		                                         "NMSecretsProviderInterface",
		                                         &interface_info, 0);

		g_type_interface_add_prerequisite (interface_type, G_TYPE_OBJECT);
	}

	return interface_type;
}

gboolean
nm_secrets_provider_interface_get_secrets (NMSecretsProviderInterface *self,
                                           NMConnection *connection,
                                           const char *setting_name,
                                           gboolean request_new,
                                           RequestSecretsCaller caller,
                                           const char *hint1,
                                           const char *hint2)
{
	guint success = FALSE;

	g_return_val_if_fail (self != NULL, FALSE);
	g_return_val_if_fail (NM_IS_SECRETS_PROVIDER_INTERFACE (self), FALSE);
	g_return_val_if_fail (connection != NULL, FALSE);
	g_return_val_if_fail (NM_IS_CONNECTION (connection), FALSE);
	g_return_val_if_fail (setting_name != NULL, FALSE);

	nm_secrets_provider_interface_cancel_get_secrets (self);

	g_signal_emit_by_name (self, "manager-get-secrets",
	                       connection, setting_name, request_new, caller, hint1, hint2,
	                       &success);
	if (!success) {
		nm_log_warn (LOGD_CORE, "failed to get connection secrets.");
		return FALSE;
	}

	return TRUE;
}

void
nm_secrets_provider_interface_cancel_get_secrets (NMSecretsProviderInterface *self)
{
	g_return_if_fail (self != NULL);
	g_return_if_fail (NM_IS_SECRETS_PROVIDER_INTERFACE (self));

	g_signal_emit_by_name (self, "manager-cancel-secrets");
}


static void
add_one_key_to_list (gpointer key, gpointer data, gpointer user_data)
{
	GSList **list = (GSList **) user_data;

	*list = g_slist_append (*list, key);
}

static gint
settings_order_func (gconstpointer a, gconstpointer b)
{
	/* Just ensure the 802.1x setting gets processed _before_ the
	 * wireless-security one.
	 */

	if (   !strcmp (a, NM_SETTING_802_1X_SETTING_NAME)
	    && !strcmp (b, NM_SETTING_WIRELESS_SECURITY_SETTING_NAME))
		return -1;

	if (   !strcmp (a, NM_SETTING_WIRELESS_SECURITY_SETTING_NAME)
	    && !strcmp (b, NM_SETTING_802_1X_SETTING_NAME))
		return 1;

	return 0;
}

void
nm_secrets_provider_interface_get_secrets_result (NMSecretsProviderInterface *self,
                                                  const char *setting_name,
                                                  RequestSecretsCaller caller,
                                                  GHashTable *settings,
                                                  GError *error)
{
	GSList *keys = NULL, *iter;
	GSList *updated = NULL;
	GError *tmp_error = NULL;

	g_return_if_fail (self != NULL);
	g_return_if_fail (NM_IS_SECRETS_PROVIDER_INTERFACE (self));

	if (error) {
		NM_SECRETS_PROVIDER_INTERFACE_GET_INTERFACE (self)->result (self,
		                                                            setting_name,
		                                                            caller,
		                                                            NULL,
		                                                            error);
		return;
	}

	if (g_hash_table_size (settings) == 0) {
		g_set_error (&tmp_error, 0, 0, "%s", "no secrets were received!");
		NM_SECRETS_PROVIDER_INTERFACE_GET_INTERFACE (self)->result (self,
		                                                            setting_name,
		                                                            caller,
		                                                            NULL,
		                                                            tmp_error);
		g_clear_error (&tmp_error);
		return;
	}

	g_hash_table_foreach (settings, add_one_key_to_list, &keys);
	keys = g_slist_sort (keys, settings_order_func);
	for (iter = keys; iter; iter = g_slist_next (iter)) {
		GHashTable *hash;
		const char *name = (const char *) iter->data;

		hash = g_hash_table_lookup (settings, name);
		if (!hash) {
			nm_log_warn (LOGD_CORE, "couldn't get setting secrets for '%s'", name);
			continue;
		}

		if (NM_SECRETS_PROVIDER_INTERFACE_GET_INTERFACE (self)->update_setting (self, name, hash))
			updated = g_slist_append (updated, (gpointer) setting_name);
	}
	g_slist_free (keys);

	if (g_slist_length (updated)) {
		NM_SECRETS_PROVIDER_INTERFACE_GET_INTERFACE (self)->result (self,
		                                                            setting_name,
		                                                            caller,
		                                                            updated,
		                                                            NULL);
	} else {
		g_set_error (&tmp_error, 0, 0, "%s", "no secrets updated because no valid "
		             "settings were received!");
		NM_SECRETS_PROVIDER_INTERFACE_GET_INTERFACE (self)->result (self,
		                                                            setting_name,
		                                                            caller,
		                                                            NULL,
		                                                            tmp_error);
		g_clear_error (&tmp_error);
	}

	g_slist_free (updated);
}