diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingWirelessSecurity.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingWirelessSecurity.html | 147 |
1 files changed, 61 insertions, 86 deletions
diff --git a/docs/libnm-util/html/NMSettingWirelessSecurity.html b/docs/libnm-util/html/NMSettingWirelessSecurity.html index 6f4b21a9..d091dda2 100644 --- a/docs/libnm-util/html/NMSettingWirelessSecurity.html +++ b/docs/libnm-util/html/NMSettingWirelessSecurity.html @@ -2,13 +2,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm-util Reference Manual: NMSettingWirelessSecurity</title> +<title>NMSettingWirelessSecurity: libnm-util Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm-util Reference Manual"> <link rel="up" href="ch01.html" title="libnm-util API Reference"> <link rel="prev" href="NMSettingWireless.html" title="NMSettingWireless"> <link rel="next" href="NMSettingBluetooth.html" title="NMSettingBluetooth"> -<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"> @@ -537,7 +537,6 @@ nm_setting_wireless_security_error_quark <div class="refsect3"> <a name="id-1.2.7.9.2.5"></a><h4>Returns</h4> <p> the error quark used for <a class="link" href="NMSettingWired.html" title="NMSettingWired"><span class="type">NMSettingWired</span></a> errors.</p> -<p></p> </div> </div> <hr> @@ -576,7 +575,6 @@ nm_setting_wireless_security_get_key_mgmt <div class="refsect3"> <a name="id-1.2.7.9.4.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--key-mgmt" title="The “key-mgmt” property"><span class="type">“key-mgmt”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -604,7 +602,6 @@ nm_setting_wireless_security_get_num_protos <a name="id-1.2.7.9.5.5"></a><h4>Returns</h4> <p> the number of security protocols this connection allows when connecting to secure Wi-Fi networks</p> -<p></p> </div> </div> <hr> @@ -640,7 +637,6 @@ nm_setting_wireless_security_get_proto <a name="id-1.2.7.9.6.5"></a><h4>Returns</h4> <p> the protocol at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -682,7 +678,6 @@ with the access point.</p> <a name="id-1.2.7.9.7.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the protocol was new and and was added to the allowed protocol list, or <code class="literal">FALSE</code> if it was already in the list</p> -<p></p> </div> </div> <hr> @@ -749,9 +744,8 @@ nm_setting_wireless_security_remove_proto_by_value <div class="refsect3"> <a name="id-1.2.7.9.9.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the protocol was found and removed; <code class="literal">FALSE</code> it it was not.</p> -<p></p> </div> -<p class="since">Since 0.9.10</p> +<p class="since">Since: 0.9.10</p> </div> <hr> <div class="refsect2"> @@ -801,7 +795,6 @@ nm_setting_wireless_security_get_num_pairwise <div class="refsect3"> <a name="id-1.2.7.9.11.5"></a><h4>Returns</h4> <p> the number of pairwise encryption algorithms in the allowed list</p> -<p></p> </div> </div> <hr> @@ -839,7 +832,6 @@ list.</p> <a name="id-1.2.7.9.12.6"></a><h4>Returns</h4> <p> the pairwise encryption algorithm at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -879,7 +871,6 @@ compatible with this connection.</p> <a name="id-1.2.7.9.13.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the algorithm was added to the list, <code class="literal">FALSE</code> if it was already in the list</p> -<p></p> </div> </div> <hr> @@ -948,9 +939,8 @@ algorithm list.</p> <div class="refsect3"> <a name="id-1.2.7.9.15.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the encryption algorith was found and removed; <code class="literal">FALSE</code> it it was not.</p> -<p></p> </div> -<p class="since">Since 0.9.10</p> +<p class="since">Since: 0.9.10</p> </div> <hr> <div class="refsect2"> @@ -1000,7 +990,6 @@ nm_setting_wireless_security_get_num_groups <div class="refsect3"> <a name="id-1.2.7.9.17.5"></a><h4>Returns</h4> <p> the number of groupwise encryption algorithms in the allowed list</p> -<p></p> </div> </div> <hr> @@ -1038,7 +1027,6 @@ list.</p> <a name="id-1.2.7.9.18.6"></a><h4>Returns</h4> <p> the groupwise encryption algorithm at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -1079,7 +1067,6 @@ compatible with this connection.</p> <a name="id-1.2.7.9.19.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the algorithm was added to the list, <code class="literal">FALSE</code> if it was already in the list</p> -<p></p> </div> </div> <hr> @@ -1149,9 +1136,8 @@ algorithm list.</p> <div class="refsect3"> <a name="id-1.2.7.9.21.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the algorithm was found and removed; <code class="literal">FALSE</code> it it was not.</p> -<p></p> </div> -<p class="since">Since 0.9.10</p> +<p class="since">Since: 0.9.10</p> </div> <hr> <div class="refsect2"> @@ -1200,7 +1186,6 @@ nm_setting_wireless_security_get_psk (<em class="parameter"><code><a class="link <div class="refsect3"> <a name="id-1.2.7.9.23.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--psk" title="The “psk” property"><span class="type">“psk”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -1228,7 +1213,6 @@ nm_setting_wireless_security_get_psk_flags <a name="id-1.2.7.9.24.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="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--psk" title="The “psk” property"><span class="type">“psk”</span></a></p> -<p></p> </div> </div> <hr> @@ -1255,7 +1239,6 @@ nm_setting_wireless_security_get_leap_username <div class="refsect3"> <a name="id-1.2.7.9.25.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--leap-username" title="The “leap-username” property"><span class="type">“leap-username”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -1282,7 +1265,6 @@ nm_setting_wireless_security_get_leap_password <div class="refsect3"> <a name="id-1.2.7.9.26.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--leap-password" title="The “leap-password” property"><span class="type">“leap-password”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -1310,7 +1292,6 @@ nm_setting_wireless_security_get_leap_password_flags <a name="id-1.2.7.9.27.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="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--leap-password" title="The “leap-password” property"><span class="type">“leap-password”</span></a></p> -<p></p> </div> </div> <hr> @@ -1345,7 +1326,6 @@ nm_setting_wireless_security_get_wep_key <div class="refsect3"> <a name="id-1.2.7.9.28.5"></a><h4>Returns</h4> <p> the WEP key at the given index</p> -<p></p> </div> </div> <hr> @@ -1411,7 +1391,6 @@ nm_setting_wireless_security_get_wep_tx_keyidx <div class="refsect3"> <a name="id-1.2.7.9.30.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--wep-tx-keyidx" title="The “wep-tx-keyidx” property"><span class="type">“wep-tx-keyidx”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -1438,7 +1417,6 @@ nm_setting_wireless_security_get_auth_alg <div class="refsect3"> <a name="id-1.2.7.9.31.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--auth-alg" title="The “auth-alg” property"><span class="type">“auth-alg”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -1465,7 +1443,6 @@ nm_setting_wireless_security_get_wep_key_flags <div class="refsect3"> <a name="id-1.2.7.9.32.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 all WEP keys</p> -<p></p> </div> </div> <hr> @@ -1492,7 +1469,6 @@ nm_setting_wireless_security_get_wep_key_type <div class="refsect3"> <a name="id-1.2.7.9.33.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--wep-key-type" title="The “wep-key-type” property"><span class="type">“wep-key-type”</span></a> property of the setting</p> -<p></p> </div> </div> </div> @@ -1502,8 +1478,6 @@ nm_setting_wireless_security_get_wep_key_type <a name="NM-SETTING-WIRELESS-SECURITY-SETTING-NAME:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_SETTING_NAME "802-11-wireless-security" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> @@ -1581,8 +1555,6 @@ encryption protocol</p> <a name="NM-SETTING-WIRELESS-SECURITY-ERROR:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_ERROR</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_ERROR nm_setting_wireless_security_error_quark () </pre> -<p> -</p> </div> <hr> <div class="refsect2"> @@ -1648,136 +1620,102 @@ the actual WEP key using the MD5 hash algorithm.</p> <a name="NM-SETTING-WIRELESS-SECURITY-KEY-MGMT:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_KEY_MGMT</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_KEY_MGMT "key-mgmt" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-WEP-TX-KEYIDX:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX "wep-tx-keyidx" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-AUTH-ALG:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_AUTH_ALG</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_AUTH_ALG "auth-alg" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-PROTO:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_PROTO</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_PROTO "proto" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-PAIRWISE:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_PAIRWISE</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_PAIRWISE "pairwise" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-GROUP:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_GROUP</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_GROUP "group" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-LEAP-USERNAME:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME "leap-username" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-WEP-KEY0:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_WEP_KEY0</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY0 "wep-key0" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-WEP-KEY1:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_WEP_KEY1</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY1 "wep-key1" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-WEP-KEY2:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_WEP_KEY2</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY2 "wep-key2" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-WEP-KEY3:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_WEP_KEY3</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY3 "wep-key3" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-WEP-KEY-FLAGS:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS "wep-key-flags" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-WEP-KEY-TYPE:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE "wep-key-type" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-PSK:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_PSK</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_PSK "psk" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-PSK-FLAGS:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS "psk-flags" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-LEAP-PASSWORD:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD "leap-password" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRELESS-SECURITY-LEAP-PASSWORD-FLAGS:CAPS"></a><h3>NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS</h3> <pre class="programlisting">#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS "leap-password-flags" </pre> -<p> -</p> </div> </div> <div class="refsect1"> @@ -1785,7 +1723,11 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--auth-alg"></a><h3>The <code class="literal">“auth-alg”</code> property</h3> <pre class="programlisting"> “auth-alg” <span class="type">gchar</span> *</pre> -<p></p> +<p>When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the +802.11 authentication algorithm required by the AP here. One of "open" +for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When +using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the +"leap-username" and "leap-password" properties must be specified.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1793,14 +1735,20 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--group"></a><h3>The <code class="literal">“group”</code> property</h3> <pre class="programlisting"> “group” <span class="type">GSList_gchararray_</span> *</pre> -<p></p> +<p>A list of group/broadcast encryption algorithms which prevents +connections to Wi-Fi networks that do not utilize one of the algorithms +in the list. For maximum compatibility leave this property empty. Each +list element may be one of "wep40", "wep104", "tkip", or "ccmp".</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingWirelessSecurity--key-mgmt"></a><h3>The <code class="literal">“key-mgmt”</code> property</h3> <pre class="programlisting"> “key-mgmt” <span class="type">gchar</span> *</pre> -<p></p> +<p>Key management used for the connection. One of "none" (WEP), "ieee8021x" +(Dynamic WEP), "wpa-none" (Ad-Hoc WPA-PSK), "wpa-psk" (infrastructure +WPA-PSK), or "wpa-eap" (WPA-Enterprise). This property must be set for +any Wi-Fi connection that uses security.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1808,7 +1756,8 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--leap-password"></a><h3>The <code class="literal">“leap-password”</code> property</h3> <pre class="programlisting"> “leap-password” <span class="type">gchar</span> *</pre> -<p></p> +<p>The login password for legacy LEAP connections (ie, key-mgmt = +"ieee8021x" and auth-alg = "leap").</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1816,7 +1765,8 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--leap-password-flags"></a><h3>The <code class="literal">“leap-password-flags”</code> property</h3> <pre class="programlisting"> “leap-password-flags” <span class="type">guint</span></pre> -<p></p> +<p>Flags indicating how to handle the +<a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--leap-password" title="The “leap-password” property"><span class="type">“leap-password”</span></a> property.</p> <p>Flags: Read / Write</p> <p>Allowed values: <= 7</p> <p>Default value: 0</p> @@ -1825,7 +1775,8 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--leap-username"></a><h3>The <code class="literal">“leap-username”</code> property</h3> <pre class="programlisting"> “leap-username” <span class="type">gchar</span> *</pre> -<p></p> +<p>The login username for legacy LEAP connections (ie, key-mgmt = +"ieee8021x" and auth-alg = "leap").</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1833,21 +1784,31 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--pairwise"></a><h3>The <code class="literal">“pairwise”</code> property</h3> <pre class="programlisting"> “pairwise” <span class="type">GSList_gchararray_</span> *</pre> -<p></p> +<p>A list of pairwise encryption algorithms which prevents connections to +Wi-Fi networks that do not utilize one of the algorithms in the list. +For maximum compatibility leave this property empty. Each list element +may be one of "tkip" or "ccmp".</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingWirelessSecurity--proto"></a><h3>The <code class="literal">“proto”</code> property</h3> <pre class="programlisting"> “proto” <span class="type">GSList_gchararray_</span> *</pre> -<p></p> +<p>List of strings specifying the allowed WPA protocol versions to use. +Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If +not specified, both WPA and RSN connections are allowed.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingWirelessSecurity--psk"></a><h3>The <code class="literal">“psk”</code> property</h3> <pre class="programlisting"> “psk” <span class="type">gchar</span> *</pre> -<p></p> +<p>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it +must contain only hexadecimal characters and is interpreted as a +hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII +characters (as specified in the 802.11i standard) and is interpreted as a +WPA passphrase, and is hashed to derive the actual WPA-PSK used when +connecting to the Wi-Fi network.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1855,7 +1816,8 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--psk-flags"></a><h3>The <code class="literal">“psk-flags”</code> property</h3> <pre class="programlisting"> “psk-flags” <span class="type">guint</span></pre> -<p></p> +<p>Flags indicating how to handle the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--psk" title="The “psk” property"><span class="type">“psk”</span></a> +property.</p> <p>Flags: Read / Write</p> <p>Allowed values: <= 7</p> <p>Default value: 0</p> @@ -1864,7 +1826,9 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--wep-key-flags"></a><h3>The <code class="literal">“wep-key-flags”</code> property</h3> <pre class="programlisting"> “wep-key-flags” <span class="type">guint</span></pre> -<p></p> +<p>Flags indicating how to handle the <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--wep-key0" title="The “wep-key0” property"><span class="type">“wep-key0”</span></a>, +<a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--wep-key1" title="The “wep-key1” property"><span class="type">“wep-key1”</span></a>, <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--wep-key2" title="The “wep-key2” property"><span class="type">“wep-key2”</span></a>, +and <a class="link" href="NMSettingWirelessSecurity.html#NMSettingWirelessSecurity--wep-key3" title="The “wep-key3” property"><span class="type">“wep-key3”</span></a> properties.</p> <p>Flags: Read / Write</p> <p>Allowed values: <= 7</p> <p>Default value: 0</p> @@ -1873,7 +1837,12 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--wep-key-type"></a><h3>The <code class="literal">“wep-key-type”</code> property</h3> <pre class="programlisting"> “wep-key-type” <span class="type">guint</span></pre> -<p></p> +<p>Controls the interpretation of WEP keys. Allowed values are +<a class="link" href="NMSettingWirelessSecurity.html#NM-WEP-KEY-TYPE-KEY:CAPS"><code class="literal">NM_WEP_KEY_TYPE_KEY</code></a>, in which case the key is either a 10- or +26-character hexadecimal string, or a 5- or 13-character ASCII password; +or <a class="link" href="NMSettingWirelessSecurity.html#NM-WEP-KEY-TYPE-PASSPHRASE:CAPS"><code class="literal">NM_WEP_KEY_TYPE_PASSPHRASE</code></a>, in which case the passphrase is provided +as a string and will be hashed using the de-facto MD5 method to derive +the actual WEP key.</p> <p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 2</p> <p>Default value: 0</p> @@ -1882,7 +1851,8 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--wep-key0"></a><h3>The <code class="literal">“wep-key0”</code> property</h3> <pre class="programlisting"> “wep-key0” <span class="type">gchar</span> *</pre> -<p></p> +<p>Index 0 WEP key. This is the WEP key used in most networks. See the +"wep-key-type" property for a description of how this key is interpreted.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1890,7 +1860,8 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--wep-key1"></a><h3>The <code class="literal">“wep-key1”</code> property</h3> <pre class="programlisting"> “wep-key1” <span class="type">gchar</span> *</pre> -<p></p> +<p>Index 1 WEP key. This WEP index is not used by most networks. See the +"wep-key-type" property for a description of how this key is interpreted.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1898,7 +1869,8 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--wep-key2"></a><h3>The <code class="literal">“wep-key2”</code> property</h3> <pre class="programlisting"> “wep-key2” <span class="type">gchar</span> *</pre> -<p></p> +<p>Index 2 WEP key. This WEP index is not used by most networks. See the +"wep-key-type" property for a description of how this key is interpreted.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1906,7 +1878,8 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--wep-key3"></a><h3>The <code class="literal">“wep-key3”</code> property</h3> <pre class="programlisting"> “wep-key3” <span class="type">gchar</span> *</pre> -<p></p> +<p>Index 3 WEP key. This WEP index is not used by most networks. See the +"wep-key-type" property for a description of how this key is interpreted.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1914,7 +1887,10 @@ the actual WEP key using the MD5 hash algorithm.</p> <div class="refsect2"> <a name="NMSettingWirelessSecurity--wep-tx-keyidx"></a><h3>The <code class="literal">“wep-tx-keyidx”</code> property</h3> <pre class="programlisting"> “wep-tx-keyidx” <span class="type">guint</span></pre> -<p></p> +<p>When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key +index is used by the AP, put that WEP key index here. Valid values are 0 +(default key) through 3. Note that some consumer access points (like the +Linksys WRT54G) number the keys 1 - 4.</p> <p>Flags: Read / Write / Construct</p> <p>Allowed values: <= 3</p> <p>Default value: 0</p> @@ -1922,7 +1898,6 @@ the actual WEP key using the MD5 hash algorithm.</p> </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 |