/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */ /* * Dan Williams * Tambet Ingo * * 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. * * (C) Copyright 2007 - 2011 Red Hat, Inc. * (C) Copyright 2007 - 2008 Novell, Inc. */ #include #include "nm-setting.h" #include "nm-setting-private.h" #include "nm-setting-connection.h" #include "nm-utils.h" #include "nm-utils-private.h" /** * SECTION:nm-setting * @short_description: Describes related configuration information * @include: nm-setting.h * * Each #NMSetting contains properties that describe configuration that applies * to a specific network layer (like IPv4 or IPv6 configuration) or device type * (like Ethernet, or WiFi). A collection of individual settings together * make up an #NMConnection. Each property is strongly typed and usually has * a number of allowed values. See each #NMSetting subclass for a description * of properties and allowed values. */ /** * nm_setting_error_quark: * * Registers an error quark for #NMSetting if necessary. * * Returns: the error quark used for NMSetting errors. **/ GQuark nm_setting_error_quark (void) { static GQuark quark; if (G_UNLIKELY (!quark)) quark = g_quark_from_static_string ("nm-setting-error-quark"); return quark; } G_DEFINE_ABSTRACT_TYPE (NMSetting, nm_setting, G_TYPE_OBJECT) #define NM_SETTING_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_SETTING, NMSettingPrivate)) typedef struct { const char *name; GType type; guint32 priority; GQuark error_quark; } SettingInfo; typedef struct { const SettingInfo *info; } NMSettingPrivate; enum { PROP_0, PROP_NAME, PROP_LAST }; /*************************************************************/ static GHashTable *registered_settings = NULL; static GHashTable *registered_settings_by_type = NULL; static gboolean _nm_gtype_equal (gconstpointer v1, gconstpointer v2) { return *((const GType *) v1) == *((const GType *) v2); } static guint _nm_gtype_hash (gconstpointer v) { return *((const GType *) v); } static void __attribute__((constructor)) _ensure_registered (void) { if (G_UNLIKELY (registered_settings == NULL)) { g_type_init (); _nm_value_transforms_register (); registered_settings = g_hash_table_new (g_str_hash, g_str_equal); registered_settings_by_type = g_hash_table_new (_nm_gtype_hash, _nm_gtype_equal); } } #define _ensure_setting_info(self, priv) \ G_STMT_START { \ NMSettingPrivate *_priv_esi = (priv); \ if (G_UNLIKELY (!_priv_esi->info)) { \ _priv_esi->info = _nm_setting_lookup_setting_by_type (G_OBJECT_TYPE (self)); \ g_assert (_priv_esi->info); \ } \ } G_STMT_END /*************************************************************/ /* * _nm_register_setting: * @name: the name of the #NMSetting object to register * @type: the #GType of the #NMSetting * @priority: the sort priority of the setting, see below * @error_quark: the setting's error quark * * INTERNAL ONLY: registers a setting's internal properties, like its priority * and its error quark type, with libnm-util. * * A setting's priority should roughly follow the OSI layer model, but it also * controls which settings get asked for secrets first. Thus settings which * relate to things that must be working first, like hardware, should get a * higher priority than things which layer on top of the hardware. For example, * the GSM/CDMA settings should provide secrets before the PPP setting does, * because a PIN is required to unlock the device before PPP can even start. * Even settings without secrets should be assigned the right priority. * * 0: reserved for the Connection setting * * 1: hardware-related settings like Ethernet, WiFi, Infiniband, Bridge, etc. * These priority 1 settings are also "base types", which means that at least * one of them is required for the connection to be valid, and their name is * valid in the 'type' property of the Connection setting. * * 2: hardware-related auxiliary settings that require a base setting to be * successful first, like WiFi security, 802.1x, etc. * * 3: hardware-independent settings that are required before IP connectivity * can be established, like PPP, PPPoE, etc. * * 4: IP-level stuff */ void (_nm_register_setting) (const char *name, const GType type, const guint32 priority, const GQuark error_quark) { SettingInfo *info; g_return_if_fail (name != NULL && *name); g_return_if_fail (type != G_TYPE_INVALID); g_return_if_fail (type != G_TYPE_NONE); g_return_if_fail (error_quark != 0); g_return_if_fail (priority <= 4); _ensure_registered (); if (G_LIKELY ((info = g_hash_table_lookup (registered_settings, name)))) { g_return_if_fail (info->type == type); g_return_if_fail (info->error_quark == error_quark); g_return_if_fail (info->priority == priority); g_return_if_fail (g_strcmp0 (info->name, name) == 0); return; } g_return_if_fail (g_hash_table_lookup (registered_settings_by_type, &type) == NULL); if (priority == 0) g_assert_cmpstr (name, ==, NM_SETTING_CONNECTION_SETTING_NAME); info = g_slice_new0 (SettingInfo); info->type = type; info->priority = priority; info->error_quark = error_quark; info->name = name; g_hash_table_insert (registered_settings, (void *) info->name, info); g_hash_table_insert (registered_settings_by_type, &info->type, info); } static const SettingInfo * _nm_setting_lookup_setting_by_type (GType type) { _ensure_registered (); return g_hash_table_lookup (registered_settings_by_type, &type); } static guint32 _get_setting_priority (NMSetting *setting) { NMSettingPrivate *priv; g_return_val_if_fail (NM_IS_SETTING (setting), G_MAXUINT32); priv = NM_SETTING_GET_PRIVATE (setting); _ensure_setting_info (setting, priv); return priv->info->priority; } gboolean _nm_setting_is_base_type (NMSetting *setting) { /* Historical oddity: PPPoE is a base-type even though it's not * priority 1. It needs to be sorted *after* lower-level stuff like * WiFi security or 802.1x for secrets, but it's still allowed as a * base type. */ return _get_setting_priority (setting) == 1 || NM_IS_SETTING_PPPOE (setting); } GType _nm_setting_lookup_setting_type (const char *name) { SettingInfo *info; g_return_val_if_fail (name != NULL, G_TYPE_NONE); _ensure_registered (); info = g_hash_table_lookup (registered_settings, name); return info ? info->type : G_TYPE_INVALID; } GType _nm_setting_lookup_setting_type_by_quark (GQuark error_quark) { SettingInfo *info; GHashTableIter iter; _ensure_registered (); g_hash_table_iter_init (&iter, registered_settings); while (g_hash_table_iter_next (&iter, NULL, (gpointer) &info)) { if (info->error_quark == error_quark) return info->type; } return G_TYPE_INVALID; } gint _nm_setting_compare_priority (gconstpointer a, gconstpointer b) { guint32 prio_a, prio_b; prio_a = _get_setting_priority (NM_SETTING (a)); prio_b = _get_setting_priority (NM_SETTING (b)); if (prio_a < prio_b) return -1; else if (prio_a == prio_b) return 0; return 1; } /*************************************************************/ static void destroy_gvalue (gpointer data) { GValue *value = (GValue *) data; g_value_unset (value); g_slice_free (GValue, value); } /** * nm_setting_to_hash: * @setting: the #NMSetting * @flags: hash flags, e.g. %NM_SETTING_HASH_FLAG_ALL * * Converts the #NMSetting into a #GHashTable mapping each setting property * name to a GValue describing that property, suitable for marshalling over * D-Bus or serializing. The mapping is string to GValue. * * Returns: (transfer full) (element-type utf8 GObject.Value): a new #GHashTable * describing the setting's properties **/ GHashTable * nm_setting_to_hash (NMSetting *setting, NMSettingHashFlags flags) { GHashTable *hash; GParamSpec **property_specs; guint n_property_specs; guint i; g_return_val_if_fail (NM_IS_SETTING (setting), NULL); property_specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (setting), &n_property_specs); if (!property_specs) { g_warning ("%s: couldn't find property specs for object of type '%s'", __func__, g_type_name (G_OBJECT_TYPE (setting))); return NULL; } hash = g_hash_table_new_full (g_str_hash, g_str_equal, (GDestroyNotify) g_free, destroy_gvalue); for (i = 0; i < n_property_specs; i++) { GParamSpec *prop_spec = property_specs[i]; GValue *value; /* 'name' doesn't get serialized */ if (strcmp (g_param_spec_get_name (prop_spec), NM_SETTING_NAME) == 0) continue; if ( (flags & NM_SETTING_HASH_FLAG_NO_SECRETS) && (prop_spec->flags & NM_SETTING_PARAM_SECRET)) continue; if ( (flags & NM_SETTING_HASH_FLAG_ONLY_SECRETS) && !(prop_spec->flags & NM_SETTING_PARAM_SECRET)) continue; value = g_slice_new0 (GValue); g_value_init (value, prop_spec->value_type); g_object_get_property (G_OBJECT (setting), prop_spec->name, value); /* Don't serialize values with default values */ if (!g_param_value_defaults (prop_spec, value)) g_hash_table_insert (hash, g_strdup (prop_spec->name), value); else destroy_gvalue (value); } g_free (property_specs); /* Don't return empty hashes, except for base types */ if (g_hash_table_size (hash) < 1 && !_nm_setting_is_base_type (setting)) { g_hash_table_destroy (hash); hash = NULL; } return hash; } /** * nm_setting_new_from_hash: * @setting_type: the #NMSetting type which the hash contains properties for * @hash: (element-type utf8 GObject.Value): the #GHashTable containing a * string to GValue mapping of properties that apply to the setting * * Creates a new #NMSetting object and populates that object with the properties * contained in the hash table, using each hash key as the property to set, * and each hash value as the value to set that property to. Setting properties * are strongly typed, thus the GValue type of the hash value must be correct. * See the documentation on each #NMSetting object subclass for the correct * property names and value types. * * Returns: a new #NMSetting object populated with the properties from the * hash table, or %NULL on failure **/ NMSetting * nm_setting_new_from_hash (GType setting_type, GHashTable *hash) { GHashTableIter iter; NMSetting *setting; const char *prop_name; GValue *src_value; GObjectClass *class; guint n_params = 0; GParameter *params; int i; g_return_val_if_fail (G_TYPE_IS_INSTANTIATABLE (setting_type), NULL); g_return_val_if_fail (hash != NULL, NULL); /* g_type_class_ref() ensures the setting class is created if it hasn't * already been used. */ class = g_type_class_ref (setting_type); params = g_new0 (GParameter, g_hash_table_size (hash)); g_hash_table_iter_init (&iter, hash); while (g_hash_table_iter_next (&iter, (gpointer) &prop_name, (gpointer) &src_value)) { GValue *dst_value = ¶ms[n_params].value; GParamSpec *param_spec; param_spec = g_object_class_find_property (class, prop_name); if (!param_spec) { /* Oh, we're so nice and only warn, maybe it should be a fatal error? */ g_warning ("Ignoring invalid property '%s'", prop_name); continue; } g_value_init (dst_value, G_VALUE_TYPE (src_value)); if (g_value_transform (src_value, dst_value)) params[n_params++].name = prop_name; else { g_warning ("Ignoring property '%s' with invalid type (%s)", prop_name, G_VALUE_TYPE_NAME (src_value)); g_value_unset (dst_value); } } setting = (NMSetting *) g_object_newv (setting_type, n_params, params); for (i = 0; i < n_params; i++) g_value_unset (¶ms[i].value); g_free (params); g_type_class_unref (class); return setting; } static void duplicate_setting (NMSetting *setting, const char *name, const GValue *value, GParamFlags flags, gpointer user_data) { if ((flags & (G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY)) == G_PARAM_WRITABLE) g_object_set_property (G_OBJECT (user_data), name, value); } /** * nm_setting_duplicate: * @setting: the #NMSetting to duplicate * * Duplicates a #NMSetting. * * Returns: (transfer full): a new #NMSetting containing the same properties and values as the * source #NMSetting **/ NMSetting * nm_setting_duplicate (NMSetting *setting) { GObject *dup; g_return_val_if_fail (NM_IS_SETTING (setting), NULL); dup = g_object_new (G_OBJECT_TYPE (setting), NULL); g_object_freeze_notify (dup); nm_setting_enumerate_values (setting, duplicate_setting, dup); g_object_thaw_notify (dup); return NM_SETTING (dup); } static gint find_setting_by_name (gconstpointer a, gconstpointer b) { NMSetting *setting = NM_SETTING (a); const char *str = (const char *) b; return strcmp (nm_setting_get_name (setting), str); } NMSetting * nm_setting_find_in_list (GSList *settings_list, const char *setting_name) { GSList *found; found = g_slist_find_custom (settings_list, setting_name, find_setting_by_name); if (found) return found->data; else return NULL; } /** * nm_setting_get_name: * @setting: the #NMSetting * * Returns the type name of the #NMSetting object * * Returns: a string containing the type name of the #NMSetting object, * like 'ppp' or 'wireless' or 'wired'. **/ const char * nm_setting_get_name (NMSetting *setting) { NMSettingPrivate *priv; g_return_val_if_fail (NM_IS_SETTING (setting), NULL); priv = NM_SETTING_GET_PRIVATE (setting); _ensure_setting_info (setting, priv); return priv->info->name; } /** * nm_setting_verify: * @setting: the #NMSetting to verify * @all_settings: (element-type NMSetting): a #GSList of all settings * in the connection from which @setting came * @error: location to store error, or %NULL * * Validates the setting. Each setting's properties have allowed values, and * some are dependent on other values (hence the need for @all_settings). The * returned #GError contains information about which property of the setting * failed validation, and in what way that property failed validation. * * Returns: %TRUE if the setting is valid, %FALSE if it is not **/ gboolean nm_setting_verify (NMSetting *setting, GSList *all_settings, GError **error) { g_return_val_if_fail (NM_IS_SETTING (setting), FALSE); g_return_val_if_fail (!error || *error == NULL, FALSE); if (NM_SETTING_GET_CLASS (setting)->verify) return NM_SETTING_GET_CLASS (setting)->verify (setting, all_settings, error); return TRUE; } static gboolean compare_property (NMSetting *setting, NMSetting *other, const GParamSpec *prop_spec, NMSettingCompareFlags flags) { GValue value1 = G_VALUE_INIT; GValue value2 = G_VALUE_INIT; gboolean different; /* Handle compare flags */ if (prop_spec->flags & NM_SETTING_PARAM_SECRET) { NMSettingSecretFlags a_secret_flags = NM_SETTING_SECRET_FLAG_NONE; NMSettingSecretFlags b_secret_flags = NM_SETTING_SECRET_FLAG_NONE; nm_setting_get_secret_flags (setting, prop_spec->name, &a_secret_flags, NULL); nm_setting_get_secret_flags (other, prop_spec->name, &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; /* Check for various secret flags that might cause us to ignore comparing * this property. */ if ( (flags & NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS) && (a_secret_flags & NM_SETTING_SECRET_FLAG_AGENT_OWNED)) return TRUE; if ( (flags & NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS) && (a_secret_flags & NM_SETTING_SECRET_FLAG_NOT_SAVED)) return TRUE; } g_value_init (&value1, prop_spec->value_type); g_object_get_property (G_OBJECT (setting), prop_spec->name, &value1); g_value_init (&value2, prop_spec->value_type); g_object_get_property (G_OBJECT (other), prop_spec->name, &value2); different = g_param_values_cmp ((GParamSpec *) prop_spec, &value1, &value2); g_value_unset (&value1); g_value_unset (&value2); return different == 0 ? TRUE : FALSE; } /** * nm_setting_compare: * @a: a #NMSetting * @b: a second #NMSetting to compare with the first * @flags: compare flags, e.g. %NM_SETTING_COMPARE_FLAG_EXACT * * Compares two #NMSetting objects for similarity, with comparison behavior * modified by a set of flags. See the documentation for #NMSettingCompareFlags * for a description of each flag's behavior. * * Returns: %TRUE if the comparison succeeds, %FALSE if it does not **/ gboolean nm_setting_compare (NMSetting *a, NMSetting *b, NMSettingCompareFlags flags) { GParamSpec **property_specs; guint n_property_specs; gint same = TRUE; guint i; g_return_val_if_fail (NM_IS_SETTING (a), FALSE); g_return_val_if_fail (NM_IS_SETTING (b), FALSE); /* First check that both have the same type */ if (G_OBJECT_TYPE (a) != G_OBJECT_TYPE (b)) return FALSE; /* And now all properties */ property_specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (a), &n_property_specs); for (i = 0; i < n_property_specs && same; i++) { GParamSpec *prop_spec = property_specs[i]; /* Fuzzy compare ignores secrets and properties defined with the FUZZY_IGNORE flag */ if ( (flags & NM_SETTING_COMPARE_FLAG_FUZZY) && (prop_spec->flags & (NM_SETTING_PARAM_FUZZY_IGNORE | NM_SETTING_PARAM_SECRET))) continue; if ((flags & NM_SETTING_COMPARE_FLAG_INFERRABLE) && !(prop_spec->flags & NM_SETTING_PARAM_INFERRABLE)) continue; if ( (flags & NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS) && (prop_spec->flags & NM_SETTING_PARAM_SECRET)) continue; same = NM_SETTING_GET_CLASS (a)->compare_property (a, b, prop_spec, flags); } g_free (property_specs); return same; } static inline gboolean should_compare_prop (NMSetting *setting, const char *prop_name, NMSettingCompareFlags comp_flags, GParamFlags prop_flags) { /* Fuzzy compare ignores secrets and properties defined with the FUZZY_IGNORE flag */ if ( (comp_flags & NM_SETTING_COMPARE_FLAG_FUZZY) && (prop_flags & (NM_SETTING_PARAM_FUZZY_IGNORE | NM_SETTING_PARAM_SECRET))) return FALSE; if ((comp_flags & NM_SETTING_COMPARE_FLAG_INFERRABLE) && !(prop_flags & NM_SETTING_PARAM_INFERRABLE)) return FALSE; if (prop_flags & NM_SETTING_PARAM_SECRET) { NMSettingSecretFlags secret_flags = NM_SETTING_SECRET_FLAG_NONE; if (comp_flags & NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS) return FALSE; nm_setting_get_secret_flags (setting, prop_name, &secret_flags, NULL); if ( (comp_flags & NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS) && (secret_flags & NM_SETTING_SECRET_FLAG_AGENT_OWNED)) return FALSE; if ( (comp_flags & NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS) && (secret_flags & NM_SETTING_SECRET_FLAG_NOT_SAVED)) return FALSE; } if ( (comp_flags & NM_SETTING_COMPARE_FLAG_IGNORE_ID) && NM_IS_SETTING_CONNECTION (setting) && !strcmp (prop_name, NM_SETTING_CONNECTION_ID)) return FALSE; return TRUE; } /** * nm_setting_diff: * @a: a #NMSetting * @b: a second #NMSetting to compare with the first * @flags: compare flags, e.g. %NM_SETTING_COMPARE_FLAG_EXACT * @invert_results: this parameter is used internally by libnm-util and should * be set to %FALSE. If %TRUE inverts the meaning of the #NMSettingDiffResult. * @results: (inout) (transfer full) (element-type utf8 guint32): if the * settings differ, on return a hash table mapping the differing keys to one or * more %NMSettingDiffResult values OR-ed together. If the settings do not * differ, any hash table passed in is unmodified. If no hash table is passed * in and the settings differ, a new one is created and returned. * * Compares two #NMSetting objects for similarity, with comparison behavior * modified by a set of flags. See the documentation for #NMSettingCompareFlags * for a description of each flag's behavior. If the settings differ, the keys * of each setting that differ from the other are added to @results, mapped to * one or more #NMSettingDiffResult values. * * Returns: %TRUE if the settings contain the same values, %FALSE if they do not **/ gboolean nm_setting_diff (NMSetting *a, NMSetting *b, NMSettingCompareFlags flags, gboolean invert_results, GHashTable **results) { GParamSpec **property_specs; guint n_property_specs; guint i; NMSettingDiffResult a_result = NM_SETTING_DIFF_RESULT_IN_A; NMSettingDiffResult b_result = NM_SETTING_DIFF_RESULT_IN_B; gboolean results_created = FALSE; g_return_val_if_fail (results != NULL, FALSE); g_return_val_if_fail (NM_IS_SETTING (a), FALSE); if (b) { g_return_val_if_fail (NM_IS_SETTING (b), FALSE); g_return_val_if_fail (G_OBJECT_TYPE (a) == G_OBJECT_TYPE (b), FALSE); } /* If the caller is calling this function in a pattern like this to get * complete diffs: * * nm_setting_diff (A, B, FALSE, &results); * nm_setting_diff (B, A, TRUE, &results); * * and wants us to invert the results so that the second invocation comes * out correctly, do that here. */ if (invert_results) { a_result = NM_SETTING_DIFF_RESULT_IN_B; b_result = NM_SETTING_DIFF_RESULT_IN_A; } if (*results == NULL) { *results = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL); results_created = TRUE; } /* And now all properties */ property_specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (a), &n_property_specs); for (i = 0; i < n_property_specs; i++) { GParamSpec *prop_spec = property_specs[i]; NMSettingDiffResult r = NM_SETTING_DIFF_RESULT_UNKNOWN, tmp; gboolean different = TRUE; /* Handle compare flags */ if (!should_compare_prop (a, prop_spec->name, flags, prop_spec->flags)) continue; if (strcmp (prop_spec->name, NM_SETTING_NAME) == 0) continue; if (b) { different = !NM_SETTING_GET_CLASS (a)->compare_property (a, b, prop_spec, flags); if (different) { GValue value = G_VALUE_INIT; g_value_init (&value, prop_spec->value_type); g_object_get_property (G_OBJECT (a), prop_spec->name, &value); if (!g_param_value_defaults (prop_spec, &value)) r |= a_result; g_value_reset (&value); g_object_get_property (G_OBJECT (b), prop_spec->name, &value); if (!g_param_value_defaults (prop_spec, &value)) r |= b_result; g_value_unset (&value); } } else r = a_result; /* only in A */ if (different) { tmp = GPOINTER_TO_UINT (g_hash_table_lookup (*results, prop_spec->name)); g_hash_table_insert (*results, g_strdup (prop_spec->name), GUINT_TO_POINTER (tmp | r)); } } g_free (property_specs); /* Don't return an empty hash table */ if (results_created && !g_hash_table_size (*results)) { g_hash_table_destroy (*results); *results = NULL; } return !(*results); } /** * nm_setting_enumerate_values: * @setting: the #NMSetting * @func: (scope call): user-supplied function called for each property of the setting * @user_data: user data passed to @func at each invocation * * Iterates over each property of the #NMSetting object, calling the supplied * user function for each property. **/ void nm_setting_enumerate_values (NMSetting *setting, NMSettingValueIterFn func, gpointer user_data) { GParamSpec **property_specs; guint n_property_specs; int i; g_return_if_fail (NM_IS_SETTING (setting)); g_return_if_fail (func != NULL); property_specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (setting), &n_property_specs); for (i = 0; i < n_property_specs; i++) { GParamSpec *prop_spec = property_specs[i]; GValue value = G_VALUE_INIT; g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (prop_spec)); g_object_get_property (G_OBJECT (setting), prop_spec->name, &value); func (setting, prop_spec->name, &value, prop_spec->flags, user_data); g_value_unset (&value); } g_free (property_specs); } /** * nm_setting_clear_secrets: * @setting: the #NMSetting * * Resets and clears any secrets in the setting. Secrets should be added to the * setting only when needed, and cleared immediately after use to prevent * leakage of information. **/ void nm_setting_clear_secrets (NMSetting *setting) { _nm_setting_clear_secrets (setting); } gboolean _nm_setting_clear_secrets (NMSetting *setting) { GParamSpec **property_specs; guint n_property_specs; guint i; gboolean changed = FALSE; g_return_val_if_fail (NM_IS_SETTING (setting), FALSE); property_specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (setting), &n_property_specs); for (i = 0; i < n_property_specs; i++) { GParamSpec *prop_spec = property_specs[i]; if (prop_spec->flags & NM_SETTING_PARAM_SECRET) { GValue value = G_VALUE_INIT; g_value_init (&value, prop_spec->value_type); g_object_get_property (G_OBJECT (setting), prop_spec->name, &value); if (!g_param_value_defaults (prop_spec, &value)) { g_param_value_set_default (prop_spec, &value); g_object_set_property (G_OBJECT (setting), prop_spec->name, &value); changed = TRUE; } g_value_unset (&value); } } g_free (property_specs); return changed; } static gboolean clear_secrets_with_flags (NMSetting *setting, GParamSpec *pspec, NMSettingClearSecretsWithFlagsFn func, gpointer user_data) { NMSettingSecretFlags flags = NM_SETTING_SECRET_FLAG_NONE; gboolean changed = FALSE; /* Clear the secret if the user function says to do so */ nm_setting_get_secret_flags (setting, pspec->name, &flags, NULL); if (func (setting, pspec->name, flags, user_data) == TRUE) { GValue value = G_VALUE_INIT; g_value_init (&value, pspec->value_type); g_object_get_property (G_OBJECT (setting), pspec->name, &value); if (!g_param_value_defaults (pspec, &value)) { g_param_value_set_default (pspec, &value); g_object_set_property (G_OBJECT (setting), pspec->name, &value); changed = TRUE; } g_value_unset (&value); } return changed; } /** * nm_setting_clear_secrets_with_flags: * @setting: the #NMSetting * @func: (scope call): function to be called to determine whether a * specific secret should be cleared or not * @user_data: caller-supplied data passed to @func * * Clears and frees secrets determined by @func. **/ void nm_setting_clear_secrets_with_flags (NMSetting *setting, NMSettingClearSecretsWithFlagsFn func, gpointer user_data) { _nm_setting_clear_secrets_with_flags (setting, func, user_data); } gboolean _nm_setting_clear_secrets_with_flags (NMSetting *setting, NMSettingClearSecretsWithFlagsFn func, gpointer user_data) { GParamSpec **property_specs; guint n_property_specs; guint i; gboolean changed = FALSE; g_return_val_if_fail (setting, FALSE); g_return_val_if_fail (NM_IS_SETTING (setting), FALSE); g_return_val_if_fail (func != NULL, FALSE); property_specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (setting), &n_property_specs); for (i = 0; i < n_property_specs; i++) { if (property_specs[i]->flags & NM_SETTING_PARAM_SECRET) { changed |= NM_SETTING_GET_CLASS (setting)->clear_secrets_with_flags (setting, property_specs[i], func, user_data); } } g_free (property_specs); return changed; } /** * nm_setting_need_secrets: * @setting: the #NMSetting * * Returns an array of property names for each secret which may be required * to make a successful connection. The returned hints are only intended as a * guide to what secrets may be required, because in some circumstances, there * is no way to conclusively determine exactly which secrets are needed. * * Returns: (transfer container) (element-type utf8): a #GPtrArray containing * the property names of secrets of the #NMSetting which may be required; the * caller owns the array and must free it with g_ptr_array_free(), but must not * free the elements. **/ GPtrArray * nm_setting_need_secrets (NMSetting *setting) { GPtrArray *secrets = NULL; g_return_val_if_fail (NM_IS_SETTING (setting), NULL); if (NM_SETTING_GET_CLASS (setting)->need_secrets) secrets = NM_SETTING_GET_CLASS (setting)->need_secrets (setting); return secrets; } static int update_one_secret (NMSetting *setting, const char *key, GValue *value, GError **error) { GParamSpec *prop_spec; GValue transformed_value = G_VALUE_INIT; prop_spec = g_object_class_find_property (G_OBJECT_GET_CLASS (setting), key); if (!prop_spec) { g_set_error (error, NM_SETTING_ERROR, NM_SETTING_ERROR_PROPERTY_NOT_FOUND, "%s", key); return NM_SETTING_UPDATE_SECRET_ERROR; } /* Silently ignore non-secrets */ if (!(prop_spec->flags & NM_SETTING_PARAM_SECRET)) return NM_SETTING_UPDATE_SECRET_SUCCESS_UNCHANGED; if (g_value_type_compatible (G_VALUE_TYPE (value), G_PARAM_SPEC_VALUE_TYPE (prop_spec))) { if (G_VALUE_HOLDS_STRING (value) && G_IS_PARAM_SPEC_STRING (prop_spec)) { /* String is expected to be a common case. Handle it specially and check whether * the value is already set. Otherwise, we just reset the property and * assume the value got modified. */ char *v; g_object_get (G_OBJECT (setting), prop_spec->name, &v, NULL); if (g_strcmp0 (v, g_value_get_string (value)) == 0) { g_free (v); return NM_SETTING_UPDATE_SECRET_SUCCESS_UNCHANGED; } g_free (v); } g_object_set_property (G_OBJECT (setting), prop_spec->name, value); return NM_SETTING_UPDATE_SECRET_SUCCESS_MODIFIED; } if (g_value_transform (value, &transformed_value)) { g_object_set_property (G_OBJECT (setting), prop_spec->name, &transformed_value); g_value_unset (&transformed_value); return NM_SETTING_UPDATE_SECRET_SUCCESS_MODIFIED; } g_set_error (error, NM_SETTING_ERROR, NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH, "%s", key); return NM_SETTING_UPDATE_SECRET_ERROR; } /** * nm_setting_update_secrets: * @setting: the #NMSetting * @secrets: (element-type utf8 GObject.Value): a #GHashTable mapping * string to #GValue of setting property names and secrets * @error: location to store error, or %NULL * * Update the setting's secrets, given a hash table of secrets intended for that * setting (deserialized from D-Bus for example). * * Returns: %TRUE if the secrets were successfully updated, %FALSE on failure to * update one or more of the secrets. **/ gboolean nm_setting_update_secrets (NMSetting *setting, GHashTable *secrets, GError **error) { return _nm_setting_update_secrets (setting, secrets, error) != NM_SETTING_UPDATE_SECRET_ERROR; } NMSettingUpdateSecretResult _nm_setting_update_secrets (NMSetting *setting, GHashTable *secrets, GError **error) { GHashTableIter iter; gpointer key, data; GError *tmp_error = NULL; NMSettingUpdateSecretResult result = NM_SETTING_UPDATE_SECRET_SUCCESS_UNCHANGED; g_return_val_if_fail (NM_IS_SETTING (setting), NM_SETTING_UPDATE_SECRET_ERROR); g_return_val_if_fail (secrets != NULL, NM_SETTING_UPDATE_SECRET_ERROR); if (error) g_return_val_if_fail (*error == NULL, NM_SETTING_UPDATE_SECRET_ERROR); g_hash_table_iter_init (&iter, secrets); while (g_hash_table_iter_next (&iter, &key, &data)) { int success; const char *secret_key = (const char *) key; GValue *secret_value = (GValue *) data; success = NM_SETTING_GET_CLASS (setting)->update_one_secret (setting, secret_key, secret_value, &tmp_error); g_assert (!((success == NM_SETTING_UPDATE_SECRET_ERROR) ^ (!!tmp_error))); if (success == NM_SETTING_UPDATE_SECRET_ERROR) { g_propagate_error (error, tmp_error); return NM_SETTING_UPDATE_SECRET_ERROR; } if (success == NM_SETTING_UPDATE_SECRET_SUCCESS_MODIFIED) result = NM_SETTING_UPDATE_SECRET_SUCCESS_MODIFIED; } return result; } static gboolean is_secret_prop (NMSetting *setting, const char *secret_name, GError **error) { GParamSpec *pspec; pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (setting), secret_name); if (!pspec) { g_set_error (error, NM_SETTING_ERROR, NM_SETTING_ERROR_PROPERTY_NOT_FOUND, "Secret %s not provided by this setting", secret_name); return FALSE; } if (!(pspec->flags & NM_SETTING_PARAM_SECRET)) { g_set_error (error, NM_SETTING_ERROR, NM_SETTING_ERROR_PROPERTY_NOT_SECRET, "Property %s is not a secret", secret_name); return FALSE; } return TRUE; } static gboolean get_secret_flags (NMSetting *setting, const char *secret_name, gboolean verify_secret, NMSettingSecretFlags *out_flags, GError **error) { char *flags_prop; NMSettingSecretFlags flags = NM_SETTING_SECRET_FLAG_NONE; if (verify_secret) g_return_val_if_fail (is_secret_prop (setting, secret_name, error), FALSE); flags_prop = g_strdup_printf ("%s-flags", secret_name); g_object_get (G_OBJECT (setting), flags_prop, &flags, NULL); g_free (flags_prop); if (out_flags) *out_flags = flags; return TRUE; } /** * nm_setting_get_secret_flags: * @setting: the #NMSetting * @secret_name: the secret key name to get flags for * @out_flags: on success, the #NMSettingSecretFlags for the secret * @error: location to store error, or %NULL * * For a given secret, retrieves the #NMSettingSecretFlags describing how to * handle that secret. * * Returns: %TRUE on success (if the given secret name was a valid property of * this setting, and if that property is secret), %FALSE if not **/ gboolean nm_setting_get_secret_flags (NMSetting *setting, const char *secret_name, NMSettingSecretFlags *out_flags, GError **error) { g_return_val_if_fail (NM_IS_SETTING (setting), FALSE); g_return_val_if_fail (secret_name != NULL, FALSE); return NM_SETTING_GET_CLASS (setting)->get_secret_flags (setting, secret_name, TRUE, out_flags, error); } static gboolean set_secret_flags (NMSetting *setting, const char *secret_name, gboolean verify_secret, NMSettingSecretFlags flags, GError **error) { char *flags_prop; if (verify_secret) g_return_val_if_fail (is_secret_prop (setting, secret_name, error), FALSE); flags_prop = g_strdup_printf ("%s-flags", secret_name); g_object_set (G_OBJECT (setting), flags_prop, flags, NULL); g_free (flags_prop); return TRUE; } /** * nm_setting_set_secret_flags: * @setting: the #NMSetting * @secret_name: the secret key name to set flags for * @flags: the #NMSettingSecretFlags for the secret * @error: location to store error, or %NULL * * For a given secret, stores the #NMSettingSecretFlags describing how to * handle that secret. * * Returns: %TRUE on success (if the given secret name was a valid property of * this setting, and if that property is secret), %FALSE if not **/ gboolean nm_setting_set_secret_flags (NMSetting *setting, const char *secret_name, NMSettingSecretFlags flags, GError **error) { g_return_val_if_fail (NM_IS_SETTING (setting), FALSE); g_return_val_if_fail (secret_name != NULL, FALSE); g_return_val_if_fail (flags <= NM_SETTING_SECRET_FLAGS_ALL, FALSE); return NM_SETTING_GET_CLASS (setting)->set_secret_flags (setting, secret_name, TRUE, flags, error); } /** * nm_setting_to_string: * @setting: the #NMSetting * * Convert the setting into a string. For debugging purposes ONLY, should NOT * be used for serialization of the setting, or machine-parsed in any way. The * output format is not guaranteed to be stable and may change at any time. * * Returns: an allocated string containing a textual representation of the * setting's properties and values (including secrets!), which the caller should * free with g_free() **/ char * nm_setting_to_string (NMSetting *setting) { GString *string; GParamSpec **property_specs; guint n_property_specs; guint i; g_return_val_if_fail (NM_IS_SETTING (setting), NULL); property_specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (setting), &n_property_specs); if (!property_specs) return NULL; string = g_string_new (nm_setting_get_name (setting)); g_string_append_c (string, '\n'); for (i = 0; i < n_property_specs; i++) { GParamSpec *prop_spec = property_specs[i]; GValue value = G_VALUE_INIT; char *value_str; gboolean is_default; if (strcmp (prop_spec->name, NM_SETTING_NAME) == 0) continue; g_value_init (&value, prop_spec->value_type); g_object_get_property (G_OBJECT (setting), prop_spec->name, &value); value_str = g_strdup_value_contents (&value); g_string_append_printf (string, "\t%s : %s", prop_spec->name, value_str); g_free (value_str); is_default = g_param_value_defaults (prop_spec, &value); g_value_unset (&value); g_string_append (string, " ("); g_string_append_c (string, 's'); if (is_default) g_string_append_c (string, 'd'); g_string_append_c (string, ')'); g_string_append_c (string, '\n'); } g_free (property_specs); g_string_append_c (string, '\n'); return g_string_free (string, FALSE); } /** * nm_setting_get_virtual_iface_name: * @setting: the #NMSetting * * Returns the name of the virtual kernel interface which the connection * needs to use if specified in the settings. * * Returns: Name of the virtual interface or %NULL if the setting does not * support this feature **/ const char * nm_setting_get_virtual_iface_name (NMSetting *setting) { g_return_val_if_fail (NM_IS_SETTING (setting), NULL); if (NM_SETTING_GET_CLASS (setting)->get_virtual_iface_name) return NM_SETTING_GET_CLASS (setting)->get_virtual_iface_name (setting); return NULL; } /*****************************************************************************/ static void nm_setting_init (NMSetting *setting) { } static GObject* constructor (GType type, guint n_construct_params, GObjectConstructParam *construct_params) { GObject *object; object = G_OBJECT_CLASS (nm_setting_parent_class)->constructor (type, n_construct_params, construct_params); _ensure_setting_info (object, NM_SETTING_GET_PRIVATE (object)); return object; } static void set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec) { NMSettingPrivate *priv = NM_SETTING_GET_PRIVATE (object); switch (prop_id) { case PROP_NAME: /* The setter for NAME is deprecated and should not be used anymore. * Keep the setter for NAME to remain backward compatible. * Only assert that the caller does not try to set the name to a different value * then the registered name, which would be extra wrong. **/ _ensure_setting_info (object, priv); g_return_if_fail (!g_strcmp0 (priv->info->name, g_value_get_string (value))); break; 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) { NMSetting *setting = NM_SETTING (object); switch (prop_id) { case PROP_NAME: g_value_set_string (value, nm_setting_get_name (setting)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void nm_setting_class_init (NMSettingClass *setting_class) { GObjectClass *object_class = G_OBJECT_CLASS (setting_class); g_type_class_add_private (setting_class, sizeof (NMSettingPrivate)); /* virtual methods */ object_class->constructor = constructor; object_class->set_property = set_property; object_class->get_property = get_property; setting_class->update_one_secret = update_one_secret; setting_class->get_secret_flags = get_secret_flags; setting_class->set_secret_flags = set_secret_flags; setting_class->compare_property = compare_property; setting_class->clear_secrets_with_flags = clear_secrets_with_flags; /* Properties */ /** * NMSetting:name: * * The setting's name, which uniquely identifies the setting within the * connection. Each setting type has a name unique to that type, for * example 'ppp' or 'wireless' or 'wired'. **/ g_object_class_install_property (object_class, PROP_NAME, g_param_spec_string (NM_SETTING_NAME, "Name", "The setting's name; these names are defined by the " "specification and cannot be changed after the object " "has been created. Each setting class has a name, and " "all objects of that class share the same name.", NULL, G_PARAM_READWRITE)); }