From 263bf4c0c89bb88dc995acd9a6a2de9095fbd461 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 23 Aug 2011 19:16:47 +0200 Subject: Imported Upstream version 0.9.0 --- .../libnm-util/html/NMSettingWirelessSecurity.html | 549 +++++++++++++++++++-- 1 file changed, 516 insertions(+), 33 deletions(-) (limited to 'docs/libnm-util/html/NMSettingWirelessSecurity.html') diff --git a/docs/libnm-util/html/NMSettingWirelessSecurity.html b/docs/libnm-util/html/NMSettingWirelessSecurity.html index 7fdbc952..0d13105c 100644 --- a/docs/libnm-util/html/NMSettingWirelessSecurity.html +++ b/docs/libnm-util/html/NMSettingWirelessSecurity.html @@ -35,13 +35,17 @@

NMSettingWirelessSecurity

-

NMSettingWirelessSecurity

+

NMSettingWirelessSecurity — Describes connection properties for WiFi networks that +use WEP, LEAP, WPA or WPA2/RSN security

Synopsis

-
#define             NM_SETTING_WIRELESS_SECURITY_SETTING_NAME
+
+#include <nm-setting-wireless-security.h>
+
+#define             NM_SETTING_WIRELESS_SECURITY_SETTING_NAME
 enum                NMSettingWirelessSecurityError;
 #define             NM_TYPE_SETTING_WIRELESS_SECURITY_ERROR
 #define             NM_SETTING_WIRELESS_SECURITY_ERROR
@@ -175,6 +179,24 @@ const char *        
 
Description

 

+The NMSettingWirelessSecurity object is a NMSetting subclass that describes
+properties necessary for connection to encrypted WiFi networks.
+

+

+It's a good idea to read up on wpa_supplicant configuration before using this
+setting extensively, since most of the options here correspond closely with
+the relevant wpa_supplicant configuration options.  To get a better overview
+of how WiFi security works, you may want to get copies of the following books.
+

+

+ 802.11 Wireless Networks: The Definitive Guide, Second Edition
+      Author: Matthew Gast
+      ISBN: 978-0596100520
+

+

+ Cisco Wireless LAN Security
+      Authors: Krishna Sankar, Sri Sundaralingam, Darrin Miller, and Andrew Balinsky
+      ISBN: 978-1587051548
@@ -189,8 +211,7 @@ const char *

enum NMSettingWirelessSecurityError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_WIRELESS_SECURITY_ERROR_UNKNOWN = 0,
 	NM_SETTING_WIRELESS_SECURITY_ERROR_INVALID_PROPERTY,
 	NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_PROPERTY,
@@ -200,8 +221,52 @@ const char *        
++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+


NM_SETTING_WIRELESS_SECURITY_ERROR_UNKNOWN
unknown or unclassified error
+
NM_SETTING_WIRELESS_SECURITY_ERROR_INVALID_PROPERTY
the property was invalid
+
NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_PROPERTY
the property was
+missing and is required
+
NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_802_1X_SETTING
a property contained
+a value that requires the connection to contain a NMSetting8021x setting
+
NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_802_1X
LEAP authentication
+was specified but key management was not set to "8021x"
+
NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_USERNAME
LEAP authentication
+was specified but no LEAP username was given
+
NM_SETTING_WIRELESS_SECURITY_ERROR_SHARED_KEY_REQUIRES_WEP
Shared Key
+authentication was specified but the setting did not specify WEP as the
+encryption protocol
+
@@ -239,7 +304,47 @@ const char * NMWepKeyType values specify how any WEP keys present in the setting +are intepreted. There are no standards governing how to hash the various WEP +key/passphrase formats into the actual WEP key. Unfortunately some WEP keys +can be interpreted in multiple ways, requring the setting to specify how to +interpret the any WEP keys. For example, the key "732f2d712e4a394a375d366931" +is both a valid Hexadecimal WEP key and a WEP passphrase. Further, many +ASCII keys are also valid WEP passphrases, but since passphrases and ASCII +keys are hashed differently to determine the actual WEP key the type must be +specified.

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

NM_WEP_KEY_TYPE_UNKNOWN

unknown WEP key type +

NM_WEP_KEY_TYPE_KEY

indicates a hexadecimal or ASCII formatted WEP key. +Hex keys are either 10 or 26 hexadecimal characters (ie "5f782f2f5f" or +"732f2d712e4a394a375d366931"), while ASCII keys are either 5 or 13 ASCII +characters (ie "abcde" or "blahblah99$*1"). +

NM_WEP_KEY_TYPE_PASSPHRASE

indicates a WEP passphrase (ex "I bought a duck +on my way back from the market 235Q&^%^*%") instead of a hexadecimal or ASCII +key. Passphrases are between 8 and 64 characters inclusive and are hashed +the actual WEP key using the MD5 hash algorithm. +

NM_WEP_KEY_TYPE_LAST

placeholder value for bounds-checking +
@@ -413,23 +518,57 @@ const char *

nm_setting_wireless_security_new ()

NMSetting *         nm_setting_wireless_security_new    (void);

+Creates a new NMSettingWirelessSecurity object with default values.

+
++ + + + +

Returns :

the new empty NMSettingWirelessSecurity object. [transfer full] +

nm_setting_wireless_security_get_key_mgmt ()

const char *        nm_setting_wireless_security_get_key_mgmt
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "key-mgmt" property of the setting

nm_setting_wireless_security_get_num_protos ()

guint32             nm_setting_wireless_security_get_num_protos
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the number of security protocols this connection allows when +connecting to secure WiFi networks
@@ -437,8 +576,25 @@ const char * const char * nm_setting_wireless_security_get_proto (NMSettingWirelessSecurity *setting, guint32 i); -

-

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

setting :

the NMSettingWirelessSecurity +

i :

an index into the protocol list

Returns :

the protocol at index i +
@@ -447,7 +603,33 @@ const char * NMSettingWirelessSecurity *setting, const char *proto);

+Adds a WiFi security protocol (one of "wpa" or "rsn") to the allowed list; +only protocols in this list will be used when finding and connecting to +the WiFi network specified by this connection. For example, if the +protocol list contains only "wpa" but the access point for the SSID specified +by this connection only supports WPA2/RSN, the connection cannot be used +with the access point.

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

setting :

the NMSettingWirelessSecurity +

proto :

the protocol to add, one of "wpa" or "rsn"

Returns :

 +TRUE if the protocol was new and and was added to the allowed +protocol list, or FALSE if it was already in the list
@@ -456,7 +638,22 @@ const char * NMSettingWirelessSecurity *setting, guint32 i);

+Removes a protocol from the allowed protocol list.

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

setting :

the NMSettingWirelessSecurity +

i :

index of the protocol to remove
@@ -464,15 +661,37 @@ const char * void nm_setting_wireless_security_clear_protos (NMSettingWirelessSecurity *setting);

+Removes all protocols from the allowed list. If there are no protocols +specified then all protocols are allowed.

+
++ + + + +

setting :

the NMSettingWirelessSecurity +

nm_setting_wireless_security_get_num_pairwise ()

guint32             nm_setting_wireless_security_get_num_pairwise
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the number of pairwise encryption algorithms in the allowed list
@@ -481,7 +700,28 @@ const char * NMSettingWirelessSecurity *setting, guint32 i);

+Returns the allowed pairwise encryption algorithm from allowed algorithm +list.

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

setting :

the NMSettingWirelessSecurity +

i :

index of an item in the allowed pairwise encryption algorithm list

Returns :

the pairwise encryption algorithm at index i +
@@ -490,7 +730,32 @@ const char * NMSettingWirelessSecurity *setting, const char *pairwise);

+Adds an encryption algorithm to the list of allowed pairwise encryption +algorithms. If the list is not empty, then only access points that support +one or more of the encryption algorithms in the list will be considered +compatible with this connection.

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

setting :

the NMSettingWirelessSecurity +

pairwise :

the encryption algorithm to add, one of "wep40", "wep104", +"tkip", or "ccmp"

Returns :

 +TRUE if the algorithm was added to the list, FALSE if it was +already in the list
@@ -499,7 +764,23 @@ const char * NMSettingWirelessSecurity *setting, guint32 i);

+Removes an encryption algorithm from the allowed pairwise encryption +algorithm list.

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

setting :

the NMSettingWirelessSecurity +

i :

the index of an item in the allowed pairwise encryption algorithm list
@@ -507,15 +788,37 @@ const char * void nm_setting_wireless_security_clear_pairwise (NMSettingWirelessSecurity *setting);

+Removes all algorithms from the allowed list. If there are no algorithms +specified then all pairwise encryption algorithms are allowed.

+
++ + + + +

setting :

the NMSettingWirelessSecurity +

nm_setting_wireless_security_get_num_groups ()

guint32             nm_setting_wireless_security_get_num_groups
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the number of groupwise encryption algorithms in the allowed list
@@ -524,7 +827,28 @@ const char * NMSettingWirelessSecurity *setting, guint32 i);

+Returns the allowed groupwise encryption algorithm from allowed algorithm +list.

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

setting :

the NMSettingWirelessSecurity +

i :

index of an item in the allowed groupwise encryption algorithm list

Returns :

the groupwise encryption algorithm at index i +
@@ -533,7 +857,32 @@ const char * NMSettingWirelessSecurity *setting, const char *group);

+Adds an encryption algorithm to the list of allowed groupwise encryption +algorithms. If the list is not empty, then only access points that support +one or more of the encryption algorithms in the list will be considered +compatible with this connection.

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

setting :

the NMSettingWirelessSecurity +

group :

the encryption algorithm to add, one of "wep40", "wep104", +"tkip", or "ccmp"

Returns :

 +TRUE if the algorithm was added to the list, FALSE if it was +already in the list
@@ -542,7 +891,23 @@ const char * NMSettingWirelessSecurity *setting, guint32 i);

+Removes an encryption algorithm from the allowed groupwise encryption +algorithm list.

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

setting :

the NMSettingWirelessSecurity +

i :

the index of an item in the allowed groupwise encryption algorithm list
@@ -550,15 +915,37 @@ const char * void nm_setting_wireless_security_clear_groups (NMSettingWirelessSecurity *setting);

+Removes all algorithms from the allowed list. If there are no algorithms +specified then all groupwise encryption algorithms are allowed.

+
++ + + + +

setting :

the NMSettingWirelessSecurity +

nm_setting_wireless_security_get_psk ()

const char *        nm_setting_wireless_security_get_psk
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "psk" property of the setting
@@ -587,16 +974,40 @@ const char *

nm_setting_wireless_security_get_leap_username ()

const char *        nm_setting_wireless_security_get_leap_username
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "leap-username" property of the setting

nm_setting_wireless_security_get_leap_password ()

const char *        nm_setting_wireless_security_get_leap_password
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "leap-password" property of the setting
@@ -626,8 +1037,24 @@ const char * const char * nm_setting_wireless_security_get_wep_key (NMSettingWirelessSecurity *setting, guint32 idx); -

-

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

setting :

the NMSettingWirelessSecurity +

idx :

the WEP key index (0..3 inclusive)

Returns :

the WEP key at the given index
@@ -637,23 +1064,68 @@ const char * guint32 idx, const char *key);

+Sets a WEP key in the given index.

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

setting :

the NMSettingWirelessSecurity +

idx :

the index of the key (0..3 inclusive)

key :

the WEP key as a string, in either hexadecimal, ASCII, or passphrase +form as determiend by the value of the "wep-key-type" +property.

nm_setting_wireless_security_get_wep_tx_keyidx ()

guint32             nm_setting_wireless_security_get_wep_tx_keyidx
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "wep-tx-keyidx" property of the setting

nm_setting_wireless_security_get_auth_alg ()

const char *        nm_setting_wireless_security_get_auth_alg
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "auth-alg" property of the setting
@@ -680,8 +1152,20 @@ const char *

nm_setting_wireless_security_get_wep_key_type ()

NMWepKeyType        nm_setting_wireless_security_get_wep_key_type
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "wep-key-type" property of the setting
@@ -809,9 +1293,8 @@ Flags indicating how to handle

The "wep-key-type" property

  "wep-key-type"             guint                 : Read / Write / Construct

-Controls the interpretation of WEP keys. Allowed values are 1 (interpret -WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP -Passphrases). If set to 1 and the keys are hexadecimal, they must be +Controls the interpretation of WEP keys. Allowed values are those given +by NMWepKeyType. If set to 1 and the keys are hexadecimal, they must be either 10 or 26 characters in length. If set to 1 and the keys are ASCII keys, they must be either 5 or 13 characters in length. If set to 2, the passphrase is hashed using the de-facto MD5 method to derive the -- cgit 1.3.0-6-gf8a5