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