| Top | |
|
|
|
GEnum ├── NMSetting8021xCKFormat ╰── NMSetting8021xCKScheme GFlags ╰── NMSetting8021xAuthFlags
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
NMSetting *
nm_setting_802_1x_new (void);
Creates a new NMSetting8021x object with default values.
NMSetting8021xCKScheme nm_setting_802_1x_check_cert_scheme (gconstpointer pdata,gsize length,GError **error);
Determines and verifies the blob type. When setting certificate properties of NMSetting8021x the blob must be not UNKNOWN (or NULL).
pdata |
the data pointer. |
[allow-none] |
length |
the length of the data |
|
error |
validation reason. |
[allow-none][out] |
the scheme of the blob or NM_SETTING_802_1X_CK_SCHEME_UNKNOWN.
For NULL it also returns NM_SETTING_802_1X_CK_SCHEME_UNKNOWN.
Since: 1.2
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.
const char * nm_setting_802_1x_get_eap_method (NMSetting8021x *setting,guint32 i);
Returns the name of the allowed EAP method at index i
.
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.
void nm_setting_802_1x_remove_eap_method (NMSetting8021x *setting,guint32 i);
Removes the allowed EAP method at the specified index.
gboolean nm_setting_802_1x_remove_eap_method_by_value (NMSetting8021x *setting,const char *eap);
Removes the allowed EAP method method
.
void
nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);
Clears all allowed EAP methods.
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.
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.
const char *
nm_setting_802_1x_get_pac_file (NMSetting8021x *setting);
Returns the file containing PAC credentials used by EAP-FAST method.
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.
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.
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.
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();
if NM_SETTING_802_1X_CK_SCHEME_PKCS11, use nm_setting_802_1x_get_ca_cert_uri().
GBytes *
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.
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.
const char *
nm_setting_802_1x_get_ca_cert_uri (NMSetting8021x *setting);
Returns the CA certificate URI analogously to
nm_setting_802_1x_get_ca_cert_blob() and
nm_setting_802_1x_get_ca_cert_path().
Currently, it's limited to PKCS11 URIs ('pkcs11' scheme as defined by RFC 7512), but may be extended to other schemes in future (such as 'file' URIs for local files and 'data' URIs for inline certificate data).
Since: 1.6
gboolean nm_setting_802_1x_set_ca_cert (NMSetting8021x *setting,const char *value,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.
setting |
the NMSetting8021x |
|
value |
when |
|
scheme |
desired storage scheme for the certificate |
|
out_format |
on successful return, the type of the certificate added |
|
error |
on unsuccessful return, an error |
const char *
nm_setting_802_1x_get_ca_cert_password
(NMSetting8021x *setting);
the password used to access the CA certificate stored in “ca-cert” property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
Since: 1.8
NMSettingSecretFlags
nm_setting_802_1x_get_ca_cert_password_flags
(NMSetting8021x *setting);
Since: 1.8
const char *
nm_setting_802_1x_get_subject_match (NMSetting8021x *setting);
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.
guint32
nm_setting_802_1x_get_num_altsubject_matches
(NMSetting8021x *setting);
Returns the number of entries in the “altsubject-matches” property of this setting.
const char * nm_setting_802_1x_get_altsubject_match (NMSetting8021x *setting,guint32 i);
Returns the altSubjectName match at index i
.
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.
setting |
the NMSetting8021x |
|
altsubject_match |
the altSubjectName to allow for this connection |
void nm_setting_802_1x_remove_altsubject_match (NMSetting8021x *setting,guint32 i);
Removes the allowed altSubjectName at the specified index.
gboolean nm_setting_802_1x_remove_altsubject_match_by_value (NMSetting8021x *setting,const char *altsubject_match);
Removes the allowed altSubjectName altsubject_match
.
void
nm_setting_802_1x_clear_altsubject_matches
(NMSetting8021x *setting);
Clears all altSubjectName matches.
const char *
nm_setting_802_1x_get_domain_suffix_match
(NMSetting8021x *setting);
Since: 1.2
const char *
nm_setting_802_1x_get_domain_match (NMSetting8021x *setting);
Since: 1.24
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();
if NM_SETTING_802_1X_CK_SCHEME_PKCS11, use nm_setting_802_1x_get_client_cert_uri().
GBytes *
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.
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.
const char *
nm_setting_802_1x_get_client_cert_uri (NMSetting8021x *setting);
Returns the client certificate URI analogously to
nm_setting_802_1x_get_client_cert_blob() and
nm_setting_802_1x_get_client_cert_path().
Currently, it's limited to PKCS11 URIs ('pkcs11' scheme as defined by RFC 7512), but may be extended to other schemes in future (such as 'file' URIs for local files and 'data' URIs for inline certificate data).
Since: 1.6
gboolean nm_setting_802_1x_set_client_cert (NMSetting8021x *setting,const char *value,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 when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x authentication method.
setting |
the NMSetting8021x |
|
value |
when |
|
scheme |
desired storage scheme for the certificate |
|
out_format |
on successful return, the type of the certificate added |
|
error |
on unsuccessful return, an error |
const char *
nm_setting_802_1x_get_client_cert_password
(NMSetting8021x *setting);
the password used to access the client certificate stored in “client-cert” property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
Since: 1.8
NMSettingSecretFlags
nm_setting_802_1x_get_client_cert_password_flags
(NMSetting8021x *setting);
Since: 1.8
const char *
nm_setting_802_1x_get_phase1_peapver (NMSetting8021x *setting);
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).
const char *
nm_setting_802_1x_get_phase1_peaplabel
(NMSetting8021x *setting);
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),
"0" (use old-style label), and "1" (use new-style label). See the
wpa_supplicant documentation for more details.
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);
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(); if NM_SETTING_802_1X_CK_SCHEME_PKCS11,
use nm_setting_802_1x_get_ca_cert_uri().
GBytes *
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.
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.
const char *
nm_setting_802_1x_get_phase2_ca_cert_uri
(NMSetting8021x *setting);
Returns the "phase 2" CA certificate URI analogously to
nm_setting_802_1x_get_phase2_ca_cert_blob() and
nm_setting_802_1x_get_phase2_ca_cert_path().
Currently, it's limited to PKCS11 URIs ('pkcs11' scheme as defined by RFC 7512), but may be extended to other schemes in future (such as 'file' URIs for local files and 'data' URIs for inline certificate data).
Since: 1.6
gboolean nm_setting_802_1x_set_phase2_ca_cert (NMSetting8021x *setting,const char *value,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.
setting |
the NMSetting8021x |
|
value |
when |
|
scheme |
desired storage scheme for the certificate |
|
out_format |
on successful return, the type of the certificate added |
|
error |
on unsuccessful return, an error |
const char *
nm_setting_802_1x_get_phase2_ca_cert_password
(NMSetting8021x *setting);
the password used to access the "phase2" CA certificate stored in “phase2-ca-cert” property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
Since: 1.8
NMSettingSecretFlags
nm_setting_802_1x_get_phase2_ca_cert_password_flags
(NMSetting8021x *setting);
Since: 1.8
const char *
nm_setting_802_1x_get_phase2_subject_match
(NMSetting8021x *setting);
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.
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.
const char * nm_setting_802_1x_get_phase2_altsubject_match (NMSetting8021x *setting,guint32 i);
Returns the "phase 2" altSubjectName match at index i
.
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.
setting |
the NMSetting8021x |
|
phase2_altsubject_match |
the "phase 2" altSubjectName to allow for this connection |
void nm_setting_802_1x_remove_phase2_altsubject_match (NMSetting8021x *setting,guint32 i);
Removes the allowed "phase 2" altSubjectName at the specified index.
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 |
void
nm_setting_802_1x_clear_phase2_altsubject_matches
(NMSetting8021x *setting);
Clears all "phase 2" altSubjectName matches.
const char *
nm_setting_802_1x_get_phase2_domain_suffix_match
(NMSetting8021x *setting);
Since: 1.2
const char *
nm_setting_802_1x_get_phase2_domain_match
(NMSetting8021x *setting);
Since: 1.24
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_CK_SCHEME_PATH, use
nm_setting_802_1x_get_client_cert_path(); if
NM_SETTING_802_1X_CK_SCHEME_PKCS11, use
nm_setting_802_1x_get_client_cert_uri().
GBytes *
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.
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.
const char *
nm_setting_802_1x_get_phase2_client_cert_uri
(NMSetting8021x *setting);
Returns the "phase 2" client certificate URI analogously to
nm_setting_802_1x_get_phase2_ca_cert_blob() and
nm_setting_802_1x_get_phase2_ca_cert_path().
Currently, it's limited to PKCS11 URIs ('pkcs11' scheme as defined by RFC 7512), but may be extended to other schemes in future (such as 'file' URIs for local files and 'data' URIs for inline certificate data).
Since: 1.6
gboolean nm_setting_802_1x_set_phase2_client_cert (NMSetting8021x *setting,const char *value,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 when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x authentication method.
setting |
the NMSetting8021x |
|
value |
when |
|
scheme |
desired storage scheme for the certificate |
|
out_format |
on successful return, the type of the certificate added |
|
error |
on unsuccessful return, an error |
const char *
nm_setting_802_1x_get_phase2_client_cert_password
(NMSetting8021x *setting);
the password used to access the "phase2" client certificate stored in “phase2-client-cert” property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
Since: 1.8
NMSettingSecretFlags
nm_setting_802_1x_get_phase2_client_cert_password_flags
(NMSetting8021x *setting);
Since: 1.8
const char *
nm_setting_802_1x_get_password (NMSetting8021x *setting);
NMSettingSecretFlags
nm_setting_802_1x_get_password_flags (NMSetting8021x *setting);
GBytes *
nm_setting_802_1x_get_password_raw (NMSetting8021x *setting);
NMSettingSecretFlags
nm_setting_802_1x_get_password_raw_flags
(NMSetting8021x *setting);
NMSettingSecretFlags
nm_setting_802_1x_get_pin_flags (NMSetting8021x *setting);
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_CK_SCHEME_PATH, use
nm_setting_802_1x_get_client_cert_path(); if
NM_SETTING_802_1X_CK_SCHEME_PKCS11, use
nm_setting_802_1x_get_client_cert_uri().
GBytes *
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 unencrypted private key data may be readable by unprivileged users. Private keys should always be encrypted with a private key password.
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.
const char *
nm_setting_802_1x_get_private_key_uri (NMSetting8021x *setting);
Returns the private key URI analogously to
nm_setting_802_1x_get_private_key_blob() and
nm_setting_802_1x_get_private_key_path().
Currently, it's limited to PKCS11 URIs ('pkcs11' scheme as defined by RFC 7512), but may be extended to other schemes in future (such as 'file' URIs for local files and 'data' URIs for inline certificate data).
Since: 1.6
gboolean nm_setting_802_1x_set_private_key (NMSetting8021x *setting,const char *value,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
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
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 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.
setting |
the NMSetting8021x |
|
value |
when |
|
password |
password used to decrypt the private key, or |
|
scheme |
desired storage scheme for the private key |
|
out_format |
on successful return, the type of the private key added |
|
error |
on unsuccessful return, an error |
const char *
nm_setting_802_1x_get_private_key_password
(NMSetting8021x *setting);
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.
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);
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_CK_SCHEME_PATH, use
nm_setting_802_1x_get_client_cert_path(); if
NM_SETTING_802_1X_CK_SCHEME_PKCS11, use
nm_setting_802_1x_get_client_cert_uri().
GBytes *
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 unencrypted private key data may be readable by unprivileged users. Private keys should always be encrypted with a private key password.
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.
const char *
nm_setting_802_1x_get_phase2_private_key_uri
(NMSetting8021x *setting);
Returns the "phase 2" private key URI analogously to
nm_setting_802_1x_get_phase2_private_key_blob() and
nm_setting_802_1x_get_phase2_private_key_path().
Currently, it's limited to PKCS11 URIs ('pkcs11' scheme as defined by RFC 7512), but may be extended to other schemes in future (such as 'file' URIs for local files and 'data' URIs for inline certificate data).
Since: 1.6
gboolean nm_setting_802_1x_set_phase2_private_key (NMSetting8021x *setting,const char *value,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
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
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 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.
setting |
the NMSetting8021x |
|
value |
when |
|
password |
password used to decrypt the private key, or |
|
scheme |
desired storage scheme for the private key |
|
out_format |
on successful return, the type of the private key added |
|
error |
on unsuccessful return, an error |
const char *
nm_setting_802_1x_get_phase2_private_key_password
(NMSetting8021x *setting);
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.
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);
NMSetting8021xAuthFlags
nm_setting_802_1x_get_phase1_auth_flags
(NMSetting8021x *setting);
Since: 1.8
int
nm_setting_802_1x_get_auth_timeout (NMSetting8021x *setting);
Returns the value contained in the “auth-timeout” property.
Since: 1.8
gboolean
nm_setting_802_1x_get_optional (NMSetting8021x *setting);
Returns the value contained in the “optional” property.
TRUE if the activation should proceed even when the 802.1X
authentication fails; FALSE otherwise
Since: 1.22
#define NM_SETTING_802_1X_CERT_SCHEME_PREFIX_PATH "file://"
#define NM_SETTING_802_1X_CERT_SCHEME_PREFIX_PKCS11 "pkcs11:"
NMSetting8021xCKFormat values indicate the general type of a certificate or private key
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
NMSetting8021xAuthFlags values indicate which authentication settings should be used.
Before 1.22, this was wrongly marked as a enum and not as a flags type.
Since: 1.8
#define NM_SETTING_802_1X_ANONYMOUS_IDENTITY "anonymous-identity"
#define NM_SETTING_802_1X_CA_CERT_PASSWORD_FLAGS "ca-cert-password-flags"
#define NM_SETTING_802_1X_ALTSUBJECT_MATCHES "altsubject-matches"
#define NM_SETTING_802_1X_DOMAIN_SUFFIX_MATCH "domain-suffix-match"
#define NM_SETTING_802_1X_CLIENT_CERT_PASSWORD "client-cert-password"
#define NM_SETTING_802_1X_CLIENT_CERT_PASSWORD_FLAGS "client-cert-password-flags"
#define NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING "phase1-fast-provisioning"
#define NM_SETTING_802_1X_PHASE2_CA_CERT_PASSWORD "phase2-ca-cert-password"
#define NM_SETTING_802_1X_PHASE2_CA_CERT_PASSWORD_FLAGS "phase2-ca-cert-password-flags"
#define NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH "phase2-subject-match"
#define NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES "phase2-altsubject-matches"
#define NM_SETTING_802_1X_PHASE2_DOMAIN_SUFFIX_MATCH "phase2-domain-suffix-match"
#define NM_SETTING_802_1X_PHASE2_DOMAIN_MATCH "phase2-domain-match"
#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT "phase2-client-cert"
#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT_PASSWORD "phase2-client-cert-password"
#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT_PASSWORD_FLAGS "phase2-client-cert-password-flags"
#define NM_SETTING_802_1X_PASSWORD_RAW_FLAGS "password-raw-flags"
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD "private-key-password"
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS "private-key-password-flags"
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY "phase2-private-key"
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD "phase2-private-key-password"
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS "phase2-private-key-password-flags"