NMSetting8021x

@@ -37,3215 +31,3831 @@

NMSetting8021x

NMSetting8021x — Describes 802.1x-authenticated connection properties

- +

Synopsis

enum                NMSetting8021xCKFormat;
-enum                NMSetting8021xCKScheme;
-#define             NM_SETTING_802_1X_SETTING_NAME
-#define             NM_SETTING_802_1X_EAP
-#define             NM_SETTING_802_1X_IDENTITY
-#define             NM_SETTING_802_1X_ANONYMOUS_IDENTITY
-#define             NM_SETTING_802_1X_PAC_FILE
-#define             NM_SETTING_802_1X_CA_CERT
-#define             NM_SETTING_802_1X_CA_PATH
-#define             NM_SETTING_802_1X_SUBJECT_MATCH
-#define             NM_SETTING_802_1X_ALTSUBJECT_MATCHES
-#define             NM_SETTING_802_1X_CLIENT_CERT
-#define             NM_SETTING_802_1X_PHASE1_PEAPVER
-#define             NM_SETTING_802_1X_PHASE1_PEAPLABEL
-#define             NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING
-#define             NM_SETTING_802_1X_PHASE2_AUTH
-#define             NM_SETTING_802_1X_PHASE2_AUTHEAP
-#define             NM_SETTING_802_1X_PHASE2_CA_CERT
-#define             NM_SETTING_802_1X_PHASE2_CA_PATH
-#define             NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH
-#define             NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES
-#define             NM_SETTING_802_1X_PHASE2_CLIENT_CERT
-#define             NM_SETTING_802_1X_PASSWORD
-#define             NM_SETTING_802_1X_PASSWORD_FLAGS
-#define             NM_SETTING_802_1X_PASSWORD_RAW
-#define             NM_SETTING_802_1X_PASSWORD_RAW_FLAGS
-#define             NM_SETTING_802_1X_PRIVATE_KEY
-#define             NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD
-#define             NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS
-#define             NM_SETTING_802_1X_PHASE2_PRIVATE_KEY
-#define             NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD
-#define             NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS
-#define             NM_SETTING_802_1X_PIN
-#define             NM_SETTING_802_1X_PIN_FLAGS
-#define             NM_SETTING_802_1X_SYSTEM_CA_CERTS
-struct              NMSetting8021x;
-                    NMSetting8021xClass;
-NMSetting *         nm_setting_802_1x_new               (void);
-guint32             nm_setting_802_1x_get_num_eap_methods
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_eap_method    (NMSetting8021x *setting,
-                                                         guint32 i);
-gboolean            nm_setting_802_1x_add_eap_method    (NMSetting8021x *setting,
-                                                         const char *eap);
-void                nm_setting_802_1x_remove_eap_method (NMSetting8021x *setting,
-                                                         guint32 i);
-gboolean            nm_setting_802_1x_remove_eap_method_by_value
-                                                        (NMSetting8021x *setting,
-                                                         const char *eap);
-void                nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_identity      (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_anonymous_identity
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_pac_file      (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_get_system_ca_certs
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_ca_path       (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_ca_path
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_ca_cert_scheme
-                                                        (NMSetting8021x *setting);
-GBytes *            nm_setting_802_1x_get_ca_cert_blob  (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_ca_cert_path  (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_ca_cert       (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_subject_match (NMSetting8021x *setting);
-guint32             nm_setting_802_1x_get_num_altsubject_matches
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-gboolean            nm_setting_802_1x_add_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         const char *altsubject_match);
-void                nm_setting_802_1x_remove_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-gboolean            nm_setting_802_1x_remove_altsubject_match_by_value
-                                                        (NMSetting8021x *setting,
-                                                         const char *altsubject_match);
-void                nm_setting_802_1x_clear_altsubject_matches
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_client_cert_scheme
-                                                        (NMSetting8021x *setting);
-GBytes *            nm_setting_802_1x_get_client_cert_blob
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_client_cert_path
-                                                        (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_client_cert   (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_phase1_peapver
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase1_peaplabel
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase1_fast_provisioning
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_auth   (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_autheap
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_ca_cert_scheme
-                                                        (NMSetting8021x *setting);
-GBytes *            nm_setting_802_1x_get_phase2_ca_cert_blob
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_ca_cert_path
-                                                        (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_phase2_ca_cert
-                                                        (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_phase2_subject_match
-                                                        (NMSetting8021x *setting);
-guint32             nm_setting_802_1x_get_num_phase2_altsubject_matches
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-gboolean            nm_setting_802_1x_add_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         const char *phase2_altsubject_match);
-void                nm_setting_802_1x_remove_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-gboolean            nm_setting_802_1x_remove_phase2_altsubject_match_by_value
-                                                        (NMSetting8021x *setting,
-                                                         const char *phase2_altsubject_match);
-void                nm_setting_802_1x_clear_phase2_altsubject_matches
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_client_cert_scheme
-                                                        (NMSetting8021x *setting);
-GBytes *            nm_setting_802_1x_get_phase2_client_cert_blob
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_client_cert_path
-                                                        (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_phase2_client_cert
-                                                        (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_password      (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_password_flags
-                                                        (NMSetting8021x *setting);
-GBytes *            nm_setting_802_1x_get_password_raw  (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_password_raw_flags
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_pin           (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_pin_flags    (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_private_key_scheme
-                                                        (NMSetting8021x *setting);
-GBytes *            nm_setting_802_1x_get_private_key_blob
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_private_key_path
-                                                        (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_private_key   (NMSetting8021x *setting,
-                                                         const char *key_path,
-                                                         const char *password,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_private_key_password
-                                                        (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_private_key_password_flags
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKFormat nm_setting_802_1x_get_private_key_format
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_private_key_scheme
-                                                        (NMSetting8021x *setting);
-GBytes *            nm_setting_802_1x_get_phase2_private_key_blob
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_private_key_path
-                                                        (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_set_phase2_private_key
-                                                        (NMSetting8021x *setting,
-                                                         const char *key_path,
-                                                         const char *password,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-const char *        nm_setting_802_1x_get_phase2_private_key_password
-                                                        (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_phase2_private_key_password_flags
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKFormat nm_setting_802_1x_get_phase2_private_key_format
-                                                        (NMSetting8021x *setting);
-

Object Hierarchy

-  GEnum
-   +----NMSetting8021xCKFormat
-

-  GEnum
-   +----NMSetting8021xCKScheme
-

-  GObject
-   +----NMSetting
-         +----NMSetting8021x
-

Properties

-  "altsubject-matches"       GStrv                 : Read / Write
-  "anonymous-identity"       gchar*                : Read / Write
-  "ca-cert"                  GBytes*               : Read / Write
-  "ca-path"                  gchar*                : Read / Write
-  "client-cert"              GBytes*               : Read / Write
-  "eap"                      GStrv                 : Read / Write
-  "identity"                 gchar*                : Read / Write
-  "pac-file"                 gchar*                : Read / Write
-  "password"                 gchar*                : Read / Write
-  "password-flags"           NMSettingSecretFlags  : Read / Write
-  "password-raw"             GBytes*               : Read / Write
-  "password-raw-flags"       NMSettingSecretFlags  : Read / Write
-  "phase1-fast-provisioning" gchar*                : Read / Write
-  "phase1-peaplabel"         gchar*                : Read / Write
-  "phase1-peapver"           gchar*                : Read / Write
-  "phase2-altsubject-matches" GStrv                 : Read / Write
-  "phase2-auth"              gchar*                : Read / Write
-  "phase2-autheap"           gchar*                : Read / Write
-  "phase2-ca-cert"           GBytes*               : Read / Write
-  "phase2-ca-path"           gchar*                : Read / Write
-  "phase2-client-cert"       GBytes*               : Read / Write
-  "phase2-private-key"       GBytes*               : Read / Write
-  "phase2-private-key-password" gchar*                : Read / Write
-  "phase2-private-key-password-flags" NMSettingSecretFlags  : Read / Write
-  "phase2-subject-match"     gchar*                : Read / Write
-  "pin"                      gchar*                : Read / Write
-  "pin-flags"                NMSettingSecretFlags  : Read / Write
-  "private-key"              GBytes*               : Read / Write
-  "private-key-password"     gchar*                : Read / Write
-  "private-key-password-flags" NMSettingSecretFlags  : Read / Write
-  "subject-match"            gchar*                : Read / Write
-  "system-ca-certs"          gboolean              : Read / Write / Construct
-

Description

-The NMSetting8021x object is a NMSetting subclass that describes -properties necessary for connection to 802.1x-authenticated networks, such as -WPA and WPA2 Enterprise Wi-Fi networks and wired 802.1x networks. 802.1x -connections typically use certificates and/or EAP authentication methods to -securely verify, identify, and authenticate the client to the network itself, -instead of simply relying on a widely shared static key. -

-It's a good idea to read up on wpa_supplicant configuration before using this -setting extensively, since most of the options here correspond closely with -the relevant wpa_supplicant configuration options. -

-Furthermore, to get a good idea of 802.1x, EAP, TLS, TTLS, etc and their -applications to Wi-Fi and wired networks, you'll want to get copies of the -following books. -

- 802.11 Wireless Networks: The Definitive Guide, Second Edition - Author: Matthew Gast - ISBN: 978-0596100520 -

- Cisco Wireless LAN Security - Authors: Krishna Sankar, Sri Sundaralingam, Darrin Miller, and Andrew Balinsky - ISBN: 978-1587051548 -

Details

enum NMSetting8021xCKFormat

typedef enum {
- /*< underscore_name=nm_setting_802_1x_ck_format >*/
-	NM_SETTING_802_1X_CK_FORMAT_UNKNOWN = 0,
-	NM_SETTING_802_1X_CK_FORMAT_X509,
-	NM_SETTING_802_1X_CK_FORMAT_RAW_KEY,
-	NM_SETTING_802_1X_CK_FORMAT_PKCS12
-} NMSetting8021xCKFormat;
-

-NMSetting8021xCKFormat values indicate the general type of a certificate -or private key -

Functions

--++ - - + - - + - - + - - + - -

`NM_SETTING_802_1X_CK_FORMAT_UNKNOWN`	unknown file format +	+NMSetting * +	+nm_setting_802_1x_new ()
`NM_SETTING_802_1X_CK_FORMAT_X509`	file contains an X.509 format certificate +	+guint32 +	+nm_setting_802_1x_get_num_eap_methods ()
`NM_SETTING_802_1X_CK_FORMAT_RAW_KEY`	file contains an old-style OpenSSL PEM -or DER private key +	const char * +	+nm_setting_802_1x_get_eap_method ()
`NM_SETTING_802_1X_CK_FORMAT_PKCS12`	file contains a PKCS#12 certificate -and private key +	+gboolean +	+nm_setting_802_1x_add_eap_method ()

enum NMSetting8021xCKScheme

typedef enum {
- /*< underscore_name=nm_setting_802_1x_ck_scheme >*/
-	NM_SETTING_802_1X_CK_SCHEME_UNKNOWN = 0,
-	NM_SETTING_802_1X_CK_SCHEME_BLOB,
-	NM_SETTING_802_1X_CK_SCHEME_PATH
-} NMSetting8021xCKScheme;
-

-NMSetting8021xCKScheme values indicate how a certificate or private key is -stored in the setting properties, either as a blob of the item's data, or as -a path to a certificate or private key file on the filesystem -

---- - - - + - - + - - + - -

`NM_SETTING_802_1X_CK_SCHEME_UNKNOWN`	unknown certificate or private key -scheme +	+void +	+nm_setting_802_1x_remove_eap_method ()
`NM_SETTING_802_1X_CK_SCHEME_BLOB`	certificate or key is stored as the raw -item data +	+gboolean +	+nm_setting_802_1x_remove_eap_method_by_value ()
`NM_SETTING_802_1X_CK_SCHEME_PATH`	certificate or key is stored as a path -to a file containing the certificate or key data +	+void +	+nm_setting_802_1x_clear_eap_methods ()

NM_SETTING_802_1X_SETTING_NAME

#define NM_SETTING_802_1X_SETTING_NAME "802-1x"
-

NM_SETTING_802_1X_EAP

#define NM_SETTING_802_1X_EAP "eap"
-

NM_SETTING_802_1X_IDENTITY

#define NM_SETTING_802_1X_IDENTITY "identity"
-

NM_SETTING_802_1X_ANONYMOUS_IDENTITY

#define NM_SETTING_802_1X_ANONYMOUS_IDENTITY "anonymous-identity"
-

NM_SETTING_802_1X_PAC_FILE

#define NM_SETTING_802_1X_PAC_FILE "pac-file"
-

NM_SETTING_802_1X_CA_CERT

#define NM_SETTING_802_1X_CA_CERT "ca-cert"
-

NM_SETTING_802_1X_CA_PATH

#define NM_SETTING_802_1X_CA_PATH "ca-path"
-

NM_SETTING_802_1X_SUBJECT_MATCH

#define NM_SETTING_802_1X_SUBJECT_MATCH "subject-match"
-

NM_SETTING_802_1X_ALTSUBJECT_MATCHES

#define NM_SETTING_802_1X_ALTSUBJECT_MATCHES "altsubject-matches"
-

NM_SETTING_802_1X_CLIENT_CERT

#define NM_SETTING_802_1X_CLIENT_CERT "client-cert"
-

NM_SETTING_802_1X_PHASE1_PEAPVER

#define NM_SETTING_802_1X_PHASE1_PEAPVER "phase1-peapver"
-

NM_SETTING_802_1X_PHASE1_PEAPLABEL

#define NM_SETTING_802_1X_PHASE1_PEAPLABEL "phase1-peaplabel"
-

NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING

#define NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING "phase1-fast-provisioning"
-

NM_SETTING_802_1X_PHASE2_AUTH

#define NM_SETTING_802_1X_PHASE2_AUTH "phase2-auth"
-

NM_SETTING_802_1X_PHASE2_AUTHEAP

#define NM_SETTING_802_1X_PHASE2_AUTHEAP "phase2-autheap"
-

NM_SETTING_802_1X_PHASE2_CA_CERT

#define NM_SETTING_802_1X_PHASE2_CA_CERT "phase2-ca-cert"
-

NM_SETTING_802_1X_PHASE2_CA_PATH

#define NM_SETTING_802_1X_PHASE2_CA_PATH "phase2-ca-path"
-

NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH

#define NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH "phase2-subject-match"
-

NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES

#define NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES "phase2-altsubject-matches"
-

NM_SETTING_802_1X_PHASE2_CLIENT_CERT

#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT "phase2-client-cert"
-

NM_SETTING_802_1X_PASSWORD

#define NM_SETTING_802_1X_PASSWORD "password"
-

NM_SETTING_802_1X_PASSWORD_FLAGS

#define NM_SETTING_802_1X_PASSWORD_FLAGS "password-flags"
-

NM_SETTING_802_1X_PASSWORD_RAW

#define NM_SETTING_802_1X_PASSWORD_RAW "password-raw"
-

NM_SETTING_802_1X_PASSWORD_RAW_FLAGS

#define NM_SETTING_802_1X_PASSWORD_RAW_FLAGS "password-raw-flags"
-

NM_SETTING_802_1X_PRIVATE_KEY

#define NM_SETTING_802_1X_PRIVATE_KEY "private-key"
-

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD

#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD "private-key-password"
-

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS

#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS "private-key-password-flags"
-

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY

#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY "phase2-private-key"
-

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD

#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD "phase2-private-key-password"
-

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS

#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS "phase2-private-key-password-flags"
-

NM_SETTING_802_1X_PIN

#define NM_SETTING_802_1X_PIN "pin"
-

Properties

+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

GStrv	altsubject-matches	Read / Write
+gchar *	anonymous-identity	Read / Write
+GBytes *	ca-cert	Read / Write
+gchar *	ca-path	Read / Write
+GBytes *	client-cert	Read / Write
GStrv	eap	Read / Write
+gchar *	identity	Read / Write
+gchar *	pac-file	Read / Write
+gchar *	password	Read / Write
NMSettingSecretFlags	password-flags	Read / Write
+GBytes *	password-raw	Read / Write
NMSettingSecretFlags	password-raw-flags	Read / Write
+gchar *	phase1-fast-provisioning	Read / Write
+gchar *	phase1-peaplabel	Read / Write
+gchar *	phase1-peapver	Read / Write
GStrv	phase2-altsubject-matches	Read / Write
+gchar *	phase2-auth	Read / Write
+gchar *	phase2-autheap	Read / Write
+GBytes *	phase2-ca-cert	Read / Write
+gchar *	phase2-ca-path	Read / Write
+GBytes *	phase2-client-cert	Read / Write
+GBytes *	phase2-private-key	Read / Write
+gchar *	phase2-private-key-password	Read / Write
NMSettingSecretFlags	phase2-private-key-password-flags	Read / Write
+gchar *	phase2-subject-match	Read / Write
+gchar *	pin	Read / Write
NMSettingSecretFlags	pin-flags	Read / Write
+GBytes *	private-key	Read / Write
+gchar *	private-key-password	Read / Write
NMSettingSecretFlags	private-key-password-flags	Read / Write
+gchar *	subject-match	Read / Write
gboolean	system-ca-certs	Read / Write / Construct

NM_SETTING_802_1X_PIN_FLAGS

#define NM_SETTING_802_1X_PIN_FLAGS "pin-flags"
-

Types and Values

++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

enum	NMSetting8021xCKFormat
enum	NMSetting8021xCKScheme
#define	NM_SETTING_802_1X_SETTING_NAME
#define	NM_SETTING_802_1X_EAP
#define	NM_SETTING_802_1X_IDENTITY
#define	NM_SETTING_802_1X_ANONYMOUS_IDENTITY
#define	NM_SETTING_802_1X_PAC_FILE
#define	NM_SETTING_802_1X_CA_CERT
#define	NM_SETTING_802_1X_CA_PATH
#define	NM_SETTING_802_1X_SUBJECT_MATCH
#define	NM_SETTING_802_1X_ALTSUBJECT_MATCHES
#define	NM_SETTING_802_1X_CLIENT_CERT
#define	NM_SETTING_802_1X_PHASE1_PEAPVER
#define	NM_SETTING_802_1X_PHASE1_PEAPLABEL
#define	NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING
#define	NM_SETTING_802_1X_PHASE2_AUTH
#define	NM_SETTING_802_1X_PHASE2_AUTHEAP
#define	NM_SETTING_802_1X_PHASE2_CA_CERT
#define	NM_SETTING_802_1X_PHASE2_CA_PATH
#define	NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH
#define	NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES
#define	NM_SETTING_802_1X_PHASE2_CLIENT_CERT
#define	NM_SETTING_802_1X_PASSWORD
#define	NM_SETTING_802_1X_PASSWORD_FLAGS
#define	NM_SETTING_802_1X_PASSWORD_RAW
#define	NM_SETTING_802_1X_PASSWORD_RAW_FLAGS
#define	NM_SETTING_802_1X_PRIVATE_KEY
#define	NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD
#define	NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS
#define	NM_SETTING_802_1X_PHASE2_PRIVATE_KEY
#define	NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD
#define	NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS
#define	NM_SETTING_802_1X_PIN
#define	NM_SETTING_802_1X_PIN_FLAGS
#define	NM_SETTING_802_1X_SYSTEM_CA_CERTS

NM_SETTING_802_1X_SYSTEM_CA_CERTS

#define NM_SETTING_802_1X_SYSTEM_CA_CERTS "system-ca-certs"
+
+Object Hierarchy
+    GEnum
+    ├── NMSetting8021xCKFormat
+    ╰── NMSetting8021xCKScheme
+    GObject
+    ╰── NMSetting
+        ╰── NMSetting8021x
 
-
-
 
-
-
-struct NMSetting8021x
-struct NMSetting8021x;
-
-
+
+Description
+The NMSetting8021x object is a NMSetting subclass that describes
+properties necessary for connection to 802.1x-authenticated networks, such as
+WPA and WPA2 Enterprise Wi-Fi networks and wired 802.1x networks.  802.1x
+connections typically use certificates and/or EAP authentication methods to
+securely verify, identify, and authenticate the client to the network itself,
+instead of simply relying on a widely shared static key.
+It's a good idea to read up on wpa_supplicant configuration before using this
+setting extensively, since most of the options here correspond closely with
+the relevant wpa_supplicant configuration options.
+Furthermore, to get a good idea of 802.1x, EAP, TLS, TTLS, etc and their
+applications to Wi-Fi and wired networks, you'll want to get copies of the
+following books.
+ 802.11 Wireless Networks: The Definitive Guide, Second Edition
+      Author: Matthew Gast
+      ISBN: 978-0596100520
+ Cisco Wireless LAN Security
+      Authors: Krishna Sankar, Sri Sundaralingam, Darrin Miller, and Andrew Balinsky
+      ISBN: 978-1587051548
 
-
+
+Functions
 
-NMSetting8021xClass
-typedef struct {
-	NMSettingClass parent;
-} NMSetting8021xClass;
-
-
-
+nm_setting_802_1x_new ()
+NMSetting *
+nm_setting_802_1x_new (void);
+Creates a new NMSetting8021x object with default values.
+
+Returns
+ the new empty NMSetting8021x object
+
+
 
 
 
-nm_setting_802_1x_new ()
-NMSetting *         nm_setting_802_1x_new               (void);
-
-Creates a new NMSetting8021x object with default values.
-
-
+nm_setting_802_1x_get_num_eap_methods ()
+guint32
+nm_setting_802_1x_get_num_eap_methods (NMSetting8021x *setting);
+Returns the number of eap methods allowed for use when connecting to the
+network.  Generally only one EAP method is used.  Use the functions
+nm_setting_802_1x_get_eap_method(), nm_setting_802_1x_add_eap_method(),
+and nm_setting_802_1x_remove_eap_method() for adding, removing, and retrieving
+allowed EAP methods.
+
+Parameters
+
--+++
-
-
+
+
+
 





 
 Returns : the new empty NMSetting8021x object setting the NMSetting8021x  
 
 
 
+
+Returns
+ the number of allowed EAP methods
+
+
+
 
 
-nm_setting_802_1x_get_num_eap_methods ()
-guint32             nm_setting_802_1x_get_num_eap_methods
-                                                        (NMSetting8021x *setting);
-
-Returns the number of eap methods allowed for use when connecting to the
-network.  Generally only one EAP method is used.  Use the functions
-nm_setting_802_1x_get_eap_method(), nm_setting_802_1x_add_eap_method(),
-and nm_setting_802_1x_remove_eap_method() for adding, removing, and retrieving
-allowed EAP methods.
-
-
+nm_setting_802_1x_get_eap_method ()
+const char *
+nm_setting_802_1x_get_eap_method (NMSetting8021x *setting,
+                                  guint32 i);
+Returns the name of the allowed EAP method at index i
+.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+
+
 





 
 
 setting : the NMSetting8021x
- setting the NMSetting8021x  
 
 Returns : the number of allowed EAP methods i the index of the EAP method name to return  
 
 
 
 
-
-
-nm_setting_802_1x_get_eap_method ()
-const char *        nm_setting_802_1x_get_eap_method    (NMSetting8021x *setting,
-                                                         guint32 i);
-
-Returns the name of the allowed EAP method at index i.
+

+Returns
+ the name of the allowed EAP method at index i
 
-
----
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-


setting : the NMSetting8021x
-
i : the index of the EAP method name to return
Returns : the name of the allowed EAP method at index i
-
+
+
 
 
 
-nm_setting_802_1x_add_eap_method ()
-gboolean            nm_setting_802_1x_add_eap_method    (NMSetting8021x *setting,
-                                                         const char *eap);
-
-Adds an allowed EAP method.  The setting is not valid until at least one
-EAP method has been added.  See "eap" property for a list of
-allowed EAP methods.
-
-
+nm_setting_802_1x_add_eap_method ()
+gboolean
+nm_setting_802_1x_add_eap_method (NMSetting8021x *setting,
+                                  const char *eap);
+Adds an allowed EAP method.  The setting is not valid until at least one
+EAP method has been added.  See “eap” property for a list of
+allowed EAP methods.
+
+Parameters
+
--+++
-
-
-
-
-
-
+
+
+
-
-
+
+
+
 





 
 
 setting : the NMSetting8021x
-
eap : the name of the EAP method to allow for this connection setting the NMSetting8021x  
 
 Returns : 
-TRUE if the EAP method was successfully added, FALSE if it was
-not a valid method or if it was already allowed. eap the name of the EAP method to allow for this connection  
 
 
 
 
+
+Returns
+ TRUE if the EAP method was successfully added, FALSE if it was
+not a valid method or if it was already allowed.
+
+
+
 
 
-nm_setting_802_1x_remove_eap_method ()
-void                nm_setting_802_1x_remove_eap_method (NMSetting8021x *setting,
-                                                         guint32 i);
-
-Removes the allowed EAP method at the specified index.
-
-
+nm_setting_802_1x_remove_eap_method ()
+void
+nm_setting_802_1x_remove_eap_method (NMSetting8021x *setting,
+                                     guint32 i);
+Removes the allowed EAP method at the specified index.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+
+
 





 
 
 setting : the NMSetting8021x
- setting the NMSetting8021x  
 
 i : the index of the EAP method to remove i the index of the EAP method to remove  
 
 
 
 
+

nm_setting_802_1x_remove_eap_method_by_value ()

gboolean            nm_setting_802_1x_remove_eap_method_by_value
-                                                        (NMSetting8021x *setting,
-                                                         const char *eap);

-Removes the allowed EAP method method. -

nm_setting_802_1x_remove_eap_method_by_value ()

gboolean
+nm_setting_802_1x_remove_eap_method_by_value
+                               (NMSetting8021x *setting,
+                                const char *eap);

Removes the allowed EAP method method +.

Parameters

--+++ - - - - - - + + + - - + + +

`setting` :	the NMSetting8021x -
`eap` :	the name of the EAP method to remove	setting	the NMSetting8021x
Returns :	-`TRUE` if the EAP method was founs and removed, `FALSE` if it was not.	eap	the name of the EAP method to remove

Returns

TRUE if the EAP method was founs and removed, FALSE if it was not.

nm_setting_802_1x_clear_eap_methods ()

void                nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);

-Clears all allowed EAP methods. -

nm_setting_802_1x_clear_eap_methods ()

void
+nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);

Clears all allowed EAP methods.

Parameters

--+++ - - + + +

setting :

the NMSetting8021x -

setting

the NMSetting8021x

nm_setting_802_1x_get_identity ()

const char *        nm_setting_802_1x_get_identity      (NMSetting8021x *setting);

-Returns the identifier used by some EAP methods (like TLS) to -authenticate the user. Often this is a username or login name. -

nm_setting_802_1x_get_identity ()

const char *
+nm_setting_802_1x_get_identity (NMSetting8021x *setting);

Returns the identifier used by some EAP methods (like TLS) to +authenticate the user. Often this is a username or login name.

Parameters

--+++ - - - - - - - - - - + + + + +

`setting` :	the NMSetting8021x -
Returns :	the user identifier
setting	the NMSetting8021x

Returns

the user identifier

nm_setting_802_1x_set_phase2_private_key ()

gboolean            nm_setting_802_1x_set_phase2_private_key
-                                                        (NMSetting8021x *setting,
-                                                         const char *key_path,
-                                                         const char *password,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);

-Private keys are used to authenticate the connecting client to the network +

nm_setting_802_1x_set_phase2_private_key ()

gboolean
+nm_setting_802_1x_set_phase2_private_key
+                               (NMSetting8021x *setting,
+                                const char *key_path,
+                                const char *password,
+                                NMSetting8021xCKScheme scheme,
+                                NMSetting8021xCKFormat *out_format,
+                                GError **error);

Private keys are used to authenticate the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. -

-This function reads a private key from disk and sets the -"phase2-private-key" property with the private key file data if +authentication method.

This function reads a private key from disk and sets the +“phase2-private-key” property with the private key file data if using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the -private key file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. -

-If password is given, this function attempts to decrypt the private key to -verify that password is correct, and if it is, updates the -"phase2-private-key-password" property with the given -password. If the decryption is unsuccessful, FALSE is returned, error is -set, and no internal data is changed. If no password is given, the private +private key file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

If password + is given, this function attempts to decrypt the private key to +verify that password + is correct, and if it is, updates the +“phase2-private-key-password” property with the given +password +. If the decryption is unsuccessful, FALSE is returned, error + is +set, and no internal data is changed. If no password + is given, the private key is assumed to be valid, no decryption is performed, and the password may -be set at a later time. -

-WARNING: the "phase2" private key property is not a "secret" property, and +be set at a later time.

WARNING: the "phase2" private key property is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private -key password to prevent unauthorized access to unencrypted private key data. -

+key password to prevent unauthorized access to unencrypted private key data.

Parameters

--+++ - - + + + - - + +use g_filename_to_utf8() to convert if needed. Passing NULL with any +scheme +clears the private key.

+ - - + - - - - +an error is returned.

+ - - + + + - - + + + - - + + +

`setting` :	the NMSetting8021x -	setting	the NMSetting8021x
`key_path` :	when `scheme` is set to either `NM_SETTING_802_1X_CK_SCHEME_PATH` or +	key_path	when `scheme` +is set to either `NM_SETTING_802_1X_CK_SCHEME_PATH` or `NM_SETTING_802_1X_CK_SCHEME_BLOB`, pass the path of the "phase2" private key file (PEM, DER, or PKCS#12 format). The path must be UTF-8 encoded; -use `g_filename_to_utf8()` to convert if needed. Passing `NULL` with any -`scheme` clears the private key.
`password` :	password used to decrypt the private key, or `NULL` if the password +	password	password used to decrypt the private key, or `NULL` if the password is unknown. If the password is given but fails to decrypt the private key, -an error is returned.
`scheme` :	desired storage scheme for the private key
`out_format` :	on successful return, the type of the private key added	scheme	desired storage scheme for the private key
`error` :	on unsuccessful return, an error	out_format	on successful return, the type of the private key added
Returns :	-`TRUE` if the operation succeeded, `FALSE` if it was unsuccessful	error	on unsuccessful return, an error

Property Details

The `"altsubject-matches"` property

  "altsubject-matches"       GStrv                 : Read / Write

NM_SETTING_802_1X_SETTING_NAME

#define NM_SETTING_802_1X_SETTING_NAME "802-1x"
+

-List of strings to be matched against the altSubjectName of the -certificate presented by the authentication server. If the list is empty, -no verification of the server certificate's altSubjectName is performed.

The `"anonymous-identity"` property

  "anonymous-identity"       gchar*                : Read / Write

NM_SETTING_802_1X_EAP

#define NM_SETTING_802_1X_EAP "eap"
+

-Anonymous identity string for EAP authentication methods. Used as the -unencrypted identity with EAP types that support different tunneled -identity like EAP-TTLS.

Default value: NULL

The `"ca-cert"` property

  "ca-cert"                  GBytes*               : Read / Write

NM_SETTING_802_1X_IDENTITY

#define NM_SETTING_802_1X_IDENTITY "identity"
+

-Contains the CA certificate if used by the EAP method specified in the -"eap" property.

NM_SETTING_802_1X_ANONYMOUS_IDENTITY

#define NM_SETTING_802_1X_ANONYMOUS_IDENTITY "anonymous-identity"
+

-Certificate data is specified using a "scheme"; two are currently -supported: blob and path. When using the blob scheme (which is backwards -compatible with NM 0.7.x) this property should be set to the -certificate's DER encoded data. When using the path scheme, this property -should be set to the full UTF-8 encoded path of the certificate, prefixed -with the string "file://" and ending with a terminating NUL byte. This -property can be unset even if the EAP method supports CA certificates, -but this allows man-in-the-middle attacks and is NOT recommended.

NM_SETTING_802_1X_PAC_FILE

#define NM_SETTING_802_1X_PAC_FILE "pac-file"
+

-Setting this property directly is discouraged; use the -nm_setting_802_1x_set_ca_cert() function instead.

The `"ca-path"` property

  "ca-path"                  gchar*                : Read / Write

NM_SETTING_802_1X_CA_CERT

#define NM_SETTING_802_1X_CA_CERT "ca-cert"
+

-UTF-8 encoded path to a directory containing PEM or DER formatted -certificates to be added to the verification chain in addition to the -certificate specified in the "ca-cert" property.

Default value: NULL

The `"client-cert"` property

  "client-cert"              GBytes*               : Read / Write

NM_SETTING_802_1X_CA_PATH

#define NM_SETTING_802_1X_CA_PATH "ca-path"
+

-Contains the client certificate if used by the EAP method specified in -the "eap" property.

NM_SETTING_802_1X_SUBJECT_MATCH

#define NM_SETTING_802_1X_SUBJECT_MATCH "subject-match"
+

NM_SETTING_802_1X_ALTSUBJECT_MATCHES

#define NM_SETTING_802_1X_ALTSUBJECT_MATCHES "altsubject-matches"
+

-Setting this property directly is discouraged; use the -nm_setting_802_1x_set_client_cert() function instead.

The `"eap"` property

  "eap"                      GStrv                 : Read / Write

NM_SETTING_802_1X_CLIENT_CERT

#define NM_SETTING_802_1X_CLIENT_CERT "client-cert"
+

-The allowed EAP method to be used when authenticating to the network with -802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", -and "fast". Each method requires different configuration using the -properties of this setting; refer to wpa_supplicant documentation for the -allowed combinations.

The `"identity"` property

  "identity"                 gchar*                : Read / Write

NM_SETTING_802_1X_PHASE1_PEAPVER

#define NM_SETTING_802_1X_PHASE1_PEAPVER "phase1-peapver"
+

-Identity string for EAP authentication methods. Often the user's user or -login name.

Default value: NULL

The `"pac-file"` property

  "pac-file"                 gchar*                : Read / Write

NM_SETTING_802_1X_PHASE1_PEAPLABEL

#define NM_SETTING_802_1X_PHASE1_PEAPLABEL "phase1-peaplabel"
+

-UTF-8 encoded file path containing PAC for EAP-FAST.

Default value: NULL

The `"password"` property

  "password"                 gchar*                : Read / Write

NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING

#define NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING "phase1-fast-provisioning"
+

-UTF-8 encoded password used for EAP authentication methods. If both the -"password" property and the "password-raw" -property are specified, "password" is preferred.

Default value: NULL

The `"password-flags"` property

  "password-flags"           NMSettingSecretFlags  : Read / Write

NM_SETTING_802_1X_PHASE2_AUTH

#define NM_SETTING_802_1X_PHASE2_AUTH "phase2-auth"
+

-Flags indicating how to handle the "password" property.

The `"password-raw"` property

  "password-raw"             GBytes*               : Read / Write

NM_SETTING_802_1X_PHASE2_AUTHEAP

#define NM_SETTING_802_1X_PHASE2_AUTHEAP "phase2-autheap"
+

-Password used for EAP authentication methods, given as a byte array to -allow passwords in other encodings than UTF-8 to be used. If both the -"password" property and the "password-raw" -property are specified, "password" is preferred.

The `"password-raw-flags"` property

  "password-raw-flags"       NMSettingSecretFlags  : Read / Write

NM_SETTING_802_1X_PHASE2_CA_CERT

#define NM_SETTING_802_1X_PHASE2_CA_CERT "phase2-ca-cert"
+

-Flags indicating how to handle the "password-raw" property.

The `"phase1-fast-provisioning"` property

  "phase1-fast-provisioning" gchar*                : Read / Write

NM_SETTING_802_1X_PHASE2_CA_PATH

#define NM_SETTING_802_1X_PHASE2_CA_PATH "phase2-ca-path"
+

-Enables or disables in-line provisioning of EAP-FAST credentials when -FAST is specified as the EAP method in the "eap" property. -Recognized values are "0" (disabled), "1" (allow unauthenticated -provisioning), "2" (allow authenticated provisioning), and "3" (allow -both authenticated and unauthenticated provisioning). See the -wpa_supplicant documentation for more details.

Default value: NULL

The `"phase1-peaplabel"` property

  "phase1-peaplabel"         gchar*                : Read / Write

NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH

#define NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH "phase2-subject-match"
+

-Forces use of the new PEAP label during key derivation. Some RADIUS -servers may require forcing the new PEAP label to interoperate with -PEAPv1. Set to "1" to force use of the new PEAP label. See the -wpa_supplicant documentation for more details.

Default value: NULL

The `"phase1-peapver"` property

  "phase1-peapver"           gchar*                : Read / Write

NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES

#define NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES "phase2-altsubject-matches"
+

-Forces which PEAP version is used when PEAP is set as the EAP method in -the "eap" property. When unset, the version reported by -the server will be used. Sometimes when using older RADIUS servers, it -is necessary to force the client to use a particular PEAP version. To do -so, this property may be set to "0" or "1" to force that specific PEAP -version.

Default value: NULL

The `"phase2-altsubject-matches"` property

  "phase2-altsubject-matches" GStrv                 : Read / Write

NM_SETTING_802_1X_PHASE2_CLIENT_CERT

#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT "phase2-client-cert"
+

-List of strings to be matched against the altSubjectName of the -certificate presented by the authentication server during the inner -"phase 2" authentication. If the list is empty, no verification of the -server certificate's altSubjectName is performed.

The `"phase2-auth"` property

  "phase2-auth"              gchar*                : Read / Write

NM_SETTING_802_1X_PASSWORD

#define NM_SETTING_802_1X_PASSWORD "password"
+

-Specifies the allowed "phase 2" inner non-EAP authentication methods when -an EAP method that uses an inner TLS tunnel is specified in the -"eap" property. Recognized non-EAP "phase 2" methods are -"pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". -Each "phase 2" inner method requires specific parameters for successful -authentication; see the wpa_supplicant documentation for more details.

Default value: NULL

The `"phase2-autheap"` property

  "phase2-autheap"           gchar*                : Read / Write

NM_SETTING_802_1X_PASSWORD_FLAGS

#define NM_SETTING_802_1X_PASSWORD_FLAGS "password-flags"
+

-Specifies the allowed "phase 2" inner EAP-based authentication methods -when an EAP method that uses an inner TLS tunnel is specified in the -"eap" property. Recognized EAP-based "phase 2" methods are -"md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method -requires specific parameters for successful authentication; see the -wpa_supplicant documentation for more details.

Default value: NULL

The `"phase2-ca-cert"` property

  "phase2-ca-cert"           GBytes*               : Read / Write

NM_SETTING_802_1X_PASSWORD_RAW

#define NM_SETTING_802_1X_PASSWORD_RAW "password-raw"
+

-Contains the "phase 2" CA certificate if used by the EAP method specified -in the "phase2-auth" or "phase2-autheap" -properties.

NM_SETTING_802_1X_PASSWORD_RAW_FLAGS

#define NM_SETTING_802_1X_PASSWORD_RAW_FLAGS "password-raw-flags"
+

NM_SETTING_802_1X_PRIVATE_KEY

#define NM_SETTING_802_1X_PRIVATE_KEY "private-key"
+

-Setting this property directly is discouraged; use the -nm_setting_802_1x_set_phase2_ca_cert() function instead.

The `"phase2-ca-path"` property

  "phase2-ca-path"           gchar*                : Read / Write

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD

#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD "private-key-password"
+

-UTF-8 encoded path to a directory containing PEM or DER formatted -certificates to be added to the verification chain in addition to the -certificate specified in the "phase2-ca-cert" property.

Default value: NULL

The `"phase2-client-cert"` property

  "phase2-client-cert"       GBytes*               : Read / Write

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS

#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS "private-key-password-flags"
+

-Contains the "phase 2" client certificate if used by the EAP method -specified in the "phase2-auth" or -"phase2-autheap" properties.

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY

#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY "phase2-private-key"
+

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD

#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD "phase2-private-key-password"
+

-Setting this property directly is discouraged; use the -nm_setting_802_1x_set_phase2_client_cert() function instead.

The `"phase2-private-key"` property

  "phase2-private-key"       GBytes*               : Read / Write

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS

#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS "phase2-private-key-password-flags"
+

-Contains the "phase 2" inner private key when the -"phase2-auth" or "phase2-autheap" property is -set to "tls".

NM_SETTING_802_1X_PIN

#define NM_SETTING_802_1X_PIN "pin"
+

-Key data is specified using a "scheme"; two are currently supported: blob -and path. When using the blob scheme and private keys, this property -should be set to the key's encrypted PEM encoded data. When using private -keys with the path scheme, this property should be set to the full UTF-8 -encoded path of the key, prefixed with the string "file://" and ending -with a terminating NUL byte. When using PKCS#12 format private -keys and the blob scheme, this property should be set to the -PKCS#12 data and the "phase2-private-key-password" -property must be set to password used to decrypt the PKCS#12 -certificate and key. When using PKCS#12 files and the path -scheme, this property should be set to the full UTF-8 encoded path of the -key, prefixed with the string "file://" and and ending with a terminating -NUL byte, and as with the blob scheme the -"phase2-private-key-password" property must be set to the -password used to decode the PKCS#12 private key and certificate.

NM_SETTING_802_1X_PIN_FLAGS

#define NM_SETTING_802_1X_PIN_FLAGS "pin-flags"
+

-Setting this property directly is discouraged; use the -nm_setting_802_1x_set_phase2_private_key() function instead.

The `"phase2-private-key-password"` property

  "phase2-private-key-password" gchar*                : Read / Write

NM_SETTING_802_1X_SYSTEM_CA_CERTS

#define NM_SETTING_802_1X_SYSTEM_CA_CERTS "system-ca-certs"
+

-The password used to decrypt the "phase 2" private key specified in the -"phase2-private-key" property when the private key either -uses the path scheme, or is a PKCS#12 format key. Setting this -property directly is not generally necessary except when returning -secrets to NetworkManager; it is generally set automatically when setting -the private key by the nm_setting_802_1x_set_phase2_private_key() -function.

Property Details

The `“altsubject-matches”` property

  “altsubject-matches”       GStrv

Flags: Read / Write

The `“anonymous-identity”` property

  “anonymous-identity”       gchar *

Flags: Read / Write

Default value: NULL

The `"phase2-private-key-password-flags"` property

  "phase2-private-key-password-flags" NMSettingSecretFlags  : Read / Write

-Flags indicating how to handle the -"phase2-private-key-password" property. -

The `“ca-cert”` property

  “ca-cert”                  GBytes *

Flags: Read / Write

The `"phase2-subject-match"` property

  "phase2-subject-match"     gchar*                : Read / Write

-Substring to be matched against the subject of the certificate presented -by the authentication server during the inner "phase 2" -authentication. When unset, no verification of the authentication server -certificate's subject is performed. -

The `“ca-path”` property

  “ca-path”                  gchar *

Flags: Read / Write

Default value: NULL

The `"pin"` property

  "pin"                      gchar*                : Read / Write

-PIN used for EAP authentication methods. -

The `“client-cert”` property

  “client-cert”              GBytes *

Flags: Read / Write

The `“eap”` property

  “eap”                      GStrv

Flags: Read / Write

The `“identity”` property

  “identity”                 gchar *

Flags: Read / Write

Default value: NULL

The `"pin-flags"` property

  "pin-flags"                NMSettingSecretFlags  : Read / Write

-Flags indicating how to handle the "pin" property. -

The `“pac-file”` property

  “pac-file”                 gchar *

Flags: Read / Write

Default value: NULL

The `"private-key"` property

  "private-key"              GBytes*               : Read / Write

-Contains the private key when the "eap" property is set to -"tls". -

-Key data is specified using a "scheme"; two are currently supported: blob -and path. When using the blob scheme and private keys, this property -should be set to the key's encrypted PEM encoded data. When using private -keys with the path scheme, this property should be set to the full UTF-8 -encoded path of the key, prefixed with the string "file://" and ending -with a terminating NUL byte. When using PKCS#12 format private -keys and the blob scheme, this property should be set to the -PKCS#12 data and the "private-key-password" -property must be set to password used to decrypt the PKCS#12 -certificate and key. When using PKCS#12 files and the path -scheme, this property should be set to the full UTF-8 encoded path of the -key, prefixed with the string "file://" and and ending with a terminating -NUL byte, and as with the blob scheme the "private-key-password" property -must be set to the password used to decode the PKCS#12 private -key and certificate. -

-Setting this property directly is discouraged; use the -nm_setting_802_1x_set_private_key() function instead. -

-WARNING: "private-key" is not a "secret" property, and thus -unencrypted private key data using the BLOB scheme may be readable by -unprivileged users. Private keys should always be encrypted with a -private key password to prevent unauthorized access to unencrypted -private key data. -

The `“password”` property

  “password”                 gchar *

Flags: Read / Write

Default value: NULL

The `"private-key-password"` property

  "private-key-password"     gchar*                : Read / Write

-The password used to decrypt the private key specified in the -"private-key" property when the private key either uses the -path scheme, or if the private key is a PKCS#12 format key. Setting this -property directly is not generally necessary except when returning -secrets to NetworkManager; it is generally set automatically when setting -the private key by the nm_setting_802_1x_set_private_key() function. -

The `“password-flags”` property

  “password-flags”           NMSettingSecretFlags

Flags: Read / Write

The `“password-raw”` property

  “password-raw”             GBytes *

Flags: Read / Write

The `“password-raw-flags”` property

  “password-raw-flags”       NMSettingSecretFlags

Flags: Read / Write

The `“phase1-fast-provisioning”` property

  “phase1-fast-provisioning” gchar *

Flags: Read / Write

Default value: NULL

The `"private-key-password-flags"` property

  "private-key-password-flags" NMSettingSecretFlags  : Read / Write

-Flags indicating how to handle the "private-key-password" -property. -

The `“phase1-peaplabel”` property

  “phase1-peaplabel”         gchar *

Flags: Read / Write

Default value: NULL

The `"subject-match"` property

  "subject-match"            gchar*                : Read / Write

-Substring to be matched against the subject of the certificate presented -by the authentication server. When unset, no verification of the -authentication server certificate's subject is performed. -

The `“phase1-peapver”` property

  “phase1-peapver”           gchar *

Flags: Read / Write

Default value: NULL

The `"system-ca-certs"` property

  "system-ca-certs"          gboolean              : Read / Write / Construct

-When TRUE, overrides the "ca-path" and -"phase2-ca-path" properties using the system CA directory -specified at configure time with the --system-ca-path switch. The -certificates in this directory are added to the verification chain in -addition to any certificates specified by the "ca-cert" and -"phase2-ca-cert" properties. -

The `“phase2-altsubject-matches”` property

  “phase2-altsubject-matches” GStrv

Flags: Read / Write

The `“phase2-auth”` property

  “phase2-auth”              gchar *

Flags: Read / Write

Default value: NULL

The `“phase2-autheap”` property

  “phase2-autheap”           gchar *

Flags: Read / Write

Default value: NULL

The `“phase2-ca-cert”` property

  “phase2-ca-cert”           GBytes *

Flags: Read / Write

The `“phase2-ca-path”` property

  “phase2-ca-path”           gchar *

Flags: Read / Write

Default value: NULL

The `“phase2-client-cert”` property

  “phase2-client-cert”       GBytes *

Flags: Read / Write

The `“phase2-private-key”` property

  “phase2-private-key”       GBytes *

Flags: Read / Write

The `“phase2-private-key-password”` property

  “phase2-private-key-password” gchar *

Flags: Read / Write

Default value: NULL

The `“phase2-private-key-password-flags”` property

  “phase2-private-key-password-flags” NMSettingSecretFlags

Flags: Read / Write

The `“phase2-subject-match”` property

  “phase2-subject-match”     gchar *

Flags: Read / Write

Default value: NULL

The `“pin”` property

  “pin”                      gchar *

Flags: Read / Write

Default value: NULL

The `“pin-flags”` property

  “pin-flags”                NMSettingSecretFlags

Flags: Read / Write

The `“private-key”` property

  “private-key”              GBytes *

Flags: Read / Write

The `“private-key-password”` property

  “private-key-password”     gchar *

Flags: Read / Write

Default value: NULL

The `“private-key-password-flags”` property

  “private-key-password-flags” NMSettingSecretFlags

Flags: Read / Write

The `“subject-match”` property

  “subject-match”            gchar *

Flags: Read / Write

Default value: NULL

The `“system-ca-certs”` property

  “system-ca-certs”          gboolean

Flags: Read / Write / Construct

Default value: FALSE

`setting` :	the NMSettingConnection -
`i` :	the zero-based index of the array of altSubjectName matches	setting	the NMSettingConnection
Returns :	the altSubjectName match at index `i` -	i	the zero-based index of the array of altSubjectName matches

`setting` :	the NMSettingConnection -
`i` :	the zero-based index of the array of "phase 2" altSubjectName matches	setting	the NMSettingConnection
Returns :	the "phase 2" altSubjectName match at index `i` -	i	the zero-based index of the array of "phase 2" altSubjectName matches

			libnm Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Properties -

`setting` :	the NMSetting8021x -
`altsubject_match` :	the altSubjectName to allow for this connection	setting	the NMSetting8021x
Returns :	-`TRUE` if the alternative subject name match was -successfully added, `FALSE` if it was already allowed.	altsubject_match	the altSubjectName to allow for this connection

`setting` :	the NMSetting8021x -
`phase2_altsubject_match` :	the "phase 2" altSubjectName to allow for this -connection	setting	the NMSetting8021x
Returns :	-`TRUE` if the "phase 2" alternative subject name match was -successfully added, `FALSE` if it was already allowed.	phase2_altsubject_match	the "phase 2" altSubjectName to allow for this +connection

`setting` :	the NMSetting8021x +	NM_SETTING_802_1X_CK_FORMAT_UNKNOWN	+ unknown file format +
NM_SETTING_802_1X_CK_FORMAT_X509	+ file contains an X.509 format certificate +
NM_SETTING_802_1X_CK_FORMAT_RAW_KEY	+ file contains an old-style OpenSSL PEM +or DER private key
Returns :	the NMSettingSecretFlags pertaining to the -"phase2-private-key-password" +	NM_SETTING_802_1X_CK_FORMAT_PKCS12	+ file contains a PKCS#12 certificate +and private key

`setting` :	the NMSetting8021x +	NM_SETTING_802_1X_CK_SCHEME_UNKNOWN	+ unknown certificate or private key +scheme +
NM_SETTING_802_1X_CK_SCHEME_BLOB	+ certificate or key is stored as the raw +item data
Returns :	the data format of the "phase 2" private key data stored in the -"phase2-private-key" property	NM_SETTING_802_1X_CK_SCHEME_PATH	+ certificate or key is stored as a path +to a file containing the certificate or key data +

NMSetting8021x

Synopsis

Object Hierarchy

Properties

Description

Details

enum NMSetting8021xCKFormat

Functions

enum NMSetting8021xCKScheme

NM_SETTING_802_1X_SETTING_NAME

NM_SETTING_802_1X_EAP

NM_SETTING_802_1X_IDENTITY

NM_SETTING_802_1X_ANONYMOUS_IDENTITY

NM_SETTING_802_1X_PAC_FILE

NM_SETTING_802_1X_CA_CERT

NM_SETTING_802_1X_CA_PATH

NM_SETTING_802_1X_SUBJECT_MATCH

NM_SETTING_802_1X_ALTSUBJECT_MATCHES

NM_SETTING_802_1X_CLIENT_CERT

NM_SETTING_802_1X_PHASE1_PEAPVER

NM_SETTING_802_1X_PHASE1_PEAPLABEL

NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING

NM_SETTING_802_1X_PHASE2_AUTH

NM_SETTING_802_1X_PHASE2_AUTHEAP

NM_SETTING_802_1X_PHASE2_CA_CERT

NM_SETTING_802_1X_PHASE2_CA_PATH

NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH

NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES

NM_SETTING_802_1X_PHASE2_CLIENT_CERT

NM_SETTING_802_1X_PASSWORD

NM_SETTING_802_1X_PASSWORD_FLAGS

NM_SETTING_802_1X_PASSWORD_RAW

NM_SETTING_802_1X_PASSWORD_RAW_FLAGS

NM_SETTING_802_1X_PRIVATE_KEY

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS

NM_SETTING_802_1X_PIN

Properties

NM_SETTING_802_1X_PIN_FLAGS

Types and Values

NM_SETTING_802_1X_SYSTEM_CA_CERTS

Object Hierarchy

struct NMSetting8021x

Description

Functions

NMSetting8021xClass

nm_setting_802_1x_new ()

Returns

nm_setting_802_1x_new ()

nm_setting_802_1x_get_num_eap_methods ()

Parameters

Returns

nm_setting_802_1x_get_num_eap_methods ()

nm_setting_802_1x_get_eap_method ()

Parameters

nm_setting_802_1x_get_eap_method ()

Returns

nm_setting_802_1x_add_eap_method ()

nm_setting_802_1x_add_eap_method ()

Parameters

Returns

nm_setting_802_1x_remove_eap_method ()

nm_setting_802_1x_remove_eap_method ()

Parameters

nm_setting_802_1x_remove_eap_method_by_value ()

nm_setting_802_1x_remove_eap_method_by_value ()

Parameters

Returns

nm_setting_802_1x_clear_eap_methods ()

nm_setting_802_1x_clear_eap_methods ()

Parameters

nm_setting_802_1x_get_identity ()

nm_setting_802_1x_get_identity ()

Parameters

Returns

nm_setting_802_1x_get_anonymous_identity ()

nm_setting_802_1x_get_anonymous_identity ()