nm-setting-vpn.c 28.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/*
 * 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.
 *
18 19
 * Copyright 2007 - 2013 Red Hat, Inc.
 * Copyright 2007 - 2008 Novell, Inc.
20
 */
21 22

#include <string.h>
23 24
#include <errno.h>
#include <stdlib.h>
25
#include <dbus/dbus-glib.h>
26 27
#include <glib/gi18n.h>

28 29 30
#include "nm-setting-vpn.h"
#include "nm-param-spec-specialized.h"
#include "nm-utils.h"
31
#include "nm-dbus-glib-types.h"
32
#include "nm-setting-private.h"
33

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
/**
 * 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.
 **/
55 56 57 58 59 60 61 62 63 64 65
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;
}


66 67 68 69 70 71
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)
72

73 74 75 76 77 78 79 80 81 82 83
#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;

84 85 86 87 88
	/* Whether the VPN stays up across link changes, until the user
	 * explicitly disconnects it.
	 */
	gboolean persistent;

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
	/* 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;

108 109 110 111
enum {
	PROP_0,
	PROP_SERVICE_TYPE,
	PROP_USER_NAME,
112
	PROP_PERSISTENT,
113
	PROP_DATA,
114
	PROP_SECRETS,
115 116 117 118

	LAST_PROP
};

119 120 121 122 123 124 125
/**
 * nm_setting_vpn_new:
 *
 * Creates a new #NMSettingVPN object with default values.
 *
 * Returns: (transfer full): the new empty #NMSettingVPN object
 **/
126 127 128 129 130 131
NMSetting *
nm_setting_vpn_new (void)
{
	return (NMSetting *) g_object_new (NM_TYPE_SETTING_VPN, NULL);
}

132 133
/**
 * nm_setting_vpn_get_service_type:
Dan Williams's avatar
Dan Williams committed
134
 * @setting: the #NMSettingVPN
135 136 137 138 139 140
 *
 * 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
 **/
141 142 143 144 145 146 147 148
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;
}

149 150 151 152 153 154
/**
 * nm_setting_vpn_get_user_name:
 * @setting: the #NMSettingVPN
 *
 * Returns: the #NMSettingVPN:user-name property of the setting
 **/
155 156 157 158 159 160 161 162
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;
}

163 164 165 166 167 168 169 170 171 172 173 174 175 176
/**
 * nm_setting_vpn_get_persistent:
 * @setting: the #NMSettingVPN
 *
 * Returns: the #NMSettingVPN:persistent property of the setting
 **/
gboolean
nm_setting_vpn_get_persistent (NMSettingVPN *setting)
{
	g_return_val_if_fail (NM_IS_SETTING_VPN (setting), FALSE);

	return NM_SETTING_VPN_GET_PRIVATE (setting)->persistent;
}

177 178 179 180 181
/**
 * nm_setting_vpn_get_num_data_items:
 * @setting: the #NMSettingVPN
 *
 * Gets number of key/value pairs of VPN configuration data.
182 183
 *
 * Returns: the number of VPN plugin specific configuration data items
184 185 186 187 188 189 190 191 192
 **/
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);
}

193 194 195 196 197 198 199 200 201 202
/**
 * 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.
 **/
203 204 205 206 207 208
void
nm_setting_vpn_add_data_item (NMSettingVPN *setting,
                              const char *key,
                              const char *item)
{
	g_return_if_fail (NM_IS_SETTING_VPN (setting));
209 210 211 212
	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);
213 214 215

	g_hash_table_insert (NM_SETTING_VPN_GET_PRIVATE (setting)->data,
	                     g_strdup (key), g_strdup (item));
216
	g_object_notify (G_OBJECT (setting), NM_SETTING_VPN_DATA);
217 218
}

219 220 221 222 223 224 225 226 227 228
/**
 * 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
 **/
229 230 231 232 233 234 235 236
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);
}

237 238 239 240 241 242 243
/**
 * 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().
244 245 246
 *
 * Returns: %TRUE if the data item was found and removed from the internal list,
 * %FALSE if it was not.
247
 **/
248
gboolean
249 250
nm_setting_vpn_remove_data_item (NMSettingVPN *setting, const char *key)
{
251 252
	gboolean found;

253
	g_return_val_if_fail (NM_IS_SETTING_VPN (setting), FALSE);
254

255 256 257 258
	found = g_hash_table_remove (NM_SETTING_VPN_GET_PRIVATE (setting)->data, key);
	if (found)
		g_object_notify (G_OBJECT (setting), NM_SETTING_VPN_DATA);
	return found;
259 260
}

261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
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);
	}

287
	g_slist_free_full (copied, g_free);
288 289
}

290 291 292 293
/**
 * nm_setting_vpn_foreach_data_item:
 * @setting: a #NMSettingVPN
 * @func: (scope call): an user provided function
294
 * @user_data: data to be passed to @func
295
 *
296 297 298
 * 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.
299
 */
300 301
void
nm_setting_vpn_foreach_data_item (NMSettingVPN *setting,
302
                                  NMVPNIterFunc func,
303 304 305 306
                                  gpointer user_data)
{
	g_return_if_fail (NM_IS_SETTING_VPN (setting));

307
	foreach_item_helper (NM_SETTING_VPN_GET_PRIVATE (setting)->data, func, user_data);
308 309
}

310 311 312 313 314
/**
 * nm_setting_vpn_get_num_secrets:
 * @setting: the #NMSettingVPN
 *
 * Gets number of VPN plugin specific secrets in the setting.
315 316
 *
 * Returns: the number of VPN plugin specific secrets
317 318 319 320 321 322 323 324 325
 **/
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);
}

326 327 328 329 330 331 332 333 334
/**
 * 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.
 **/
335 336 337 338 339 340
void
nm_setting_vpn_add_secret (NMSettingVPN *setting,
                           const char *key,
                           const char *secret)
{
	g_return_if_fail (NM_IS_SETTING_VPN (setting));
341 342 343 344
	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);
345 346 347

	g_hash_table_insert (NM_SETTING_VPN_GET_PRIVATE (setting)->secrets,
	                     g_strdup (key), g_strdup (secret));
348
	g_object_notify (G_OBJECT (setting), NM_SETTING_VPN_SECRETS);
349 350
}

351 352 353 354 355 356 357 358 359 360
/**
 * 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
 **/
361 362 363 364 365 366 367 368
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);
}

369 370 371 372 373 374 375
/**
 * 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().
376 377 378
 *
 * Returns: %TRUE if the secret was found and removed from the internal list,
 * %FALSE if it was not.
379
 **/
380
gboolean
381 382
nm_setting_vpn_remove_secret (NMSettingVPN *setting, const char *key)
{
383 384
	gboolean found;

385
	g_return_val_if_fail (NM_IS_SETTING_VPN (setting), FALSE);
386

387 388 389 390
	found = g_hash_table_remove (NM_SETTING_VPN_GET_PRIVATE (setting)->secrets, key);
	if (found)
		g_object_notify (G_OBJECT (setting), NM_SETTING_VPN_SECRETS);
	return found;
391 392
}

393 394 395 396
/**
 * nm_setting_vpn_foreach_secret:
 * @setting: a #NMSettingVPN
 * @func: (scope call): an user provided function
397
 * @user_data: data to be passed to @func
398
 *
399 400 401
 * 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.
402
 */
403 404
void
nm_setting_vpn_foreach_secret (NMSettingVPN *setting,
405
                               NMVPNIterFunc func,
406 407 408 409
                               gpointer user_data)
{
	g_return_if_fail (NM_IS_SETTING_VPN (setting));

410
	foreach_item_helper (NM_SETTING_VPN_GET_PRIVATE (setting)->secrets, func, user_data);
411 412
}

413
static gboolean
414
verify (NMSetting *setting, GSList *all_settings, GError **error)
415
{
416
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
417

418
	if (!priv->service_type) {
419 420 421 422
		g_set_error_literal (error,
		                     NM_SETTING_VPN_ERROR,
		                     NM_SETTING_VPN_ERROR_MISSING_PROPERTY,
		                     _("property is missing"));
423
		g_prefix_error (error, "%s.%s: ", NM_SETTING_VPN_SETTING_NAME, NM_SETTING_VPN_SERVICE_TYPE);
424 425 426
		return FALSE;
	}

427
	if (!strlen (priv->service_type)) {
428 429 430 431
		g_set_error_literal (error,
		                     NM_SETTING_VPN_ERROR,
		                     NM_SETTING_VPN_ERROR_INVALID_PROPERTY,
		                     _("property is empty"));
432
		g_prefix_error (error, "%s.%s: ", NM_SETTING_VPN_SETTING_NAME, NM_SETTING_VPN_SERVICE_TYPE);
433
		return FALSE;
434
	}
435 436

	/* default username can be NULL, but can't be zero-length */
437
	if (priv->user_name && !strlen (priv->user_name)) {
438 439 440 441
		g_set_error_literal (error,
		                     NM_SETTING_VPN_ERROR,
		                     NM_SETTING_VPN_ERROR_INVALID_PROPERTY,
		                     _("property is empty"));
442
		g_prefix_error (error, "%s.%s: ", NM_SETTING_VPN_SETTING_NAME, NM_SETTING_VPN_USER_NAME);
443
		return FALSE;
444
	}
445 446 447 448

	return TRUE;
}

449
static NMSettingUpdateSecretResult
450 451 452 453
update_secret_string (NMSetting *setting,
                      const char *key,
                      const char *value,
                      GError **error)
454
{
455
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
456

457 458
	g_return_val_if_fail (key != NULL, NM_SETTING_UPDATE_SECRET_ERROR);
	g_return_val_if_fail (value != NULL, NM_SETTING_UPDATE_SECRET_ERROR);
459

460
	if (!value || !strlen (value)) {
461 462
		g_set_error (error, NM_SETTING_ERROR,
		             NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH,
463
		             "Secret %s was empty", key);
464
		return NM_SETTING_UPDATE_SECRET_ERROR;
465
	}
466

467 468 469
	if (g_strcmp0 (g_hash_table_lookup (priv->secrets, key), value) == 0)
		return NM_SETTING_UPDATE_SECRET_SUCCESS_UNCHANGED;

470
	g_hash_table_insert (priv->secrets, g_strdup (key), g_strdup (value));
471
	return NM_SETTING_UPDATE_SECRET_SUCCESS_MODIFIED;
472 473
}

474
static NMSettingUpdateSecretResult
475 476 477 478 479 480 481
update_secret_hash (NMSetting *setting,
                    GHashTable *secrets,
                    GError **error)
{
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
	GHashTableIter iter;
	const char *name, *value;
482
	NMSettingUpdateSecretResult result = NM_SETTING_UPDATE_SECRET_SUCCESS_UNCHANGED;
483

484
	g_return_val_if_fail (secrets != NULL, NM_SETTING_UPDATE_SECRET_ERROR);
485 486 487 488 489 490 491 492

	/* 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");
493
			return NM_SETTING_UPDATE_SECRET_ERROR;
494 495 496 497 498
		}

		if (!value || !strlen (value)) {
			g_set_error (error, NM_SETTING_ERROR,
			             NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH,
499
			             "Secret %s value was empty", name);
500
			return NM_SETTING_UPDATE_SECRET_ERROR;
501
		}
502 503
	}

504 505
	/* Now add the items to the settings' secrets list */
	g_hash_table_iter_init (&iter, secrets);
506 507 508 509 510 511 512 513 514 515
	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;
		}

516 517 518
		if (g_strcmp0 (g_hash_table_lookup (priv->secrets, name), value) == 0)
			continue;

519
		g_hash_table_insert (priv->secrets, g_strdup (name), g_strdup (value));
520
		result = NM_SETTING_UPDATE_SECRET_SUCCESS_MODIFIED;
521
	}
522

523
	return result;
524 525
}

526
static int
527 528
update_one_secret (NMSetting *setting, const char *key, GValue *value, GError **error)
{
529
	NMSettingUpdateSecretResult success = NM_SETTING_UPDATE_SECRET_ERROR;
530

531 532
	g_return_val_if_fail (key != NULL, NM_SETTING_UPDATE_SECRET_ERROR);
	g_return_val_if_fail (value != NULL, NM_SETTING_UPDATE_SECRET_ERROR);
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549

	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);

550
	if (success == NM_SETTING_UPDATE_SECRET_SUCCESS_MODIFIED)
551 552
		g_object_notify (G_OBJECT (setting), NM_SETTING_VPN_SECRETS);

553 554 555
	return success;
}

556 557 558
static gboolean
get_secret_flags (NMSetting *setting,
                  const char *secret_name,
559
                  gboolean verify_secret,
560 561 562 563 564 565 566 567
                  NMSettingSecretFlags *out_flags,
                  GError **error)
{
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
	gboolean success = FALSE;
	char *flags_key;
	gpointer val;
	unsigned long tmp;
568
	NMSettingSecretFlags flags = NM_SETTING_SECRET_FLAG_NONE;
569 570 571 572 573 574

	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)) {
575
			flags = (NMSettingSecretFlags) tmp;
576 577 578 579 580
			success = TRUE;
		} else {
			g_set_error (error,
			             NM_SETTING_ERROR,
			             NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH,
581
			             _("Failed to convert '%s' value '%s' to uint"),
582 583 584 585 586 587
			             flags_key, (const char *) val);
		}
	} else {
		g_set_error (error,
		             NM_SETTING_ERROR,
		             NM_SETTING_ERROR_PROPERTY_NOT_FOUND,
588
		             _("Secret flags property '%s' not found"), flags_key);
589 590
	}
	g_free (flags_key);
591 592
	if (out_flags)
		*out_flags = flags;
593 594 595 596 597 598
	return success;
}

static gboolean
set_secret_flags (NMSetting *setting,
                  const char *secret_name,
599
                  gboolean verify_secret,
600 601 602 603 604 605
                  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));
606
	g_object_notify (G_OBJECT (setting), NM_SETTING_VPN_SECRETS);
607 608 609
	return TRUE;
}

610 611 612 613 614 615 616
static GPtrArray *
need_secrets (NMSetting *setting)
{
	/* Assume that VPN connections need secrets since they almost always will */
	return g_ptr_array_sized_new (1);
}

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
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;
}

679
static gboolean
680
clear_secrets_with_flags (NMSetting *setting,
681 682 683
                          GParamSpec *pspec,
                          NMSettingClearSecretsWithFlagsFn func,
                          gpointer user_data)
684 685 686 687
{
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
	GHashTableIter iter;
	const char *secret;
688
	gboolean changed = TRUE;
689 690

	if (priv->secrets == NULL)
691
		return FALSE;
692 693 694 695 696 697 698

	/* 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);
699
		if (func (setting, pspec->name, flags, user_data) == TRUE) {
700
			g_hash_table_iter_remove (&iter);
701 702
			changed = TRUE;
		}
703
	}
704 705 706

	if (changed)
		g_object_notify (G_OBJECT (setting), NM_SETTING_VPN_SECRETS);
707 708

	return changed;
709 710
}

711 712 713 714 715 716 717 718
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);
719 720
}

721 722 723
static void
nm_setting_vpn_init (NMSettingVPN *setting)
{
724
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
725

726 727
	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);
728 729 730 731 732
}

static void
finalize (GObject *object)
{
733
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (object);
734

735 736 737 738
	g_free (priv->service_type);
	g_free (priv->user_name);
	g_hash_table_destroy (priv->data);
	g_hash_table_destroy (priv->secrets);
739 740 741 742

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

743 744 745
static void
copy_hash (gpointer key, gpointer value, gpointer user_data)
{
746 747
	g_return_if_fail (value != NULL);
	g_return_if_fail (strlen (value));
748 749 750
	g_hash_table_insert ((GHashTable *) user_data, g_strdup (key), g_strdup (value));
}

751 752
static void
set_property (GObject *object, guint prop_id,
753
              const GValue *value, GParamSpec *pspec)
754
{
755
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (object);
756
	GHashTable *new_hash;
757 758 759

	switch (prop_id) {
	case PROP_SERVICE_TYPE:
760 761
		g_free (priv->service_type);
		priv->service_type = g_value_dup_string (value);
762 763
		break;
	case PROP_USER_NAME:
764 765
		g_free (priv->user_name);
		priv->user_name = g_value_dup_string (value);
766
		break;
767 768 769
	case PROP_PERSISTENT:
		priv->persistent = g_value_get_boolean (value);
		break;
770 771
	case PROP_DATA:
		/* Must make a deep copy of the hash table here... */
772
		g_hash_table_remove_all (priv->data);
773 774
		new_hash = g_value_get_boxed (value);
		if (new_hash)
775
			g_hash_table_foreach (new_hash, copy_hash, priv->data);
776 777 778
		break;
	case PROP_SECRETS:
		/* Must make a deep copy of the hash table here... */
779
		g_hash_table_remove_all (priv->secrets);
780 781
		new_hash = g_value_get_boxed (value);
		if (new_hash)
782
			g_hash_table_foreach (new_hash, copy_hash, priv->secrets);
783
		break;
784 785 786 787 788 789 790 791
	default:
		G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
		break;
	}
}

static void
get_property (GObject *object, guint prop_id,
792
              GValue *value, GParamSpec *pspec)
793 794
{
	NMSettingVPN *setting = NM_SETTING_VPN (object);
795
	NMSettingVPNPrivate *priv = NM_SETTING_VPN_GET_PRIVATE (setting);
796 797 798

	switch (prop_id) {
	case PROP_SERVICE_TYPE:
799
		g_value_set_string (value, nm_setting_vpn_get_service_type (setting));
800 801
		break;
	case PROP_USER_NAME:
802
		g_value_set_string (value, nm_setting_vpn_get_user_name (setting));
803
		break;
804 805 806
	case PROP_PERSISTENT:
		g_value_set_boolean (value, priv->persistent);
		break;
807
	case PROP_DATA:
808
		g_value_set_boxed (value, priv->data);
809
		break;
810
	case PROP_SECRETS:
811
		g_value_set_boxed (value, priv->secrets);
812
		break;
813 814 815 816 817 818 819 820 821 822 823 824
	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);

825 826
	g_type_class_add_private (setting_class, sizeof (NMSettingVPNPrivate));

827 828 829 830
	/* virtual methods */
	object_class->set_property = set_property;
	object_class->get_property = get_property;
	object_class->finalize     = finalize;
831 832

	parent_class->verify            = verify;
833
	parent_class->update_one_secret = update_one_secret;
834 835
	parent_class->get_secret_flags  = get_secret_flags;
	parent_class->set_secret_flags  = set_secret_flags;
836
	parent_class->need_secrets      = need_secrets;
837
	parent_class->compare_property  = compare_property;
838
	parent_class->clear_secrets_with_flags = clear_secrets_with_flags;
839 840

	/* Properties */
841 842 843
	/**
	 * NMSettingVPN:service-type:
	 *
844 845
	 * 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
846
	 * plugin.
847
	 **/
848 849
	g_object_class_install_property
		(object_class, PROP_SERVICE_TYPE,
850 851 852 853
		 g_param_spec_string (NM_SETTING_VPN_SERVICE_TYPE, "", "",
		                      NULL,
		                      G_PARAM_READWRITE |
		                      G_PARAM_STATIC_STRINGS));
854

855
	/**
856
	 * NMSettingVPN:user-name:
857
	 *
858
	 * If the VPN connection requires a user name for authentication, that name
859 860
	 * 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
861 862 863
	 * leave this property empty.  If this property is empty, NetworkManager
	 * will automatically supply the username of the user which requested the
	 * VPN connection.
864
	 **/
865 866
	g_object_class_install_property
		(object_class, PROP_USER_NAME,
867
		 g_param_spec_string (NM_SETTING_VPN_USER_NAME, "", "",
868
		                      NULL,
869 870
		                      G_PARAM_READWRITE |
		                      G_PARAM_STATIC_STRINGS));
871

872 873 874 875 876 877 878 879 880 881 882 883 884 885
	/**
	 * NMSettingVPN:persistent:
	 *
	 * If the VPN service supports persistence, and this property is %TRUE,
	 * the VPN will attempt to stay connected across link changes and outages,
	 * until explicitly disconnected.
	 **/
	g_object_class_install_property
		(object_class, PROP_PERSISTENT,
		 g_param_spec_boolean (NM_SETTING_VPN_PERSISTENT, "", "",
		                       FALSE,
		                       G_PARAM_READWRITE |
		                       G_PARAM_STATIC_STRINGS));

886 887 888
	/**
	 * NMSettingVPN:data:
	 *
889 890
	 * Dictionary of key/value pairs of VPN plugin specific data.  Both keys and
	 * values must be strings.
891
	 **/
892 893 894 895 896 897 898 899 900
	/* plugins docs
	 * ---keyfile---
	 * property: data
	 * variable: separate variables named after keys of the dictionary
	 * description: The keys of the data dictionary are used as variable names directly
	 *   under [vpn] section.
	 * example: remote=ovpn.corp.com cipher=AES-256-CBC username=joe
	 * ---end---
	 */
901 902
	g_object_class_install_property
		(object_class, PROP_DATA,
903 904 905 906
		 _nm_param_spec_specialized (NM_SETTING_VPN_DATA, "", "",
		                             DBUS_TYPE_G_MAP_OF_STRING,
		                             G_PARAM_READWRITE |
		                             G_PARAM_STATIC_STRINGS));
907

908 909 910 911 912 913
	/**
	 * NMSettingVPN:secrets:
	 *
	 * Dictionary of key/value pairs of VPN plugin specific secrets like
	 * passwords or private keys.  Both keys and values must be strings.
	 **/
914 915 916 917 918 919 920 921 922
	/* plugins docs
	 * ---keyfile---
	 * property: secrets
	 * variable: separate variables named after keys of the dictionary
	 * description: The keys of the secrets dictionary are used as variable names directly
	 *   under [vpn-secrets] section.
	 * example: password=Popocatepetl
	 * ---end---
	 */
923 924
	g_object_class_install_property
		(object_class, PROP_SECRETS,
925 926
		 _nm_param_spec_specialized (NM_SETTING_VPN_SECRETS, "", "",
		                             DBUS_TYPE_G_MAP_OF_STRING,
927 928
		                             G_PARAM_READWRITE |
		                             NM_SETTING_PARAM_SECRET |
929
		                             G_PARAM_STATIC_STRINGS));
930
}