nm-setting-vpn.c 26.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/*
 * Dan Williams <dcbw@redhat.com>
 * Tambet Ingo <tambet@gmail.com>
 *
 * This library 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 License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301 USA.
 *
21
 * (C) Copyright 2007 - 2013 Red Hat, Inc.
22 23
 * (C) Copyright 2007 - 2008 Novell, Inc.
 */
24 25

#include <string.h>
26 27
#include <errno.h>
#include <stdlib.h>
28
#include <dbus/dbus-glib.h>
29 30
#include <glib/gi18n.h>

31 32 33
#include "nm-setting-vpn.h"
#include "nm-param-spec-specialized.h"
#include "nm-utils.h"
34
#include "nm-dbus-glib-types.h"
35
#include "nm-setting-private.h"
36

Dan Williams's avatar
Dan Williams committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
/**
 * SECTION:nm-setting-vpn
 * @short_description: Describes connection properties for Virtual Private Networks
 * @include: nm-setting-vpn.h
 *
 * The #NMSettingVPN object is a #NMSetting subclass that describes properties
 * necessary for connection to Virtual Private Networks.  NetworkManager uses
 * a plugin architecture to allow easier use of new VPN types, and this
 * setting abstracts the configuration for those plugins.  Since the configuration
 * options are only known to the VPN plugins themselves, the VPN configuration
 * options are stored as key/value pairs of strings rather than GObject
 * properties.
 **/

/**
 * nm_setting_vpn_error_quark:
 *
 * Registers an error quark for #NMSettingVPN if necessary.
 *
 * Returns: the error quark used for #NMSettingVPN errors.
 **/
58 59 60 61 62 63 64 65 66 67 68
GQuark
nm_setting_vpn_error_quark (void)
{
	static GQuark quark;

	if (G_UNLIKELY (!quark))
		quark = g_quark_from_static_string ("nm-setting-vpn-error-quark");
	return quark;
}


69 70 71 72 73 74
G_DEFINE_TYPE_WITH_CODE (NMSettingVPN, nm_setting_vpn, NM_TYPE_SETTING,
                         _nm_register_setting (NM_SETTING_VPN_SETTING_NAME,
                                               g_define_type_id,
                                               1,
                                               NM_SETTING_VPN_ERROR))
NM_SETTING_REGISTER_TYPE (NM_TYPE_SETTING_VPN)
75

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
#define NM_SETTING_VPN_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_SETTING_VPN, NMSettingVPNPrivate))

typedef struct {
	char *service_type;

	/* username of the user requesting this connection, thus
	 * it's really only valid for user connections, and it also
	 * should never be saved out to persistent config.
	 */
	char *user_name;

	/* The hash table is created at setting object
	 * init time and should not be replaced.  It is
	 * a char * -> char * mapping, and both the key
	 * and value are owned by the hash table, and should
	 * be allocated with functions whose value can be
	 * freed with g_free().  Should not contain secrets.
	 */
	GHashTable *data;

	/* The hash table is created at setting object
	 * init time and should not be replaced.  It is
	 * a char * -> char * mapping, and both the key
	 * and value are owned by the hash table, and should
	 * be allocated with functions whose value can be
	 * freed with g_free().  Should contain secrets only.
	 */
	GHashTable *secrets;
} NMSettingVPNPrivate;

106 107 108 109
enum {
	PROP_0,
	PROP_SERVICE_TYPE,
	PROP_USER_NAME,
110
	PROP_DATA,
111
	PROP_SECRETS,
112 113 114 115

	LAST_PROP
};

Dan Williams's avatar
Dan Williams committed
116 117 118 119 120 121 122
/**
 * nm_setting_vpn_new:
 *
 * Creates a new #NMSettingVPN object with default values.
 *
 * Returns: (transfer full): the new empty #NMSettingVPN object
 **/
123 124 125 126 127 128
NMSetting *
nm_setting_vpn_new (void)
{
	return (NMSetting *) g_object_new (NM_TYPE_SETTING_VPN, NULL);
}

Dan Williams's avatar
Dan Williams committed
129 130
/**
 * nm_setting_vpn_get_service_type:
Dan Williams's avatar
Dan Williams committed
131
 * @setting: the #NMSettingVPN
Dan Williams's avatar
Dan Williams committed
132 133 134 135 136 137
 *
 * Returns the service name of the VPN, which identifies the specific VPN
 * plugin that should be used to connect to this VPN.
 *
 * Returns: the VPN plugin's service name
 **/
138 139 140 141 142 143 144 145
const char *
nm_setting_vpn_get_service_type (NMSettingVPN *setting)
{
	g_return_val_if_fail (NM_IS_SETTING_VPN (setting), NULL);

	return NM_SETTING_VPN_GET_PRIVATE (setting)->service_type;
}

Dan Williams's avatar
Dan Williams committed
146 147 148 149 150 151
/**
 * nm_setting_vpn_get_user_name:
 * @setting: the #NMSettingVPN
 *
 * Returns: the #NMSettingVPN:user-name property of the setting
 **/
152 153 154 155 156 157 158 159
const char *
nm_setting_vpn_get_user_name (NMSettingVPN *setting)
{
	g_return_val_if_fail (NM_IS_SETTING_VPN (setting), NULL);

	return NM_SETTING_VPN_GET_PRIVATE (setting)->user_name;
}

160 161 162 163 164
/**
 * nm_setting_vpn_get_num_data_items:
 * @setting: the #NMSettingVPN
 *
 * Gets number of key/value pairs of VPN configuration data.
165 166
 *
 * Returns: the number of VPN plugin specific configuration data items
167 168 169 170 171 172 173 174 175
 **/
guint32
nm_setting_vpn_get_num_data_items (NMSettingVPN *setting)
{
	g_return_val_if_fail (NM_IS_SETTING_VPN (setting), 0);

	return g_hash_table_size (NM_SETTING_VPN_GET_PRIVATE (setting)->data);
}

Dan Williams's avatar
Dan Williams committed
176 177 178 179 180 181 182 183 184 185
/**
 * nm_setting_vpn_add_data_item:
 * @setting: the #NMSettingVPN
 * @key: a name that uniquely identifies the given value @item
 * @item: the value to be referenced by @key
 *
 * Establishes a relationship between @key and @item internally in the
 * setting which may be retrieved later.  Should not be used to store passwords
 * or other secrets, which is what nm_setting_vpn_add_secret() is for.
 **/
186 187 188 189 190 191
void
nm_setting_vpn_add_data_item (NMSettingVPN *setting,
                              const char *key,
                              const char *item)
{
	g_return_if_fail (NM_IS_SETTING_VPN (setting));
192 193 194 195
	g_return_if_fail (key != NULL);
	g_return_if_fail (strlen (key) > 0);
	g_return_if_fail (item != NULL);
	g_return_if_fail (strlen (item) > 0);
196 197 198 199 200

	g_hash_table_insert (NM_SETTING_VPN_GET_PRIVATE (setting)->data,
	                     g_strdup (key), g_strdup (item));
}

Dan Williams's avatar
Dan Williams committed
201 202 203 204 205 206 207 208 209 210
/**
 * nm_setting_vpn_get_data_item:
 * @setting: the #NMSettingVPN
 * @key: the name of the data item to retrieve
 *
 * Retrieves the data item of a key/value relationship previously established
 * by nm_setting_vpn_add_data_item().
 *
 * Returns: the data item, if any
 **/
211 212 213 214 215 216 217 218
const char *
nm_setting_vpn_get_data_item (NMSettingVPN *setting, const char *key)
{
	g_return_val_if_fail (NM_IS_SETTING_VPN (setting), NULL);

	return (const char *) g_hash_table_lookup (NM_SETTING_VPN_GET_PRIVATE (setting)->data, key);
}

Dan Williams's avatar
Dan Williams committed
219 220 221 222 223 224 225
/**
 * nm_setting_vpn_remove_data_item:
 * @setting: the #NMSettingVPN
 * @key: the name of the data item to remove
 *
 * Deletes a key/value relationship previously established by
 * nm_setting_vpn_add_data_item().
226 227 228
 *
 * Returns: %TRUE if the data item was found and removed from the internal list,
 * %FALSE if it was not.
Dan Williams's avatar
Dan Williams committed
229
 **/
230
gboolean
231 232
nm_setting_vpn_remove_data_item (NMSettingVPN *setting, const char *key)
{
233
	g_return_val_if_fail (NM_IS_SETTING_VPN (setting), FALSE);
234

235
	return g_hash_table_remove (NM_SETTING_VPN_GET_PRIVATE (setting)->data, key);
236 237
}

238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
static void
foreach_item_helper (GHashTable *hash,
                     NMVPNIterFunc func,
                     gpointer user_data)
{
	GList *keys, *liter;
	GSList *copied = NULL, *siter;

	g_return_if_fail (hash != NULL);

	/* Grab keys and copy them so that the callback func can modify
	 * the hash table items if it wants to.
	 */
	keys = g_hash_table_get_keys (hash);
	for (liter = keys; liter; liter = g_list_next (liter))
		copied = g_slist_prepend (copied, g_strdup (liter->data));
	copied = g_slist_reverse (copied);
	g_list_free (keys);

	for (siter = copied; siter; siter = g_slist_next (siter)) {
		gpointer value;

		value = g_hash_table_lookup (hash, siter->data);
		func (siter->data, value, user_data);
	}

	g_slist_foreach (copied, (GFunc) g_free, NULL);
	g_slist_free (copied);
}

268 269 270 271
/**
 * nm_setting_vpn_foreach_data_item:
 * @setting: a #NMSettingVPN
 * @func: (scope call): an user provided function
272
 * @user_data: data to be passed to @func
273
 *
274 275 276
 * Iterates all data items stored in this setting.  It is safe to add, remove,
 * and modify data items inside @func, though any additions or removals made
 * during iteration will not be part of the iteration.
277
 */
278 279
void
nm_setting_vpn_foreach_data_item (NMSettingVPN *setting,
280
                                  NMVPNIterFunc func,
281 282 283 284
                                  gpointer user_data)
{
	g_return_if_fail (NM_IS_SETTING_VPN (setting));

285
	foreach_item_helper (NM_SETTING_VPN_GET_PRIVATE (setting)->data, func, user_data);
286 287
}

288 289 290 291 292
/**
 * nm_setting_vpn_get_num_secrets:
 * @setting: the #NMSettingVPN
 *
 * Gets number of VPN plugin specific secrets in the setting.
293 294
 *
 * Returns: the number of VPN plugin specific secrets
295 296 297 298 299 300 301 302 303
 **/
guint32
nm_setting_vpn_get_num_secrets (NMSettingVPN *setting)
{
	g_return_val_if_fail (NM_IS_SETTING_VPN (setting), 0);

	return g_hash_table_size (NM_SETTING_VPN_GET_PRIVATE (setting)->secrets);
}

Dan Williams's avatar
Dan Williams committed
304 305 306 307 308 309 310 311 312
/**
 * nm_setting_vpn_add_secret:
 * @setting: the #NMSettingVPN
 * @key: a name that uniquely identifies the given secret @secret
 * @secret: the secret to be referenced by @key
 *
 * Establishes a relationship between @key and @secret internally in the
 * setting which may be retrieved later.
 **/
313 314 315 316 317 318
void
nm_setting_vpn_add_secret (NMSettingVPN *setting,
                           const char *key,
                           const char *secret)
{
	g_return_if_fail (NM_IS_SETTING_VPN (setting));
319 320 321 322
	g_return_if_fail (key != NULL);
	g_return_if_fail (strlen (key) > 0);
	g_return_if_fail (secret != NULL);
	g_return_if_fail (strlen (secret) > 0);
323 324 325 326 327

	g_hash_table_insert (NM_SETTING_VPN_GET_PRIVATE (setting)->secrets,
	                     g_strdup (key), g_strdup (secret));
}

Dan Williams's avatar
Dan Williams committed
328 329 330 331 332 333 334 335 336 337
/**
 * nm_setting_vpn_get_secret:
 * @setting: the #NMSettingVPN
 * @key: the name of the secret to retrieve
 *
 * Retrieves the secret of a key/value relationship previously established
 * by nm_setting_vpn_add_secret().
 *
 * Returns: the secret, if any
 **/
338 339 340 341 342 343 344 345
const char *
nm_setting_vpn_get_secret (NMSettingVPN *setting, const char *key)
{
	g_return_val_if_fail (NM_IS_SETTING_VPN (setting), NULL);

	return (const char *) g_hash_table_lookup (NM_SETTING_VPN_GET_PRIVATE (setting)->secrets, key);
}

Dan Williams's avatar
Dan Williams committed
346 347 348 349 350 351 352
/**
 * nm_setting_vpn_remove_secret:
 * @setting: the #NMSettingVPN
 * @key: the name of the secret to remove
 *
 * Deletes a key/value relationship previously established by
 * nm_setting_vpn_add_secret().
353 354 355
 *
 * Returns: %TRUE if the secret was found and removed from the internal list,
 * %FALSE if it was not.
Dan Williams's avatar
Dan Williams committed
356
 **/
357
gboolean
358 359
nm_setting_vpn_remove_secret (NMSettingVPN *setting, const char *key)
{
360
	g_return_val_if_fail (NM_IS_SETTING_VPN (setting), FALSE);
361

362
	return g_hash_table_remove (NM_SETTING_VPN_GET_PRIVATE (setting)->secrets, key);
363 364
}

365 366 367 368
/**
 * nm_setting_vpn_foreach_secret:
 * @setting: a #NMSettingVPN
 * @func: (scope call): an user provided function
369
 * @user_data: data to be passed to @func
370
 *
371 372 373
 * Iterates all secrets stored in this setting.  It is safe to add, remove,
 * and modify secrets inside @func, though any additions or removals made during
 * iteration will not be part of the iteration.
374
 */
375 376
void
nm_setting_vpn_foreach_secret (NMSettingVPN *setting,
377
                               NMVPNIterFunc func,
378 379 380 381
                               gpointer user_data)
{
	g_return_if_fail (NM_IS_SETTING_VPN (setting));

382
	foreach_item_helper (NM_SETTING_VPN_GET_PRIVATE (setting)->secrets, func, user_data);
383 384
}

385
static gboolean
386
verify (NMSetting *setting, GSList *all_settings, GError **error)
387
{
388
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
389

390
	if (!priv->service_type) {
391 392 393 394 395
		g_set_error_literal (error,
		                     NM_SETTING_VPN_ERROR,
		                     NM_SETTING_VPN_ERROR_MISSING_PROPERTY,
		                     _("property is missing"));
		g_prefix_error (error, "%s: ", NM_SETTING_VPN_SERVICE_TYPE);
396 397 398
		return FALSE;
	}

399
	if (!strlen (priv->service_type)) {
400 401 402 403 404
		g_set_error_literal (error,
		                     NM_SETTING_VPN_ERROR,
		                     NM_SETTING_VPN_ERROR_INVALID_PROPERTY,
		                     _("property is empty"));
		g_prefix_error (error, "%s: ", NM_SETTING_VPN_SERVICE_TYPE);
405
		return FALSE;
406
	}
407 408

	/* default username can be NULL, but can't be zero-length */
409
	if (priv->user_name && !strlen (priv->user_name)) {
410 411 412 413 414
		g_set_error_literal (error,
		                     NM_SETTING_VPN_ERROR,
		                     NM_SETTING_VPN_ERROR_INVALID_PROPERTY,
		                     _("property is empty"));
		g_prefix_error (error, "%s: ", NM_SETTING_VPN_USER_NAME);
415
		return FALSE;
416
	}
417 418 419 420

	return TRUE;
}

421
static gboolean
422 423 424 425
update_secret_string (NMSetting *setting,
                      const char *key,
                      const char *value,
                      GError **error)
426
{
427
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
428

429 430 431
	g_return_val_if_fail (key != NULL, FALSE);
	g_return_val_if_fail (value != NULL, FALSE);

432
	if (!value || !strlen (value)) {
433 434
		g_set_error (error, NM_SETTING_ERROR,
		             NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH,
435
		             "Secret %s was empty", key);
436 437
		return FALSE;
	}
438

439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
	g_hash_table_insert (priv->secrets, g_strdup (key), g_strdup (value));
	return TRUE;
}

static gboolean
update_secret_hash (NMSetting *setting,
                    GHashTable *secrets,
                    GError **error)
{
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
	GHashTableIter iter;
	const char *name, *value;

	g_return_val_if_fail (secrets != NULL, FALSE);

	/* Make sure the items are valid */
	g_hash_table_iter_init (&iter, secrets);
	while (g_hash_table_iter_next (&iter, (gpointer *) &name, (gpointer *) &value)) {
		if (!name || !strlen (name)) {
			g_set_error_literal (error, NM_SETTING_ERROR,
			                     NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH,
			                     "Secret name was empty");
			return FALSE;
		}

		if (!value || !strlen (value)) {
			g_set_error (error, NM_SETTING_ERROR,
			             NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH,
				         "Secret %s value was empty", name);
			return FALSE;
		}
470 471
	}

472 473
	/* Now add the items to the settings' secrets list */
	g_hash_table_iter_init (&iter, secrets);
474 475 476 477 478 479 480 481 482 483
	while (g_hash_table_iter_next (&iter, (gpointer *) &name, (gpointer *) &value)) {
		if (value == NULL) {
			g_warn_if_fail (value != NULL);
			continue;
		}
		if (strlen (value) == 0) {
			g_warn_if_fail (strlen (value) > 0);
			continue;
		}

484
		g_hash_table_insert (priv->secrets, g_strdup (name), g_strdup (value));
485
	}
486

487
	return TRUE;
488 489
}

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
static gboolean
update_one_secret (NMSetting *setting, const char *key, GValue *value, GError **error)
{
	gboolean success = FALSE;

	g_return_val_if_fail (key != NULL, FALSE);
	g_return_val_if_fail (value != NULL, FALSE);

	if (G_VALUE_HOLDS_STRING (value)) {
		/* Passing the string properties individually isn't correct, and won't
		 * produce the correct result, but for some reason that's how it used
		 * to be done.  So even though it's not correct, keep the code around
		 * for compatibility's sake.
		 */
		success = update_secret_string (setting, key, g_value_get_string (value), error);
	} else if (G_VALUE_HOLDS (value, DBUS_TYPE_G_MAP_OF_STRING)) {
		if (strcmp (key, NM_SETTING_VPN_SECRETS) != 0) {
			g_set_error (error, NM_SETTING_ERROR, NM_SETTING_ERROR_PROPERTY_NOT_SECRET,
			             "Property %s not a secret property", key);
		} else
			success = update_secret_hash (setting, g_value_get_boxed (value), error);
	} else
		g_set_error_literal (error, NM_SETTING_ERROR, NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH, key);

	return success;
}

517 518 519
static gboolean
get_secret_flags (NMSetting *setting,
                  const char *secret_name,
520
                  gboolean verify_secret,
521 522 523 524 525 526 527 528 529 530 531 532 533 534
                  NMSettingSecretFlags *out_flags,
                  GError **error)
{
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
	gboolean success = FALSE;
	char *flags_key;
	gpointer val;
	unsigned long tmp;

	flags_key = g_strdup_printf ("%s-flags", secret_name);
	if (g_hash_table_lookup_extended (priv->data, flags_key, NULL, &val)) {
		errno = 0;
		tmp = strtoul ((const char *) val, NULL, 10);
		if ((errno == 0) && (tmp <= NM_SETTING_SECRET_FLAGS_ALL)) {
535 536
			if (out_flags)
				*out_flags = (guint32) tmp;
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
			success = TRUE;
		} else {
			g_set_error (error,
			             NM_SETTING_ERROR,
			             NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH,
			             "Failed to convert '%s' value '%s' to uint",
			             flags_key, (const char *) val);
		}
	} else {
		g_set_error (error,
		             NM_SETTING_ERROR,
		             NM_SETTING_ERROR_PROPERTY_NOT_FOUND,
		             "Secret flags property '%s' not found", flags_key);
	}
	g_free (flags_key);
	return success;
}

static gboolean
set_secret_flags (NMSetting *setting,
                  const char *secret_name,
558
                  gboolean verify_secret,
559 560 561 562 563 564 565 566 567
                  NMSettingSecretFlags flags,
                  GError **error)
{
	g_hash_table_insert (NM_SETTING_VPN_GET_PRIVATE (setting)->data,
	                     g_strdup_printf ("%s-flags", secret_name),
	                     g_strdup_printf ("%u", flags));
	return TRUE;
}

568 569 570 571 572 573 574
static GPtrArray *
need_secrets (NMSetting *setting)
{
	/* Assume that VPN connections need secrets since they almost always will */
	return g_ptr_array_sized_new (1);
}

575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
static gboolean
compare_one_secret (NMSettingVPN *a,
                    NMSettingVPN *b,
                    NMSettingCompareFlags flags)
{
	GHashTable *a_secrets, *b_secrets;
	GHashTableIter iter;
	const char *key, *val;

	a_secrets = NM_SETTING_VPN_GET_PRIVATE (a)->secrets;
	b_secrets = NM_SETTING_VPN_GET_PRIVATE (b)->secrets;

	g_hash_table_iter_init (&iter, a_secrets);
	while (g_hash_table_iter_next (&iter, (gpointer) &key, (gpointer) &val)) {
		NMSettingSecretFlags a_secret_flags = NM_SETTING_SECRET_FLAG_NONE;
		NMSettingSecretFlags b_secret_flags = NM_SETTING_SECRET_FLAG_NONE;

		nm_setting_get_secret_flags (NM_SETTING (a), key, &a_secret_flags, NULL);
		nm_setting_get_secret_flags (NM_SETTING (b), key, &b_secret_flags, NULL);

		/* If the secret flags aren't the same, the settings aren't the same */
		if (a_secret_flags != b_secret_flags)
			return FALSE;

		if (   (flags & NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS)
		    && (a_secret_flags & NM_SETTING_SECRET_FLAG_AGENT_OWNED))
			continue;

		if (   (flags & NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS)
		    && (a_secret_flags & NM_SETTING_SECRET_FLAG_NOT_SAVED))
			continue;

		/* Now compare the values themselves */
		if (g_strcmp0 (val, nm_setting_vpn_get_secret (b, key)) != 0)
			return FALSE;
	}

	return TRUE;
}

static gboolean
compare_property (NMSetting *setting,
                  NMSetting *other,
                  const GParamSpec *prop_spec,
                  NMSettingCompareFlags flags)
{
	gboolean same;

	/* We only need to treat the 'secrets' property specially */
	if (g_strcmp0 (prop_spec->name, NM_SETTING_VPN_SECRETS) != 0)
		return NM_SETTING_CLASS (nm_setting_vpn_parent_class)->compare_property (setting, other, prop_spec, flags);

	/* Compare A to B to ensure everything in A is found in B */
	same = compare_one_secret (NM_SETTING_VPN (setting), NM_SETTING_VPN (other), flags);
	if (same) {
		/* And then B to A to ensure everything in B is also found in A */
		same = compare_one_secret (NM_SETTING_VPN (other), NM_SETTING_VPN (setting), flags);
	}

	return same;
}

637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
static void
clear_secrets_with_flags (NMSetting *setting,
	                      GParamSpec *pspec,
	                      NMSettingClearSecretsWithFlagsFn func,
	                      gpointer user_data)
{
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
	GHashTableIter iter;
	const char *secret;

	if (priv->secrets == NULL)
		return;

	/* Iterate through secrets hash and check each entry */
	g_hash_table_iter_init (&iter, priv->secrets);
	while (g_hash_table_iter_next (&iter, (gpointer) &secret, NULL)) {
		NMSettingSecretFlags flags = NM_SETTING_SECRET_FLAG_NONE;

		nm_setting_get_secret_flags (setting, secret, &flags, NULL);
		if (func (setting, pspec->name, flags, user_data) == TRUE)
			g_hash_table_iter_remove (&iter);
	}
}

661 662 663 664 665 666 667 668
static void
destroy_one_secret (gpointer data)
{
	char *secret = (char *) data;

	/* Don't leave the secret lying around in memory */
	memset (secret, 0, strlen (secret));
	g_free (secret);
669 670
}

671 672 673
static void
nm_setting_vpn_init (NMSettingVPN *setting)
{
674
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
675

676 677 678
	g_object_set (setting, NM_SETTING_NAME, NM_SETTING_VPN_SETTING_NAME, NULL);
	priv->data = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
	priv->secrets = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, destroy_one_secret);
679 680 681 682 683
}

static void
finalize (GObject *object)
{
684
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (object);
685

686 687 688 689
	g_free (priv->service_type);
	g_free (priv->user_name);
	g_hash_table_destroy (priv->data);
	g_hash_table_destroy (priv->secrets);
690 691 692 693

	G_OBJECT_CLASS (nm_setting_vpn_parent_class)->finalize (object);
}

694 695 696
static void
copy_hash (gpointer key, gpointer value, gpointer user_data)
{
697 698
	g_return_if_fail (value != NULL);
	g_return_if_fail (strlen (value));
699 700 701
	g_hash_table_insert ((GHashTable *) user_data, g_strdup (key), g_strdup (value));
}

702 703 704 705
static void
set_property (GObject *object, guint prop_id,
		    const GValue *value, GParamSpec *pspec)
{
706
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (object);
707
	GHashTable *new_hash;
708 709 710

	switch (prop_id) {
	case PROP_SERVICE_TYPE:
711 712
		g_free (priv->service_type);
		priv->service_type = g_value_dup_string (value);
713 714
		break;
	case PROP_USER_NAME:
715 716
		g_free (priv->user_name);
		priv->user_name = g_value_dup_string (value);
717
		break;
718 719
	case PROP_DATA:
		/* Must make a deep copy of the hash table here... */
720
		g_hash_table_remove_all (priv->data);
721 722
		new_hash = g_value_get_boxed (value);
		if (new_hash)
723
			g_hash_table_foreach (new_hash, copy_hash, priv->data);
724 725 726
		break;
	case PROP_SECRETS:
		/* Must make a deep copy of the hash table here... */
727
		g_hash_table_remove_all (priv->secrets);
728 729
		new_hash = g_value_get_boxed (value);
		if (new_hash)
730
			g_hash_table_foreach (new_hash, copy_hash, priv->secrets);
731
		break;
732 733 734 735 736 737 738 739 740 741 742
	default:
		G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
		break;
	}
}

static void
get_property (GObject *object, guint prop_id,
		    GValue *value, GParamSpec *pspec)
{
	NMSettingVPN *setting = NM_SETTING_VPN (object);
743
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
744 745 746

	switch (prop_id) {
	case PROP_SERVICE_TYPE:
747
		g_value_set_string (value, nm_setting_vpn_get_service_type (setting));
748 749
		break;
	case PROP_USER_NAME:
750
		g_value_set_string (value, nm_setting_vpn_get_user_name (setting));
751
		break;
752
	case PROP_DATA:
753
		g_value_set_boxed (value, priv->data);
754
		break;
755
	case PROP_SECRETS:
756
		g_value_set_boxed (value, priv->secrets);
757
		break;
758 759 760 761 762 763 764 765 766 767 768 769
	default:
		G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
		break;
	}
}

static void
nm_setting_vpn_class_init (NMSettingVPNClass *setting_class)
{
	GObjectClass *object_class = G_OBJECT_CLASS (setting_class);
	NMSettingClass *parent_class = NM_SETTING_CLASS (setting_class);

770 771
	g_type_class_add_private (setting_class, sizeof (NMSettingVPNPrivate));

772 773 774 775
	/* virtual methods */
	object_class->set_property = set_property;
	object_class->get_property = get_property;
	object_class->finalize     = finalize;
776 777

	parent_class->verify            = verify;
778
	parent_class->update_one_secret = update_one_secret;
779 780
	parent_class->get_secret_flags  = get_secret_flags;
	parent_class->set_secret_flags  = set_secret_flags;
781
	parent_class->need_secrets      = need_secrets;
782
	parent_class->compare_property  = compare_property;
783
	parent_class->clear_secrets_with_flags = clear_secrets_with_flags;
784 785

	/* Properties */
786 787 788 789 790
	/**
	 * NMSettingVPN:service-type:
	 *
	 * D-Bus service name of the VPN plugin that this setting uses to connect
	 * to its network.  i.e. org.freedesktop.NetworkManager.vpnc for the vpnc
791
	 * plugin.
792
	 **/
793 794 795 796
	g_object_class_install_property
		(object_class, PROP_SERVICE_TYPE,
		 g_param_spec_string (NM_SETTING_VPN_SERVICE_TYPE,
						  "Service type",
797 798 799 800
						  "D-Bus service name of the VPN plugin that this "
						  "setting uses to connect to its network.  i.e. "
						  "org.freedesktop.NetworkManager.vpnc for the vpnc "
						  "plugin.",
801 802 803
						  NULL,
						  G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE));

804
	/**
805
	 * NMSettingVPN:user-name:
806
	 *
807 808 809 810 811 812
	 * If the VPN connection requires a user name for authentication, that name
	 * should be provided here.  If the connection is available to more than
	 * one user, and the VPN requires each user to supply a different name, then
	 * leave this property empty.  If this property is empty, NetworkManager
	 * will automatically supply the username of the user which requested the
	 * VPN connection.
813
	 **/
814 815 816
	g_object_class_install_property
		(object_class, PROP_USER_NAME,
		 g_param_spec_string (NM_SETTING_VPN_USER_NAME,
817 818 819 820 821 822 823 824 825 826 827
		                      "User name",
		                      "If the VPN connection requires a user name for "
		                      "authentication, that name should be provided here.  "
		                      "If the connection is available to more than one "
		                      "user, and the VPN requires each user to supply a "
		                      "different name, then leave this property empty.  If "
		                      "this property is empty, NetworkManager will "
		                      "automatically supply the username of the user which "
		                      "requested the VPN connection.",
		                      NULL,
		                      G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE));
828

829 830 831 832 833 834
	/**
	 * NMSettingVPN:data:
	 *
	 * Dictionary of key/value pairs of VPN plugin specific data.  Both keys
	 * and values must be strings.
	 **/
835 836
	g_object_class_install_property
		(object_class, PROP_DATA,
837
		 _nm_param_spec_specialized (NM_SETTING_VPN_DATA,
838
							   "Data",
839 840 841
							   "Dictionary of key/value pairs of VPN plugin "
							   "specific data.  Both keys and values must be "
							   "strings.",
842 843
							   DBUS_TYPE_G_MAP_OF_STRING,
							   G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE));
844

845 846 847 848 849 850
	/**
	 * NMSettingVPN:secrets:
	 *
	 * Dictionary of key/value pairs of VPN plugin specific secrets like
	 * passwords or private keys.  Both keys and values must be strings.
	 **/
851 852 853 854
	g_object_class_install_property
		(object_class, PROP_SECRETS,
		 _nm_param_spec_specialized (NM_SETTING_VPN_SECRETS,
							   "Secrets",
855 856 857
							   "Dictionary of key/value pairs of VPN plugin "
							   "specific secrets like passwords or private keys."
							   "  Both keys and values must be strings.",
858 859
							   DBUS_TYPE_G_MAP_OF_STRING,
							   G_PARAM_READWRITE | NM_SETTING_PARAM_SERIALIZE | NM_SETTING_PARAM_SECRET));
860
}
861