1 /* 2 * WPA Supplicant / Network configuration structures 3 * Copyright (c) 2003-2008, Jouni Malinen <j@w1.fi> 4 * 5 * This software may be distributed under the terms of the BSD license. 6 * See README for more details. 7 */ 8 9 #ifndef CONFIG_SSID_H 10 #define CONFIG_SSID_H 11 12 #include "common/defs.h" 13 #include "eap_peer/eap_config.h" 14 15 #define MAX_SSID_LEN 32 16 17 18 #define DEFAULT_EAP_WORKAROUND ((unsigned int) -1) 19 #define DEFAULT_EAPOL_FLAGS (EAPOL_FLAG_REQUIRE_KEY_UNICAST | \ 20 EAPOL_FLAG_REQUIRE_KEY_BROADCAST) 21 #define DEFAULT_PROTO (WPA_PROTO_WPA | WPA_PROTO_RSN) 22 #define DEFAULT_KEY_MGMT (WPA_KEY_MGMT_PSK | WPA_KEY_MGMT_IEEE8021X) 23 #define DEFAULT_PAIRWISE (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP) 24 #define DEFAULT_GROUP (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP | \ 25 WPA_CIPHER_WEP104 | WPA_CIPHER_WEP40) 26 #define DEFAULT_FRAGMENT_SIZE 1398 27 28 #define DEFAULT_BG_SCAN_PERIOD -1 29 #define DEFAULT_DISABLE_HT 0 30 #define DEFAULT_DISABLE_HT40 0 31 #define DEFAULT_DISABLE_MAX_AMSDU -1 /* no change */ 32 #define DEFAULT_AMPDU_FACTOR -1 /* no change */ 33 #define DEFAULT_AMPDU_DENSITY -1 /* no change */ 34 35 /** 36 * struct wpa_ssid - Network configuration data 37 * 38 * This structure includes all the configuration variables for a network. This 39 * data is included in the per-interface configuration data as an element of 40 * the network list, struct wpa_config::ssid. Each network block in the 41 * configuration is mapped to a struct wpa_ssid instance. 42 */ 43 struct wpa_ssid { 44 /** 45 * next - Next network in global list 46 * 47 * This pointer can be used to iterate over all networks. The head of 48 * this list is stored in the ssid field of struct wpa_config. 49 */ 50 struct wpa_ssid *next; 51 52 /** 53 * pnext - Next network in per-priority list 54 * 55 * This pointer can be used to iterate over all networks in the same 56 * priority class. The heads of these list are stored in the pssid 57 * fields of struct wpa_config. 58 */ 59 struct wpa_ssid *pnext; 60 61 /** 62 * id - Unique id for the network 63 * 64 * This identifier is used as a unique identifier for each network 65 * block when using the control interface. Each network is allocated an 66 * id when it is being created, either when reading the configuration 67 * file or when a new network is added through the control interface. 68 */ 69 int id; 70 71 /** 72 * priority - Priority group 73 * 74 * By default, all networks will get same priority group (0). If some 75 * of the networks are more desirable, this field can be used to change 76 * the order in which wpa_supplicant goes through the networks when 77 * selecting a BSS. The priority groups will be iterated in decreasing 78 * priority (i.e., the larger the priority value, the sooner the 79 * network is matched against the scan results). Within each priority 80 * group, networks will be selected based on security policy, signal 81 * strength, etc. 82 * 83 * Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are 84 * not using this priority to select the order for scanning. Instead, 85 * they try the networks in the order that used in the configuration 86 * file. 87 */ 88 int priority; 89 90 /** 91 * ssid - Service set identifier (network name) 92 * 93 * This is the SSID for the network. For wireless interfaces, this is 94 * used to select which network will be used. If set to %NULL (or 95 * ssid_len=0), any SSID can be used. For wired interfaces, this must 96 * be set to %NULL. Note: SSID may contain any characters, even nul 97 * (ASCII 0) and as such, this should not be assumed to be a nul 98 * terminated string. ssid_len defines how many characters are valid 99 * and the ssid field is not guaranteed to be nul terminated. 100 */ 101 u8 *ssid; 102 103 /** 104 * ssid_len - Length of the SSID 105 */ 106 size_t ssid_len; 107 108 /** 109 * bssid - BSSID 110 * 111 * If set, this network block is used only when associating with the AP 112 * using the configured BSSID 113 * 114 * If this is a persistent P2P group (disabled == 2), this is the GO 115 * Device Address. 116 */ 117 u8 bssid[ETH_ALEN]; 118 119 /** 120 * bssid_set - Whether BSSID is configured for this network 121 */ 122 int bssid_set; 123 124 /** 125 * psk - WPA pre-shared key (256 bits) 126 */ 127 u8 psk[32]; 128 129 /** 130 * psk_set - Whether PSK field is configured 131 */ 132 int psk_set; 133 134 /** 135 * passphrase - WPA ASCII passphrase 136 * 137 * If this is set, psk will be generated using the SSID and passphrase 138 * configured for the network. ASCII passphrase must be between 8 and 139 * 63 characters (inclusive). 140 */ 141 char *passphrase; 142 143 /** 144 * ext_psk - PSK/passphrase name in external storage 145 * 146 * If this is set, PSK/passphrase will be fetched from external storage 147 * when requesting association with the network. 148 */ 149 char *ext_psk; 150 151 /** 152 * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_* 153 */ 154 int pairwise_cipher; 155 156 /** 157 * group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_* 158 */ 159 int group_cipher; 160 161 /** 162 * key_mgmt - Bitfield of allowed key management protocols 163 * 164 * WPA_KEY_MGMT_* 165 */ 166 int key_mgmt; 167 168 /** 169 * bg_scan_period - Background scan period in seconds, 0 to disable, or 170 * -1 to indicate no change to default driver configuration 171 */ 172 int bg_scan_period; 173 174 /** 175 * proto - Bitfield of allowed protocols, WPA_PROTO_* 176 */ 177 int proto; 178 179 /** 180 * auth_alg - Bitfield of allowed authentication algorithms 181 * 182 * WPA_AUTH_ALG_* 183 */ 184 int auth_alg; 185 186 /** 187 * scan_ssid - Scan this SSID with Probe Requests 188 * 189 * scan_ssid can be used to scan for APs using hidden SSIDs. 190 * Note: Many drivers do not support this. ap_mode=2 can be used with 191 * such drivers to use hidden SSIDs. 192 */ 193 int scan_ssid; 194 195 #ifdef IEEE8021X_EAPOL 196 #define EAPOL_FLAG_REQUIRE_KEY_UNICAST BIT(0) 197 #define EAPOL_FLAG_REQUIRE_KEY_BROADCAST BIT(1) 198 /** 199 * eapol_flags - Bit field of IEEE 802.1X/EAPOL options (EAPOL_FLAG_*) 200 */ 201 int eapol_flags; 202 203 /** 204 * eap - EAP peer configuration for this network 205 */ 206 struct eap_peer_config eap; 207 #endif /* IEEE8021X_EAPOL */ 208 209 #define NUM_WEP_KEYS 4 210 #define MAX_WEP_KEY_LEN 16 211 /** 212 * wep_key - WEP keys 213 */ 214 u8 wep_key[NUM_WEP_KEYS][MAX_WEP_KEY_LEN]; 215 216 /** 217 * wep_key_len - WEP key lengths 218 */ 219 size_t wep_key_len[NUM_WEP_KEYS]; 220 221 /** 222 * wep_tx_keyidx - Default key index for TX frames using WEP 223 */ 224 int wep_tx_keyidx; 225 226 /** 227 * proactive_key_caching - Enable proactive key caching 228 * 229 * This field can be used to enable proactive key caching which is also 230 * known as opportunistic PMKSA caching for WPA2. This is disabled (0) 231 * by default. Enable by setting this to 1. 232 * 233 * Proactive key caching is used to make supplicant assume that the APs 234 * are using the same PMK and generate PMKSA cache entries without 235 * doing RSN pre-authentication. This requires support from the AP side 236 * and is normally used with wireless switches that co-locate the 237 * authenticator. 238 */ 239 int proactive_key_caching; 240 241 /** 242 * mixed_cell - Whether mixed cells are allowed 243 * 244 * This option can be used to configure whether so called mixed cells, 245 * i.e., networks that use both plaintext and encryption in the same 246 * SSID, are allowed. This is disabled (0) by default. Enable by 247 * setting this to 1. 248 */ 249 int mixed_cell; 250 251 #ifdef IEEE8021X_EAPOL 252 253 /** 254 * leap - Number of EAP methods using LEAP 255 * 256 * This field should be set to 1 if LEAP is enabled. This is used to 257 * select IEEE 802.11 authentication algorithm. 258 */ 259 int leap; 260 261 /** 262 * non_leap - Number of EAP methods not using LEAP 263 * 264 * This field should be set to >0 if any EAP method other than LEAP is 265 * enabled. This is used to select IEEE 802.11 authentication 266 * algorithm. 267 */ 268 int non_leap; 269 270 /** 271 * eap_workaround - EAP workarounds enabled 272 * 273 * wpa_supplicant supports number of "EAP workarounds" to work around 274 * interoperability issues with incorrectly behaving authentication 275 * servers. This is recommended to be enabled by default because some 276 * of the issues are present in large number of authentication servers. 277 * 278 * Strict EAP conformance mode can be configured by disabling 279 * workarounds with eap_workaround = 0. 280 */ 281 unsigned int eap_workaround; 282 283 #endif /* IEEE8021X_EAPOL */ 284 285 /** 286 * mode - IEEE 802.11 operation mode (Infrastucture/IBSS) 287 * 288 * 0 = infrastructure (Managed) mode, i.e., associate with an AP. 289 * 290 * 1 = IBSS (ad-hoc, peer-to-peer) 291 * 292 * 2 = AP (access point) 293 * 294 * 3 = P2P Group Owner (can be set in the configuration file) 295 * 296 * 4 = P2P Group Formation (used internally; not in configuration 297 * files) 298 * 299 * Note: IBSS can only be used with key_mgmt NONE (plaintext and 300 * static WEP) and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). In 301 * addition, ap_scan has to be set to 2 for IBSS. WPA-None requires 302 * following network block options: proto=WPA, key_mgmt=WPA-NONE, 303 * pairwise=NONE, group=TKIP (or CCMP, but not both), and psk must also 304 * be set (either directly or using ASCII passphrase). 305 */ 306 enum wpas_mode { 307 WPAS_MODE_INFRA = 0, 308 WPAS_MODE_IBSS = 1, 309 WPAS_MODE_AP = 2, 310 WPAS_MODE_P2P_GO = 3, 311 WPAS_MODE_P2P_GROUP_FORMATION = 4, 312 } mode; 313 314 /** 315 * disabled - Whether this network is currently disabled 316 * 317 * 0 = this network can be used (default). 318 * 1 = this network block is disabled (can be enabled through 319 * ctrl_iface, e.g., with wpa_cli or wpa_gui). 320 * 2 = this network block includes parameters for a persistent P2P 321 * group (can be used with P2P ctrl_iface commands) 322 */ 323 int disabled; 324 325 /** 326 * peerkey - Whether PeerKey handshake for direct links is allowed 327 * 328 * This is only used when both RSN/WPA2 and IEEE 802.11e (QoS) are 329 * enabled. 330 * 331 * 0 = disabled (default) 332 * 1 = enabled 333 */ 334 int peerkey; 335 336 /** 337 * id_str - Network identifier string for external scripts 338 * 339 * This value is passed to external ctrl_iface monitors in 340 * WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR 341 * environment variable for action scripts. 342 */ 343 char *id_str; 344 345 #ifdef CONFIG_IEEE80211W 346 /** 347 * ieee80211w - Whether management frame protection is enabled 348 * 349 * This value is used to configure policy for management frame 350 * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required. 351 */ 352 enum mfp_options ieee80211w; 353 #endif /* CONFIG_IEEE80211W */ 354 355 /** 356 * frequency - Channel frequency in megahertz (MHz) for IBSS 357 * 358 * This value is used to configure the initial channel for IBSS (adhoc) 359 * networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in 360 * the infrastructure mode. In addition, this value is only used by the 361 * station that creates the IBSS. If an IBSS network with the 362 * configured SSID is already present, the frequency of the network 363 * will be used instead of this configured value. 364 */ 365 int frequency; 366 367 int ht40; 368 369 /** 370 * wpa_ptk_rekey - Maximum lifetime for PTK in seconds 371 * 372 * This value can be used to enforce rekeying of PTK to mitigate some 373 * attacks against TKIP deficiencies. 374 */ 375 int wpa_ptk_rekey; 376 377 /** 378 * scan_freq - Array of frequencies to scan or %NULL for all 379 * 380 * This is an optional zero-terminated array of frequencies in 381 * megahertz (MHz) to include in scan requests when searching for this 382 * network. This can be used to speed up scanning when the network is 383 * known to not use all possible channels. 384 */ 385 int *scan_freq; 386 387 /** 388 * bgscan - Background scan and roaming parameters or %NULL if none 389 * 390 * This is an optional set of parameters for background scanning and 391 * roaming within a network (ESS) in following format: 392 * <bgscan module name>:<module parameters> 393 */ 394 char *bgscan; 395 396 /** 397 * ignore_broadcast_ssid - Hide SSID in AP mode 398 * 399 * Send empty SSID in beacons and ignore probe request frames that do 400 * not specify full SSID, i.e., require stations to know SSID. 401 * default: disabled (0) 402 * 1 = send empty (length=0) SSID in beacon and ignore probe request 403 * for broadcast SSID 404 * 2 = clear SSID (ASCII 0), but keep the original length (this may be 405 * required with some clients that do not support empty SSID) and 406 * ignore probe requests for broadcast SSID 407 */ 408 int ignore_broadcast_ssid; 409 410 /** 411 * freq_list - Array of allowed frequencies or %NULL for all 412 * 413 * This is an optional zero-terminated array of frequencies in 414 * megahertz (MHz) to allow for selecting the BSS. If set, scan results 415 * that do not match any of the specified frequencies are not 416 * considered when selecting a BSS. 417 */ 418 int *freq_list; 419 420 /** 421 * p2p_client_list - List of P2P Clients in a persistent group (GO) 422 * 423 * This is a list of P2P Clients (P2P Device Address) that have joined 424 * the persistent group. This is maintained on the GO for persistent 425 * group entries (disabled == 2). 426 */ 427 u8 *p2p_client_list; 428 429 /** 430 * num_p2p_clients - Number of entries in p2p_client_list 431 */ 432 size_t num_p2p_clients; 433 434 #ifndef P2P_MAX_STORED_CLIENTS 435 #define P2P_MAX_STORED_CLIENTS 100 436 #endif /* P2P_MAX_STORED_CLIENTS */ 437 438 /** 439 * p2p_group - Network generated as a P2P group (used internally) 440 */ 441 int p2p_group; 442 443 /** 444 * p2p_persistent_group - Whether this is a persistent group 445 */ 446 int p2p_persistent_group; 447 448 /** 449 * temporary - Whether this network is temporary and not to be saved 450 */ 451 int temporary; 452 453 /** 454 * export_keys - Whether keys may be exported 455 * 456 * This attribute will be set when keys are determined through 457 * WPS or similar so that they may be exported. 458 */ 459 int export_keys; 460 461 #ifdef ANDROID_P2P 462 /** 463 * assoc_retry - Number of times association should be retried. 464 */ 465 int assoc_retry; 466 #endif 467 468 #ifdef CONFIG_HT_OVERRIDES 469 /** 470 * disable_ht - Disable HT (IEEE 802.11n) for this network 471 * 472 * By default, use it if it is available, but this can be configured 473 * to 1 to have it disabled. 474 */ 475 int disable_ht; 476 477 /** 478 * disable_ht40 - Disable HT40 for this network 479 * 480 * By default, use it if it is available, but this can be configured 481 * to 1 to have it disabled. 482 */ 483 int disable_ht40; 484 485 /** 486 * disable_max_amsdu - Disable MAX A-MSDU 487 * 488 * A-MDSU will be 3839 bytes when disabled, or 7935 489 * when enabled (assuming it is otherwise supported) 490 * -1 (default) means do not apply any settings to the kernel. 491 */ 492 int disable_max_amsdu; 493 494 /** 495 * ampdu_factor - Maximum A-MPDU Length Exponent 496 * 497 * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009. 498 */ 499 int ampdu_factor; 500 501 /** 502 * ampdu_density - Minimum A-MPDU Start Spacing 503 * 504 * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009. 505 */ 506 int ampdu_density; 507 508 /** 509 * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000... 510 * 511 * By default (empty string): Use whatever the OS has configured. 512 */ 513 char *ht_mcs; 514 #endif /* CONFIG_HT_OVERRIDES */ 515 516 /** 517 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity 518 * 519 * This timeout value is used in AP mode to clean up inactive stations. 520 * By default: 300 seconds. 521 */ 522 int ap_max_inactivity; 523 524 /** 525 * dtim_period - DTIM period in Beacon intervals 526 * By default: 2 527 */ 528 int dtim_period; 529 530 /** 531 * auth_failures - Number of consecutive authentication failures 532 */ 533 unsigned int auth_failures; 534 535 /** 536 * disabled_until - Network block disabled until this time if non-zero 537 */ 538 struct os_time disabled_until; 539 }; 540 541 #endif /* CONFIG_SSID_H */ 542