Updated through tag hostap_2_5 from git://w1.fi/hostap.git
[mech_eap.git] / libeap / wpa_supplicant / config_ssid.h
index 38da3fc..7ef326c 100644 (file)
@@ -1,25 +1,18 @@
 /*
  * WPA Supplicant / Network configuration structures
- * Copyright (c) 2003-2008, Jouni Malinen <j@w1.fi>
+ * Copyright (c) 2003-2013, Jouni Malinen <j@w1.fi>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation.
- *
- * Alternatively, this software may be distributed under the terms of BSD
- * license.
- *
- * See README and COPYING for more details.
+ * This software may be distributed under the terms of the BSD license.
+ * See README for more details.
  */
 
 #ifndef CONFIG_SSID_H
 #define CONFIG_SSID_H
 
 #include "common/defs.h"
+#include "utils/list.h"
 #include "eap_peer/eap_config.h"
 
-#define MAX_SSID_LEN 32
-
 
 #define DEFAULT_EAP_WORKAROUND ((unsigned int) -1)
 #define DEFAULT_EAPOL_FLAGS (EAPOL_FLAG_REQUIRE_KEY_UNICAST | \
 #define DEFAULT_PROTO (WPA_PROTO_WPA | WPA_PROTO_RSN)
 #define DEFAULT_KEY_MGMT (WPA_KEY_MGMT_PSK | WPA_KEY_MGMT_IEEE8021X)
 #define DEFAULT_PAIRWISE (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP)
-#define DEFAULT_GROUP (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP | \
-                      WPA_CIPHER_WEP104 | WPA_CIPHER_WEP40)
+#define DEFAULT_GROUP (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP)
 #define DEFAULT_FRAGMENT_SIZE 1398
 
+#define DEFAULT_BG_SCAN_PERIOD -1
+#define DEFAULT_MESH_MAX_RETRIES 2
+#define DEFAULT_MESH_RETRY_TIMEOUT 40
+#define DEFAULT_MESH_CONFIRM_TIMEOUT 40
+#define DEFAULT_MESH_HOLDING_TIMEOUT 40
+#define DEFAULT_DISABLE_HT 0
+#define DEFAULT_DISABLE_HT40 0
+#define DEFAULT_DISABLE_SGI 0
+#define DEFAULT_DISABLE_LDPC 0
+#define DEFAULT_DISABLE_MAX_AMSDU -1 /* no change */
+#define DEFAULT_AMPDU_FACTOR -1 /* no change */
+#define DEFAULT_AMPDU_DENSITY -1 /* no change */
+#define DEFAULT_USER_SELECTED_SIM 1
+
+struct psk_list_entry {
+       struct dl_list list;
+       u8 addr[ETH_ALEN];
+       u8 psk[32];
+       u8 p2p;
+};
+
 /**
  * struct wpa_ssid - Network configuration data
  *
@@ -116,11 +129,28 @@ struct wpa_ssid {
        u8 bssid[ETH_ALEN];
 
        /**
+        * bssid_blacklist - List of inacceptable BSSIDs
+        */
+       u8 *bssid_blacklist;
+       size_t num_bssid_blacklist;
+
+       /**
+        * bssid_blacklist - List of acceptable BSSIDs
+        */
+       u8 *bssid_whitelist;
+       size_t num_bssid_whitelist;
+
+       /**
         * bssid_set - Whether BSSID is configured for this network
         */
        int bssid_set;
 
        /**
+        * go_p2p_dev_addr - GO's P2P Device Address or all zeros if not set
+        */
+       u8 go_p2p_dev_addr[ETH_ALEN];
+
+       /**
         * psk - WPA pre-shared key (256 bits)
         */
        u8 psk[32];
@@ -140,6 +170,22 @@ struct wpa_ssid {
        char *passphrase;
 
        /**
+        * ext_psk - PSK/passphrase name in external storage
+        *
+        * If this is set, PSK/passphrase will be fetched from external storage
+        * when requesting association with the network.
+        */
+       char *ext_psk;
+
+       /**
+        * mem_only_psk - Whether to keep PSK/passphrase only in memory
+        *
+        * 0 = allow psk/passphrase to be stored to the configuration file
+        * 1 = do not store psk/passphrase to the configuration file
+        */
+       int mem_only_psk;
+
+       /**
         * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_*
         */
        int pairwise_cipher;
@@ -157,6 +203,12 @@ struct wpa_ssid {
        int key_mgmt;
 
        /**
+        * bg_scan_period - Background scan period in seconds, 0 to disable, or
+        * -1 to indicate no change to default driver configuration
+        */
+       int bg_scan_period;
+
+       /**
         * proto - Bitfield of allowed protocols, WPA_PROTO_*
         */
        int proto;
@@ -173,7 +225,9 @@ struct wpa_ssid {
         *
         * scan_ssid can be used to scan for APs using hidden SSIDs.
         * Note: Many drivers do not support this. ap_mode=2 can be used with
-        * such drivers to use hidden SSIDs.
+        * such drivers to use hidden SSIDs. Note2: Most nl80211-based drivers
+        * do support scan_ssid=1 and that should be used with them instead of
+        * ap_scan=2.
         */
        int scan_ssid;
 
@@ -213,13 +267,18 @@ struct wpa_ssid {
         *
         * This field can be used to enable proactive key caching which is also
         * known as opportunistic PMKSA caching for WPA2. This is disabled (0)
-        * by default. Enable by setting this to 1.
+        * by default unless default value is changed with the global okc=1
+        * parameter. Enable by setting this to 1.
         *
         * Proactive key caching is used to make supplicant assume that the APs
         * are using the same PMK and generate PMKSA cache entries without
         * doing RSN pre-authentication. This requires support from the AP side
         * and is normally used with wireless switches that co-locate the
         * authenticator.
+        *
+        * Internally, special value -1 is used to indicate that the parameter
+        * was not specified in the configuration (i.e., default behavior is
+        * followed).
         */
        int proactive_key_caching;
 
@@ -281,12 +340,15 @@ struct wpa_ssid {
         * 4 = P2P Group Formation (used internally; not in configuration
         * files)
         *
-        * Note: IBSS can only be used with key_mgmt NONE (plaintext and
-        * static WEP) and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). In
-        * addition, ap_scan has to be set to 2 for IBSS. WPA-None requires
-        * following network block options: proto=WPA, key_mgmt=WPA-NONE,
-        * pairwise=NONE, group=TKIP (or CCMP, but not both), and psk must also
-        * be set (either directly or using ASCII passphrase).
+        * 5 = Mesh
+        *
+        * Note: IBSS can only be used with key_mgmt NONE (plaintext and static
+        * WEP) and WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE
+        * (fixed group key TKIP/CCMP) is available for backwards compatibility,
+        * but its use is deprecated. WPA-None requires following network block
+        * options: proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or
+        * CCMP, but not both), and psk must also be set (either directly or
+        * using ASCII passphrase).
         */
        enum wpas_mode {
                WPAS_MODE_INFRA = 0,
@@ -294,6 +356,7 @@ struct wpa_ssid {
                WPAS_MODE_AP = 2,
                WPAS_MODE_P2P_GO = 3,
                WPAS_MODE_P2P_GROUP_FORMATION = 4,
+               WPAS_MODE_MESH = 5,
        } mode;
 
        /**
@@ -308,6 +371,14 @@ struct wpa_ssid {
        int disabled;
 
        /**
+        * disabled_for_connect - Whether this network was temporarily disabled
+        *
+        * This flag is used to reenable all the temporarily disabled networks
+        * after either the success or failure of a WPS connection.
+        */
+       int disabled_for_connect;
+
+       /**
         * peerkey -  Whether PeerKey handshake for direct links is allowed
         *
         * This is only used when both RSN/WPA2 and IEEE 802.11e (QoS) are
@@ -333,6 +404,12 @@ struct wpa_ssid {
         *
         * This value is used to configure policy for management frame
         * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required.
+        * This is disabled by default unless the default value has been changed
+        * with the global pmf=1/2 parameter.
+        *
+        * Internally, special value 3 is used to indicate that the parameter
+        * was not specified in the configuration (i.e., default behavior is
+        * followed).
         */
        enum mfp_options ieee80211w;
 #endif /* CONFIG_IEEE80211W */
@@ -350,6 +427,29 @@ struct wpa_ssid {
        int frequency;
 
        /**
+        * fixed_freq - Use fixed frequency for IBSS
+        */
+       int fixed_freq;
+
+       /**
+        * mesh_basic_rates - BSS Basic rate set for mesh network
+        *
+        */
+       int *mesh_basic_rates;
+
+       /**
+        * Mesh network plink parameters
+        */
+       int dot11MeshMaxRetries;
+       int dot11MeshRetryTimeout; /* msec */
+       int dot11MeshConfirmTimeout; /* msec */
+       int dot11MeshHoldingTimeout; /* msec */
+
+       int ht40;
+
+       int vht;
+
+       /**
         * wpa_ptk_rekey - Maximum lifetime for PTK in seconds
         *
         * This value can be used to enforce rekeying of PTK to mitigate some
@@ -377,6 +477,20 @@ struct wpa_ssid {
        char *bgscan;
 
        /**
+        * ignore_broadcast_ssid - Hide SSID in AP mode
+        *
+        * Send empty SSID in beacons and ignore probe request frames that do
+        * not specify full SSID, i.e., require stations to know SSID.
+        * default: disabled (0)
+        * 1 = send empty (length=0) SSID in beacon and ignore probe request
+        * for broadcast SSID
+        * 2 = clear SSID (ASCII 0), but keep the original length (this may be
+        * required with some clients that do not support empty SSID) and
+        * ignore probe requests for broadcast SSID
+        */
+       int ignore_broadcast_ssid;
+
+       /**
         * freq_list - Array of allowed frequencies or %NULL for all
         *
         * This is an optional zero-terminated array of frequencies in
@@ -387,6 +501,29 @@ struct wpa_ssid {
        int *freq_list;
 
        /**
+        * p2p_client_list - List of P2P Clients in a persistent group (GO)
+        *
+        * This is a list of P2P Clients (P2P Device Address) that have joined
+        * the persistent group. This is maintained on the GO for persistent
+        * group entries (disabled == 2).
+        */
+       u8 *p2p_client_list;
+
+       /**
+        * num_p2p_clients - Number of entries in p2p_client_list
+        */
+       size_t num_p2p_clients;
+
+#ifndef P2P_MAX_STORED_CLIENTS
+#define P2P_MAX_STORED_CLIENTS 100
+#endif /* P2P_MAX_STORED_CLIENTS */
+
+       /**
+        * psk_list - Per-client PSKs (struct psk_list_entry)
+        */
+       struct dl_list psk_list;
+
+       /**
         * p2p_group - Network generated as a P2P group (used internally)
         */
        int p2p_group;
@@ -400,6 +537,188 @@ struct wpa_ssid {
         * temporary - Whether this network is temporary and not to be saved
         */
        int temporary;
+
+       /**
+        * export_keys - Whether keys may be exported
+        *
+        * This attribute will be set when keys are determined through
+        * WPS or similar so that they may be exported.
+        */
+       int export_keys;
+
+#ifdef CONFIG_HT_OVERRIDES
+       /**
+        * disable_ht - Disable HT (IEEE 802.11n) for this network
+        *
+        * By default, use it if it is available, but this can be configured
+        * to 1 to have it disabled.
+        */
+       int disable_ht;
+
+       /**
+        * disable_ht40 - Disable HT40 for this network
+        *
+        * By default, use it if it is available, but this can be configured
+        * to 1 to have it disabled.
+        */
+       int disable_ht40;
+
+       /**
+        * disable_sgi - Disable SGI (Short Guard Interval) for this network
+        *
+        * By default, use it if it is available, but this can be configured
+        * to 1 to have it disabled.
+        */
+       int disable_sgi;
+
+       /**
+        * disable_ldpc - Disable LDPC for this network
+        *
+        * By default, use it if it is available, but this can be configured
+        * to 1 to have it disabled.
+        */
+       int disable_ldpc;
+
+       /**
+        * ht40_intolerant - Indicate 40 MHz intolerant for this network
+        */
+       int ht40_intolerant;
+
+       /**
+        * disable_max_amsdu - Disable MAX A-MSDU
+        *
+        * A-MDSU will be 3839 bytes when disabled, or 7935
+        * when enabled (assuming it is otherwise supported)
+        * -1 (default) means do not apply any settings to the kernel.
+        */
+       int disable_max_amsdu;
+
+       /**
+        * ampdu_factor - Maximum A-MPDU Length Exponent
+        *
+        * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
+        */
+       int ampdu_factor;
+
+       /**
+        * ampdu_density - Minimum A-MPDU Start Spacing
+        *
+        * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
+        */
+       int ampdu_density;
+
+       /**
+        * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000...
+        *
+        * By default (empty string): Use whatever the OS has configured.
+        */
+       char *ht_mcs;
+#endif /* CONFIG_HT_OVERRIDES */
+
+#ifdef CONFIG_VHT_OVERRIDES
+       /**
+        * disable_vht - Disable VHT (IEEE 802.11ac) for this network
+        *
+        * By default, use it if it is available, but this can be configured
+        * to 1 to have it disabled.
+        */
+       int disable_vht;
+
+       /**
+        * vht_capa - VHT capabilities to use
+        */
+       unsigned int vht_capa;
+
+       /**
+        * vht_capa_mask - mask for VHT capabilities
+        */
+       unsigned int vht_capa_mask;
+
+       int vht_rx_mcs_nss_1, vht_rx_mcs_nss_2,
+           vht_rx_mcs_nss_3, vht_rx_mcs_nss_4,
+           vht_rx_mcs_nss_5, vht_rx_mcs_nss_6,
+           vht_rx_mcs_nss_7, vht_rx_mcs_nss_8;
+       int vht_tx_mcs_nss_1, vht_tx_mcs_nss_2,
+           vht_tx_mcs_nss_3, vht_tx_mcs_nss_4,
+           vht_tx_mcs_nss_5, vht_tx_mcs_nss_6,
+           vht_tx_mcs_nss_7, vht_tx_mcs_nss_8;
+#endif /* CONFIG_VHT_OVERRIDES */
+
+       /**
+        * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
+        *
+        * This timeout value is used in AP mode to clean up inactive stations.
+        * By default: 300 seconds.
+        */
+       int ap_max_inactivity;
+
+       /**
+        * dtim_period - DTIM period in Beacon intervals
+        * By default: 2
+        */
+       int dtim_period;
+
+       /**
+        * beacon_int - Beacon interval (default: 100 TU)
+        */
+       int beacon_int;
+
+       /**
+        * auth_failures - Number of consecutive authentication failures
+        */
+       unsigned int auth_failures;
+
+       /**
+        * disabled_until - Network block disabled until this time if non-zero
+        */
+       struct os_reltime disabled_until;
+
+       /**
+        * parent_cred - Pointer to parent wpa_cred entry
+        *
+        * This pointer can be used to delete temporary networks when a wpa_cred
+        * that was used to create them is removed. This pointer should not be
+        * dereferences since it may not be updated in all cases.
+        */
+       void *parent_cred;
+
+#ifdef CONFIG_MACSEC
+       /**
+        * macsec_policy - Determines the policy for MACsec secure session
+        *
+        * 0: MACsec not in use (default)
+        * 1: MACsec enabled - Should secure, accept key server's advice to
+        *    determine whether to use a secure session or not.
+        */
+       int macsec_policy;
+#endif /* CONFIG_MACSEC */
+
+#ifdef CONFIG_HS20
+       int update_identifier;
+#endif /* CONFIG_HS20 */
+
+       unsigned int wps_run;
+
+       /**
+        * mac_addr - MAC address policy
+        *
+        * 0 = use permanent MAC address
+        * 1 = use random MAC address for each ESS connection
+        * 2 = like 1, but maintain OUI (with local admin bit set)
+        *
+        * Internally, special value -1 is used to indicate that the parameter
+        * was not specified in the configuration (i.e., default behavior is
+        * followed).
+        */
+       int mac_addr;
+
+       /**
+        * no_auto_peer - Do not automatically peer with compatible mesh peers
+        *
+        * When unset, the reception of a beacon from a another mesh peer in
+        * this MBSS will trigger a peering attempt.
+        */
+       int no_auto_peer;
 };
 
 #endif /* CONFIG_SSID_H */