Date: Fri, 26 Aug 2016 02:18:32 +0200 Subject: Imported Upstream version 1.4.0 --- docs/libnm-util/html/NMSetting8021x.html | 270 +++++++++++++++---------------- 1 file changed, 135 insertions(+), 135 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 05d9516c..6713ef28 100644 --- a/docs/libnm-util/html/NMSetting8021x.html +++ b/docs/libnm-util/html/NMSetting8021x.html @@ -8,7 +8,7 @@ - + @@ -966,7 +966,7 @@ following books.

nm_setting_802_1x_error_quark (void);

Registers an error quark for NMSetting8021x if necessary.

Returns

the error quark used for NMSetting8021x errors.

@@ -977,7 +977,7 @@ nm_setting_802_1x_error_quark (vo nm_setting_802_1x_new (void); Creates a new NMSetting8021x object with default values. -Returns +Returns the new empty NMSetting8021x object @@ -992,7 +992,7 @@ network. Generally only one EAP method is used. Use the functions and nm_setting_802_1x_remove_eap_method() for adding, removing, and retrieving allowed EAP methods. -Parameters +Parameters @@ -1007,7 +1007,7 @@ allowed EAP methods. -Returns +Returns the number of allowed EAP methods @@ -1020,7 +1020,7 @@ nm_setting_802_1x_get_eap_method (Returns the name of the allowed EAP method at index i . -Parameters +Parameters @@ -1042,7 +1042,7 @@ nm_setting_802_1x_get_eap_method ( -Returns +Returns the name of the allowed EAP method at index i @@ -1057,7 +1057,7 @@ nm_setting_802_1x_add_eap_method (“eap” property for a list of allowed EAP methods. -Parameters +Parameters @@ -1079,7 +1079,7 @@ allowed EAP methods. -Returns +Returns TRUE if the EAP method was successfully added, FALSE if it was not a valid method or if it was already allowed. @@ -1092,7 +1092,7 @@ nm_setting_802_1x_remove_eap_method (guint32 i); Removes the allowed EAP method at the specified index. -Parameters +Parameters @@ -1124,7 +1124,7 @@ nm_setting_802_1x_remove_eap_method_by_value Removes the allowed EAP method method . -Parameters +Parameters @@ -1146,7 +1146,7 @@ nm_setting_802_1x_remove_eap_method_by_value -Returns +Returns TRUE if the EAP method was founs and removed, FALSE if it was not. Since: 0.9.10 @@ -1158,7 +1158,7 @@ nm_setting_802_1x_remove_eap_method_by_value nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting); Clears all allowed EAP methods. -Parameters +Parameters @@ -1181,7 +1181,7 @@ nm_setting_802_1x_get_identity (Returns the identifier used by some EAP methods (like TLS) to authenticate the user. Often this is a username or login name. -Parameters +Parameters @@ -1196,7 +1196,7 @@ authenticate the user. Often this is a username or login name. -Returns +Returns the user identifier @@ -1211,7 +1211,7 @@ 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 +Parameters @@ -1226,7 +1226,7 @@ a secure form, if applicable for that EAP method. -Returns +Returns the anonymous identifier @@ -1237,7 +1237,7 @@ a secure form, if applicable for that EAP method. nm_setting_802_1x_get_pac_file (NMSetting8021x *setting); Returns the file containing PAC credentials used by EAP-FAST method. -Parameters +Parameters @@ -1252,7 +1252,7 @@ nm_setting_802_1x_get_pac_file ( -Returns +Returns the PAC file @@ -1268,7 +1268,7 @@ properties are ignored if the -Parameters +Parameters @@ -1283,7 +1283,7 @@ of these properties. -Returns +Returns TRUE if a system CA certificate path should be used, FALSE if not @@ -1298,7 +1298,7 @@ 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 +Parameters @@ -1313,7 +1313,7 @@ certificates for verifying the network to client. -Returns +Returns the CA certificate directory path @@ -1328,7 +1328,7 @@ 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 +Parameters @@ -1343,7 +1343,7 @@ to add more CA certificates for verifying the network to client. -Returns +Returns the "phase 2" CA certificate directory path @@ -1356,7 +1356,7 @@ nm_setting_802_1x_get_ca_cert_scheme (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 +Parameters @@ -1371,7 +1371,7 @@ if -Returns +Returns scheme used to store the CA certificate (blob or path) @@ -1387,7 +1387,7 @@ 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 +Parameters @@ -1402,7 +1402,7 @@ of the network cannot be confirmed by the client. -Returns +Returns the CA certificate data @@ -1418,7 +1418,7 @@ 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 +Parameters @@ -1433,7 +1433,7 @@ of the network cannot be confirmed by the client. -Returns +Returns path to the CA certificate file @@ -1451,7 +1451,7 @@ with the raw certificate data if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. -Parameters +Parameters @@ -1493,7 +1493,7 @@ clears the CA certificate. -Returns +Returns TRUE if the operation succeeded, FALSE if it was unsuccessful @@ -1503,7 +1503,7 @@ clears the CA certificate. const char * nm_setting_802_1x_get_subject_match (NMSetting8021x *setting); -Parameters +Parameters @@ -1518,7 +1518,7 @@ nm_setting_802_1x_get_subject_match ( -Returns +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 @@ -1534,7 +1534,7 @@ nm_setting_802_1x_get_num_altsubject_matches Returns the number of entries in the “altsubject-matches” property of this setting. -Parameters +Parameters @@ -1549,7 +1549,7 @@ nm_setting_802_1x_get_num_altsubject_matches -Returns +Returns the number of altsubject-matches entries. @@ -1563,7 +1563,7 @@ nm_setting_802_1x_get_altsubject_match Returns the altSubjectName match at index i . -Parameters +Parameters @@ -1585,7 +1585,7 @@ nm_setting_802_1x_get_altsubject_match -Returns +Returns the altSubjectName match at index i @@ -1601,7 +1601,7 @@ nm_setting_802_1x_add_altsubject_match match is added, the altSubjectName of the remote authentication server is not verified. -Parameters +Parameters @@ -1623,7 +1623,7 @@ server is not verified. -Returns +Returns TRUE if the alternative subject name match was successfully added, FALSE if it was already allowed. @@ -1637,7 +1637,7 @@ nm_setting_802_1x_remove_altsubject_match guint32 i); Removes the allowed altSubjectName at the specified index. -Parameters +Parameters @@ -1669,7 +1669,7 @@ nm_setting_802_1x_remove_altsubject_match_by_value Removes the allowed altSubjectName altsubject_match . -Parameters +Parameters @@ -1691,7 +1691,7 @@ nm_setting_802_1x_remove_altsubject_match_by_value -Returns +Returns TRUE if the alternative subject name match was found and removed, FALSE if it was not. @@ -1705,7 +1705,7 @@ nm_setting_802_1x_clear_altsubject_matches (NMSetting8021x *setting); Clears all altSubjectName matches. -Parameters +Parameters @@ -1730,7 +1730,7 @@ nm_setting_802_1x_get_client_cert_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 +Parameters @@ -1745,7 +1745,7 @@ if -Returns +Returns scheme used to store the client certificate (blob or path) @@ -1759,7 +1759,7 @@ nm_setting_802_1x_get_client_cert_blob when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x authentication method. -Parameters +Parameters @@ -1774,7 +1774,7 @@ authentication method. -Returns +Returns the client certificate data @@ -1788,7 +1788,7 @@ nm_setting_802_1x_get_client_cert_path when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x authentication method. -Parameters +Parameters @@ -1803,7 +1803,7 @@ authentication method. -Returns +Returns path to the client certificate file @@ -1824,7 +1824,7 @@ file if using the -Parameters +Parameters @@ -1867,7 +1867,7 @@ clears the client certificate. -Returns +Returns TRUE if the operation succeeded, FALSE if it was unsuccessful @@ -1877,7 +1877,7 @@ clears the client certificate. const char * nm_setting_802_1x_get_phase1_peapver (NMSetting8021x *setting); -Parameters +Parameters @@ -1892,7 +1892,7 @@ nm_setting_802_1x_get_phase1_peapver ( -Returns +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). @@ -1905,7 +1905,7 @@ values are NULL (unset), "0" (PEAP version 0), and nm_setting_802_1x_get_phase1_peaplabel (NMSetting8021x *setting); -Parameters +Parameters @@ -1920,7 +1920,7 @@ nm_setting_802_1x_get_phase1_peaplabel -Returns +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), @@ -1935,7 +1935,7 @@ wpa_supplicant documentation for more details. nm_setting_802_1x_get_phase1_fast_provisioning (NMSetting8021x *setting); -Parameters +Parameters @@ -1950,7 +1950,7 @@ nm_setting_802_1x_get_phase1_fast_provisioning -Returns +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. @@ -1962,7 +1962,7 @@ wpa_supplicant documentation for more details. const char * nm_setting_802_1x_get_phase2_auth (NMSetting8021x *setting); -Parameters +Parameters @@ -1977,7 +1977,7 @@ nm_setting_802_1x_get_phase2_auth ( -Returns +Returns the "phase 2" non-EAP (ex MD5) allowed authentication method as specified by the “phase2-auth” property. @@ -1988,7 +1988,7 @@ specified by the const char * nm_setting_802_1x_get_phase2_autheap (NMSetting8021x *setting); -Parameters +Parameters @@ -2003,7 +2003,7 @@ nm_setting_802_1x_get_phase2_autheap ( -Returns +Returns the "phase 2" EAP-based (ex TLS) allowed authentication method as specified by the “phase2-autheap” property. @@ -2019,7 +2019,7 @@ returned scheme is 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 +Parameters @@ -2034,7 +2034,7 @@ use -Returns +Returns scheme used to store the "phase 2" CA certificate (blob or path) @@ -2051,7 +2051,7 @@ 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 +Parameters @@ -2066,7 +2066,7 @@ of the network cannot be confirmed by the client. -Returns +Returns the "phase 2" CA certificate data @@ -2083,7 +2083,7 @@ 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 +Parameters @@ -2098,7 +2098,7 @@ of the network cannot be confirmed by the client. -Returns +Returns path to the "phase 2" CA certificate file @@ -2116,7 +2116,7 @@ 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 +Parameters @@ -2158,7 +2158,7 @@ clears the "phase2" CA certificate. -Returns +Returns TRUE if the operation succeeded, FALSE if it was unsuccessful @@ -2169,7 +2169,7 @@ clears the "phase2" CA certificate. nm_setting_802_1x_get_phase2_subject_match (NMSetting8021x *setting); -Parameters +Parameters @@ -2184,7 +2184,7 @@ nm_setting_802_1x_get_phase2_subject_match -Returns +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 @@ -2200,7 +2200,7 @@ nm_setting_802_1x_get_num_phase2_altsubject_matches Returns the number of entries in the “phase2-altsubject-matches” property of this setting. -Parameters +Parameters @@ -2215,7 +2215,7 @@ nm_setting_802_1x_get_num_phase2_altsubject_matches -Returns +Returns the number of phase2-altsubject-matches entries. @@ -2229,7 +2229,7 @@ nm_setting_802_1x_get_phase2_altsubject_match Returns the "phase 2" altSubjectName match at index i . -Parameters +Parameters @@ -2251,7 +2251,7 @@ nm_setting_802_1x_get_phase2_altsubject_match -Returns +Returns the "phase 2" altSubjectName match at index i @@ -2267,7 +2267,7 @@ nm_setting_802_1x_add_phase2_altsubject_match at least one match is added, the altSubjectName of the "phase 2" remote authentication server is not verified. -Parameters +Parameters @@ -2290,7 +2290,7 @@ connection -Returns +Returns TRUE if the "phase 2" alternative subject name match was successfully added, FALSE if it was already allowed. @@ -2304,7 +2304,7 @@ nm_setting_802_1x_remove_phase2_altsubject_match guint32 i); Removes the allowed "phase 2" altSubjectName at the specified index. -Parameters +Parameters @@ -2336,7 +2336,7 @@ nm_setting_802_1x_remove_phase2_altsubject_match_by_value Removes the allowed "phase 2" altSubjectName phase2_altsubject_match . -Parameters +Parameters @@ -2358,7 +2358,7 @@ nm_setting_802_1x_remove_phase2_altsubject_match_by_value -Returns +Returns TRUE if the alternative subject name match for "phase 2" was found and removed, FALSE if it was not. @@ -2372,7 +2372,7 @@ nm_setting_802_1x_clear_phase2_altsubject_matches (NMSetting8021x *setting); Clears all "phase 2" altSubjectName matches. -Parameters +Parameters @@ -2399,7 +2399,7 @@ returned scheme is NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_client_cert_path(). -Parameters +Parameters @@ -2414,7 +2414,7 @@ returned scheme is -Returns +Returns scheme used to store the "phase 2" client certificate (blob or path) @@ -2428,7 +2428,7 @@ nm_setting_802_1x_get_phase2_client_cert_blob when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x authentication method. -Parameters +Parameters @@ -2443,7 +2443,7 @@ authentication method. -Returns +Returns the "phase 2" client certificate data @@ -2457,7 +2457,7 @@ nm_setting_802_1x_get_phase2_client_cert_path when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x authentication method. -Parameters +Parameters @@ -2472,7 +2472,7 @@ authentication method. -Returns +Returns path to the "phase 2" client certificate file @@ -2494,7 +2494,7 @@ file if using the -Parameters +Parameters @@ -2537,7 +2537,7 @@ clears the "phase2" client certificate. -Returns +Returns TRUE if the operation succeeded, FALSE if it was unsuccessful @@ -2547,7 +2547,7 @@ clears the "phase2" client certificate. const char * nm_setting_802_1x_get_password (NMSetting8021x *setting); -Parameters +Parameters @@ -2562,7 +2562,7 @@ nm_setting_802_1x_get_password ( -Returns +Returns the password used by the authentication method, if any, as specified by the “password” property @@ -2573,7 +2573,7 @@ by the NMSettingSecretFlags nm_setting_802_1x_get_password_flags (NMSetting8021x *setting); -Parameters +Parameters @@ -2588,7 +2588,7 @@ nm_setting_802_1x_get_password_flags ( -Returns +Returns the NMSettingSecretFlags pertaining to the “password” @@ -2598,7 +2598,7 @@ nm_setting_802_1x_get_password_flags (const GByteArray * nm_setting_802_1x_get_password_raw (NMSetting8021x *setting); -Parameters +Parameters @@ -2613,7 +2613,7 @@ nm_setting_802_1x_get_password_raw ( -Returns +Returns the password used by the authentication method as a UTF-8-encoded array of bytes, as specified by the “password-raw” property @@ -2626,7 +2626,7 @@ UTF-8-encoded array of bytes, as specified by the nm_setting_802_1x_get_password_raw_flags (NMSetting8021x *setting); -Parameters +Parameters @@ -2641,7 +2641,7 @@ nm_setting_802_1x_get_password_raw_flags -Returns +Returns the NMSettingSecretFlags pertaining to the “password-raw” @@ -2652,7 +2652,7 @@ nm_setting_802_1x_get_password_raw_flags const char * nm_setting_802_1x_get_pin (NMSetting8021x *setting); -Parameters +Parameters @@ -2667,7 +2667,7 @@ nm_setting_802_1x_get_pin ( -Returns +Returns the PIN used by the authentication method, if any, as specified by the “pin” property @@ -2678,7 +2678,7 @@ by the NMSettingSecretFlags nm_setting_802_1x_get_pin_flags (NMSetting8021x *setting); -Parameters +Parameters @@ -2693,7 +2693,7 @@ nm_setting_802_1x_get_pin_flags ( -Returns +Returns the NMSettingSecretFlags pertaining to the “pin” @@ -2710,7 +2710,7 @@ nm_setting_802_1x_get_private_key_scheme NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_client_cert_path(). -Parameters +Parameters @@ -2725,7 +2725,7 @@ nm_setting_802_1x_get_private_key_scheme -Returns +Returns scheme used to store the private key (blob or path) @@ -2742,7 +2742,7 @@ authentication method. unencrypted private key data may be readable by unprivileged users. Private keys should always be encrypted with a private key password. -Parameters +Parameters @@ -2757,7 +2757,7 @@ keys should always be encrypted with a private key password. -Returns +Returns the private key data @@ -2771,7 +2771,7 @@ nm_setting_802_1x_get_private_key_path when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x authentication method. -Parameters +Parameters @@ -2786,7 +2786,7 @@ authentication method. -Returns +Returns path to the private key file @@ -2824,7 +2824,7 @@ 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 +Parameters @@ -2873,7 +2873,7 @@ an error is returned. -Returns +Returns TRUE if the operation succeeded, FALSE if it was unsuccessful @@ -2884,7 +2884,7 @@ an error is returned. nm_setting_802_1x_get_private_key_password (NMSetting8021x *setting); -Parameters +Parameters @@ -2899,7 +2899,7 @@ nm_setting_802_1x_get_private_key_password -Returns +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. @@ -2912,7 +2912,7 @@ previously set with NMSetting8021x *setting); -Parameters +Parameters @@ -2927,7 +2927,7 @@ nm_setting_802_1x_get_private_key_password_flags -Returns +Returns the NMSettingSecretFlags pertaining to the “private-key-password” @@ -2939,7 +2939,7 @@ nm_setting_802_1x_get_private_key_password_flags nm_setting_802_1x_get_private_key_format (NMSetting8021x *setting); -Parameters +Parameters @@ -2954,7 +2954,7 @@ nm_setting_802_1x_get_private_key_format -Returns +Returns the data format of the private key data stored in the “private-key” property @@ -2971,7 +2971,7 @@ scheme is NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_client_cert_path(). -Parameters +Parameters @@ -2986,7 +2986,7 @@ scheme is -Returns +Returns scheme used to store the "phase 2" private key (blob or path) @@ -3003,7 +3003,7 @@ authentication method. unencrypted private key data may be readable by unprivileged users. Private keys should always be encrypted with a private key password. -Parameters +Parameters @@ -3018,7 +3018,7 @@ keys should always be encrypted with a private key password. -Returns +Returns the "phase 2" private key data @@ -3032,7 +3032,7 @@ nm_setting_802_1x_get_phase2_private_key_path when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x authentication method. -Parameters +Parameters @@ -3047,7 +3047,7 @@ authentication method. -Returns +Returns path to the "phase 2" private key file @@ -3086,7 +3086,7 @@ 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 +Parameters @@ -3136,7 +3136,7 @@ an error is returned. -Returns +Returns TRUE if the operation succeeded, FALSE if it was unsuccessful @@ -3147,7 +3147,7 @@ an error is returned. nm_setting_802_1x_get_phase2_private_key_password (NMSetting8021x *setting); -Parameters +Parameters @@ -3162,7 +3162,7 @@ nm_setting_802_1x_get_phase2_private_key_password -Returns +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. @@ -3175,7 +3175,7 @@ previously set with NMSetting8021x *setting); -Parameters +Parameters @@ -3190,7 +3190,7 @@ nm_setting_802_1x_get_phase2_private_key_password_flags -Returns +Returns the NMSettingSecretFlags pertaining to the “phase2-private-key-password” @@ -3202,7 +3202,7 @@ nm_setting_802_1x_get_phase2_private_key_password_flags nm_setting_802_1x_get_phase2_private_key_format (NMSetting8021x *setting); -Parameters +Parameters @@ -3217,7 +3217,7 @@ nm_setting_802_1x_get_phase2_private_key_format -Returns +Returns the data format of the "phase 2" private key data stored in the “phase2-private-key” property @@ -3230,7 +3230,7 @@ nm_setting_802_1x_get_phase2_private_key_format NMSetting8021xCKFormat values indicate the general type of a certificate or private key -Members +Members @@ -3279,7 +3279,7 @@ and private key 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 +Members @@ -3325,7 +3325,7 @@ to a file containing the certificate or key data enum NMSetting8021xError -Members +Members @@ -3963,6 +3963,6 @@ addition to any certificates specified by the -Generated by GTK-Doc V1.24 +Generated by GTK-Doc V1.25 \ No newline at end of file -- cgit 1.3.0-6-gf8a5