![]() |
![]() |
![]() |
libnm-util Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <nm-setting.h> NMSetting; NMSettingClass; gboolean (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting
,const char *secret
,NMSettingSecretFlags flags
,gpointer user_data
); enum NMSettingCompareFlags; enum NMSettingDiffResult; enum NMSettingError; enum NMSettingHashFlags; enum NMSettingSecretFlags; void (*NMSettingValueIterFn) (NMSetting *setting
,const char *key
,const GValue *value
,GParamFlags flags
,gpointer user_data
); #define NM_SETTING_ERROR #define NM_SETTING_NAME #define NM_SETTING_PARAM_FUZZY_IGNORE #define NM_SETTING_PARAM_REQUIRED #define NM_SETTING_PARAM_SECRET #define NM_SETTING_PARAM_SERIALIZE void nm_setting_clear_secrets (NMSetting *setting
); void nm_setting_clear_secrets_with_flags (NMSetting *setting
,NMSettingClearSecretsWithFlagsFn func
,gpointer user_data
); gboolean nm_setting_compare (NMSetting *a
,NMSetting *b
,NMSettingCompareFlags flags
); gboolean nm_setting_diff (NMSetting *a
,NMSetting *b
,NMSettingCompareFlags flags
,gboolean invert_results
,GHashTable **results
); NMSetting * nm_setting_duplicate (NMSetting *setting
); void nm_setting_enumerate_values (NMSetting *setting
,NMSettingValueIterFn func
,gpointer user_data
); GQuark nm_setting_error_quark (void
); const char * nm_setting_get_name (NMSetting *setting
); gboolean nm_setting_get_secret_flags (NMSetting *setting
,const char *secret_name
,NMSettingSecretFlags *out_flags
,GError **error
); const char * nm_setting_get_virtual_iface_name (NMSetting *setting
); GPtrArray * nm_setting_need_secrets (NMSetting *setting
); NMSetting * nm_setting_new_from_hash (GType setting_type
,GHashTable *hash
); gboolean nm_setting_set_secret_flags (NMSetting *setting
,const char *secret_name
,NMSettingSecretFlags flags
,GError **error
); GHashTable * nm_setting_to_hash (NMSetting *setting
,NMSettingHashFlags flags
); char * nm_setting_to_string (NMSetting *setting
); gboolean nm_setting_update_secrets (NMSetting *setting
,GHashTable *secrets
,GError **error
); gboolean nm_setting_verify (NMSetting *setting
,GSList *all_settings
,GError **error
);
GObject +----NMSetting +----NMSetting8021x +----NMSettingAdsl +----NMSettingBluetooth +----NMSettingBond +----NMSettingBridge +----NMSettingBridgePort +----NMSettingConnection +----NMSettingInfiniband +----NMSettingIP4Config +----NMSettingVlan +----NMSettingIP6Config +----NMSettingPPP +----NMSettingPPPOE +----NMSettingSerial +----NMSettingGsm +----NMSettingCdma +----NMSettingOlpcMesh +----NMSettingWimax +----NMSettingWired +----NMSettingWireless +----NMSettingWirelessSecurity +----NMSettingVPN
GEnum +----NMSettingCompareFlags
GEnum +----NMSettingDiffResult
GEnum +----NMSettingError
GEnum +----NMSettingHashFlags
GEnum +----NMSettingSecretFlags
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.
typedef struct _NMSetting NMSetting;
The NMSetting struct contains only private data. It should only be accessed through the functions described below.
typedef struct { GObjectClass parent; /* Virtual functions */ gboolean (*verify) (NMSetting *setting, GSList *all_settings, GError **error); GPtrArray *(*need_secrets) (NMSetting *setting); gboolean (*update_one_secret) (NMSetting *setting, const char *key, GValue *value, GError **error); gboolean (*get_secret_flags) (NMSetting *setting, const char *secret_name, gboolean verify_secret, NMSettingSecretFlags *out_flags, GError **error); gboolean (*set_secret_flags) (NMSetting *setting, const char *secret_name, gboolean verify_secret, NMSettingSecretFlags flags, GError **error); /* Returns TRUE if the given property contains the same value in both settings */ gboolean (*compare_property) (NMSetting *setting, NMSetting *other, const GParamSpec *prop_spec, NMSettingCompareFlags flags); void (*clear_secrets_with_flags) (NMSetting *setting, GParamSpec *pspec, NMSettingClearSecretsWithFlagsFn func, gpointer user_data); const char *(*get_virtual_iface_name) (NMSetting *setting); /* Padding for future expansion */ void (*_reserved1) (void); } NMSettingClass;
gboolean (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting
,const char *secret
,NMSettingSecretFlags flags
,gpointer user_data
);
|
The setting for which secrets are being iterated |
|
The secret's name |
|
The secret's flags, eg NM_SETTING_SECRET_FLAG_AGENT_OWNED
|
|
User data passed to nm_connection_clear_secrets_with_flags()
|
Returns : |
TRUE to clear the secret, FALSE to not clear the secret |
typedef enum { NM_SETTING_COMPARE_FLAG_EXACT = 0x00000000, NM_SETTING_COMPARE_FLAG_FUZZY = 0x00000001, NM_SETTING_COMPARE_FLAG_IGNORE_ID = 0x00000002, NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS = 0x00000004, NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS = 0x00000008, NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS = 0x00000010 } NMSettingCompareFlags;
These flags modify the comparison behavior when comparing two settings or two connections.
match all properties exactly | |
match only important attributes, like SSID, type, security settings, etc. Does not match, for example, connection ID or UUID. | |
ignore the connection's ID | |
ignore all secrets | |
ignore secrets for which
the secret's flags indicate the secret is owned by a user secret agent
(ie, the secret's flag includes NM_SETTING_SECRET_FLAG_AGENT_OWNED )
|
|
ignore secrets for which
the secret's flags indicate the secret should not be saved to persistent
storage (ie, the secret's flag includes NM_SETTING_SECRET_FLAG_NOT_SAVED )
|
typedef enum { NM_SETTING_DIFF_RESULT_UNKNOWN = 0x00000000, NM_SETTING_DIFF_RESULT_IN_A = 0x00000001, NM_SETTING_DIFF_RESULT_IN_B = 0x00000002, } NMSettingDiffResult;
These values indicate the result of a setting difference operation.
typedef enum { NM_SETTING_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ NM_SETTING_ERROR_PROPERTY_NOT_FOUND, /*< nick=PropertyNotFound >*/ NM_SETTING_ERROR_PROPERTY_NOT_SECRET, /*< nick=PropertyNotSecret >*/ NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH /*< nick=PropertyTypeMismatch >*/ } NMSettingError;
Describes errors that may result from operations involving a NMSetting.
unknown or unclassified error | |
a property required by the operation was not found; for example, an attempt to update an invalid secret | |
an operation which requires a secret was attempted on a non-secret property | |
the operation requires a property of a specific type, or the value couldn't be transformed to the same type as the property being acted upon |
typedef enum { NM_SETTING_HASH_FLAG_ALL = 0x00000000, NM_SETTING_HASH_FLAG_NO_SECRETS = 0x00000001, NM_SETTING_HASH_FLAG_ONLY_SECRETS = 0x00000002, } NMSettingHashFlags;
These flags determine which properties are added to the resulting hash
when calling nm_setting_to_hash()
.
typedef enum { NM_SETTING_SECRET_FLAG_NONE = 0x00000000, NM_SETTING_SECRET_FLAG_AGENT_OWNED = 0x00000001, NM_SETTING_SECRET_FLAG_NOT_SAVED = 0x00000002, NM_SETTING_SECRET_FLAG_NOT_REQUIRED = 0x00000004 /* NOTE: if adding flags, update nm-setting-private.h as well */ } NMSettingSecretFlags;
These flags indicate specific behavior related to handling of a secret. Each secret has a corresponding set of these flags which indicate how the secret is to be stored and/or requested when it is needed.
the system is responsible for providing and storing this secret (default) | |
a user secret agent is responsible for providing and storing this secret; when it is required agents will be asked to retrieve it | |
this secret should not be saved, but should be requested from the user each time it is needed | |
in situations where it cannot be automatically determined that the secret is required (some VPNs and PPP providers dont require all secrets) this flag indicates that the specific secret is not required |
void (*NMSettingValueIterFn) (NMSetting *setting
,const char *key
,const GValue *value
,GParamFlags flags
,gpointer user_data
);
|
The setting for which properties are being iterated, given to
nm_setting_enumerate_values()
|
|
The value/property name |
|
The property's value |
|
The property's flags, like NM_SETTING_PARAM_SECRET
|
|
User data passed to nm_setting_enumerate_values()
|
void nm_setting_clear_secrets (NMSetting *setting
);
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.
|
the NMSetting |
void nm_setting_clear_secrets_with_flags (NMSetting *setting
,NMSettingClearSecretsWithFlagsFn func
,gpointer user_data
);
Clears and frees secrets determined by func
.
|
the NMSetting |
|
function to be called to determine whether a specific secret should be cleared or not. [scope call] |
|
caller-supplied data passed to func
|
gboolean nm_setting_compare (NMSetting *a
,NMSetting *b
,NMSettingCompareFlags flags
);
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.
|
a NMSetting |
|
a second NMSetting to compare with the first |
|
compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT
|
Returns : |
TRUE if the comparison succeeds, FALSE if it does not |
gboolean nm_setting_diff (NMSetting *a
,NMSetting *b
,NMSettingCompareFlags flags
,gboolean invert_results
,GHashTable **results
);
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.
|
a NMSetting |
|
a second NMSetting to compare with the first |
|
compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT
|
|
this parameter is used internally by libnm-util and should
be set to FALSE . If TRUE inverts the meaning of the NMSettingDiffResult. |
|
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. [inout][transfer full][element-type utf8 guint32]
|
Returns : |
TRUE if the settings contain the same values, FALSE if they do not |
NMSetting * nm_setting_duplicate (NMSetting *setting
);
Duplicates a NMSetting.
void nm_setting_enumerate_values (NMSetting *setting
,NMSettingValueIterFn func
,gpointer user_data
);
Iterates over each property of the NMSetting object, calling the supplied user function for each property.
|
the NMSetting |
|
user-supplied function called for each property of the setting. [scope call] |
|
user data passed to func at each invocation |
GQuark nm_setting_error_quark (void
);
Registers an error quark for NMSetting if necessary.
Returns : |
the error quark used for NMSetting errors. |
const char * nm_setting_get_name (NMSetting *setting
);
Returns the type name of the NMSetting object
gboolean nm_setting_get_secret_flags (NMSetting *setting
,const char *secret_name
,NMSettingSecretFlags *out_flags
,GError **error
);
For a given secret, retrieves the NMSettingSecretFlags describing how to handle that secret.
|
the NMSetting |
|
the secret key name to get flags for |
|
on success, the NMSettingSecretFlags for the secret |
|
location to store error, or NULL
|
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 |
const char * nm_setting_get_virtual_iface_name (NMSetting *setting
);
Returns the name of the virtual kernel interface which the connection needs to use if specified in the settings.
GPtrArray * nm_setting_need_secrets (NMSetting *setting
);
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.
|
the NMSetting |
Returns : |
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. [transfer container][element-type utf8]
|
NMSetting * nm_setting_new_from_hash (GType setting_type
,GHashTable *hash
);
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.
|
the NMSetting type which the hash contains properties for |
|
the GHashTable containing a string to GValue mapping of properties that apply to the setting. [element-type utf8 GObject.Value] |
Returns : |
a new NMSetting object populated with the properties from the
hash table, or NULL on failure |
gboolean nm_setting_set_secret_flags (NMSetting *setting
,const char *secret_name
,NMSettingSecretFlags flags
,GError **error
);
For a given secret, retrieves the NMSettingSecretFlags describing how to handle that secret.
|
the NMSetting |
|
the secret key name to set flags for |
|
the NMSettingSecretFlags for the secret |
|
location to store error, or NULL
|
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 |
GHashTable * nm_setting_to_hash (NMSetting *setting
,NMSettingHashFlags flags
);
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.
|
the NMSetting |
|
hash flags, e.g. NM_SETTING_HASH_FLAG_ALL
|
Returns : |
a new GHashTable describing the setting's properties. [transfer full][element-type utf8 GObject.Value] |
char * nm_setting_to_string (NMSetting *setting
);
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.
gboolean nm_setting_update_secrets (NMSetting *setting
,GHashTable *secrets
,GError **error
);
Update the setting's secrets, given a hash table of secrets intended for that setting (deserialized from D-Bus for example).
gboolean nm_setting_verify (NMSetting *setting
,GSList *all_settings
,GError **error
);
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.
"name"
property"name" gchar* : Read / Write
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'.
Default value: NULL