2 * WPA Supplicant / Network configuration structures
3 * Copyright (c) 2003-2013, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
12 #include "common/defs.h"
13 #include "utils/list.h"
14 #include "eap_peer/eap_config.h"
17 #define DEFAULT_EAP_WORKAROUND ((unsigned int) -1)
18 #define DEFAULT_EAPOL_FLAGS (EAPOL_FLAG_REQUIRE_KEY_UNICAST | \
19 EAPOL_FLAG_REQUIRE_KEY_BROADCAST)
20 #define DEFAULT_PROTO (WPA_PROTO_WPA | WPA_PROTO_RSN)
21 #define DEFAULT_KEY_MGMT (WPA_KEY_MGMT_PSK | WPA_KEY_MGMT_IEEE8021X)
22 #define DEFAULT_PAIRWISE (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP)
23 #define DEFAULT_GROUP (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP | \
24 WPA_CIPHER_WEP104 | WPA_CIPHER_WEP40)
25 #define DEFAULT_FRAGMENT_SIZE 1398
27 #define DEFAULT_BG_SCAN_PERIOD -1
28 #define DEFAULT_MESH_MAX_RETRIES 2
29 #define DEFAULT_MESH_RETRY_TIMEOUT 40
30 #define DEFAULT_MESH_CONFIRM_TIMEOUT 40
31 #define DEFAULT_MESH_HOLDING_TIMEOUT 40
32 #define DEFAULT_DISABLE_HT 0
33 #define DEFAULT_DISABLE_HT40 0
34 #define DEFAULT_DISABLE_SGI 0
35 #define DEFAULT_DISABLE_LDPC 0
36 #define DEFAULT_DISABLE_MAX_AMSDU -1 /* no change */
37 #define DEFAULT_AMPDU_FACTOR -1 /* no change */
38 #define DEFAULT_AMPDU_DENSITY -1 /* no change */
39 #define DEFAULT_USER_SELECTED_SIM 1
41 struct psk_list_entry {
49 * struct wpa_ssid - Network configuration data
51 * This structure includes all the configuration variables for a network. This
52 * data is included in the per-interface configuration data as an element of
53 * the network list, struct wpa_config::ssid. Each network block in the
54 * configuration is mapped to a struct wpa_ssid instance.
58 * next - Next network in global list
60 * This pointer can be used to iterate over all networks. The head of
61 * this list is stored in the ssid field of struct wpa_config.
63 struct wpa_ssid *next;
66 * pnext - Next network in per-priority list
68 * This pointer can be used to iterate over all networks in the same
69 * priority class. The heads of these list are stored in the pssid
70 * fields of struct wpa_config.
72 struct wpa_ssid *pnext;
75 * id - Unique id for the network
77 * This identifier is used as a unique identifier for each network
78 * block when using the control interface. Each network is allocated an
79 * id when it is being created, either when reading the configuration
80 * file or when a new network is added through the control interface.
85 * priority - Priority group
87 * By default, all networks will get same priority group (0). If some
88 * of the networks are more desirable, this field can be used to change
89 * the order in which wpa_supplicant goes through the networks when
90 * selecting a BSS. The priority groups will be iterated in decreasing
91 * priority (i.e., the larger the priority value, the sooner the
92 * network is matched against the scan results). Within each priority
93 * group, networks will be selected based on security policy, signal
96 * Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are
97 * not using this priority to select the order for scanning. Instead,
98 * they try the networks in the order that used in the configuration
104 * ssid - Service set identifier (network name)
106 * This is the SSID for the network. For wireless interfaces, this is
107 * used to select which network will be used. If set to %NULL (or
108 * ssid_len=0), any SSID can be used. For wired interfaces, this must
109 * be set to %NULL. Note: SSID may contain any characters, even nul
110 * (ASCII 0) and as such, this should not be assumed to be a nul
111 * terminated string. ssid_len defines how many characters are valid
112 * and the ssid field is not guaranteed to be nul terminated.
117 * ssid_len - Length of the SSID
124 * If set, this network block is used only when associating with the AP
125 * using the configured BSSID
127 * If this is a persistent P2P group (disabled == 2), this is the GO
133 * bssid_blacklist - List of inacceptable BSSIDs
136 size_t num_bssid_blacklist;
139 * bssid_blacklist - List of acceptable BSSIDs
142 size_t num_bssid_whitelist;
145 * bssid_set - Whether BSSID is configured for this network
150 * go_p2p_dev_addr - GO's P2P Device Address or all zeros if not set
152 u8 go_p2p_dev_addr[ETH_ALEN];
155 * psk - WPA pre-shared key (256 bits)
160 * psk_set - Whether PSK field is configured
165 * passphrase - WPA ASCII passphrase
167 * If this is set, psk will be generated using the SSID and passphrase
168 * configured for the network. ASCII passphrase must be between 8 and
169 * 63 characters (inclusive).
174 * ext_psk - PSK/passphrase name in external storage
176 * If this is set, PSK/passphrase will be fetched from external storage
177 * when requesting association with the network.
182 * mem_only_psk - Whether to keep PSK/passphrase only in memory
184 * 0 = allow psk/passphrase to be stored to the configuration file
185 * 1 = do not store psk/passphrase to the configuration file
190 * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_*
195 * group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_*
200 * key_mgmt - Bitfield of allowed key management protocols
207 * bg_scan_period - Background scan period in seconds, 0 to disable, or
208 * -1 to indicate no change to default driver configuration
213 * proto - Bitfield of allowed protocols, WPA_PROTO_*
218 * auth_alg - Bitfield of allowed authentication algorithms
225 * scan_ssid - Scan this SSID with Probe Requests
227 * scan_ssid can be used to scan for APs using hidden SSIDs.
228 * Note: Many drivers do not support this. ap_mode=2 can be used with
229 * such drivers to use hidden SSIDs.
233 #ifdef IEEE8021X_EAPOL
234 #define EAPOL_FLAG_REQUIRE_KEY_UNICAST BIT(0)
235 #define EAPOL_FLAG_REQUIRE_KEY_BROADCAST BIT(1)
237 * eapol_flags - Bit field of IEEE 802.1X/EAPOL options (EAPOL_FLAG_*)
242 * eap - EAP peer configuration for this network
244 struct eap_peer_config eap;
245 #endif /* IEEE8021X_EAPOL */
247 #define NUM_WEP_KEYS 4
248 #define MAX_WEP_KEY_LEN 16
252 u8 wep_key[NUM_WEP_KEYS][MAX_WEP_KEY_LEN];
255 * wep_key_len - WEP key lengths
257 size_t wep_key_len[NUM_WEP_KEYS];
260 * wep_tx_keyidx - Default key index for TX frames using WEP
265 * proactive_key_caching - Enable proactive key caching
267 * This field can be used to enable proactive key caching which is also
268 * known as opportunistic PMKSA caching for WPA2. This is disabled (0)
269 * by default unless default value is changed with the global okc=1
270 * parameter. Enable by setting this to 1.
272 * Proactive key caching is used to make supplicant assume that the APs
273 * are using the same PMK and generate PMKSA cache entries without
274 * doing RSN pre-authentication. This requires support from the AP side
275 * and is normally used with wireless switches that co-locate the
278 * Internally, special value -1 is used to indicate that the parameter
279 * was not specified in the configuration (i.e., default behavior is
282 int proactive_key_caching;
285 * mixed_cell - Whether mixed cells are allowed
287 * This option can be used to configure whether so called mixed cells,
288 * i.e., networks that use both plaintext and encryption in the same
289 * SSID, are allowed. This is disabled (0) by default. Enable by
294 #ifdef IEEE8021X_EAPOL
297 * leap - Number of EAP methods using LEAP
299 * This field should be set to 1 if LEAP is enabled. This is used to
300 * select IEEE 802.11 authentication algorithm.
305 * non_leap - Number of EAP methods not using LEAP
307 * This field should be set to >0 if any EAP method other than LEAP is
308 * enabled. This is used to select IEEE 802.11 authentication
314 * eap_workaround - EAP workarounds enabled
316 * wpa_supplicant supports number of "EAP workarounds" to work around
317 * interoperability issues with incorrectly behaving authentication
318 * servers. This is recommended to be enabled by default because some
319 * of the issues are present in large number of authentication servers.
321 * Strict EAP conformance mode can be configured by disabling
322 * workarounds with eap_workaround = 0.
324 unsigned int eap_workaround;
326 #endif /* IEEE8021X_EAPOL */
329 * mode - IEEE 802.11 operation mode (Infrastucture/IBSS)
331 * 0 = infrastructure (Managed) mode, i.e., associate with an AP.
333 * 1 = IBSS (ad-hoc, peer-to-peer)
335 * 2 = AP (access point)
337 * 3 = P2P Group Owner (can be set in the configuration file)
339 * 4 = P2P Group Formation (used internally; not in configuration
344 * Note: IBSS can only be used with key_mgmt NONE (plaintext and static
345 * WEP) and WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE
346 * (fixed group key TKIP/CCMP) is available for backwards compatibility,
347 * but its use is deprecated. WPA-None requires following network block
348 * options: proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or
349 * CCMP, but not both), and psk must also be set (either directly or
350 * using ASCII passphrase).
356 WPAS_MODE_P2P_GO = 3,
357 WPAS_MODE_P2P_GROUP_FORMATION = 4,
362 * disabled - Whether this network is currently disabled
364 * 0 = this network can be used (default).
365 * 1 = this network block is disabled (can be enabled through
366 * ctrl_iface, e.g., with wpa_cli or wpa_gui).
367 * 2 = this network block includes parameters for a persistent P2P
368 * group (can be used with P2P ctrl_iface commands)
373 * disabled_for_connect - Whether this network was temporarily disabled
375 * This flag is used to reenable all the temporarily disabled networks
376 * after either the success or failure of a WPS connection.
378 int disabled_for_connect;
381 * peerkey - Whether PeerKey handshake for direct links is allowed
383 * This is only used when both RSN/WPA2 and IEEE 802.11e (QoS) are
386 * 0 = disabled (default)
392 * id_str - Network identifier string for external scripts
394 * This value is passed to external ctrl_iface monitors in
395 * WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR
396 * environment variable for action scripts.
400 #ifdef CONFIG_IEEE80211W
402 * ieee80211w - Whether management frame protection is enabled
404 * This value is used to configure policy for management frame
405 * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required.
406 * This is disabled by default unless the default value has been changed
407 * with the global pmf=1/2 parameter.
409 * Internally, special value 3 is used to indicate that the parameter
410 * was not specified in the configuration (i.e., default behavior is
413 enum mfp_options ieee80211w;
414 #endif /* CONFIG_IEEE80211W */
417 * frequency - Channel frequency in megahertz (MHz) for IBSS
419 * This value is used to configure the initial channel for IBSS (adhoc)
420 * networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in
421 * the infrastructure mode. In addition, this value is only used by the
422 * station that creates the IBSS. If an IBSS network with the
423 * configured SSID is already present, the frequency of the network
424 * will be used instead of this configured value.
429 * fixed_freq - Use fixed frequency for IBSS
434 * mesh_basic_rates - BSS Basic rate set for mesh network
437 int *mesh_basic_rates;
440 * Mesh network plink parameters
442 int dot11MeshMaxRetries;
443 int dot11MeshRetryTimeout; /* msec */
444 int dot11MeshConfirmTimeout; /* msec */
445 int dot11MeshHoldingTimeout; /* msec */
452 * wpa_ptk_rekey - Maximum lifetime for PTK in seconds
454 * This value can be used to enforce rekeying of PTK to mitigate some
455 * attacks against TKIP deficiencies.
460 * scan_freq - Array of frequencies to scan or %NULL for all
462 * This is an optional zero-terminated array of frequencies in
463 * megahertz (MHz) to include in scan requests when searching for this
464 * network. This can be used to speed up scanning when the network is
465 * known to not use all possible channels.
470 * bgscan - Background scan and roaming parameters or %NULL if none
472 * This is an optional set of parameters for background scanning and
473 * roaming within a network (ESS) in following format:
474 * <bgscan module name>:<module parameters>
479 * ignore_broadcast_ssid - Hide SSID in AP mode
481 * Send empty SSID in beacons and ignore probe request frames that do
482 * not specify full SSID, i.e., require stations to know SSID.
483 * default: disabled (0)
484 * 1 = send empty (length=0) SSID in beacon and ignore probe request
486 * 2 = clear SSID (ASCII 0), but keep the original length (this may be
487 * required with some clients that do not support empty SSID) and
488 * ignore probe requests for broadcast SSID
490 int ignore_broadcast_ssid;
493 * freq_list - Array of allowed frequencies or %NULL for all
495 * This is an optional zero-terminated array of frequencies in
496 * megahertz (MHz) to allow for selecting the BSS. If set, scan results
497 * that do not match any of the specified frequencies are not
498 * considered when selecting a BSS.
503 * p2p_client_list - List of P2P Clients in a persistent group (GO)
505 * This is a list of P2P Clients (P2P Device Address) that have joined
506 * the persistent group. This is maintained on the GO for persistent
507 * group entries (disabled == 2).
512 * num_p2p_clients - Number of entries in p2p_client_list
514 size_t num_p2p_clients;
516 #ifndef P2P_MAX_STORED_CLIENTS
517 #define P2P_MAX_STORED_CLIENTS 100
518 #endif /* P2P_MAX_STORED_CLIENTS */
521 * psk_list - Per-client PSKs (struct psk_list_entry)
523 struct dl_list psk_list;
526 * p2p_group - Network generated as a P2P group (used internally)
531 * p2p_persistent_group - Whether this is a persistent group
533 int p2p_persistent_group;
536 * temporary - Whether this network is temporary and not to be saved
541 * export_keys - Whether keys may be exported
543 * This attribute will be set when keys are determined through
544 * WPS or similar so that they may be exported.
548 #ifdef CONFIG_HT_OVERRIDES
550 * disable_ht - Disable HT (IEEE 802.11n) for this network
552 * By default, use it if it is available, but this can be configured
553 * to 1 to have it disabled.
558 * disable_ht40 - Disable HT40 for this network
560 * By default, use it if it is available, but this can be configured
561 * to 1 to have it disabled.
566 * disable_sgi - Disable SGI (Short Guard Interval) for this network
568 * By default, use it if it is available, but this can be configured
569 * to 1 to have it disabled.
574 * disable_ldpc - Disable LDPC for this network
576 * By default, use it if it is available, but this can be configured
577 * to 1 to have it disabled.
582 * ht40_intolerant - Indicate 40 MHz intolerant for this network
587 * disable_max_amsdu - Disable MAX A-MSDU
589 * A-MDSU will be 3839 bytes when disabled, or 7935
590 * when enabled (assuming it is otherwise supported)
591 * -1 (default) means do not apply any settings to the kernel.
593 int disable_max_amsdu;
596 * ampdu_factor - Maximum A-MPDU Length Exponent
598 * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
603 * ampdu_density - Minimum A-MPDU Start Spacing
605 * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
610 * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000...
612 * By default (empty string): Use whatever the OS has configured.
615 #endif /* CONFIG_HT_OVERRIDES */
617 #ifdef CONFIG_VHT_OVERRIDES
619 * disable_vht - Disable VHT (IEEE 802.11ac) for this network
621 * By default, use it if it is available, but this can be configured
622 * to 1 to have it disabled.
627 * vht_capa - VHT capabilities to use
629 unsigned int vht_capa;
632 * vht_capa_mask - mask for VHT capabilities
634 unsigned int vht_capa_mask;
636 int vht_rx_mcs_nss_1, vht_rx_mcs_nss_2,
637 vht_rx_mcs_nss_3, vht_rx_mcs_nss_4,
638 vht_rx_mcs_nss_5, vht_rx_mcs_nss_6,
639 vht_rx_mcs_nss_7, vht_rx_mcs_nss_8;
640 int vht_tx_mcs_nss_1, vht_tx_mcs_nss_2,
641 vht_tx_mcs_nss_3, vht_tx_mcs_nss_4,
642 vht_tx_mcs_nss_5, vht_tx_mcs_nss_6,
643 vht_tx_mcs_nss_7, vht_tx_mcs_nss_8;
644 #endif /* CONFIG_VHT_OVERRIDES */
647 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
649 * This timeout value is used in AP mode to clean up inactive stations.
650 * By default: 300 seconds.
652 int ap_max_inactivity;
655 * dtim_period - DTIM period in Beacon intervals
661 * beacon_int - Beacon interval (default: 100 TU)
666 * auth_failures - Number of consecutive authentication failures
668 unsigned int auth_failures;
671 * disabled_until - Network block disabled until this time if non-zero
673 struct os_reltime disabled_until;
676 * parent_cred - Pointer to parent wpa_cred entry
678 * This pointer can be used to delete temporary networks when a wpa_cred
679 * that was used to create them is removed. This pointer should not be
680 * dereferences since it may not be updated in all cases.
686 * macsec_policy - Determines the policy for MACsec secure session
688 * 0: MACsec not in use (default)
689 * 1: MACsec enabled - Should secure, accept key server's advice to
690 * determine whether to use a secure session or not.
693 #endif /* CONFIG_MACSEC */
696 int update_identifier;
697 #endif /* CONFIG_HS20 */
699 unsigned int wps_run;
702 * mac_addr - MAC address policy
704 * 0 = use permanent MAC address
705 * 1 = use random MAC address for each ESS connection
706 * 2 = like 1, but maintain OUI (with local admin bit set)
708 * Internally, special value -1 is used to indicate that the parameter
709 * was not specified in the configuration (i.e., default behavior is
715 * no_auto_peer - Do not automatically peer with compatible mesh peers
717 * When unset, the reception of a beacon from a another mesh peer in
718 * this MBSS will trigger a peering attempt.
723 #endif /* CONFIG_SSID_H */