From 33491bc4279481db8ae47213e34a6d695a0e8830 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 6 Jul 2014 02:16:10 +0200 Subject: Imported Upstream version 0.9.10.0 --- docs/libnm-util/html/NMSetting8021x.html | 5393 ++++++++++++++---------------- 1 file changed, 2457 insertions(+), 2936 deletions(-) (limited to 'docs/libnm-util/html/NMSetting8021x.html') diff --git a/docs/libnm-util/html/NMSetting8021x.html b/docs/libnm-util/html/NMSetting8021x.html index 67162ead..a0bd18de 100644 --- a/docs/libnm-util/html/NMSetting8021x.html +++ b/docs/libnm-util/html/NMSetting8021x.html @@ -2,28 +2,34 @@ -libnm-util Reference Manual: NMSetting8021x +NMSetting8021x - + - + - - - - - - - + + + + + + + + + +
@@ -31,3780 +37,3295 @@

NMSetting8021x

NMSetting8021x — Describes 802.1x-authenticated connection properties

- +
+
+

Synopsis

+
+#include <nm-setting-8021x.h>
+
+enum                NMSetting8021xCKFormat;
+enum                NMSetting8021xCKScheme;
+#define             NM_SETTING_802_1X_SETTING_NAME
+enum                NMSetting8021xError;
+#define             NM_SETTING_802_1X_ERROR
+GQuark              nm_setting_802_1x_error_quark       (void);
+#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
+                    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);
+const GByteArray *  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);
+const GByteArray *  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);
+const GByteArray *  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);
+const GByteArray *  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);
+const GByteArray *  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);
+const GByteArray *  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);
+const GByteArray *  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
+
+
+  GEnum
+   +----NMSetting8021xError
+
+
+  GObject
+   +----NMSetting
+         +----NMSetting8021x
+
+
+
+

Properties

+
+  "altsubject-matches"       GSList_gchararray_*   : Read / Write
+  "anonymous-identity"       gchar*                : Read / Write
+  "ca-cert"                  GArray_guchar_*       : Read / Write
+  "ca-path"                  gchar*                : Read / Write
+  "client-cert"              GArray_guchar_*       : Read / Write
+  "eap"                      GSList_gchararray_*   : Read / Write
+  "identity"                 gchar*                : Read / Write
+  "pac-file"                 gchar*                : Read / Write
+  "password"                 gchar*                : Read / Write
+  "password-flags"           guint                 : Read / Write
+  "password-raw"             GArray_guchar_*       : Read / Write
+  "password-raw-flags"       guint                 : Read / Write
+  "phase1-fast-provisioning" gchar*                : Read / Write
+  "phase1-peaplabel"         gchar*                : Read / Write
+  "phase1-peapver"           gchar*                : Read / Write
+  "phase2-altsubject-matches" GSList_gchararray_*   : Read / Write
+  "phase2-auth"              gchar*                : Read / Write
+  "phase2-autheap"           gchar*                : Read / Write
+  "phase2-ca-cert"           GArray_guchar_*       : Read / Write
+  "phase2-ca-path"           gchar*                : Read / Write
+  "phase2-client-cert"       GArray_guchar_*       : Read / Write
+  "phase2-private-key"       GArray_guchar_*       : Read / Write
+  "phase2-private-key-password" gchar*                : Read / Write
+  "phase2-private-key-password-flags" guint                 : Read / Write
+  "phase2-subject-match"     gchar*                : Read / Write
+  "pin"                      gchar*                : Read / Write
+  "pin-flags"                guint                 : Read / Write
+  "private-key"              GArray_guchar_*       : Read / Write
+  "private-key-password"     gchar*                : Read / Write
+  "private-key-password-flags" guint                 : 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 +

+
-

Functions

-
+

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 +

+
--++ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - + - - + - - + + +
-GQuark - -nm_setting_802_1x_error_quark () -
-NMSetting * - -nm_setting_802_1x_new () -
-guint32 - -nm_setting_802_1x_get_num_eap_methods () -
const char * - -nm_setting_802_1x_get_eap_method () -
-gboolean - -nm_setting_802_1x_add_eap_method () -
-void - -nm_setting_802_1x_remove_eap_method () -
-void - -nm_setting_802_1x_clear_eap_methods () -
const char * - -nm_setting_802_1x_get_identity () -
const char * - -nm_setting_802_1x_get_anonymous_identity () -
const char * - -nm_setting_802_1x_get_pac_file () -
-gboolean - -nm_setting_802_1x_get_system_ca_certs () -
const char * - -nm_setting_802_1x_get_ca_path () -
const char * - -nm_setting_802_1x_get_phase2_ca_path () -
-NMSetting8021xCKScheme - -nm_setting_802_1x_get_ca_cert_scheme () -
const GByteArray * - -nm_setting_802_1x_get_ca_cert_blob () -
const char * - -nm_setting_802_1x_get_ca_cert_path () -
-gboolean - -nm_setting_802_1x_set_ca_cert () -
const char * - -nm_setting_802_1x_get_subject_match () -
-guint32 - -nm_setting_802_1x_get_num_altsubject_matches () -
const char * - -nm_setting_802_1x_get_altsubject_match () -
-gboolean - -nm_setting_802_1x_add_altsubject_match () -
-void - -nm_setting_802_1x_remove_altsubject_match () -
-void - -nm_setting_802_1x_clear_altsubject_matches () -
-NMSetting8021xCKScheme - -nm_setting_802_1x_get_client_cert_scheme () -
const GByteArray * - -nm_setting_802_1x_get_client_cert_blob () -
const char * - -nm_setting_802_1x_get_client_cert_path () -
-gboolean - -nm_setting_802_1x_set_client_cert () -
const char * - -nm_setting_802_1x_get_phase1_peapver () -
const char * - -nm_setting_802_1x_get_phase1_peaplabel () -
const char * - -nm_setting_802_1x_get_phase1_fast_provisioning () -
const char * - -nm_setting_802_1x_get_phase2_auth () -
const char * - -nm_setting_802_1x_get_phase2_autheap () -
-NMSetting8021xCKScheme - -nm_setting_802_1x_get_phase2_ca_cert_scheme () -
const GByteArray * - -nm_setting_802_1x_get_phase2_ca_cert_blob () -
const char * - -nm_setting_802_1x_get_phase2_ca_cert_path () -
-gboolean - -nm_setting_802_1x_set_phase2_ca_cert () -
const char * - -nm_setting_802_1x_get_phase2_subject_match () -
-guint32 - -nm_setting_802_1x_get_num_phase2_altsubject_matches () -
const char * - -nm_setting_802_1x_get_phase2_altsubject_match () -
-gboolean - -nm_setting_802_1x_add_phase2_altsubject_match () -
-void - -nm_setting_802_1x_remove_phase2_altsubject_match () -
-void - -nm_setting_802_1x_clear_phase2_altsubject_matches () -
-NMSetting8021xCKScheme - -nm_setting_802_1x_get_phase2_client_cert_scheme () -
const GByteArray * - -nm_setting_802_1x_get_phase2_client_cert_blob () -
const char * - -nm_setting_802_1x_get_phase2_client_cert_path () -
-gboolean - -nm_setting_802_1x_set_phase2_client_cert () +

NM_SETTING_802_1X_CK_FORMAT_UNKNOWN

unknown file format
const char * - -nm_setting_802_1x_get_password () +

NM_SETTING_802_1X_CK_FORMAT_X509

file contains an X.509 format certificate
-NMSettingSecretFlags - -nm_setting_802_1x_get_password_flags () +

NM_SETTING_802_1X_CK_FORMAT_RAW_KEY

file contains an old-style OpenSSL PEM +or DER private key
const GByteArray * - -nm_setting_802_1x_get_password_raw () +

NM_SETTING_802_1X_CK_FORMAT_PKCS12

file contains a PKCS12 certificate +and private key
+
+
+
+

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 +

+
++++ + - - + - - + - - + + +
-NMSettingSecretFlags - -nm_setting_802_1x_get_password_raw_flags () +

NM_SETTING_802_1X_CK_SCHEME_UNKNOWN

unknown certificate or private key +scheme
const char * - -nm_setting_802_1x_get_pin () +

NM_SETTING_802_1X_CK_SCHEME_BLOB

certificate or key is stored as the raw +item data
-NMSettingSecretFlags - -nm_setting_802_1x_get_pin_flags () +

NM_SETTING_802_1X_CK_SCHEME_PATH

certificate or key is stored as a path +to a file containing the certificate or key data
+
+
+
+

NM_SETTING_802_1X_SETTING_NAME

+
#define NM_SETTING_802_1X_SETTING_NAME "802-1x"
+
+

+

+
+
+
+

enum NMSetting8021xError

+
typedef enum {
+ /*< underscore_name=nm_setting_802_1x_error >*/
+	NM_SETTING_802_1X_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
+	NM_SETTING_802_1X_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
+	NM_SETTING_802_1X_ERROR_MISSING_PROPERTY  /*< nick=MissingProperty >*/
+} NMSetting8021xError;
+
+
++++ + - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
-NMSetting8021xCKScheme - -nm_setting_802_1x_get_private_key_scheme () +

NM_SETTING_802_1X_ERROR_UNKNOWN

unknown or unclassified error
const GByteArray * - -nm_setting_802_1x_get_private_key_blob () +

NM_SETTING_802_1X_ERROR_INVALID_PROPERTY

the property was invalid
const char * - -nm_setting_802_1x_get_private_key_path () -
-gboolean - -nm_setting_802_1x_set_private_key () -
const char * - -nm_setting_802_1x_get_private_key_password () -
-NMSettingSecretFlags - -nm_setting_802_1x_get_private_key_password_flags () -
-NMSetting8021xCKFormat - -nm_setting_802_1x_get_private_key_format () -
-NMSetting8021xCKScheme - -nm_setting_802_1x_get_phase2_private_key_scheme () -
const GByteArray * - -nm_setting_802_1x_get_phase2_private_key_blob () -
const char * - -nm_setting_802_1x_get_phase2_private_key_path () -
-gboolean - -nm_setting_802_1x_set_phase2_private_key () -
const char * - -nm_setting_802_1x_get_phase2_private_key_password () -
-NMSettingSecretFlags - -nm_setting_802_1x_get_phase2_private_key_password_flags () -
-NMSetting8021xCKFormat - -nm_setting_802_1x_get_phase2_private_key_format () +

NM_SETTING_802_1X_ERROR_MISSING_PROPERTY

the property was missing and is +required
-
-

Properties

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-GSList_gchararray_ *altsubject-matchesRead / Write
-gchar *anonymous-identityRead / Write
-GArray_guchar_ *ca-certRead / Write
-gchar *ca-pathRead / Write
-GArray_guchar_ *client-certRead / Write
-GSList_gchararray_ *eapRead / Write
-gchar *identityRead / Write
-gchar *pac-fileRead / Write
-gchar *passwordRead / Write
guintpassword-flagsRead / Write
-GArray_guchar_ *password-rawRead / Write
guintpassword-raw-flagsRead / Write
-gchar *phase1-fast-provisioningRead / Write
-gchar *phase1-peaplabelRead / Write
-gchar *phase1-peapverRead / Write
-GSList_gchararray_ *phase2-altsubject-matchesRead / Write
-gchar *phase2-authRead / Write
-gchar *phase2-autheapRead / Write
-GArray_guchar_ *phase2-ca-certRead / Write
-gchar *phase2-ca-pathRead / Write
-GArray_guchar_ *phase2-client-certRead / Write
-GArray_guchar_ *phase2-private-keyRead / Write
-gchar *phase2-private-key-passwordRead / Write
guintphase2-private-key-password-flagsRead / Write
-gchar *phase2-subject-matchRead / Write
-gchar *pinRead / Write
guintpin-flagsRead / Write
-GArray_guchar_ *private-keyRead / Write
-gchar *private-key-passwordRead / Write
guintprivate-key-password-flagsRead / Write
-gchar *subject-matchRead / Write
gbooleansystem-ca-certsRead / Write / Construct
+
+
+

NM_SETTING_802_1X_ERROR

+
#define NM_SETTING_802_1X_ERROR nm_setting_802_1x_error_quark ()
+
+

+

-
-

Types and Values

-
+
+
+

nm_setting_802_1x_error_quark ()

+
GQuark              nm_setting_802_1x_error_quark       (void);
+

+Registers an error quark for NMSetting8021x if necessary. +

+
--++ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
enumNMSetting8021xCKFormat
enumNMSetting8021xCKScheme
#defineNM_SETTING_802_1X_SETTING_NAME
enumNMSetting8021xError
#defineNM_SETTING_802_1X_ERROR
#defineNM_SETTING_802_1X_EAP
#defineNM_SETTING_802_1X_IDENTITY
#defineNM_SETTING_802_1X_ANONYMOUS_IDENTITY
#defineNM_SETTING_802_1X_PAC_FILE
#defineNM_SETTING_802_1X_CA_CERT
#defineNM_SETTING_802_1X_CA_PATH
#defineNM_SETTING_802_1X_SUBJECT_MATCH
#defineNM_SETTING_802_1X_ALTSUBJECT_MATCHES
#defineNM_SETTING_802_1X_CLIENT_CERT
#defineNM_SETTING_802_1X_PHASE1_PEAPVER
#defineNM_SETTING_802_1X_PHASE1_PEAPLABEL
#defineNM_SETTING_802_1X_PHASE1_FAST_PROVISIONING
#defineNM_SETTING_802_1X_PHASE2_AUTH
#defineNM_SETTING_802_1X_PHASE2_AUTHEAP
#defineNM_SETTING_802_1X_PHASE2_CA_CERT
#defineNM_SETTING_802_1X_PHASE2_CA_PATH
#defineNM_SETTING_802_1X_PHASE2_SUBJECT_MATCH
#defineNM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES
#defineNM_SETTING_802_1X_PHASE2_CLIENT_CERT
#defineNM_SETTING_802_1X_PASSWORD
#defineNM_SETTING_802_1X_PASSWORD_FLAGS
#defineNM_SETTING_802_1X_PASSWORD_RAW
#defineNM_SETTING_802_1X_PASSWORD_RAW_FLAGS
#defineNM_SETTING_802_1X_PRIVATE_KEY
#defineNM_SETTING_802_1X_PRIVATE_KEY_PASSWORD
#defineNM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS
#defineNM_SETTING_802_1X_PHASE2_PRIVATE_KEY
#defineNM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD
#defineNM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS
#defineNM_SETTING_802_1X_PIN
#defineNM_SETTING_802_1X_PIN_FLAGS
#defineNM_SETTING_802_1X_SYSTEM_CA_CERTS

Returns :

the error quark used for NMSetting8021x errors.
-
-

Object Hierarchy

-
    GEnum
-    ├── NMSetting8021xCKFormat
-    ├── NMSetting8021xCKScheme
-    ╰── NMSetting8021xError
-    GObject
-    ╰── NMSetting
-        ╰── NMSetting8021x
+
+
+

NM_SETTING_802_1X_EAP

+
#define NM_SETTING_802_1X_EAP "eap"
 
+

+

-
-

Includes

-
#include <nm-setting-8021x.h>
+
+
+

NM_SETTING_802_1X_IDENTITY

+
#define NM_SETTING_802_1X_IDENTITY "identity"
 
+

+

-
-

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 WiFi 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 WiFi 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

+
+
+

NM_SETTING_802_1X_ANONYMOUS_IDENTITY

+
#define NM_SETTING_802_1X_ANONYMOUS_IDENTITY "anonymous-identity"
+
+

+

-
-

Functions

+
+
+

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_error_quark ()

-
GQuark
-nm_setting_802_1x_error_quark (void);
-

Registers an error quark for NMSetting8021x if necessary.

-
-

Returns

-

the error quark used for NMSetting8021x errors.

-

+

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_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_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"
+
+

+

+
+
+
+

NM_SETTING_802_1X_PIN_FLAGS

+
#define NM_SETTING_802_1X_PIN_FLAGS "pin-flags"
+
+

+

+
+
+
+

NM_SETTING_802_1X_SYSTEM_CA_CERTS

+
#define NM_SETTING_802_1X_SYSTEM_CA_CERTS "system-ca-certs"
+
+

+

+
+
+
+

NMSetting8021x

+
typedef struct _NMSetting8021x NMSetting8021x;
+

+

+
+
+
+

NMSetting8021xClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} 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_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. +

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

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.

-
-

Parameters

-
+

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. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

i :

the index of the EAP method name to return

Returns :

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

Returns

-

the number of 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

-
+

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. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

eap :

the name of the EAP method to allow for this connection

i

the index of the EAP method name to return

 

Returns :

+TRUE if the EAP method was successfully added, FALSE if it was +not a valid method or if it was already allowed.
-
-

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.

-
-

Parameters

-
+

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. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

eap

the name of the EAP method to allow for this connection

 

i :

the index of the EAP method to remove
-
-

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.

-
-

Parameters

-
+

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. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

eap :

the name of the EAP method to remove

i

the index of the EAP method to remove

 

Returns :

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

Since 0.9.10


-

nm_setting_802_1x_clear_eap_methods ()

-
void
-nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);
-

Clears all allowed EAP methods.

-
-

Parameters

-
+

nm_setting_802_1x_clear_eap_methods ()

+
void                nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);
+

+Clears all allowed EAP methods. +

+
---++ - - - + +

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.

-
-

Parameters

-
+

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. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the user identifier
-
-

Returns

-

the user identifier

-

-
-

-

nm_setting_802_1x_get_anonymous_identity ()

-
const char *
-nm_setting_802_1x_get_anonymous_identity
-                               (NMSetting8021x *setting);
-

Returns the anonymous identifier used by some EAP methods (like TTLS) to +

nm_setting_802_1x_get_anonymous_identity ()

+
const char *        nm_setting_802_1x_get_anonymous_identity
+                                                        (NMSetting8021x *setting);
+

+Returns the anonymous identifier used by some EAP methods (like TTLS) to authenticate the user in the outer unencrypted "phase 1" authentication. The -inner "phase 2" authentication will use the “identity” in -a secure form, if applicable for that EAP method.

-
-

Parameters

-
+inner "phase 2" authentication will use the "identity" in +a secure form, if applicable for that EAP method. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the anonymous identifier
-
-

Returns

-

the anonymous identifier

-

-
-

-

nm_setting_802_1x_get_pac_file ()

-
const char *
-nm_setting_802_1x_get_pac_file (NMSetting8021x *setting);
-

Returns the file containing PAC credentials used by EAP-FAST method.

-
-

Parameters

-
+

nm_setting_802_1x_get_pac_file ()

+
const char *        nm_setting_802_1x_get_pac_file      (NMSetting8021x *setting);
+

+Returns the file containing PAC credentials used by EAP-FAST method. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the PAC file
-
-

Returns

-

the PAC file

-

-
-

-

nm_setting_802_1x_get_system_ca_certs ()

-
gboolean
-nm_setting_802_1x_get_system_ca_certs (NMSetting8021x *setting);
-

Sets the “system-ca-certs” property. The -“ca-path” and “phase2-ca-path” -properties are ignored if the “system-ca-certs” property is +

nm_setting_802_1x_get_system_ca_certs ()

+
gboolean            nm_setting_802_1x_get_system_ca_certs
+                                                        (NMSetting8021x *setting);
+

+Sets the "system-ca-certs" property. The +"ca-path" and "phase2-ca-path" +properties are ignored if the "system-ca-certs" property is TRUE, in which case a system-wide CA certificate directory specified at compile time (using the --system-ca-path configure option) is used in place -of these properties.

-
-

Parameters

-
+of these properties. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

+TRUE if a system CA certificate path should be used, FALSE if not
-
-

Returns

-

TRUE if a system CA certificate path should be used, FALSE if not

-

-
-

-

nm_setting_802_1x_get_ca_path ()

-
const char *
-nm_setting_802_1x_get_ca_path (NMSetting8021x *setting);
-

Returns the path of the CA certificate directory if previously set. Systems +

nm_setting_802_1x_get_ca_path ()

+
const char *        nm_setting_802_1x_get_ca_path       (NMSetting8021x *setting);
+

+Returns the path of the CA certificate directory if previously set. Systems will often have a directory that contains multiple individual CA certificates which the supplicant can then add to the verification chain. This may be -used in addition to the “ca-cert” property to add more CA -certificates for verifying the network to client.

-
-

Parameters

-
+used in addition to the "ca-cert" property to add more CA +certificates for verifying the network to client. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the CA certificate directory path
-
-

Returns

-

the CA certificate directory path

-

-
-

-

nm_setting_802_1x_get_phase2_ca_path ()

-
const char *
-nm_setting_802_1x_get_phase2_ca_path (NMSetting8021x *setting);
-

Returns the path of the "phase 2" CA certificate directory if previously set. +

nm_setting_802_1x_get_phase2_ca_path ()

+
const char *        nm_setting_802_1x_get_phase2_ca_path
+                                                        (NMSetting8021x *setting);
+

+Returns the path of the "phase 2" CA certificate directory if previously set. Systems will often have a directory that contains multiple individual CA certificates which the supplicant can then add to the verification chain. -This may be used in addition to the “phase2-ca-cert” property -to add more CA certificates for verifying the network to client.

-
-

Parameters

-
+This may be used in addition to the "phase2-ca-cert" property +to add more CA certificates for verifying the network to client. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the "phase 2" CA certificate directory path
-
-

Returns

-

the "phase 2" CA certificate directory path

-

-
-

-

nm_setting_802_1x_get_ca_cert_scheme ()

-
NMSetting8021xCKScheme
-nm_setting_802_1x_get_ca_cert_scheme (NMSetting8021x *setting);
-

Returns the scheme used to store the CA certificate. If the returned scheme -is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_ca_cert_blob(); -if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_ca_cert_path().

-
-

Parameters

-
+

nm_setting_802_1x_get_ca_cert_scheme ()

+
NMSetting8021xCKScheme nm_setting_802_1x_get_ca_cert_scheme
+                                                        (NMSetting8021x *setting);
+

+Returns the scheme used to store the CA certificate. If the returned scheme +is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_ca_cert_blob(); +if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_ca_cert_path(). +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

scheme used to store the CA certificate (blob or path)
-
-

Returns

-

scheme used to store the CA certificate (blob or path)

-

-
-

-

nm_setting_802_1x_get_ca_cert_blob ()

-
const GByteArray *
-nm_setting_802_1x_get_ca_cert_blob (NMSetting8021x *setting);
-

Returns the CA certificate blob if the CA certificate is stored using the +

nm_setting_802_1x_get_ca_cert_blob ()

+
const GByteArray *  nm_setting_802_1x_get_ca_cert_blob  (NMSetting8021x *setting);
+

+Returns the CA certificate blob if the CA certificate is stored using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme. Not all EAP methods use a CA certificate (LEAP for example), and those that can take advantage of the CA certificate allow it to be unset. Note that lack of a CA certificate reduces security by allowing man-in-the-middle attacks, because the identity -of the network cannot be confirmed by the client.

-
-

Parameters

-
+of the network cannot be confirmed by the client. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the CA certificate data
-
-

Returns

-

the CA certificate data

-

-
-

-

nm_setting_802_1x_get_ca_cert_path ()

-
const char *
-nm_setting_802_1x_get_ca_cert_path (NMSetting8021x *setting);
-

Returns the CA certificate path if the CA certificate is stored using the +

nm_setting_802_1x_get_ca_cert_path ()

+
const char *        nm_setting_802_1x_get_ca_cert_path  (NMSetting8021x *setting);
+

+Returns the CA certificate path if the CA certificate is stored using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. Not all EAP methods use a CA certificate (LEAP for example), and those that can take advantage of the CA certificate allow it to be unset. Note that lack of a CA certificate reduces security by allowing man-in-the-middle attacks, because the identity -of the network cannot be confirmed by the client.

-
-

Parameters

-
+of the network cannot be confirmed by the client. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

path to the CA certificate file
-
-

Returns

-

path to the CA certificate file

-

-
-

-

nm_setting_802_1x_set_ca_cert ()

-
gboolean
-nm_setting_802_1x_set_ca_cert (NMSetting8021x *setting,
-                               const char *cert_path,
-                               NMSetting8021xCKScheme scheme,
-                               NMSetting8021xCKFormat *out_format,
-                               GError **error);
-

Reads a certificate from disk and sets the “ca-cert” property +

nm_setting_802_1x_set_ca_cert ()

+
gboolean            nm_setting_802_1x_set_ca_cert       (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);
+

+Reads a certificate from disk and sets the "ca-cert" property with the raw certificate data if using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate file if using the -NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

-
-

Parameters

-
+NM_SETTING_802_1X_CK_SCHEME_PATH scheme. +

+
---++ - - - + + - - + - +g_filename_to_utf8() to convert if needed. Passing NULL with any scheme +clears the CA certificate. - - - + + - - - + + - - - + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

cert_path

when scheme -is set to either NM_SETTING_802_1X_CK_SCHEME_PATH +

cert_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 CA certificate file (PEM or DER format). The path must be UTF-8 encoded; use -g_filename_to_utf8() to convert if needed. Passing NULL with any scheme -clears the CA certificate.

 

scheme

desired storage scheme for the certificate

 

scheme :

desired storage scheme for the certificate

out_format

on successful return, the type of the certificate added

 

out_format :

on successful return, the type of the certificate added

error

on unsuccessful return, an error

 

error :

on unsuccessful return, an error

Returns :

+TRUE if the operation succeeded, FALSE if it was unsuccessful
-
-

Returns

-

TRUE if the operation succeeded, FALSE if it was unsuccessful

-

-
-

-

nm_setting_802_1x_get_subject_match ()

-
const char *
-nm_setting_802_1x_get_subject_match (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_subject_match ()

+
const char *        nm_setting_802_1x_get_subject_match (NMSetting8021x *setting);
+
---++ - - - - - -

setting

the NMSetting8021x

 
-
-
-

Returns

-

the “subject-match” property. This is the + + +

setting :

+the NMSetting8021x + + + +

Returns :

+the "subject-match" property. This is the substring to be matched against the subject of the authentication -server certificate, or NULL no subject verification is to be -performed.

-

-
+server certificate, or NULL no subject verification is to be +performed. + + +

-

nm_setting_802_1x_get_num_altsubject_matches ()

-
guint32
-nm_setting_802_1x_get_num_altsubject_matches
-                               (NMSetting8021x *setting);
-

Returns the number of entries in the -“altsubject-matches” property of this setting.

-
-

Parameters

-
+

nm_setting_802_1x_get_num_altsubject_matches ()

+
guint32             nm_setting_802_1x_get_num_altsubject_matches
+                                                        (NMSetting8021x *setting);
+

+Returns the number of entries in the +"altsubject-matches" property of this setting. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the number of altsubject-matches entries.
-
-

Returns

-

the number of altsubject-matches entries.

-

-
-

-

nm_setting_802_1x_get_altsubject_match ()

-
const char *
-nm_setting_802_1x_get_altsubject_match
-                               (NMSetting8021x *setting,
-                                guint32 i);
-

Returns the altSubjectName match at index i -.

-
-

Parameters

-
+

nm_setting_802_1x_get_altsubject_match ()

+
const char *        nm_setting_802_1x_get_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);
+

+Returns the altSubjectName match at index i. +

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

setting

the NMSettingConnection

 

setting :

the NMSettingConnection +

i :

the zero-based index of the array of altSubjectName matches

i

the zero-based index of the array of altSubjectName matches

 

Returns :

the altSubjectName match at index i +
-
-

Returns

-

the altSubjectName match at index i -

-

-
-

-

nm_setting_802_1x_add_altsubject_match ()

-
gboolean
-nm_setting_802_1x_add_altsubject_match
-                               (NMSetting8021x *setting,
-                                const char *altsubject_match);
-

Adds an allowed alternate subject name match. Until at least one +

nm_setting_802_1x_add_altsubject_match ()

+
gboolean            nm_setting_802_1x_add_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         const char *altsubject_match);
+

+Adds an allowed alternate subject name match. Until at least one match is added, the altSubjectName of the remote authentication -server is not verified.

-
-

Parameters

-
+server is not verified. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

altsubject_match :

the altSubjectName to allow for this connection

altsubject_match

the altSubjectName to allow for this connection

 

Returns :

+TRUE if the alternative subject name match was +successfully added, FALSE if it was already allowed.
-
-

Returns

-

TRUE if the alternative subject name match was -successfully added, FALSE if it was already allowed.

-

-
-

-

nm_setting_802_1x_remove_altsubject_match ()

-
void
-nm_setting_802_1x_remove_altsubject_match
-                               (NMSetting8021x *setting,
-                                guint32 i);
-

Removes the allowed altSubjectName at the specified index.

-
-

Parameters

-
+

nm_setting_802_1x_remove_altsubject_match ()

+
void                nm_setting_802_1x_remove_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);
+

+Removes the allowed altSubjectName at the specified index. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

i

the index of the altSubjectName match to remove

 

i :

the index of the altSubjectName match to remove
-

-

nm_setting_802_1x_clear_altsubject_matches ()

-
void
-nm_setting_802_1x_clear_altsubject_matches
-                               (NMSetting8021x *setting);
-

Clears all altSubjectName matches.

-
-

Parameters

-
+

nm_setting_802_1x_remove_altsubject_match_by_value ()

+
gboolean            nm_setting_802_1x_remove_altsubject_match_by_value
+                                                        (NMSetting8021x *setting,
+                                                         const char *altsubject_match);
+

+Removes the allowed altSubjectName altsubject_match. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

altsubject_match :

the altSubjectName to remove

Returns :

+TRUE if the alternative subject name match was found and removed, +FALSE if it was not.
-
+

Since 0.9.10


-

nm_setting_802_1x_get_client_cert_scheme ()

-
NMSetting8021xCKScheme
-nm_setting_802_1x_get_client_cert_scheme
-                               (NMSetting8021x *setting);
-

Returns the scheme used to store the client certificate. If the returned scheme -is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_client_cert_blob(); -if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_client_cert_path().

-
-

Parameters

-
+

nm_setting_802_1x_clear_altsubject_matches ()

+
void                nm_setting_802_1x_clear_altsubject_matches
+                                                        (NMSetting8021x *setting);
+

+Clears all altSubjectName matches. +

+
---++ - - - + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +
-
-

Returns

-

scheme used to store the client certificate (blob or path)

-

-
+
+
+

nm_setting_802_1x_get_client_cert_scheme ()

+
NMSetting8021xCKScheme nm_setting_802_1x_get_client_cert_scheme
+                                                        (NMSetting8021x *setting);
+

+Returns the scheme used to store the client certificate. If the returned scheme +is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_client_cert_blob(); +if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_client_cert_path(). +

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

setting :

the NMSetting8021x +

Returns :

scheme used to store the client certificate (blob or path)

-

nm_setting_802_1x_get_client_cert_blob ()

-
const GByteArray *
-nm_setting_802_1x_get_client_cert_blob
-                               (NMSetting8021x *setting);
-

Client certificates are used to identify the connecting client to the network +

nm_setting_802_1x_get_client_cert_blob ()

+
const GByteArray *  nm_setting_802_1x_get_client_cert_blob
+                                                        (NMSetting8021x *setting);
+

+Client certificates are used to identify the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

-
-

Parameters

-
+authentication method. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the client certificate data
-
-

Returns

-

the client certificate data

-

-
-

-

nm_setting_802_1x_get_client_cert_path ()

-
const char *
-nm_setting_802_1x_get_client_cert_path
-                               (NMSetting8021x *setting);
-

Client certificates are used to identify the connecting client to the network +

nm_setting_802_1x_get_client_cert_path ()

+
const char *        nm_setting_802_1x_get_client_cert_path
+                                                        (NMSetting8021x *setting);
+

+Client certificates are used to identify the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

-
-

Parameters

-
+authentication method. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

path to the client certificate file
-
-

Returns

-

path to the client certificate file

-

-
-

-

nm_setting_802_1x_set_client_cert ()

-
gboolean
-nm_setting_802_1x_set_client_cert (NMSetting8021x *setting,
-                                   const char *cert_path,
-                                   NMSetting8021xCKScheme scheme,
-                                   NMSetting8021xCKFormat *out_format,
-                                   GError **error);
-

Reads a certificate from disk and sets the “client-cert” +

nm_setting_802_1x_set_client_cert ()

+
gboolean            nm_setting_802_1x_set_client_cert   (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);
+

+Reads a certificate from disk and sets the "client-cert" property with the raw certificate data if using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate -file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

-

Client certificates are used to identify the connecting client to the network +file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. +

+

+Client certificates are used to identify the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

-
-

Parameters

-
+authentication method. +

+
---++ - - - + + - - + - +encoded; use g_filename_to_utf8() to convert if needed. Passing NULL with +any scheme clears the client certificate. + + + + - - - + + - - - + + - - - + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

cert_path

when scheme -is set to either NM_SETTING_802_1X_CK_SCHEME_PATH +

cert_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 client certificate file (PEM, DER, or PKCS12 format). The path must be UTF-8 -encoded; use g_filename_to_utf8() to convert if needed. Passing NULL with -any scheme -clears the client certificate.

 

scheme :

desired storage scheme for the certificate

scheme

desired storage scheme for the certificate

 

out_format :

on successful return, the type of the certificate added

out_format

on successful return, the type of the certificate added

 

error :

on unsuccessful return, an error

error

on unsuccessful return, an error

 

Returns :

+TRUE if the operation succeeded, FALSE if it was unsuccessful
-
-

Returns

-

TRUE if the operation succeeded, FALSE if it was unsuccessful

-

-
-

-

nm_setting_802_1x_get_phase1_peapver ()

-
const char *
-nm_setting_802_1x_get_phase1_peapver (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_phase1_peapver ()

+
const char *        nm_setting_802_1x_get_phase1_peapver
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the "phase 1" PEAP version to be used when authenticating with +EAP-PEAP as contained in the "phase1-peapver" property. Valid +values are NULL (unset), "0" (PEAP version 0), and "1" (PEAP version 1).
-
-

Returns

-

the "phase 1" PEAP version to be used when authenticating with -EAP-PEAP as contained in the “phase1-peapver” property. Valid -values are NULL (unset), "0" (PEAP version 0), and "1" (PEAP version 1).

-

-
-

-

nm_setting_802_1x_get_phase1_peaplabel ()

-
const char *
-nm_setting_802_1x_get_phase1_peaplabel
-                               (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_phase1_peaplabel ()

+
const char *        nm_setting_802_1x_get_phase1_peaplabel
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - -

setting

the NMSetting8021x

 
-
-
-

Returns

-

whether the "phase 1" PEAP label is new-style or old-style, to be + + +

setting :

+the NMSetting8021x + + + +

Returns :

+whether the "phase 1" PEAP label is new-style or old-style, to be used when authenticating with EAP-PEAP, as contained in the -“phase1-peaplabel” property. Valid values are NULL (unset), +"phase1-peaplabel" property. Valid values are NULL (unset), "0" (use old-style label), and "1" (use new-style label). See the -wpa_supplicant documentation for more details.

-

-
+wpa_supplicant documentation for more details. + + +

-

nm_setting_802_1x_get_phase1_fast_provisioning ()

-
const char *
-nm_setting_802_1x_get_phase1_fast_provisioning
-                               (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_phase1_fast_provisioning ()

+
const char *        nm_setting_802_1x_get_phase1_fast_provisioning
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

whether "phase 1" PEAP fast provisioning should be used, as specified +by the "phase1-fast-provisioning" property. See the +wpa_supplicant documentation for more details.
-
-

Returns

-

whether "phase 1" PEAP fast provisioning should be used, as specified -by the “phase1-fast-provisioning” property. See the -wpa_supplicant documentation for more details.

-

-
-

-

nm_setting_802_1x_get_phase2_auth ()

-
const char *
-nm_setting_802_1x_get_phase2_auth (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_phase2_auth ()

+
const char *        nm_setting_802_1x_get_phase2_auth   (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the "phase 2" non-EAP (ex MD5) allowed authentication method as +specified by the "phase2-auth" property.
-
-

Returns

-

the "phase 2" non-EAP (ex MD5) allowed authentication method as -specified by the “phase2-auth” property.

-

-
-

-

nm_setting_802_1x_get_phase2_autheap ()

-
const char *
-nm_setting_802_1x_get_phase2_autheap (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_phase2_autheap ()

+
const char *        nm_setting_802_1x_get_phase2_autheap
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the "phase 2" EAP-based (ex TLS) allowed authentication method as +specified by the "phase2-autheap" property.
-
-

Returns

-

the "phase 2" EAP-based (ex TLS) allowed authentication method as -specified by the “phase2-autheap” property.

-

-
-

-

nm_setting_802_1x_get_phase2_ca_cert_scheme ()

-
NMSetting8021xCKScheme
-nm_setting_802_1x_get_phase2_ca_cert_scheme
-                               (NMSetting8021x *setting);
-

Returns the scheme used to store the "phase 2" CA certificate. If the +

nm_setting_802_1x_get_phase2_ca_cert_scheme ()

+
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_ca_cert_scheme
+                                                        (NMSetting8021x *setting);
+

+Returns the scheme used to store the "phase 2" CA certificate. If the returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use -nm_setting_802_1x_get_ca_cert_blob(); if NM_SETTING_802_1X_CK_SCHEME_PATH, -use nm_setting_802_1x_get_ca_cert_path().

-
-

Parameters

-
+nm_setting_802_1x_get_ca_cert_blob(); if NM_SETTING_802_1X_CK_SCHEME_PATH, +use nm_setting_802_1x_get_ca_cert_path(). +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

scheme used to store the "phase 2" CA certificate (blob or path)
-
-

Returns

-

scheme used to store the "phase 2" CA certificate (blob or path)

-

-
-

-

nm_setting_802_1x_get_phase2_ca_cert_blob ()

-
const GByteArray *
-nm_setting_802_1x_get_phase2_ca_cert_blob
-                               (NMSetting8021x *setting);
-

Returns the "phase 2" CA certificate blob if the CA certificate is stored +

nm_setting_802_1x_get_phase2_ca_cert_blob ()

+
const GByteArray *  nm_setting_802_1x_get_phase2_ca_cert_blob
+                                                        (NMSetting8021x *setting);
+

+Returns the "phase 2" CA certificate blob if the CA certificate is stored using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme. Not all EAP methods use a CA certificate (LEAP for example), and those that can take advantage of the CA certificate allow it to be unset. Note that lack of a CA certificate reduces security by allowing man-in-the-middle attacks, because the identity -of the network cannot be confirmed by the client.

-
-

Parameters

-
+of the network cannot be confirmed by the client. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the "phase 2" CA certificate data
-
-

Returns

-

the "phase 2" CA certificate data

-

-
-

-

nm_setting_802_1x_get_phase2_ca_cert_path ()

-
const char *
-nm_setting_802_1x_get_phase2_ca_cert_path
-                               (NMSetting8021x *setting);
-

Returns the "phase 2" CA certificate path if the CA certificate is stored +

nm_setting_802_1x_get_phase2_ca_cert_path ()

+
const char *        nm_setting_802_1x_get_phase2_ca_cert_path
+                                                        (NMSetting8021x *setting);
+

+Returns the "phase 2" CA certificate path if the CA certificate is stored using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. Not all EAP methods use a CA certificate (LEAP for example), and those that can take advantage of the CA certificate allow it to be unset. Note that lack of a CA certificate reduces security by allowing man-in-the-middle attacks, because the identity -of the network cannot be confirmed by the client.

-
-

Parameters

-
+of the network cannot be confirmed by the client. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

path to the "phase 2" CA certificate file
-
-

Returns

-

path to the "phase 2" CA certificate file

-

-
-

-

nm_setting_802_1x_set_phase2_ca_cert ()

-
gboolean
-nm_setting_802_1x_set_phase2_ca_cert (NMSetting8021x *setting,
-                                      const char *cert_path,
-                                      NMSetting8021xCKScheme scheme,
-                                      NMSetting8021xCKFormat *out_format,
-                                      GError **error);
-

Reads a certificate from disk and sets the “phase2-ca-cert” +

nm_setting_802_1x_set_phase2_ca_cert ()

+
gboolean            nm_setting_802_1x_set_phase2_ca_cert
+                                                        (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);
+

+Reads a certificate from disk and sets the "phase2-ca-cert" property with the raw certificate data if using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate -file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

-
-

Parameters

-
+file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. +

+
---++ - - - + + - - + - +g_filename_to_utf8() to convert if needed. Passing NULL with any scheme +clears the "phase2" CA certificate. - - - + + - - - + + - - - + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

cert_path

when scheme -is set to either NM_SETTING_802_1X_CK_SCHEME_PATH +

cert_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" CA certificate file (PEM or DER format). The path must be UTF-8 encoded; use -g_filename_to_utf8() to convert if needed. Passing NULL with any scheme -clears the "phase2" CA certificate.

 

scheme

desired storage scheme for the certificate

 

scheme :

desired storage scheme for the certificate

out_format

on successful return, the type of the certificate added

 

out_format :

on successful return, the type of the certificate added

error

on unsuccessful return, an error

 

error :

on unsuccessful return, an error

Returns :

+TRUE if the operation succeeded, FALSE if it was unsuccessful
-
-

Returns

-

TRUE if the operation succeeded, FALSE if it was unsuccessful

-

-
-

-

nm_setting_802_1x_get_phase2_subject_match ()

-
const char *
-nm_setting_802_1x_get_phase2_subject_match
-                               (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_phase2_subject_match ()

+
const char *        nm_setting_802_1x_get_phase2_subject_match
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - -

setting

the NMSetting8021x

 
-
-
-

Returns

-

the “phase2-subject-match” property. This is + + +

setting :

+the NMSetting8021x + + + +

Returns :

+the "phase2-subject-match" property. This is the substring to be matched against the subject of the "phase 2" -authentication server certificate, or NULL no subject verification -is to be performed.

-

-
+authentication server certificate, or NULL no subject verification +is to be performed. + + +

-

nm_setting_802_1x_get_num_phase2_altsubject_matches ()

-
guint32
-nm_setting_802_1x_get_num_phase2_altsubject_matches
-                               (NMSetting8021x *setting);
-

Returns the number of entries in the -“phase2-altsubject-matches” property of this setting.

-
-

Parameters

-
+

nm_setting_802_1x_get_num_phase2_altsubject_matches ()

+
guint32             nm_setting_802_1x_get_num_phase2_altsubject_matches
+                                                        (NMSetting8021x *setting);
+

+Returns the number of entries in the +"phase2-altsubject-matches" property of this setting. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the number of phase2-altsubject-matches entries.
-
-

Returns

-

the number of phase2-altsubject-matches entries.

-

-
-

-

nm_setting_802_1x_get_phase2_altsubject_match ()

-
const char *
-nm_setting_802_1x_get_phase2_altsubject_match
-                               (NMSetting8021x *setting,
-                                guint32 i);
-

Returns the "phase 2" altSubjectName match at index i -.

-
-

Parameters

-
+

nm_setting_802_1x_get_phase2_altsubject_match ()

+
const char *        nm_setting_802_1x_get_phase2_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);
+

+Returns the "phase 2" altSubjectName match at index i. +

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

setting

the NMSettingConnection

 

setting :

the NMSettingConnection +

i :

the zero-based index of the array of "phase 2" altSubjectName matches

i

the zero-based index of the array of "phase 2" altSubjectName matches

 

Returns :

the "phase 2" altSubjectName match at index i +
-
-

Returns

-

the "phase 2" altSubjectName match at index i -

-

-
-

-

nm_setting_802_1x_add_phase2_altsubject_match ()

-
gboolean
-nm_setting_802_1x_add_phase2_altsubject_match
-                               (NMSetting8021x *setting,
-                                const char *phase2_altsubject_match);
-

Adds an allowed alternate subject name match for "phase 2". Until +

nm_setting_802_1x_add_phase2_altsubject_match ()

+
gboolean            nm_setting_802_1x_add_phase2_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         const char *phase2_altsubject_match);
+

+Adds an allowed alternate subject name match for "phase 2". Until at least one match is added, the altSubjectName of the "phase 2" -remote authentication server is not verified.

-
-

Parameters

-
+remote authentication server is not verified. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

phase2_altsubject_match :

the "phase 2" altSubjectName to allow for this +connection

phase2_altsubject_match

the "phase 2" altSubjectName to allow for this -connection

 

Returns :

+TRUE if the "phase 2" alternative subject name match was +successfully added, FALSE if it was already allowed.
-
-

Returns

-

TRUE if the "phase 2" alternative subject name match was -successfully added, FALSE if it was already allowed.

-

-
-

-

nm_setting_802_1x_remove_phase2_altsubject_match ()

-
void
-nm_setting_802_1x_remove_phase2_altsubject_match
-                               (NMSetting8021x *setting,
-                                guint32 i);
-

Removes the allowed "phase 2" altSubjectName at the specified index.

-
-

Parameters

-
+

nm_setting_802_1x_remove_phase2_altsubject_match ()

+
void                nm_setting_802_1x_remove_phase2_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);
+

+Removes the allowed "phase 2" altSubjectName at the specified index. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

i

the index of the "phase 2" altSubjectName match to remove

 

i :

the index of the "phase 2" altSubjectName match to remove
+
+
+

nm_setting_802_1x_remove_phase2_altsubject_match_by_value ()

+
gboolean            nm_setting_802_1x_remove_phase2_altsubject_match_by_value
+                                                        (NMSetting8021x *setting,
+                                                         const char *phase2_altsubject_match);
+

+Removes the allowed "phase 2" altSubjectName phase2_altsubject_match. +

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

setting :

the NMSetting8021x +

phase2_altsubject_match :

the "phase 2" altSubjectName to remove

Returns :

+TRUE if the alternative subject name match for "phase 2" was found and removed, +FALSE if it was not.
+

Since 0.9.10


-

nm_setting_802_1x_clear_phase2_altsubject_matches ()

-
void
-nm_setting_802_1x_clear_phase2_altsubject_matches
-                               (NMSetting8021x *setting);
-

Clears all "phase 2" altSubjectName matches.

-
-

Parameters

-
+

nm_setting_802_1x_clear_phase2_altsubject_matches ()

+
void                nm_setting_802_1x_clear_phase2_altsubject_matches
+                                                        (NMSetting8021x *setting);
+

+Clears all "phase 2" altSubjectName matches. +

+
---++ - - - + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +
-

-

nm_setting_802_1x_get_phase2_client_cert_scheme ()

-
NMSetting8021xCKScheme
-nm_setting_802_1x_get_phase2_client_cert_scheme
-                               (NMSetting8021x *setting);
-

Returns the scheme used to store the "phase 2" client certificate. If the +

nm_setting_802_1x_get_phase2_client_cert_scheme ()

+
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_client_cert_scheme
+                                                        (NMSetting8021x *setting);
+

+Returns the scheme used to store the "phase 2" client certificate. If the returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use -nm_setting_802_1x_get_client_cert_blob(); if +nm_setting_802_1x_get_client_cert_blob(); if NM_SETTING_802_1X_CK_SCHEME_PATH, use -nm_setting_802_1x_get_client_cert_path().

-
-

Parameters

-
+nm_setting_802_1x_get_client_cert_path(). +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

scheme used to store the "phase 2" client certificate (blob or path)
-
-

Returns

-

scheme used to store the "phase 2" client certificate (blob or path)

-

-
-

-

nm_setting_802_1x_get_phase2_client_cert_blob ()

-
const GByteArray *
-nm_setting_802_1x_get_phase2_client_cert_blob
-                               (NMSetting8021x *setting);
-

Client certificates are used to identify the connecting client to the network +

nm_setting_802_1x_get_phase2_client_cert_blob ()

+
const GByteArray *  nm_setting_802_1x_get_phase2_client_cert_blob
+                                                        (NMSetting8021x *setting);
+

+Client certificates are used to identify the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

-
-

Parameters

-
+authentication method. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the "phase 2" client certificate data
-
-

Returns

-

the "phase 2" client certificate data

-

-
-

-

nm_setting_802_1x_get_phase2_client_cert_path ()

-
const char *
-nm_setting_802_1x_get_phase2_client_cert_path
-                               (NMSetting8021x *setting);
-

Client certificates are used to identify the connecting client to the network +

nm_setting_802_1x_get_phase2_client_cert_path ()

+
const char *        nm_setting_802_1x_get_phase2_client_cert_path
+                                                        (NMSetting8021x *setting);
+

+Client certificates are used to identify the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

-
-

Parameters

-
+authentication method. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

path to the "phase 2" client certificate file
-
-

Returns

-

path to the "phase 2" client certificate file

-

-
-

-

nm_setting_802_1x_set_phase2_client_cert ()

-
gboolean
-nm_setting_802_1x_set_phase2_client_cert
-                               (NMSetting8021x *setting,
-                                const char *cert_path,
-                                NMSetting8021xCKScheme scheme,
-                                NMSetting8021xCKFormat *out_format,
-                                GError **error);
-

Reads a certificate from disk and sets the “phase2-client-cert” +

nm_setting_802_1x_set_phase2_client_cert ()

+
gboolean            nm_setting_802_1x_set_phase2_client_cert
+                                                        (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);
+

+Reads a certificate from disk and sets the "phase2-client-cert" property with the raw certificate data if using the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate -file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

-

Client certificates are used to identify the connecting client to the network +file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. +

+

+Client certificates are used to identify the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method.

-
-

Parameters

-
+authentication method. +

+
---++ - - - + + - - + - +encoded; use g_filename_to_utf8() to convert if needed. Passing NULL with +any scheme clears the "phase2" client certificate. + + + + - - - + + - - - + + - - - + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

cert_path

when scheme -is set to either NM_SETTING_802_1X_CK_SCHEME_PATH +

cert_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" client certificate file (PEM, DER, or PKCS12 format). The path must be UTF-8 -encoded; use g_filename_to_utf8() to convert if needed. Passing NULL with -any scheme -clears the "phase2" client certificate.

 

scheme :

desired storage scheme for the certificate

scheme

desired storage scheme for the certificate

 

out_format :

on successful return, the type of the certificate added

out_format

on successful return, the type of the certificate added

 

error :

on unsuccessful return, an error

error

on unsuccessful return, an error

 

Returns :

+TRUE if the operation succeeded, FALSE if it was unsuccessful
-
-

Returns

-

TRUE if the operation succeeded, FALSE if it was unsuccessful

-

-
-

-

nm_setting_802_1x_get_password ()

-
const char *
-nm_setting_802_1x_get_password (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_password ()

+
const char *        nm_setting_802_1x_get_password      (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the password used by the authentication method, if any, as specified +by the "password" property
-
-

Returns

-

the password used by the authentication method, if any, as specified -by the “password” property

-

-
-

-

nm_setting_802_1x_get_password_flags ()

-
NMSettingSecretFlags
-nm_setting_802_1x_get_password_flags (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_password_flags ()

+
NMSettingSecretFlags nm_setting_802_1x_get_password_flags
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the NMSettingSecretFlags pertaining to the "password" +
-
-

Returns

-

the NMSettingSecretFlags pertaining to the “password”

-

-
-

-

nm_setting_802_1x_get_password_raw ()

-
const GByteArray *
-nm_setting_802_1x_get_password_raw (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_password_raw ()

+
const GByteArray *  nm_setting_802_1x_get_password_raw  (NMSetting8021x *setting);
+
---++ - - - - - -

setting

the NMSetting8021x

 
-
-
-

Returns

-

the password used by the authentication method as a + + +

setting :

+the NMSetting8021x + + + +

Returns :

+the password used by the authentication method as a UTF-8-encoded array of bytes, as specified by the -“password-raw” property

-

-
+"password-raw" property + + +

-

nm_setting_802_1x_get_password_raw_flags ()

-
NMSettingSecretFlags
-nm_setting_802_1x_get_password_raw_flags
-                               (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_password_raw_flags ()

+
NMSettingSecretFlags nm_setting_802_1x_get_password_raw_flags
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the NMSettingSecretFlags pertaining to the +"password-raw" +
-
-

Returns

-

the NMSettingSecretFlags pertaining to the -“password-raw”

-

-
-

-

nm_setting_802_1x_get_pin ()

-
const char *
-nm_setting_802_1x_get_pin (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_pin ()

+
const char *        nm_setting_802_1x_get_pin           (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the PIN used by the authentication method, if any, as specified +by the "pin" property
-
-

Returns

-

the PIN used by the authentication method, if any, as specified -by the “pin” property

-

-
-

-

nm_setting_802_1x_get_pin_flags ()

-
NMSettingSecretFlags
-nm_setting_802_1x_get_pin_flags (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_pin_flags ()

+
NMSettingSecretFlags nm_setting_802_1x_get_pin_flags    (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the NMSettingSecretFlags pertaining to the +"pin" +
-
-

Returns

-

the NMSettingSecretFlags pertaining to the -“pin”

-

-
-

-

nm_setting_802_1x_get_private_key_scheme ()

-
NMSetting8021xCKScheme
-nm_setting_802_1x_get_private_key_scheme
-                               (NMSetting8021x *setting);
-

Returns the scheme used to store the private key. If the returned scheme is +

nm_setting_802_1x_get_private_key_scheme ()

+
NMSetting8021xCKScheme nm_setting_802_1x_get_private_key_scheme
+                                                        (NMSetting8021x *setting);
+

+Returns the scheme used to store the private key. If the returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use -nm_setting_802_1x_get_client_cert_blob(); if +nm_setting_802_1x_get_client_cert_blob(); if NM_SETTING_802_1X_CK_SCHEME_PATH, use -nm_setting_802_1x_get_client_cert_path().

-
-

Parameters

-
+nm_setting_802_1x_get_client_cert_path(). +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

scheme used to store the private key (blob or path)
-
-

Returns

-

scheme used to store the private key (blob or path)

-

-
-

-

nm_setting_802_1x_get_private_key_blob ()

-
const GByteArray *
-nm_setting_802_1x_get_private_key_blob
-                               (NMSetting8021x *setting);
-

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

nm_setting_802_1x_get_private_key_blob ()

+
const GByteArray *  nm_setting_802_1x_get_private_key_blob
+                                                        (NMSetting8021x *setting);
+

+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.

-

WARNING: the private key property is not a "secret" property, and thus +authentication method. +

+

+WARNING: the private key property is not a "secret" property, and thus unencrypted private key data may be readable by unprivileged users. Private -keys should always be encrypted with a private key password.

-
-

Parameters

-
+keys should always be encrypted with a private key password. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the private key data
-
-

Returns

-

the private key data

-

-
-

-

nm_setting_802_1x_get_private_key_path ()

-
const char *
-nm_setting_802_1x_get_private_key_path
-                               (NMSetting8021x *setting);
-

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

nm_setting_802_1x_get_private_key_path ()

+
const char *        nm_setting_802_1x_get_private_key_path
+                                                        (NMSetting8021x *setting);
+

+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.

-
-

Parameters

-
+authentication method. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

path to the private key file
-
-

Returns

-

path to the private key file

-

-
-

-

nm_setting_802_1x_set_private_key ()

-
gboolean
-nm_setting_802_1x_set_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_private_key ()

+
gboolean            nm_setting_802_1x_set_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 -“private-key” property with the private key file data if using +authentication method. +

+

+This function reads a private key from disk and sets the +"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 -“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 +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 +"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 private key property is not a "secret" property, and thus +at a later time. +

+

+WARNING: the 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.

-
-

Parameters

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

+
---++ - - - + + - - + - +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 private key file (PEM, DER, or PKCS12 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

scheme

desired storage scheme for the private key

 

out_format :

on successful return, the type of the private key added

out_format

on successful return, the type of the private key added

 

error :

on unsuccessful return, an error

error

on unsuccessful return, an error

 

Returns :

+TRUE if the operation succeeded, FALSE if it was unsuccessful
-
-

Returns

-

TRUE if the operation succeeded, FALSE if it was unsuccessful

-

-
-

-

nm_setting_802_1x_get_private_key_password ()

-
const char *
-nm_setting_802_1x_get_private_key_password
-                               (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_private_key_password ()

+
const char *        nm_setting_802_1x_get_private_key_password
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the private key password used to decrypt the private key if +previously set with nm_setting_802_1x_set_private_key(), or the +"private-key-password" property.
-
-

Returns

-

the private key password used to decrypt the private key if -previously set with nm_setting_802_1x_set_private_key(), or the -“private-key-password” property.

-

-
-

-

nm_setting_802_1x_get_private_key_password_flags ()

-
NMSettingSecretFlags
-nm_setting_802_1x_get_private_key_password_flags
-                               (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_private_key_password_flags ()

+
NMSettingSecretFlags nm_setting_802_1x_get_private_key_password_flags
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the NMSettingSecretFlags pertaining to the +"private-key-password" +
-
-

Returns

-

the NMSettingSecretFlags pertaining to the -“private-key-password”

-

-
-

-

nm_setting_802_1x_get_private_key_format ()

-
NMSetting8021xCKFormat
-nm_setting_802_1x_get_private_key_format
-                               (NMSetting8021x *setting);
-
-

Parameters

-
+

nm_setting_802_1x_get_private_key_format ()

+
NMSetting8021xCKFormat nm_setting_802_1x_get_private_key_format
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - + + + + + + + + + +

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the data format of the private key data stored in the +"private-key" property
-
-

Returns

-

the data format of the private key data stored in the -“private-key” property

-

-
-

-

nm_setting_802_1x_get_phase2_private_key_scheme ()

-
NMSetting8021xCKScheme
-nm_setting_802_1x_get_phase2_private_key_scheme
-                               (NMSetting8021x *setting);
-

Returns the scheme used to store the "phase 2" private key. If the returned +

nm_setting_802_1x_get_phase2_private_key_scheme ()

+
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_private_key_scheme
+                                                        (NMSetting8021x *setting);
+

+Returns the scheme used to store the "phase 2" private key. If the returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use -nm_setting_802_1x_get_client_cert_blob(); if +nm_setting_802_1x_get_client_cert_blob(); if NM_SETTING_802_1X_CK_SCHEME_PATH, use -nm_setting_802_1x_get_client_cert_path().

-
-

Parameters

-
+nm_setting_802_1x_get_client_cert_path(). +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

scheme used to store the "phase 2" private key (blob or path)
-
-

Returns

-

scheme used to store the "phase 2" private key (blob or path)

-

-
-

-

nm_setting_802_1x_get_phase2_private_key_blob ()

-
const GByteArray *
-nm_setting_802_1x_get_phase2_private_key_blob
-                               (NMSetting8021x *setting);
-

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

nm_setting_802_1x_get_phase2_private_key_blob ()

+
const GByteArray *  nm_setting_802_1x_get_phase2_private_key_blob
+                                                        (NMSetting8021x *setting);
+

+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.

-

WARNING: the phase2 private key property is not a "secret" property, and thus +authentication method. +

+

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

-
-

Parameters

-
+keys should always be encrypted with a private key password. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

the "phase 2" private key data
-
-

Returns

-

the "phase 2" private key data

-

-
-

-

nm_setting_802_1x_get_phase2_private_key_path ()

-
const char *
-nm_setting_802_1x_get_phase2_private_key_path
-                               (NMSetting8021x *setting);
-

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

nm_setting_802_1x_get_phase2_private_key_path ()

+
const char *        nm_setting_802_1x_get_phase2_private_key_path
+                                                        (NMSetting8021x *setting);
+

+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.

-
-

Parameters

-
+authentication method. +

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

setting

the NMSetting8021x

 

setting :

the NMSetting8021x +

Returns :

path to the "phase 2" private key file
-
-

Returns

-

path to the "phase 2" private key file

-

-
-

-

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.

-
-

Parameters

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

+
---++ - - - + + - - + - +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 PKCS12 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

scheme

desired storage scheme for the private key

 

out_format :

on successful return, the type of the private key added

out_format

on successful return, the type of the private key added

 

error :

on unsuccessful return, an error

error

on unsuccessful return, an error

 

Returns :

+TRUE if the operation succeeded, FALSE if it was unsuccessful
-
-

Returns

-

TRUE if the operation succeeded, FALSE if it was unsuccessful

-

-
-
-
-
-

nm_setting_802_1x_get_phase2_private_key_password ()

-
const char *
-nm_setting_802_1x_get_phase2_private_key_password
-                               (NMSetting8021x *setting);
-
-

Parameters

-
----- - - - - - -

setting

the NMSetting8021x

 
-
-
-

Returns

-

the private key password used to decrypt the private key if -previously set with nm_setting_802_1x_set_phase2_private_key() or the -“phase2-private-key-password” property.

-

-
-
-
-
-

nm_setting_802_1x_get_phase2_private_key_password_flags ()

-
NMSettingSecretFlags
-nm_setting_802_1x_get_phase2_private_key_password_flags
-                               (NMSetting8021x *setting);
-
-

Parameters

-
----- - - - - - -

setting

the NMSetting8021x

 
-
-
-

Returns

-

the NMSettingSecretFlags pertaining to the -“phase2-private-key-password”

-

-
-

-

nm_setting_802_1x_get_phase2_private_key_format ()

-
NMSetting8021xCKFormat
-nm_setting_802_1x_get_phase2_private_key_format
-                               (NMSetting8021x *setting);
-
-

Parameters

-
----- - - - - - -

setting

the NMSetting8021x

 
-
-
-

Returns

-

the data format of the "phase 2" private key data stored in the -“phase2-private-key” property

-

-
-
-
-
-

Types and Values

-
-

enum NMSetting8021xCKFormat

-

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

-
-

Members

-
+

nm_setting_802_1x_get_phase2_private_key_password ()

+
const char *        nm_setting_802_1x_get_phase2_private_key_password
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - - - + - - - - - - - - - + +

NM_SETTING_802_1X_CK_FORMAT_UNKNOWN

-

unknown file format

-
 

NM_SETTING_802_1X_CK_FORMAT_X509

-

file contains an X.509 format certificate

+

setting :

the NMSetting8021x  

NM_SETTING_802_1X_CK_FORMAT_RAW_KEY

-

file contains an old-style OpenSSL PEM -or DER private key

-
 

NM_SETTING_802_1X_CK_FORMAT_PKCS12

-

file contains a PKCS12 certificate -and private key

-
 

Returns :

the private key password used to decrypt the private key if +previously set with nm_setting_802_1x_set_phase2_private_key() or the +"phase2-private-key-password" property.
-

-

enum 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

-
-

Members

-
+

nm_setting_802_1x_get_phase2_private_key_password_flags ()

+
NMSettingSecretFlags nm_setting_802_1x_get_phase2_private_key_password_flags
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - - - + - - - + -

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

+

setting :

the NMSetting8021x  

NM_SETTING_802_1X_CK_SCHEME_PATH

-

certificate or key is stored as a path -to a file containing the certificate or key data

+

Returns :

the NMSettingSecretFlags pertaining to the +"phase2-private-key-password"  
-
-
-
-

NM_SETTING_802_1X_SETTING_NAME

-
#define NM_SETTING_802_1X_SETTING_NAME "802-1x"
-
-

-

-

-

enum NMSetting8021xError

-
-

Members

-
+

nm_setting_802_1x_get_phase2_private_key_format ()

+
NMSetting8021xCKFormat nm_setting_802_1x_get_phase2_private_key_format
+                                                        (NMSetting8021x *setting);
+
---++ - - - - - - - + - - - - + +

NM_SETTING_802_1X_ERROR_UNKNOWN

-

unknown or unclassified error

-
 

NM_SETTING_802_1X_ERROR_INVALID_PROPERTY

-

the property was invalid

+

setting :

the NMSetting8021x  

NM_SETTING_802_1X_ERROR_MISSING_PROPERTY

-

the property was missing and is -required

-
 

Returns :

the data format of the "phase 2" private key data stored in the +"phase2-private-key" property
-
+
+

Property Details

-

NM_SETTING_802_1X_ERROR

-
#define NM_SETTING_802_1X_ERROR nm_setting_802_1x_error_quark ()
-
+

The "altsubject-matches" property

+
  "altsubject-matches"       GSList_gchararray_*   : Read / Write

+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.


-

NM_SETTING_802_1X_EAP

-
#define NM_SETTING_802_1X_EAP "eap"
-
+

The "anonymous-identity" property

+
  "anonymous-identity"       gchar*                : Read / Write

+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


-

NM_SETTING_802_1X_IDENTITY

-
#define NM_SETTING_802_1X_IDENTITY "identity"
-
+

The "ca-cert" property

+
  "ca-cert"                  GArray_guchar_*       : Read / Write

+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.


-

NM_SETTING_802_1X_CA_CERT

-
#define NM_SETTING_802_1X_CA_CERT "ca-cert"
-
+

The "ca-path" property

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

+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


-

NM_SETTING_802_1X_CA_PATH

-
#define NM_SETTING_802_1X_CA_PATH "ca-path"
-
+

The "client-cert" property

+
  "client-cert"              GArray_guchar_*       : Read / Write

+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"
-

+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.

-
-
-
-

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.


-

NM_SETTING_802_1X_CLIENT_CERT

-
#define NM_SETTING_802_1X_CLIENT_CERT "client-cert"
-
+

The "eap" property

+
  "eap"                      GSList_gchararray_*   : Read / Write

+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.


-

NM_SETTING_802_1X_PHASE1_PEAPVER

-
#define NM_SETTING_802_1X_PHASE1_PEAPVER "phase1-peapver"
-
+

The "identity" property

+
  "identity"                 gchar*                : Read / Write

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

+

Default value: NULL


-

NM_SETTING_802_1X_PHASE1_PEAPLABEL

-
#define NM_SETTING_802_1X_PHASE1_PEAPLABEL "phase1-peaplabel"
-
+

The "pac-file" property

+
  "pac-file"                 gchar*                : Read / Write

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

+

Default value: NULL


-

NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING

-
#define NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING "phase1-fast-provisioning"
-
+

The "password" property

+
  "password"                 gchar*                : Read / Write

+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


-

NM_SETTING_802_1X_PHASE2_AUTH

-
#define NM_SETTING_802_1X_PHASE2_AUTH "phase2-auth"
-
+

The "password-flags" property

+
  "password-flags"           guint                 : Read / Write

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

+

Allowed values: <= 7

+

Default value: 0


-

NM_SETTING_802_1X_PHASE2_AUTHEAP

-
#define NM_SETTING_802_1X_PHASE2_AUTHEAP "phase2-autheap"
-
+

The "password-raw" property

+
  "password-raw"             GArray_guchar_*       : Read / Write

+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.


-

NM_SETTING_802_1X_PHASE2_CA_CERT

-
#define NM_SETTING_802_1X_PHASE2_CA_CERT "phase2-ca-cert"
-
+

The "password-raw-flags" property

+
  "password-raw-flags"       guint                 : Read / Write

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

+

Allowed values: <= 7

+

Default value: 0


-

NM_SETTING_802_1X_PHASE2_CA_PATH

-
#define NM_SETTING_802_1X_PHASE2_CA_PATH "phase2-ca-path"
-
+

The "phase1-fast-provisioning" property

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

+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


-

NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH

-
#define NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH "phase2-subject-match"
-
+

The "phase1-peaplabel" property

+
  "phase1-peaplabel"         gchar*                : Read / Write

+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


-

NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES

-
#define NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES "phase2-altsubject-matches"
-
+

The "phase1-peapver" property

+
  "phase1-peapver"           gchar*                : Read / Write

+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


-

NM_SETTING_802_1X_PHASE2_CLIENT_CERT

-
#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT "phase2-client-cert"
-
+

The "phase2-altsubject-matches" property

+
  "phase2-altsubject-matches" GSList_gchararray_*   : Read / Write

+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.


-

NM_SETTING_802_1X_PASSWORD

-
#define NM_SETTING_802_1X_PASSWORD "password"
-
+

The "phase2-auth" property

+
  "phase2-auth"              gchar*                : Read / Write

+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


-

NM_SETTING_802_1X_PASSWORD_FLAGS

-
#define NM_SETTING_802_1X_PASSWORD_FLAGS "password-flags"
-
+

The "phase2-autheap" property

+
  "phase2-autheap"           gchar*                : Read / Write

+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


-

NM_SETTING_802_1X_PASSWORD_RAW

-
#define NM_SETTING_802_1X_PASSWORD_RAW "password-raw"
-
+

The "phase2-ca-cert" property

+
  "phase2-ca-cert"           GArray_guchar_*       : Read / Write

+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"
-

+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_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.


-

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD

-
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD "private-key-password"
-
+

The "phase2-ca-path" property

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

+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


-

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS

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

The "phase2-client-cert" property

+
  "phase2-client-cert"       GArray_guchar_*       : Read / Write

+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"
-

+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_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.


-

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS

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

The "phase2-private-key" property

+
  "phase2-private-key"       GArray_guchar_*       : Read / Write

+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 PKCS12 format private keys and +the blob scheme, this property should be set to the PKCS12 data and the +"phase2-private-key-password" property must be set to +password used to decrypt the PKCS12 certificate and key. When using +PKCS12 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 PKCS12 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.


-

NM_SETTING_802_1X_SYSTEM_CA_CERTS

-
#define NM_SETTING_802_1X_SYSTEM_CA_CERTS "system-ca-certs"
-
+

The "phase2-private-key-password" property

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

+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 PKCS12 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”       GSList_gchararray_ *
-

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.

-

Flags: Read / Write

-
-
-
-

The “anonymous-identity” property

-
  “anonymous-identity”       gchar *
-

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

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “ca-cert” property

-
  “ca-cert”                  GArray_guchar_ *
-

Contains the CA certificate if used by the EAP method specified in the 'eap' property. 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 NULL 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.

-

Flags: Read / Write

-
-
-
-

The “ca-path” property

-
  “ca-path”                  gchar *
-

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.

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “client-cert” property

-
  “client-cert”              GArray_guchar_ *
-

Contains the client certificate if used by the EAP method specified in the 'eap' property. 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 NULL byte.

-

Flags: Read / Write

-
-
-
-

The “eap” property

-
  “eap”                      GSList_gchararray_ *
-

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

-

Flags: Read / Write

-
-
-
-

The “identity” property

-
  “identity”                 gchar *
-

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

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “pac-file” property

-
  “pac-file”                 gchar *
-

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

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “password” property

-
  “password”                 gchar *
-

UTF-8 encoded password used for EAP authentication methods.

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “password-flags” property

-
  “password-flags”           guint
-

Flags indicating how to handle the 802.1x password.

-

Flags: Read / Write

-

Allowed values: <= 7

-

Default value: 0

-
-
-
-

The “password-raw” property

-
  “password-raw”             GArray_guchar_ *
-

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 'password' and 'password-raw' are given, 'password' is preferred.

-

Flags: Read / Write

-
-
-
-

The “password-raw-flags” property

-
  “password-raw-flags”       guint
-

Flags indicating how to handle the 802.1x password byte array.

-

Flags: Read / Write

-

Allowed values: <= 7

-

Default value: 0

-
-
-
-

The “phase1-fast-provisioning” property

-
  “phase1-fast-provisioning” gchar *
-

Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the #NMSetting8021x:eap property. Allowed 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.

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “phase1-peaplabel” property

-
  “phase1-peaplabel”         gchar *
-

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.

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “phase1-peapver” property

-
  “phase1-peapver”           gchar *
-

Forces which PEAP version is used when PEAP is set as the EAP method in '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.

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “phase2-altsubject-matches” property

-
  “phase2-altsubject-matches” GSList_gchararray_ *
-

List of strings to be matched against 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.

-

Flags: Read / Write

-
-
-
-

The “phase2-auth” property

-
  “phase2-auth”              gchar *
-

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 phase2 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.

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “phase2-autheap” property

-
  “phase2-autheap”           gchar *
-

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.

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “phase2-ca-cert” property

-
  “phase2-ca-cert”           GArray_guchar_ *
-

Contains the 'phase 2' CA certificate if used by the EAP method specified in the 'phase2-auth' or 'phase2-autheap' properties. Certificate data is specified using a 'scheme'; two are currentlysupported: 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 NULL 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.

-

Flags: Read / Write

-
-
-
-

The “phase2-ca-path” property

-
  “phase2-ca-path”           gchar *
-

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.

-

Flags: Read / Write

-

Default value: NULL

-
-
-
-

The “phase2-client-cert” property

-
  “phase2-client-cert”       GArray_guchar_ *
-

Contains the 'phase 2' client certificate if used by the EAP method specified in the 'phase2-auth' or 'phase2-autheap' properties. 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 NULL byte.

-

Flags: Read / Write

-
-
-
-

The “phase2-private-key” property

-
  “phase2-private-key”       GArray_guchar_ *
-

Contains the 'phase 2' inner private key when the 'phase2-auth' or 'phase2-autheap' 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 NULL 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 NULL 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.

-

Flags: Read / Write

-
-
-
-

The “phase2-private-key-password” property

-
  “phase2-private-key-password” gchar *
-

The password used to decrypt the 'phase 2' private key specified in the 'private-key' property when the phase2 private key either uses the path scheme, or if the phase2 private key is a PKCS#12 format key.

-

Flags: Read / Write

Default value: NULL


-

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

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

Flags indicating how to handle the 802.1x phase2 private key password.

-

Flags: Read / Write

+

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

+
  "phase2-private-key-password-flags" guint                 : Read / Write
+

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

Allowed values: <= 7

Default value: 0


-

The “phase2-subject-match” property

-
  “phase2-subject-match”     gchar *
-

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

-

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. +

Default value: NULL


-

The “pin” property

-
  “pin”                      gchar *
-

PIN used for EAP authentication methods.

-

Flags: Read / Write

+

The "pin" property

+
  "pin"                      gchar*                : Read / Write
+

+PIN used for EAP authentication methods. +

Default value: NULL


-

The “pin-flags” property

-
  “pin-flags”                guint
-

Flags indicating how to handle the 802.1x PIN.

-

Flags: Read / Write

+

The "pin-flags" property

+
  "pin-flags"                guint                 : Read / Write
+

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

Allowed values: <= 7

Default value: 0


-

The “private-key” property

-
  “private-key”              GArray_guchar_ *
-

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 NULL 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 NULL 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.

-

Flags: Read / Write

+

The "private-key" property

+
  "private-key"              GArray_guchar_*       : 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 PKCS12 format private keys and +the blob scheme, this property should be set to the PKCS12 data and the +"private-key-password" property must be set to password +used to decrypt the PKCS12 certificate and key. When using PKCS12 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 PKCS12 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 “private-key-password” property

-
  “private-key-password”     gchar *
-

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.

-

Flags: Read / Write

+

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 PKCS12 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. +

Default value: NULL


-

The “private-key-password-flags” property

-
  “private-key-password-flags” guint
-

Flags indicating how to handle the 802.1x private key password.

-

Flags: Read / Write

+

The "private-key-password-flags" property

+
  "private-key-password-flags" guint                 : Read / Write
+

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

Allowed values: <= 7

Default value: 0


-

The “subject-match” property

-
  “subject-match”            gchar *
-

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.

-

Flags: Read / Write

+

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. +

Default value: NULL


-

The “system-ca-certs” property

-
  “system-ca-certs”          gboolean
-

When TRUE, overrides '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.

-

Flags: Read / Write / Construct

+

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. +

Default value: FALSE

+ Generated by GTK-Doc V1.19
\ No newline at end of file -- cgit 1.3.0-6-gf8a5