diff options
| author | Michael Biebl <biebl@debian.org> | 2015-07-14 19:38:58 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2015-07-14 19:38:58 +0200 |
| commit | 50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 (patch) | |
| tree | 6790165f39daee79e2b6c6617483320613493367 /docs/libnm/html/NMSetting8021x.html | |
| parent | f408e27bccfacf347605a8d98649975a68f38a17 (diff) | |
Imported Upstream version 1.0.4 upstream/1.0.4
Diffstat (limited to 'docs/libnm/html/NMSetting8021x.html')
| -rw-r--r-- | docs/libnm/html/NMSetting8021x.html | 362 |
1 files changed, 203 insertions, 159 deletions
diff --git a/docs/libnm/html/NMSetting8021x.html b/docs/libnm/html/NMSetting8021x.html index ba6aa73f..f9e3ae1b 100644 --- a/docs/libnm/html/NMSetting8021x.html +++ b/docs/libnm/html/NMSetting8021x.html @@ -2,13 +2,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm Reference Manual: NMSetting8021x</title> +<title>NMSetting8021x: libnm Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm Reference Manual"> <link rel="up" href="ch03.html" title="Connection and Setting API Reference"> <link rel="prev" href="NMSettingConnection.html" title="NMSettingConnection"> <link rel="next" href="NMSettingAdsl.html" title="NMSettingAdsl"> -<meta name="generator" content="GTK-Doc V1.21 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -767,6 +767,10 @@ </colgroup> <tbody> <tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSetting8021x.html#NM-SETTING-802-1X-CERT-SCHEME-PREFIX-PATH:CAPS" title="NM_SETTING_802_1X_CERT_SCHEME_PREFIX_PATH">NM_SETTING_802_1X_CERT_SCHEME_PREFIX_PATH</a></td> +</tr> +<tr> <td class="datatype_keyword">enum</td> <td class="function_name"><a class="link" href="NMSetting8021x.html#NMSetting8021xCKFormat" title="enum NMSetting8021xCKFormat">NMSetting8021xCKFormat</a></td> </tr> @@ -950,7 +954,6 @@ nm_setting_802_1x_new (<em class="parameter"><code><span class="type">void</span <div class="refsect3"> <a name="id-1.4.6.8.2.5"></a><h4>Returns</h4> <p> the new empty <a class="link" href="NMSetting8021x.html" title="NMSetting8021x"><span class="type">NMSetting8021x</span></a> object</p> -<p></p> </div> </div> <hr> @@ -981,7 +984,6 @@ allowed EAP methods.</p> <div class="refsect3"> <a name="id-1.4.6.8.3.6"></a><h4>Returns</h4> <p> the number of allowed EAP methods</p> -<p></p> </div> </div> <hr> @@ -1018,7 +1020,6 @@ nm_setting_802_1x_get_eap_method (<em class="parameter"><code><a class="link" hr <a name="id-1.4.6.8.4.6"></a><h4>Returns</h4> <p> the name of the allowed EAP method at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -1056,7 +1057,6 @@ allowed EAP methods.</p> <a name="id-1.4.6.8.5.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the EAP method was successfully added, <code class="literal">FALSE</code> if it was not a valid method or if it was already allowed.</p> -<p></p> </div> </div> <hr> @@ -1123,7 +1123,6 @@ nm_setting_802_1x_remove_eap_method_by_value <div class="refsect3"> <a name="id-1.4.6.8.7.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the EAP method was founs and removed, <code class="literal">FALSE</code> if it was not.</p> -<p></p> </div> </div> <hr> @@ -1173,7 +1172,6 @@ authenticate the user. Often this is a username or login name.</p> <div class="refsect3"> <a name="id-1.4.6.8.9.6"></a><h4>Returns</h4> <p> the user identifier</p> -<p></p> </div> </div> <hr> @@ -1204,7 +1202,6 @@ a secure form, if applicable for that EAP method.</p> <div class="refsect3"> <a name="id-1.4.6.8.10.6"></a><h4>Returns</h4> <p> the anonymous identifier</p> -<p></p> </div> </div> <hr> @@ -1231,7 +1228,6 @@ nm_setting_802_1x_get_pac_file (<em class="parameter"><code><a class="link" href <div class="refsect3"> <a name="id-1.4.6.8.11.6"></a><h4>Returns</h4> <p> the PAC file</p> -<p></p> </div> </div> <hr> @@ -1263,7 +1259,6 @@ of these properties.</p> <div class="refsect3"> <a name="id-1.4.6.8.12.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if a system CA certificate path should be used, <code class="literal">FALSE</code> if not</p> -<p></p> </div> </div> <hr> @@ -1294,7 +1289,6 @@ certificates for verifying the network to client.</p> <div class="refsect3"> <a name="id-1.4.6.8.13.6"></a><h4>Returns</h4> <p> the CA certificate directory path</p> -<p></p> </div> </div> <hr> @@ -1325,7 +1319,6 @@ to add more CA certificates for verifying the network to client.</p> <div class="refsect3"> <a name="id-1.4.6.8.14.6"></a><h4>Returns</h4> <p> the "phase 2" CA certificate directory path</p> -<p></p> </div> </div> <hr> @@ -1354,7 +1347,6 @@ if <a class="link" href="NMSetting8021x.html#NM-SETTING-802-1X-CK-SCHEME-PATH:CA <div class="refsect3"> <a name="id-1.4.6.8.15.6"></a><h4>Returns</h4> <p> scheme used to store the CA certificate (blob or path)</p> -<p></p> </div> </div> <hr> @@ -1418,7 +1410,6 @@ of the network cannot be confirmed by the client.</p> <div class="refsect3"> <a name="id-1.4.6.8.17.6"></a><h4>Returns</h4> <p> path to the CA certificate file</p> -<p></p> </div> </div> <hr> @@ -1479,7 +1470,6 @@ clears the CA certificate.</p></td> <div class="refsect3"> <a name="id-1.4.6.8.18.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the operation succeeded, <code class="literal">FALSE</code> if it was unsuccessful</p> -<p></p> </div> </div> <hr> @@ -1508,7 +1498,6 @@ nm_setting_802_1x_get_subject_match (<em class="parameter"><code><a class="link" substring to be matched against the subject of the authentication server certificate, or <code class="literal">NULL</code> no subject verification is to be performed.</p> -<p></p> </div> </div> <hr> @@ -1537,7 +1526,6 @@ nm_setting_802_1x_get_num_altsubject_matches <div class="refsect3"> <a name="id-1.4.6.8.20.6"></a><h4>Returns</h4> <p> the number of altsubject-matches entries.</p> -<p></p> </div> </div> <hr> @@ -1575,7 +1563,6 @@ nm_setting_802_1x_get_altsubject_match <a name="id-1.4.6.8.21.6"></a><h4>Returns</h4> <p> the altSubjectName match at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -1614,7 +1601,6 @@ server is not verified.</p> <a name="id-1.4.6.8.22.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the alternative subject name match was successfully added, <code class="literal">FALSE</code> if it was already allowed.</p> -<p></p> </div> </div> <hr> @@ -1683,7 +1669,6 @@ nm_setting_802_1x_remove_altsubject_match_by_value <a name="id-1.4.6.8.24.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the alternative subject name match was found and removed, <code class="literal">FALSE</code> if it was not.</p> -<p></p> </div> </div> <hr> @@ -1736,7 +1721,6 @@ if <a class="link" href="NMSetting8021x.html#NM-SETTING-802-1X-CK-SCHEME-PATH:CA <div class="refsect3"> <a name="id-1.4.6.8.26.6"></a><h4>Returns</h4> <p> scheme used to store the client certificate (blob or path)</p> -<p></p> </div> </div> <hr> @@ -1796,7 +1780,6 @@ authentication method.</p> <div class="refsect3"> <a name="id-1.4.6.8.28.6"></a><h4>Returns</h4> <p> path to the client certificate file</p> -<p></p> </div> </div> <hr> @@ -1861,7 +1844,6 @@ clears the client certificate.</p></td> <div class="refsect3"> <a name="id-1.4.6.8.29.7"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the operation succeeded, <code class="literal">FALSE</code> if it was unsuccessful</p> -<p></p> </div> </div> <hr> @@ -1889,7 +1871,6 @@ nm_setting_802_1x_get_phase1_peapver (<em class="parameter"><code><a class="link <p> the "phase 1" PEAP version to be used when authenticating with EAP-PEAP as contained in the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase1-peapver" title="The “phase1-peapver” property"><span class="type">“phase1-peapver”</span></a> property. Valid values are <code class="literal">NULL</code> (unset), "0" (PEAP version 0), and "1" (PEAP version 1).</p> -<p></p> </div> </div> <hr> @@ -1920,7 +1901,6 @@ used when authenticating with EAP-PEAP, as contained in the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase1-peaplabel" title="The “phase1-peaplabel” property"><span class="type">“phase1-peaplabel”</span></a> property. Valid values are <code class="literal">NULL</code> (unset), "0" (use old-style label), and "1" (use new-style label). See the wpa_supplicant documentation for more details.</p> -<p></p> </div> </div> <hr> @@ -1949,7 +1929,6 @@ nm_setting_802_1x_get_phase1_fast_provisioning <p> whether "phase 1" PEAP fast provisioning should be used, as specified by the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase1-fast-provisioning" title="The “phase1-fast-provisioning” property"><span class="type">“phase1-fast-provisioning”</span></a> property. See the wpa_supplicant documentation for more details.</p> -<p></p> </div> </div> <hr> @@ -1976,7 +1955,6 @@ nm_setting_802_1x_get_phase2_auth (<em class="parameter"><code><a class="link" h <a name="id-1.4.6.8.33.5"></a><h4>Returns</h4> <p> the "phase 2" non-EAP (ex MD5) allowed authentication method as specified by the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-auth" title="The “phase2-auth” property"><span class="type">“phase2-auth”</span></a> property.</p> -<p></p> </div> </div> <hr> @@ -2003,7 +1981,6 @@ nm_setting_802_1x_get_phase2_autheap (<em class="parameter"><code><a class="link <a name="id-1.4.6.8.34.5"></a><h4>Returns</h4> <p> the "phase 2" EAP-based (ex TLS) allowed authentication method as specified by the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-autheap" title="The “phase2-autheap” property"><span class="type">“phase2-autheap”</span></a> property.</p> -<p></p> </div> </div> <hr> @@ -2034,7 +2011,6 @@ use <a class="link" href="NMSetting8021x.html#nm-setting-802-1x-get-ca-cert-path <div class="refsect3"> <a name="id-1.4.6.8.35.6"></a><h4>Returns</h4> <p> scheme used to store the "phase 2" CA certificate (blob or path)</p> -<p></p> </div> </div> <hr> @@ -2100,7 +2076,6 @@ of the network cannot be confirmed by the client.</p> <div class="refsect3"> <a name="id-1.4.6.8.37.6"></a><h4>Returns</h4> <p> path to the "phase 2" CA certificate file</p> -<p></p> </div> </div> <hr> @@ -2161,7 +2136,6 @@ clears the "phase2" CA certificate.</p></td> <div class="refsect3"> <a name="id-1.4.6.8.38.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the operation succeeded, <code class="literal">FALSE</code> if it was unsuccessful</p> -<p></p> </div> </div> <hr> @@ -2191,7 +2165,6 @@ nm_setting_802_1x_get_phase2_subject_match the substring to be matched against the subject of the "phase 2" authentication server certificate, or <code class="literal">NULL</code> no subject verification is to be performed.</p> -<p></p> </div> </div> <hr> @@ -2220,7 +2193,6 @@ nm_setting_802_1x_get_num_phase2_altsubject_matches <div class="refsect3"> <a name="id-1.4.6.8.40.6"></a><h4>Returns</h4> <p> the number of phase2-altsubject-matches entries.</p> -<p></p> </div> </div> <hr> @@ -2258,7 +2230,6 @@ nm_setting_802_1x_get_phase2_altsubject_match <a name="id-1.4.6.8.41.6"></a><h4>Returns</h4> <p> the "phase 2" altSubjectName match at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -2298,7 +2269,6 @@ connection</p></td> <a name="id-1.4.6.8.42.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the "phase 2" alternative subject name match was successfully added, <code class="literal">FALSE</code> if it was already allowed.</p> -<p></p> </div> </div> <hr> @@ -2367,7 +2337,6 @@ nm_setting_802_1x_remove_phase2_altsubject_match_by_value <a name="id-1.4.6.8.44.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the alternative subject name match for "phase 2" was found and removed, <code class="literal">FALSE</code> if it was not.</p> -<p></p> </div> </div> <hr> @@ -2422,7 +2391,6 @@ returned scheme is <a class="link" href="NMSetting8021x.html#NM-SETTING-802-1X-C <div class="refsect3"> <a name="id-1.4.6.8.46.6"></a><h4>Returns</h4> <p> scheme used to store the "phase 2" client certificate (blob or path)</p> -<p></p> </div> </div> <hr> @@ -2482,7 +2450,6 @@ authentication method.</p> <div class="refsect3"> <a name="id-1.4.6.8.48.6"></a><h4>Returns</h4> <p> path to the "phase 2" client certificate file</p> -<p></p> </div> </div> <hr> @@ -2548,7 +2515,6 @@ clears the "phase2" client certificate.</p></td> <div class="refsect3"> <a name="id-1.4.6.8.49.7"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the operation succeeded, <code class="literal">FALSE</code> if it was unsuccessful</p> -<p></p> </div> </div> <hr> @@ -2575,7 +2541,6 @@ nm_setting_802_1x_get_password (<em class="parameter"><code><a class="link" href <a name="id-1.4.6.8.50.5"></a><h4>Returns</h4> <p> the password used by the authentication method, if any, as specified by the <a class="link" href="NMSetting8021x.html#NMSetting8021x--password" title="The “password” property"><span class="type">“password”</span></a> property</p> -<p></p> </div> </div> <hr> @@ -2601,7 +2566,6 @@ nm_setting_802_1x_get_password_flags (<em class="parameter"><code><a class="link <div class="refsect3"> <a name="id-1.4.6.8.51.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSetting8021x.html#NMSetting8021x--password" title="The “password” property"><span class="type">“password”</span></a></p> -<p></p> </div> </div> <hr> @@ -2657,7 +2621,6 @@ nm_setting_802_1x_get_password_raw_flags <a name="id-1.4.6.8.53.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSetting8021x.html#NMSetting8021x--password-raw" title="The “password-raw” property"><span class="type">“password-raw”</span></a></p> -<p></p> </div> </div> <hr> @@ -2684,7 +2647,6 @@ nm_setting_802_1x_get_pin (<em class="parameter"><code><a class="link" href="NMS <a name="id-1.4.6.8.54.5"></a><h4>Returns</h4> <p> the PIN used by the authentication method, if any, as specified by the <a class="link" href="NMSetting8021x.html#NMSetting8021x--pin" title="The “pin” property"><span class="type">“pin”</span></a> property</p> -<p></p> </div> </div> <hr> @@ -2711,7 +2673,6 @@ nm_setting_802_1x_get_pin_flags (<em class="parameter"><code><a class="link" hre <a name="id-1.4.6.8.55.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSetting8021x.html#NMSetting8021x--pin" title="The “pin” property"><span class="type">“pin”</span></a></p> -<p></p> </div> </div> <hr> @@ -2743,7 +2704,6 @@ nm_setting_802_1x_get_private_key_scheme <div class="refsect3"> <a name="id-1.4.6.8.56.6"></a><h4>Returns</h4> <p> scheme used to store the private key (blob or path)</p> -<p></p> </div> </div> <hr> @@ -2806,7 +2766,6 @@ authentication method.</p> <div class="refsect3"> <a name="id-1.4.6.8.58.6"></a><h4>Returns</h4> <p> path to the private key file</p> -<p></p> </div> </div> <hr> @@ -2894,7 +2853,6 @@ an error is returned.</p></td> <div class="refsect3"> <a name="id-1.4.6.8.59.9"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the operation succeeded, <code class="literal">FALSE</code> if it was unsuccessful</p> -<p></p> </div> </div> <hr> @@ -2923,7 +2881,6 @@ nm_setting_802_1x_get_private_key_password <p> the private key password used to decrypt the private key if previously set with <a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-private-key" title="nm_setting_802_1x_set_private_key ()"><code class="function">nm_setting_802_1x_set_private_key()</code></a>, or the <a class="link" href="NMSetting8021x.html#NMSetting8021x--private-key-password" title="The “private-key-password” property"><span class="type">“private-key-password”</span></a> property.</p> -<p></p> </div> </div> <hr> @@ -2951,7 +2908,6 @@ nm_setting_802_1x_get_private_key_password_flags <a name="id-1.4.6.8.61.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSetting8021x.html#NMSetting8021x--private-key-password" title="The “private-key-password” property"><span class="type">“private-key-password”</span></a></p> -<p></p> </div> </div> <hr> @@ -2979,7 +2935,6 @@ nm_setting_802_1x_get_private_key_format <a name="id-1.4.6.8.62.5"></a><h4>Returns</h4> <p> the data format of the private key data stored in the <a class="link" href="NMSetting8021x.html#NMSetting8021x--private-key" title="The “private-key” property"><span class="type">“private-key”</span></a> property</p> -<p></p> </div> </div> <hr> @@ -3011,7 +2966,6 @@ scheme is <a class="link" href="NMSetting8021x.html#NM-SETTING-802-1X-CK-SCHEME- <div class="refsect3"> <a name="id-1.4.6.8.63.6"></a><h4>Returns</h4> <p> scheme used to store the "phase 2" private key (blob or path)</p> -<p></p> </div> </div> <hr> @@ -3074,7 +3028,6 @@ authentication method.</p> <div class="refsect3"> <a name="id-1.4.6.8.65.6"></a><h4>Returns</h4> <p> path to the "phase 2" private key file</p> -<p></p> </div> </div> <hr> @@ -3164,7 +3117,6 @@ an error is returned.</p></td> <div class="refsect3"> <a name="id-1.4.6.8.66.9"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the operation succeeded, <code class="literal">FALSE</code> if it was unsuccessful</p> -<p></p> </div> </div> <hr> @@ -3193,7 +3145,6 @@ nm_setting_802_1x_get_phase2_private_key_password <p> the private key password used to decrypt the private key if previously set with <a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-phase2-private-key" title="nm_setting_802_1x_set_phase2_private_key ()"><code class="function">nm_setting_802_1x_set_phase2_private_key()</code></a> or the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-private-key-password" title="The “phase2-private-key-password” property"><span class="type">“phase2-private-key-password”</span></a> property.</p> -<p></p> </div> </div> <hr> @@ -3221,7 +3172,6 @@ nm_setting_802_1x_get_phase2_private_key_password_flags <a name="id-1.4.6.8.68.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a> pertaining to the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-private-key-password" title="The “phase2-private-key-password” property"><span class="type">“phase2-private-key-password”</span></a></p> -<p></p> </div> </div> <hr> @@ -3249,18 +3199,23 @@ nm_setting_802_1x_get_phase2_private_key_format <a name="id-1.4.6.8.69.5"></a><h4>Returns</h4> <p> the data format of the "phase 2" private key data stored in the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-private-key" title="The “phase2-private-key” property"><span class="type">“phase2-private-key”</span></a> property</p> -<p></p> </div> </div> </div> <div class="refsect1"> <a name="NMSetting8021x.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> +<a name="NM-SETTING-802-1X-CERT-SCHEME-PREFIX-PATH:CAPS"></a><h3>NM_SETTING_802_1X_CERT_SCHEME_PREFIX_PATH</h3> +<pre class="programlisting">#define NM_SETTING_802_1X_CERT_SCHEME_PREFIX_PATH "file://" +</pre> +</div> +<hr> +<div class="refsect2"> <a name="NMSetting8021xCKFormat"></a><h3>enum NMSetting8021xCKFormat</h3> <p><a class="link" href="NMSetting8021x.html#NMSetting8021xCKFormat" title="enum NMSetting8021xCKFormat"><span class="type">NMSetting8021xCKFormat</span></a> values indicate the general type of a certificate or private key</p> <div class="refsect3"> -<a name="id-1.4.6.9.2.4"></a><h4>Members</h4> +<a name="id-1.4.6.9.3.4"></a><h4>Members</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="300px" class="enum_members_name"> @@ -3309,7 +3264,7 @@ and private key</p> 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</p> <div class="refsect3"> -<a name="id-1.4.6.9.3.4"></a><h4>Members</h4> +<a name="id-1.4.6.9.4.4"></a><h4>Members</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="300px" class="enum_members_name"> @@ -3350,264 +3305,198 @@ to a file containing the certificate or key data</p> <a name="NM-SETTING-802-1X-SETTING-NAME:CAPS"></a><h3>NM_SETTING_802_1X_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_802_1X_SETTING_NAME "802-1x" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-EAP:CAPS"></a><h3>NM_SETTING_802_1X_EAP</h3> <pre class="programlisting">#define NM_SETTING_802_1X_EAP "eap" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-IDENTITY:CAPS"></a><h3>NM_SETTING_802_1X_IDENTITY</h3> <pre class="programlisting">#define NM_SETTING_802_1X_IDENTITY "identity" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-ANONYMOUS-IDENTITY:CAPS"></a><h3>NM_SETTING_802_1X_ANONYMOUS_IDENTITY</h3> <pre class="programlisting">#define NM_SETTING_802_1X_ANONYMOUS_IDENTITY "anonymous-identity" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PAC-FILE:CAPS"></a><h3>NM_SETTING_802_1X_PAC_FILE</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PAC_FILE "pac-file" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-CA-CERT:CAPS"></a><h3>NM_SETTING_802_1X_CA_CERT</h3> <pre class="programlisting">#define NM_SETTING_802_1X_CA_CERT "ca-cert" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-CA-PATH:CAPS"></a><h3>NM_SETTING_802_1X_CA_PATH</h3> <pre class="programlisting">#define NM_SETTING_802_1X_CA_PATH "ca-path" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-SUBJECT-MATCH:CAPS"></a><h3>NM_SETTING_802_1X_SUBJECT_MATCH</h3> <pre class="programlisting">#define NM_SETTING_802_1X_SUBJECT_MATCH "subject-match" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-ALTSUBJECT-MATCHES:CAPS"></a><h3>NM_SETTING_802_1X_ALTSUBJECT_MATCHES</h3> <pre class="programlisting">#define NM_SETTING_802_1X_ALTSUBJECT_MATCHES "altsubject-matches" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-CLIENT-CERT:CAPS"></a><h3>NM_SETTING_802_1X_CLIENT_CERT</h3> <pre class="programlisting">#define NM_SETTING_802_1X_CLIENT_CERT "client-cert" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE1-PEAPVER:CAPS"></a><h3>NM_SETTING_802_1X_PHASE1_PEAPVER</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE1_PEAPVER "phase1-peapver" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE1-PEAPLABEL:CAPS"></a><h3>NM_SETTING_802_1X_PHASE1_PEAPLABEL</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE1_PEAPLABEL "phase1-peaplabel" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE1-FAST-PROVISIONING:CAPS"></a><h3>NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING "phase1-fast-provisioning" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE2-AUTH:CAPS"></a><h3>NM_SETTING_802_1X_PHASE2_AUTH</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE2_AUTH "phase2-auth" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE2-AUTHEAP:CAPS"></a><h3>NM_SETTING_802_1X_PHASE2_AUTHEAP</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE2_AUTHEAP "phase2-autheap" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE2-CA-CERT:CAPS"></a><h3>NM_SETTING_802_1X_PHASE2_CA_CERT</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE2_CA_CERT "phase2-ca-cert" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE2-CA-PATH:CAPS"></a><h3>NM_SETTING_802_1X_PHASE2_CA_PATH</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE2_CA_PATH "phase2-ca-path" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE2-SUBJECT-MATCH:CAPS"></a><h3>NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH "phase2-subject-match" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE2-ALTSUBJECT-MATCHES:CAPS"></a><h3>NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES "phase2-altsubject-matches" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE2-CLIENT-CERT:CAPS"></a><h3>NM_SETTING_802_1X_PHASE2_CLIENT_CERT</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT "phase2-client-cert" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PASSWORD:CAPS"></a><h3>NM_SETTING_802_1X_PASSWORD</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PASSWORD "password" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PASSWORD-FLAGS:CAPS"></a><h3>NM_SETTING_802_1X_PASSWORD_FLAGS</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PASSWORD_FLAGS "password-flags" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PASSWORD-RAW:CAPS"></a><h3>NM_SETTING_802_1X_PASSWORD_RAW</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PASSWORD_RAW "password-raw" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PASSWORD-RAW-FLAGS:CAPS"></a><h3>NM_SETTING_802_1X_PASSWORD_RAW_FLAGS</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PASSWORD_RAW_FLAGS "password-raw-flags" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PRIVATE-KEY:CAPS"></a><h3>NM_SETTING_802_1X_PRIVATE_KEY</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PRIVATE_KEY "private-key" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PRIVATE-KEY-PASSWORD:CAPS"></a><h3>NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD "private-key-password" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PRIVATE-KEY-PASSWORD-FLAGS:CAPS"></a><h3>NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS "private-key-password-flags" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE2-PRIVATE-KEY:CAPS"></a><h3>NM_SETTING_802_1X_PHASE2_PRIVATE_KEY</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY "phase2-private-key" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE2-PRIVATE-KEY-PASSWORD:CAPS"></a><h3>NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD "phase2-private-key-password" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PHASE2-PRIVATE-KEY-PASSWORD-FLAGS:CAPS"></a><h3>NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS "phase2-private-key-password-flags" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PIN:CAPS"></a><h3>NM_SETTING_802_1X_PIN</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PIN "pin" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-PIN-FLAGS:CAPS"></a><h3>NM_SETTING_802_1X_PIN_FLAGS</h3> <pre class="programlisting">#define NM_SETTING_802_1X_PIN_FLAGS "pin-flags" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-802-1X-SYSTEM-CA-CERTS:CAPS"></a><h3>NM_SETTING_802_1X_SYSTEM_CA_CERTS</h3> <pre class="programlisting">#define NM_SETTING_802_1X_SYSTEM_CA_CERTS "system-ca-certs" </pre> -<p> -</p> </div> </div> <div class="refsect1"> @@ -3615,14 +3504,18 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--altsubject-matches"></a><h3>The <code class="literal">“altsubject-matches”</code> property</h3> <pre class="programlisting"> “altsubject-matches” <span class="type">GStrv</span></pre> -<p></p> +<p>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.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--anonymous-identity"></a><h3>The <code class="literal">“anonymous-identity”</code> property</h3> <pre class="programlisting"> “anonymous-identity” <span class="type">gchar</span> *</pre> -<p></p> +<p>Anonymous identity string for EAP authentication methods. Used as the +unencrypted identity with EAP types that support different tunneled +identity like EAP-TTLS.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3630,14 +3523,27 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--ca-cert"></a><h3>The <code class="literal">“ca-cert”</code> property</h3> <pre class="programlisting"> “ca-cert” <span class="type">GBytes</span> *</pre> -<p></p> +<p>Contains the CA certificate if used by the EAP method specified in the +<a class="link" href="NMSetting8021x.html#NMSetting8021x--eap" title="The “eap” property"><span class="type">“eap”</span></a> property.</p> +<p>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.</p> +<p>Setting this property directly is discouraged; use the +<a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-ca-cert" title="nm_setting_802_1x_set_ca_cert ()"><code class="function">nm_setting_802_1x_set_ca_cert()</code></a> function instead.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--ca-path"></a><h3>The <code class="literal">“ca-path”</code> property</h3> <pre class="programlisting"> “ca-path” <span class="type">gchar</span> *</pre> -<p></p> +<p>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 <a class="link" href="NMSetting8021x.html#NMSetting8021x--ca-cert" title="The “ca-cert” property"><span class="type">“ca-cert”</span></a> property.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3645,21 +3551,35 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--client-cert"></a><h3>The <code class="literal">“client-cert”</code> property</h3> <pre class="programlisting"> “client-cert” <span class="type">GBytes</span> *</pre> -<p></p> +<p>Contains the client certificate if used by the EAP method specified in +the <a class="link" href="NMSetting8021x.html#NMSetting8021x--eap" title="The “eap” property"><span class="type">“eap”</span></a> property.</p> +<p>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.</p> +<p>Setting this property directly is discouraged; use the +<a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-client-cert" title="nm_setting_802_1x_set_client_cert ()"><code class="function">nm_setting_802_1x_set_client_cert()</code></a> function instead.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--eap"></a><h3>The <code class="literal">“eap”</code> property</h3> <pre class="programlisting"> “eap” <span class="type">GStrv</span></pre> -<p></p> +<p>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.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--identity"></a><h3>The <code class="literal">“identity”</code> property</h3> <pre class="programlisting"> “identity” <span class="type">gchar</span> *</pre> -<p></p> +<p>Identity string for EAP authentication methods. Often the user's user or +login name.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3667,7 +3587,7 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--pac-file"></a><h3>The <code class="literal">“pac-file”</code> property</h3> <pre class="programlisting"> “pac-file” <span class="type">gchar</span> *</pre> -<p></p> +<p>UTF-8 encoded file path containing PAC for EAP-FAST.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3675,7 +3595,9 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--password"></a><h3>The <code class="literal">“password”</code> property</h3> <pre class="programlisting"> “password” <span class="type">gchar</span> *</pre> -<p></p> +<p>UTF-8 encoded password used for EAP authentication methods. If both the +<a class="link" href="NMSetting8021x.html#NMSetting8021x--password" title="The “password” property"><span class="type">“password”</span></a> property and the <a class="link" href="NMSetting8021x.html#NMSetting8021x--password-raw" title="The “password-raw” property"><span class="type">“password-raw”</span></a> +property are specified, <a class="link" href="NMSetting8021x.html#NMSetting8021x--password" title="The “password” property"><span class="type">“password”</span></a> is preferred.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3683,28 +3605,36 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--password-flags"></a><h3>The <code class="literal">“password-flags”</code> property</h3> <pre class="programlisting"> “password-flags” <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a></pre> -<p></p> +<p>Flags indicating how to handle the <a class="link" href="NMSetting8021x.html#NMSetting8021x--password" title="The “password” property"><span class="type">“password”</span></a> property.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--password-raw"></a><h3>The <code class="literal">“password-raw”</code> property</h3> <pre class="programlisting"> “password-raw” <span class="type">GBytes</span> *</pre> -<p></p> +<p>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 +<a class="link" href="NMSetting8021x.html#NMSetting8021x--password" title="The “password” property"><span class="type">“password”</span></a> property and the <a class="link" href="NMSetting8021x.html#NMSetting8021x--password-raw" title="The “password-raw” property"><span class="type">“password-raw”</span></a> +property are specified, <a class="link" href="NMSetting8021x.html#NMSetting8021x--password" title="The “password” property"><span class="type">“password”</span></a> is preferred.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--password-raw-flags"></a><h3>The <code class="literal">“password-raw-flags”</code> property</h3> <pre class="programlisting"> “password-raw-flags” <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a></pre> -<p></p> +<p>Flags indicating how to handle the <a class="link" href="NMSetting8021x.html#NMSetting8021x--password-raw" title="The “password-raw” property"><span class="type">“password-raw”</span></a> property.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--phase1-fast-provisioning"></a><h3>The <code class="literal">“phase1-fast-provisioning”</code> property</h3> <pre class="programlisting"> “phase1-fast-provisioning” <span class="type">gchar</span> *</pre> -<p></p> +<p>Enables or disables in-line provisioning of EAP-FAST credentials when +FAST is specified as the EAP method in the <a class="link" href="NMSetting8021x.html#NMSetting8021x--eap" title="The “eap” property"><span class="type">“eap”</span></a> 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.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3712,7 +3642,10 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--phase1-peaplabel"></a><h3>The <code class="literal">“phase1-peaplabel”</code> property</h3> <pre class="programlisting"> “phase1-peaplabel” <span class="type">gchar</span> *</pre> -<p></p> +<p>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.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3720,7 +3653,12 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--phase1-peapver"></a><h3>The <code class="literal">“phase1-peapver”</code> property</h3> <pre class="programlisting"> “phase1-peapver” <span class="type">gchar</span> *</pre> -<p></p> +<p>Forces which PEAP version is used when PEAP is set as the EAP method in +the <a class="link" href="NMSetting8021x.html#NMSetting8021x--eap" title="The “eap” property"><span class="type">“eap”</span></a> 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.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3728,14 +3666,22 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--phase2-altsubject-matches"></a><h3>The <code class="literal">“phase2-altsubject-matches”</code> property</h3> <pre class="programlisting"> “phase2-altsubject-matches” <span class="type">GStrv</span></pre> -<p></p> +<p>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.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--phase2-auth"></a><h3>The <code class="literal">“phase2-auth”</code> property</h3> <pre class="programlisting"> “phase2-auth” <span class="type">gchar</span> *</pre> -<p></p> +<p>Specifies the allowed "phase 2" inner non-EAP authentication methods when +an EAP method that uses an inner TLS tunnel is specified in the +<a class="link" href="NMSetting8021x.html#NMSetting8021x--eap" title="The “eap” property"><span class="type">“eap”</span></a> 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.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3743,7 +3689,12 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--phase2-autheap"></a><h3>The <code class="literal">“phase2-autheap”</code> property</h3> <pre class="programlisting"> “phase2-autheap” <span class="type">gchar</span> *</pre> -<p></p> +<p>Specifies the allowed "phase 2" inner EAP-based authentication methods +when an EAP method that uses an inner TLS tunnel is specified in the +<a class="link" href="NMSetting8021x.html#NMSetting8021x--eap" title="The “eap” property"><span class="type">“eap”</span></a> 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.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3751,14 +3702,28 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--phase2-ca-cert"></a><h3>The <code class="literal">“phase2-ca-cert”</code> property</h3> <pre class="programlisting"> “phase2-ca-cert” <span class="type">GBytes</span> *</pre> -<p></p> +<p>Contains the "phase 2" CA certificate if used by the EAP method specified +in the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-auth" title="The “phase2-auth” property"><span class="type">“phase2-auth”</span></a> or <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-autheap" title="The “phase2-autheap” property"><span class="type">“phase2-autheap”</span></a> +properties.</p> +<p>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.</p> +<p>Setting this property directly is discouraged; use the +<a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-phase2-ca-cert" title="nm_setting_802_1x_set_phase2_ca_cert ()"><code class="function">nm_setting_802_1x_set_phase2_ca_cert()</code></a> function instead.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--phase2-ca-path"></a><h3>The <code class="literal">“phase2-ca-path”</code> property</h3> <pre class="programlisting"> “phase2-ca-path” <span class="type">gchar</span> *</pre> -<p></p> +<p>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 <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-ca-cert" title="The “phase2-ca-cert” property"><span class="type">“phase2-ca-cert”</span></a> property.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3766,21 +3731,58 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--phase2-client-cert"></a><h3>The <code class="literal">“phase2-client-cert”</code> property</h3> <pre class="programlisting"> “phase2-client-cert” <span class="type">GBytes</span> *</pre> -<p></p> +<p>Contains the "phase 2" client certificate if used by the EAP method +specified in the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-auth" title="The “phase2-auth” property"><span class="type">“phase2-auth”</span></a> or +<a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-autheap" title="The “phase2-autheap” property"><span class="type">“phase2-autheap”</span></a> properties.</p> +<p>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.</p> +<p>Setting this property directly is discouraged; use the +<a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-phase2-client-cert" title="nm_setting_802_1x_set_phase2_client_cert ()"><code class="function">nm_setting_802_1x_set_phase2_client_cert()</code></a> function instead.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--phase2-private-key"></a><h3>The <code class="literal">“phase2-private-key”</code> property</h3> <pre class="programlisting"> “phase2-private-key” <span class="type">GBytes</span> *</pre> -<p></p> +<p>Contains the "phase 2" inner private key when the +<a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-auth" title="The “phase2-auth” property"><span class="type">“phase2-auth”</span></a> or <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-autheap" title="The “phase2-autheap” property"><span class="type">“phase2-autheap”</span></a> property is +set to "tls".</p> +<p>Key data is specified using a "scheme"; two are currently supported: blob +and path. When using the blob scheme and private keys, this property +should be set to the key's encrypted PEM encoded data. When using private +keys with the path scheme, this property should be set to the full UTF-8 +encoded path of the key, prefixed with the string "file://" and ending +with a terminating NUL byte. When using PKCS#12 format private +keys and the blob scheme, this property should be set to the +PKCS#12 data and the <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-private-key-password" title="The “phase2-private-key-password” property"><span class="type">“phase2-private-key-password”</span></a> +property must be set to password used to decrypt the PKCS#12 +certificate and key. When using PKCS#12 files and the path +scheme, this property should be set to the full UTF-8 encoded path of the +key, prefixed with the string "file://" and and ending with a terminating +NUL byte, and as with the blob scheme the +<a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-private-key-password" title="The “phase2-private-key-password” property"><span class="type">“phase2-private-key-password”</span></a> property must be set to the +password used to decode the PKCS#12 private key and certificate.</p> +<p>Setting this property directly is discouraged; use the +<a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-phase2-private-key" title="nm_setting_802_1x_set_phase2_private_key ()"><code class="function">nm_setting_802_1x_set_phase2_private_key()</code></a> function instead.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--phase2-private-key-password"></a><h3>The <code class="literal">“phase2-private-key-password”</code> property</h3> <pre class="programlisting"> “phase2-private-key-password” <span class="type">gchar</span> *</pre> -<p></p> +<p>The password used to decrypt the "phase 2" private key specified in the +<a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-private-key" title="The “phase2-private-key” property"><span class="type">“phase2-private-key”</span></a> property when the private key either +uses the path scheme, or is a PKCS#12 format key. Setting this +property directly is not generally necessary except when returning +secrets to NetworkManager; it is generally set automatically when setting +the private key by the <a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-phase2-private-key" title="nm_setting_802_1x_set_phase2_private_key ()"><code class="function">nm_setting_802_1x_set_phase2_private_key()</code></a> +function.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3788,14 +3790,18 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--phase2-private-key-password-flags"></a><h3>The <code class="literal">“phase2-private-key-password-flags”</code> property</h3> <pre class="programlisting"> “phase2-private-key-password-flags” <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a></pre> -<p></p> +<p>Flags indicating how to handle the +<a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-private-key-password" title="The “phase2-private-key-password” property"><span class="type">“phase2-private-key-password”</span></a> property.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--phase2-subject-match"></a><h3>The <code class="literal">“phase2-subject-match”</code> property</h3> <pre class="programlisting"> “phase2-subject-match” <span class="type">gchar</span> *</pre> -<p></p> +<p>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.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3803,7 +3809,7 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--pin"></a><h3>The <code class="literal">“pin”</code> property</h3> <pre class="programlisting"> “pin” <span class="type">gchar</span> *</pre> -<p></p> +<p>PIN used for EAP authentication methods.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3811,21 +3817,49 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--pin-flags"></a><h3>The <code class="literal">“pin-flags”</code> property</h3> <pre class="programlisting"> “pin-flags” <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a></pre> -<p></p> +<p>Flags indicating how to handle the <a class="link" href="NMSetting8021x.html#NMSetting8021x--pin" title="The “pin” property"><span class="type">“pin”</span></a> property.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--private-key"></a><h3>The <code class="literal">“private-key”</code> property</h3> <pre class="programlisting"> “private-key” <span class="type">GBytes</span> *</pre> -<p></p> +<p>Contains the private key when the <a class="link" href="NMSetting8021x.html#NMSetting8021x--eap" title="The “eap” property"><span class="type">“eap”</span></a> property is set to +"tls".</p> +<p>Key data is specified using a "scheme"; two are currently supported: blob +and path. When using the blob scheme and private keys, this property +should be set to the key's encrypted PEM encoded data. When using private +keys with the path scheme, this property should be set to the full UTF-8 +encoded path of the key, prefixed with the string "file://" and ending +with a terminating NUL byte. When using PKCS#12 format private +keys and the blob scheme, this property should be set to the +PKCS#12 data and the <a class="link" href="NMSetting8021x.html#NMSetting8021x--private-key-password" title="The “private-key-password” property"><span class="type">“private-key-password”</span></a> +property must be set to password used to decrypt the PKCS#12 +certificate and key. When using PKCS#12 files and the path +scheme, this property should be set to the full UTF-8 encoded path of the +key, prefixed with the string "file://" and and ending with a terminating +NUL byte, and as with the blob scheme the "private-key-password" property +must be set to the password used to decode the PKCS#12 private +key and certificate.</p> +<p>Setting this property directly is discouraged; use the +<a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-private-key" title="nm_setting_802_1x_set_private_key ()"><code class="function">nm_setting_802_1x_set_private_key()</code></a> function instead.</p> +<p>WARNING: <a class="link" href="NMSetting8021x.html#NMSetting8021x--private-key" title="The “private-key” property"><span class="type">“private-key”</span></a> 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.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--private-key-password"></a><h3>The <code class="literal">“private-key-password”</code> property</h3> <pre class="programlisting"> “private-key-password” <span class="type">gchar</span> *</pre> -<p></p> +<p>The password used to decrypt the private key specified in the +<a class="link" href="NMSetting8021x.html#NMSetting8021x--private-key" title="The “private-key” property"><span class="type">“private-key”</span></a> property when the private key either uses the +path scheme, or if the private key is a PKCS#12 format key. Setting this +property directly is not generally necessary except when returning +secrets to NetworkManager; it is generally set automatically when setting +the private key by the <a class="link" href="NMSetting8021x.html#nm-setting-802-1x-set-private-key" title="nm_setting_802_1x_set_private_key ()"><code class="function">nm_setting_802_1x_set_private_key()</code></a> function.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3833,14 +3867,17 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--private-key-password-flags"></a><h3>The <code class="literal">“private-key-password-flags”</code> property</h3> <pre class="programlisting"> “private-key-password-flags” <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="type">NMSettingSecretFlags</span></a></pre> -<p></p> +<p>Flags indicating how to handle the <a class="link" href="NMSetting8021x.html#NMSetting8021x--private-key-password" title="The “private-key-password” property"><span class="type">“private-key-password”</span></a> +property.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSetting8021x--subject-match"></a><h3>The <code class="literal">“subject-match”</code> property</h3> <pre class="programlisting"> “subject-match” <span class="type">gchar</span> *</pre> -<p></p> +<p>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.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3848,14 +3885,21 @@ to a file containing the certificate or key data</p> <div class="refsect2"> <a name="NMSetting8021x--system-ca-certs"></a><h3>The <code class="literal">“system-ca-certs”</code> property</h3> <pre class="programlisting"> “system-ca-certs” <span class="type">gboolean</span></pre> -<p></p> +<p>When <code class="literal">TRUE</code>, overrides the <a class="link" href="NMSetting8021x.html#NMSetting8021x--ca-path" title="The “ca-path” property"><span class="type">“ca-path”</span></a> and +<a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-ca-path" title="The “phase2-ca-path” property"><span class="type">“phase2-ca-path”</span></a> 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 <a class="link" href="NMSetting8021x.html#NMSetting8021x--ca-cert" title="The “ca-cert” property"><span class="type">“ca-cert”</span></a> and +<a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-ca-cert" title="The “phase2-ca-cert” property"><span class="type">“phase2-ca-cert”</span></a> properties. If the path provided with +--system-ca-path is rather a file name (bundle of trusted CA certificates), +it overrides <a class="link" href="NMSetting8021x.html#NMSetting8021x--ca-cert" title="The “ca-cert” property"><span class="type">“ca-cert”</span></a> and <a class="link" href="NMSetting8021x.html#NMSetting8021x--phase2-ca-cert" title="The “phase2-ca-cert” property"><span class="type">“phase2-ca-cert”</span></a> +properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</p> <p>Flags: Read / Write / Construct</p> <p>Default value: FALSE</p> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.21</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html> \ No newline at end of file |