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 DEFAULT_EAP_WORKAROUND ((unsigned int) -1) 17 #define DEFAULT_EAPOL_FLAGS (EAPOL_FLAG_REQUIRE_KEY_UNICAST | \ 18 EAPOL_FLAG_REQUIRE_KEY_BROADCAST) 19 #define DEFAULT_PROTO (WPA_PROTO_WPA | WPA_PROTO_RSN) 20 #define DEFAULT_KEY_MGMT (WPA_KEY_MGMT_PSK | WPA_KEY_MGMT_IEEE8021X) 21 #ifdef CONFIG_NO_TKIP 22 #define DEFAULT_PAIRWISE (WPA_CIPHER_CCMP) 23 #define DEFAULT_GROUP (WPA_CIPHER_CCMP) 24 #else /* CONFIG_NO_TKIP */ 25 #define DEFAULT_PAIRWISE (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP) 26 #define DEFAULT_GROUP (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP) 27 #endif /* CONFIG_NO_TKIP */ 28 #define DEFAULT_FRAGMENT_SIZE 1398 29 30 #define DEFAULT_BG_SCAN_PERIOD -1 31 #define DEFAULT_MESH_MAX_RETRIES 2 32 #define DEFAULT_MESH_RETRY_TIMEOUT 40 33 #define DEFAULT_MESH_CONFIRM_TIMEOUT 40 34 #define DEFAULT_MESH_HOLDING_TIMEOUT 40 35 #define DEFAULT_MESH_RSSI_THRESHOLD 1 /* no change */ 36 #define DEFAULT_DISABLE_HT 0 37 #define DEFAULT_DISABLE_HT40 0 38 #define DEFAULT_DISABLE_SGI 0 39 #define DEFAULT_DISABLE_LDPC 0 40 #define DEFAULT_TX_STBC -1 /* no change */ 41 #define DEFAULT_RX_STBC -1 /* no change */ 42 #define DEFAULT_DISABLE_MAX_AMSDU -1 /* no change */ 43 #define DEFAULT_AMPDU_FACTOR -1 /* no change */ 44 #define DEFAULT_AMPDU_DENSITY -1 /* no change */ 45 #define DEFAULT_USER_SELECTED_SIM 1 46 #define DEFAULT_MAX_OPER_CHWIDTH -1 47 48 /* Consider global sae_pwe for SAE mechanism for PWE derivation */ 49 #define DEFAULT_SAE_PWE SAE_PWE_NOT_SET 50 51 struct psk_list_entry { 52 struct dl_list list; 53 u8 addr[ETH_ALEN]; 54 u8 psk[32]; 55 u8 p2p; 56 }; 57 58 enum wpas_mode { 59 WPAS_MODE_INFRA = 0, 60 WPAS_MODE_IBSS = 1, 61 WPAS_MODE_AP = 2, 62 WPAS_MODE_P2P_GO = 3, 63 WPAS_MODE_P2P_GROUP_FORMATION = 4, 64 WPAS_MODE_MESH = 5, 65 }; 66 67 enum sae_pk_mode { 68 SAE_PK_MODE_AUTOMATIC = 0, 69 SAE_PK_MODE_ONLY = 1, 70 SAE_PK_MODE_DISABLED = 2, 71 }; 72 73 enum wpas_mac_addr_style { 74 WPAS_MAC_ADDR_STYLE_NOT_SET = -1, 75 WPAS_MAC_ADDR_STYLE_PERMANENT = 0, 76 WPAS_MAC_ADDR_STYLE_RANDOM = 1, 77 WPAS_MAC_ADDR_STYLE_RANDOM_SAME_OUI = 2, 78 WPAS_MAC_ADDR_STYLE_DEDICATED_PER_ESS = 3, 79 }; 80 81 /** 82 * struct wpa_ssid - Network configuration data 83 * 84 * This structure includes all the configuration variables for a network. This 85 * data is included in the per-interface configuration data as an element of 86 * the network list, struct wpa_config::ssid. Each network block in the 87 * configuration is mapped to a struct wpa_ssid instance. 88 */ 89 struct wpa_ssid { 90 /** 91 * next - Next network in global list 92 * 93 * This pointer can be used to iterate over all networks. The head of 94 * this list is stored in the ssid field of struct wpa_config. 95 */ 96 struct wpa_ssid *next; 97 98 /** 99 * pnext - Next network in per-priority list 100 * 101 * This pointer can be used to iterate over all networks in the same 102 * priority class. The heads of these list are stored in the pssid 103 * fields of struct wpa_config. 104 */ 105 struct wpa_ssid *pnext; 106 107 /** 108 * id - Unique id for the network 109 * 110 * This identifier is used as a unique identifier for each network 111 * block when using the control interface. Each network is allocated an 112 * id when it is being created, either when reading the configuration 113 * file or when a new network is added through the control interface. 114 */ 115 int id; 116 117 /** 118 * ro - Whether a network is declared as read-only 119 * 120 * Every network which is defined in a config file that is passed to 121 * wpa_supplicant using the -I option will be marked as read-only 122 * using this flag. It has the effect that it won't be written to 123 * /etc/wpa_supplicant.conf (from -c argument) if, e.g., wpa_gui tells 124 * the daemon to save all changed configs. 125 * 126 * This is necessary because networks from /etc/wpa_supplicant.conf 127 * have a higher priority and changes from an alternative file would be 128 * silently overwritten without this. 129 */ 130 bool ro; 131 132 /** 133 * priority - Priority group 134 * 135 * By default, all networks will get same priority group (0). If some 136 * of the networks are more desirable, this field can be used to change 137 * the order in which wpa_supplicant goes through the networks when 138 * selecting a BSS. The priority groups will be iterated in decreasing 139 * priority (i.e., the larger the priority value, the sooner the 140 * network is matched against the scan results). Within each priority 141 * group, networks will be selected based on security policy, signal 142 * strength, etc. 143 * 144 * Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are 145 * not using this priority to select the order for scanning. Instead, 146 * they try the networks in the order that used in the configuration 147 * file. 148 */ 149 int priority; 150 151 /** 152 * ssid - Service set identifier (network name) 153 * 154 * This is the SSID for the network. For wireless interfaces, this is 155 * used to select which network will be used. If set to %NULL (or 156 * ssid_len=0), any SSID can be used. For wired interfaces, this must 157 * be set to %NULL. Note: SSID may contain any characters, even nul 158 * (ASCII 0) and as such, this should not be assumed to be a nul 159 * terminated string. ssid_len defines how many characters are valid 160 * and the ssid field is not guaranteed to be nul terminated. 161 */ 162 u8 *ssid; 163 164 /** 165 * ssid_len - Length of the SSID 166 */ 167 size_t ssid_len; 168 169 /** 170 * bssid - BSSID 171 * 172 * If set, this network block is used only when associating with the AP 173 * using the configured BSSID 174 * 175 * If this is a persistent P2P group (disabled == 2), this is the GO 176 * Device Address. 177 */ 178 u8 bssid[ETH_ALEN]; 179 180 /** 181 * bssid_ignore - List of inacceptable BSSIDs 182 */ 183 u8 *bssid_ignore; 184 size_t num_bssid_ignore; 185 186 /** 187 * bssid_accept - List of acceptable BSSIDs 188 */ 189 u8 *bssid_accept; 190 size_t num_bssid_accept; 191 192 /** 193 * bssid_set - Whether BSSID is configured for this network 194 */ 195 int bssid_set; 196 197 /** 198 * bssid_hint - BSSID hint 199 * 200 * If set, this is configured to the driver as a preferred initial BSSID 201 * while connecting to this network. 202 */ 203 u8 bssid_hint[ETH_ALEN]; 204 205 /** 206 * bssid_hint_set - Whether BSSID hint is configured for this network 207 */ 208 int bssid_hint_set; 209 210 /** 211 * go_p2p_dev_addr - GO's P2P Device Address or all zeros if not set 212 */ 213 u8 go_p2p_dev_addr[ETH_ALEN]; 214 215 /** 216 * psk - WPA pre-shared key (256 bits) 217 */ 218 u8 psk[32]; 219 220 /** 221 * psk_set - Whether PSK field is configured 222 */ 223 int psk_set; 224 225 /** 226 * passphrase - WPA ASCII passphrase 227 * 228 * If this is set, psk will be generated using the SSID and passphrase 229 * configured for the network. ASCII passphrase must be between 8 and 230 * 63 characters (inclusive). 231 */ 232 char *passphrase; 233 234 /** 235 * sae_password - SAE password 236 * 237 * This parameter can be used to set a password for SAE. By default, the 238 * passphrase value is used if this separate parameter is not used, but 239 * passphrase follows the WPA-PSK constraints (8..63 characters) even 240 * though SAE passwords do not have such constraints. 241 */ 242 char *sae_password; 243 244 /** 245 * sae_password_id - SAE password identifier 246 * 247 * This parameter can be used to identify a specific SAE password. If 248 * not included, the default SAE password is used instead. 249 */ 250 char *sae_password_id; 251 252 struct sae_pt *pt; 253 254 /** 255 * ext_psk - PSK/passphrase name in external storage 256 * 257 * If this is set, PSK/passphrase will be fetched from external storage 258 * when requesting association with the network. 259 */ 260 char *ext_psk; 261 262 /** 263 * mem_only_psk - Whether to keep PSK/passphrase only in memory 264 * 265 * 0 = allow psk/passphrase to be stored to the configuration file 266 * 1 = do not store psk/passphrase to the configuration file 267 */ 268 int mem_only_psk; 269 270 /** 271 * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_* 272 */ 273 int pairwise_cipher; 274 275 /** 276 * group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_* 277 */ 278 int group_cipher; 279 280 /** 281 * group_mgmt_cipher - Bitfield of allowed group management ciphers 282 * 283 * This is a bitfield of WPA_CIPHER_AES_128_CMAC and WPA_CIPHER_BIP_* 284 * values. If 0, no constraint is used for the cipher, i.e., whatever 285 * the AP uses is accepted. 286 */ 287 int group_mgmt_cipher; 288 289 /** 290 * key_mgmt - Bitfield of allowed key management protocols 291 * 292 * WPA_KEY_MGMT_* 293 */ 294 int key_mgmt; 295 296 /** 297 * bg_scan_period - Background scan period in seconds, 0 to disable, or 298 * -1 to indicate no change to default driver configuration 299 */ 300 int bg_scan_period; 301 302 /** 303 * proto - Bitfield of allowed protocols, WPA_PROTO_* 304 */ 305 int proto; 306 307 /** 308 * auth_alg - Bitfield of allowed authentication algorithms 309 * 310 * WPA_AUTH_ALG_* 311 */ 312 int auth_alg; 313 314 /** 315 * scan_ssid - Scan this SSID with Probe Requests 316 * 317 * scan_ssid can be used to scan for APs using hidden SSIDs. 318 * Note: Many drivers do not support this. ap_mode=2 can be used with 319 * such drivers to use hidden SSIDs. Note2: Most nl80211-based drivers 320 * do support scan_ssid=1 and that should be used with them instead of 321 * ap_scan=2. 322 */ 323 int scan_ssid; 324 325 #ifdef IEEE8021X_EAPOL 326 #define EAPOL_FLAG_REQUIRE_KEY_UNICAST BIT(0) 327 #define EAPOL_FLAG_REQUIRE_KEY_BROADCAST BIT(1) 328 /** 329 * eapol_flags - Bit field of IEEE 802.1X/EAPOL options (EAPOL_FLAG_*) 330 */ 331 int eapol_flags; 332 333 /** 334 * eap - EAP peer configuration for this network 335 */ 336 struct eap_peer_config eap; 337 #endif /* IEEE8021X_EAPOL */ 338 339 #ifdef CONFIG_WEP 340 #define NUM_WEP_KEYS 4 341 #define MAX_WEP_KEY_LEN 16 342 /** 343 * wep_key - WEP keys 344 */ 345 u8 wep_key[NUM_WEP_KEYS][MAX_WEP_KEY_LEN]; 346 347 /** 348 * wep_key_len - WEP key lengths 349 */ 350 size_t wep_key_len[NUM_WEP_KEYS]; 351 352 /** 353 * wep_tx_keyidx - Default key index for TX frames using WEP 354 */ 355 int wep_tx_keyidx; 356 #endif /* CONFIG_WEP */ 357 358 /** 359 * proactive_key_caching - Enable proactive key caching 360 * 361 * This field can be used to enable proactive key caching which is also 362 * known as opportunistic PMKSA caching for WPA2. This is disabled (0) 363 * by default unless default value is changed with the global okc=1 364 * parameter. Enable by setting this to 1. 365 * 366 * Proactive key caching is used to make supplicant assume that the APs 367 * are using the same PMK and generate PMKSA cache entries without 368 * doing RSN pre-authentication. This requires support from the AP side 369 * and is normally used with wireless switches that co-locate the 370 * authenticator. 371 * 372 * Internally, special value -1 is used to indicate that the parameter 373 * was not specified in the configuration (i.e., default behavior is 374 * followed). 375 */ 376 int proactive_key_caching; 377 378 /** 379 * mixed_cell - Whether mixed cells are allowed 380 * 381 * This option can be used to configure whether so called mixed cells, 382 * i.e., networks that use both plaintext and encryption in the same 383 * SSID, are allowed. This is disabled (0) by default. Enable by 384 * setting this to 1. 385 */ 386 int mixed_cell; 387 388 #ifdef IEEE8021X_EAPOL 389 390 /** 391 * leap - Number of EAP methods using LEAP 392 * 393 * This field should be set to 1 if LEAP is enabled. This is used to 394 * select IEEE 802.11 authentication algorithm. 395 */ 396 int leap; 397 398 /** 399 * non_leap - Number of EAP methods not using LEAP 400 * 401 * This field should be set to >0 if any EAP method other than LEAP is 402 * enabled. This is used to select IEEE 802.11 authentication 403 * algorithm. 404 */ 405 int non_leap; 406 407 /** 408 * eap_workaround - EAP workarounds enabled 409 * 410 * wpa_supplicant supports number of "EAP workarounds" to work around 411 * interoperability issues with incorrectly behaving authentication 412 * servers. This is recommended to be enabled by default because some 413 * of the issues are present in large number of authentication servers. 414 * 415 * Strict EAP conformance mode can be configured by disabling 416 * workarounds with eap_workaround = 0. 417 */ 418 unsigned int eap_workaround; 419 420 #endif /* IEEE8021X_EAPOL */ 421 422 /** 423 * mode - IEEE 802.11 operation mode (Infrastucture/IBSS) 424 * 425 * 0 = infrastructure (Managed) mode, i.e., associate with an AP. 426 * 427 * 1 = IBSS (ad-hoc, peer-to-peer) 428 * 429 * 2 = AP (access point) 430 * 431 * 3 = P2P Group Owner (can be set in the configuration file) 432 * 433 * 4 = P2P Group Formation (used internally; not in configuration 434 * files) 435 * 436 * 5 = Mesh 437 * 438 * Note: IBSS can only be used with key_mgmt NONE (plaintext and static 439 * WEP) and WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE 440 * (fixed group key TKIP/CCMP) is available for backwards compatibility, 441 * but its use is deprecated. WPA-None requires following network block 442 * options: proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or 443 * CCMP, but not both), and psk must also be set (either directly or 444 * using ASCII passphrase). 445 */ 446 enum wpas_mode mode; 447 448 /** 449 * pbss - Whether to use PBSS. Relevant to DMG networks only. 450 * 0 = do not use PBSS 451 * 1 = use PBSS 452 * 2 = don't care (not allowed in AP mode) 453 * Used together with mode configuration. When mode is AP, it 454 * means to start a PCP instead of a regular AP. When mode is INFRA it 455 * means connect to a PCP instead of AP. In this mode you can also 456 * specify 2 (don't care) meaning connect to either AP or PCP. 457 * P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in DMG network. 458 */ 459 int pbss; 460 461 /** 462 * disabled - Whether this network is currently disabled 463 * 464 * 0 = this network can be used (default). 465 * 1 = this network block is disabled (can be enabled through 466 * ctrl_iface, e.g., with wpa_cli or wpa_gui). 467 * 2 = this network block includes parameters for a persistent P2P 468 * group (can be used with P2P ctrl_iface commands) 469 */ 470 int disabled; 471 472 /** 473 * disabled_for_connect - Whether this network was temporarily disabled 474 * 475 * This flag is used to reenable all the temporarily disabled networks 476 * after either the success or failure of a WPS connection. 477 */ 478 int disabled_for_connect; 479 480 /** 481 * id_str - Network identifier string for external scripts 482 * 483 * This value is passed to external ctrl_iface monitors in 484 * WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR 485 * environment variable for action scripts. 486 */ 487 char *id_str; 488 489 /** 490 * ieee80211w - Whether management frame protection is enabled 491 * 492 * This value is used to configure policy for management frame 493 * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required. 494 * This is disabled by default unless the default value has been changed 495 * with the global pmf=1/2 parameter. 496 * 497 * Internally, special value 3 is used to indicate that the parameter 498 * was not specified in the configuration (i.e., default behavior is 499 * followed). 500 */ 501 enum mfp_options ieee80211w; 502 503 #ifdef CONFIG_OCV 504 /** 505 * ocv - Enable/disable operating channel validation 506 * 507 * If this parameter is set to 1, stations will exchange OCI element 508 * to cryptographically verify the operating channel. Setting this 509 * parameter to 0 disables this option. Default value: 0. 510 */ 511 int ocv; 512 #endif /* CONFIG_OCV */ 513 514 /** 515 * frequency - Channel frequency in megahertz (MHz) for IBSS 516 * 517 * This value is used to configure the initial channel for IBSS (adhoc) 518 * networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in 519 * the infrastructure mode. In addition, this value is only used by the 520 * station that creates the IBSS. If an IBSS network with the 521 * configured SSID is already present, the frequency of the network 522 * will be used instead of this configured value. 523 */ 524 int frequency; 525 526 /** 527 * enable_edmg - Enable EDMG feature in STA/AP mode 528 * 529 * This flag is used for enabling the EDMG capability in STA/AP mode. 530 */ 531 int enable_edmg; 532 533 /** 534 * edmg_channel - EDMG channel number 535 * 536 * This value is used to configure the EDMG channel bonding feature. 537 * In AP mode it defines the EDMG channel to start the AP on. 538 * in STA mode it defines the EDMG channel to use for connection 539 * (if supported by AP). 540 */ 541 u8 edmg_channel; 542 543 /** 544 * fixed_freq - Use fixed frequency for IBSS 545 */ 546 int fixed_freq; 547 548 #ifdef CONFIG_ACS 549 /** 550 * ACS - Automatic Channel Selection for AP mode 551 * 552 * If present, it will be handled together with frequency. 553 * frequency will be used to determine hardware mode only, when it is 554 * used for both hardware mode and channel when used alone. This will 555 * force the channel to be set to 0, thus enabling ACS. 556 */ 557 int acs; 558 #endif /* CONFIG_ACS */ 559 560 /** 561 * mesh_basic_rates - BSS Basic rate set for mesh network 562 * 563 */ 564 int *mesh_basic_rates; 565 566 /** 567 * Mesh network plink parameters 568 */ 569 int dot11MeshMaxRetries; 570 int dot11MeshRetryTimeout; /* msec */ 571 int dot11MeshConfirmTimeout; /* msec */ 572 int dot11MeshHoldingTimeout; /* msec */ 573 574 /** 575 * Mesh network layer-2 forwarding (dot11MeshForwarding) 576 */ 577 int mesh_fwding; 578 579 int ht; 580 int ht40; 581 582 int vht; 583 584 int he; 585 586 int eht; 587 588 enum oper_chan_width max_oper_chwidth; 589 590 unsigned int vht_center_freq1; 591 unsigned int vht_center_freq2; 592 593 /** 594 * wpa_ptk_rekey - Maximum lifetime for PTK in seconds 595 * 596 * This value can be used to enforce rekeying of PTK to mitigate some 597 * attacks against TKIP deficiencies. 598 */ 599 int wpa_ptk_rekey; 600 601 /** wpa_deny_ptk0_rekey - Control PTK0 rekeying 602 * 603 * Rekeying a pairwise key using only keyid 0 (PTK0 rekey) has many 604 * broken implementations and should be avoided when using or 605 * interacting with one. 606 * 607 * 0 = always rekey when configured/instructed 608 * 1 = only rekey when the local driver is explicitly indicating it can 609 * perform this operation without issues 610 * 2 = never allow PTK0 rekeys 611 */ 612 enum ptk0_rekey_handling wpa_deny_ptk0_rekey; 613 614 /** 615 * group_rekey - Group rekeying time in seconds 616 * 617 * This value, if non-zero, is used as the dot11RSNAConfigGroupRekeyTime 618 * parameter when operating in Authenticator role in IBSS. 619 */ 620 int group_rekey; 621 622 /** 623 * scan_freq - Array of frequencies to scan or %NULL for all 624 * 625 * This is an optional zero-terminated array of frequencies in 626 * megahertz (MHz) to include in scan requests when searching for this 627 * network. This can be used to speed up scanning when the network is 628 * known to not use all possible channels. 629 */ 630 int *scan_freq; 631 632 /** 633 * bgscan - Background scan and roaming parameters or %NULL if none 634 * 635 * This is an optional set of parameters for background scanning and 636 * roaming within a network (ESS) in following format: 637 * <bgscan module name>:<module parameters> 638 */ 639 char *bgscan; 640 641 /** 642 * ignore_broadcast_ssid - Hide SSID in AP mode 643 * 644 * Send empty SSID in beacons and ignore probe request frames that do 645 * not specify full SSID, i.e., require stations to know SSID. 646 * default: disabled (0) 647 * 1 = send empty (length=0) SSID in beacon and ignore probe request 648 * for broadcast SSID 649 * 2 = clear SSID (ASCII 0), but keep the original length (this may be 650 * required with some clients that do not support empty SSID) and 651 * ignore probe requests for broadcast SSID 652 */ 653 int ignore_broadcast_ssid; 654 655 /** 656 * freq_list - Array of allowed frequencies or %NULL for all 657 * 658 * This is an optional zero-terminated array of frequencies in 659 * megahertz (MHz) to allow for selecting the BSS. If set, scan results 660 * that do not match any of the specified frequencies are not 661 * considered when selecting a BSS. 662 */ 663 int *freq_list; 664 665 /** 666 * p2p_client_list - List of P2P Clients in a persistent group (GO) 667 * 668 * This is a list of P2P Clients (P2P Device Address) that have joined 669 * the persistent group. This is maintained on the GO for persistent 670 * group entries (disabled == 2). 671 */ 672 u8 *p2p_client_list; 673 674 /** 675 * num_p2p_clients - Number of entries in p2p_client_list 676 */ 677 size_t num_p2p_clients; 678 679 #ifndef P2P_MAX_STORED_CLIENTS 680 #define P2P_MAX_STORED_CLIENTS 100 681 #endif /* P2P_MAX_STORED_CLIENTS */ 682 683 /** 684 * psk_list - Per-client PSKs (struct psk_list_entry) 685 */ 686 struct dl_list psk_list; 687 688 /** 689 * p2p_group - Network generated as a P2P group (used internally) 690 */ 691 int p2p_group; 692 693 /** 694 * p2p_persistent_group - Whether this is a persistent group 695 */ 696 int p2p_persistent_group; 697 698 /** 699 * temporary - Whether this network is temporary and not to be saved 700 */ 701 int temporary; 702 703 /** 704 * export_keys - Whether keys may be exported 705 * 706 * This attribute will be set when keys are determined through 707 * WPS or similar so that they may be exported. 708 */ 709 int export_keys; 710 711 #ifdef CONFIG_HT_OVERRIDES 712 /** 713 * disable_ht - Disable HT (IEEE 802.11n) for this network 714 * 715 * By default, use it if it is available, but this can be configured 716 * to 1 to have it disabled. 717 */ 718 int disable_ht; 719 720 /** 721 * disable_ht40 - Disable HT40 for this network 722 * 723 * By default, use it if it is available, but this can be configured 724 * to 1 to have it disabled. 725 */ 726 int disable_ht40; 727 728 /** 729 * disable_sgi - Disable SGI (Short Guard Interval) for this network 730 * 731 * By default, use it if it is available, but this can be configured 732 * to 1 to have it disabled. 733 */ 734 int disable_sgi; 735 736 /** 737 * disable_ldpc - Disable LDPC for this network 738 * 739 * By default, use it if it is available, but this can be configured 740 * to 1 to have it disabled. 741 */ 742 int disable_ldpc; 743 744 /** 745 * ht40_intolerant - Indicate 40 MHz intolerant for this network 746 */ 747 int ht40_intolerant; 748 749 /** 750 * disable_max_amsdu - Disable MAX A-MSDU 751 * 752 * A-MDSU will be 3839 bytes when disabled, or 7935 753 * when enabled (assuming it is otherwise supported) 754 * -1 (default) means do not apply any settings to the kernel. 755 */ 756 int disable_max_amsdu; 757 758 /** 759 * ampdu_factor - Maximum A-MPDU Length Exponent 760 * 761 * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009. 762 */ 763 int ampdu_factor; 764 765 /** 766 * ampdu_density - Minimum A-MPDU Start Spacing 767 * 768 * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009. 769 */ 770 int ampdu_density; 771 772 /** 773 * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000... 774 * 775 * By default (empty string): Use whatever the OS has configured. 776 */ 777 char *ht_mcs; 778 779 /** 780 * tx_stbc - Indicate STBC support for TX streams 781 * 782 * Value: -1..1, by default (-1): use whatever the OS or card has 783 * configured. See IEEE Std 802.11-2016, 9.4.2.56.2. 784 */ 785 int tx_stbc; 786 787 /** 788 * rx_stbc - Indicate STBC support for RX streams 789 * 790 * Value: -1..3, by default (-1): use whatever the OS or card has 791 * configured. See IEEE Std 802.11-2016, 9.4.2.56.2. 792 */ 793 int rx_stbc; 794 #endif /* CONFIG_HT_OVERRIDES */ 795 796 #ifdef CONFIG_VHT_OVERRIDES 797 /** 798 * disable_vht - Disable VHT (IEEE 802.11ac) for this network 799 * 800 * By default, use it if it is available, but this can be configured 801 * to 1 to have it disabled. 802 */ 803 int disable_vht; 804 805 /** 806 * vht_capa - VHT capabilities to use 807 */ 808 unsigned int vht_capa; 809 810 /** 811 * vht_capa_mask - mask for VHT capabilities 812 */ 813 unsigned int vht_capa_mask; 814 815 int vht_rx_mcs_nss_1, vht_rx_mcs_nss_2, 816 vht_rx_mcs_nss_3, vht_rx_mcs_nss_4, 817 vht_rx_mcs_nss_5, vht_rx_mcs_nss_6, 818 vht_rx_mcs_nss_7, vht_rx_mcs_nss_8; 819 int vht_tx_mcs_nss_1, vht_tx_mcs_nss_2, 820 vht_tx_mcs_nss_3, vht_tx_mcs_nss_4, 821 vht_tx_mcs_nss_5, vht_tx_mcs_nss_6, 822 vht_tx_mcs_nss_7, vht_tx_mcs_nss_8; 823 #endif /* CONFIG_VHT_OVERRIDES */ 824 825 #ifdef CONFIG_HE_OVERRIDES 826 /** 827 * disable_he - Disable HE (IEEE 802.11ax) for this network 828 * 829 * By default, use it if it is available, but this can be configured 830 * to 1 to have it disabled. 831 */ 832 int disable_he; 833 #endif /* CONFIG_HE_OVERRIDES */ 834 835 /** 836 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity 837 * 838 * This timeout value is used in AP mode to clean up inactive stations. 839 * By default: 300 seconds. 840 */ 841 int ap_max_inactivity; 842 843 /** 844 * dtim_period - DTIM period in Beacon intervals 845 * By default: 2 846 */ 847 int dtim_period; 848 849 /** 850 * beacon_int - Beacon interval (default: 100 TU) 851 */ 852 int beacon_int; 853 854 /** 855 * auth_failures - Number of consecutive authentication failures 856 */ 857 unsigned int auth_failures; 858 859 /** 860 * disabled_until - Network block disabled until this time if non-zero 861 */ 862 struct os_reltime disabled_until; 863 864 /** 865 * disabled_due_to - BSSID of the disabling failure 866 * 867 * This identifies the BSS that failed the connection attempt that 868 * resulted in the network being temporarily disabled. 869 */ 870 u8 disabled_due_to[ETH_ALEN]; 871 872 /** 873 * parent_cred - Pointer to parent wpa_cred entry 874 * 875 * This pointer can be used to delete temporary networks when a wpa_cred 876 * that was used to create them is removed. This pointer should not be 877 * dereferences since it may not be updated in all cases. 878 */ 879 void *parent_cred; 880 881 #ifdef CONFIG_MACSEC 882 /** 883 * macsec_policy - Determines the policy for MACsec secure session 884 * 885 * 0: MACsec not in use (default) 886 * 1: MACsec enabled - Should secure, accept key server's advice to 887 * determine whether to use a secure session or not. 888 */ 889 int macsec_policy; 890 891 /** 892 * macsec_integ_only - Determines how MACsec are transmitted 893 * 894 * This setting applies only when MACsec is in use, i.e., 895 * - macsec_policy is enabled 896 * - the key server has decided to enable MACsec 897 * 898 * 0: Encrypt traffic (default) 899 * 1: Integrity only 900 */ 901 int macsec_integ_only; 902 903 /** 904 * macsec_replay_protect - Enable MACsec replay protection 905 * 906 * This setting applies only when MACsec is in use, i.e., 907 * - macsec_policy is enabled 908 * - the key server has decided to enable MACsec 909 * 910 * 0: Replay protection disabled (default) 911 * 1: Replay protection enabled 912 */ 913 int macsec_replay_protect; 914 915 /** 916 * macsec_replay_window - MACsec replay protection window 917 * 918 * A window in which replay is tolerated, to allow receipt of frames 919 * that have been misordered by the network. 920 * 921 * This setting applies only when MACsec replay protection active, i.e., 922 * - macsec_replay_protect is enabled 923 * - the key server has decided to enable MACsec 924 * 925 * 0: No replay window, strict check (default) 926 * 1..2^32-1: number of packets that could be misordered 927 */ 928 u32 macsec_replay_window; 929 930 /** 931 * macsec_offload - Enable MACsec hardware offload 932 * 933 * This setting applies only when MACsec is in use, i.e., 934 * - the key server has decided to enable MACsec 935 * 936 * 0 = MACSEC_OFFLOAD_OFF (default) 937 * 1 = MACSEC_OFFLOAD_PHY 938 * 2 = MACSEC_OFFLOAD_MAC 939 */ 940 int macsec_offload; 941 942 /** 943 * macsec_port - MACsec port (in SCI) 944 * 945 * Port component of the SCI. 946 * 947 * Range: 1-65534 (default: 1) 948 */ 949 int macsec_port; 950 951 /** 952 * mka_priority - Priority of MKA Actor 953 * 954 * Range: 0-255 (default: 255) 955 */ 956 int mka_priority; 957 958 /** 959 * macsec_csindex - Cipher suite index for MACsec 960 * 961 * Range: 0-1 (default: 0) 962 */ 963 int macsec_csindex; 964 965 /** 966 * mka_ckn - MKA pre-shared CKN 967 */ 968 #define MACSEC_CKN_MAX_LEN 32 969 size_t mka_ckn_len; 970 u8 mka_ckn[MACSEC_CKN_MAX_LEN]; 971 972 /** 973 * mka_cak - MKA pre-shared CAK 974 */ 975 #define MACSEC_CAK_MAX_LEN 32 976 size_t mka_cak_len; 977 u8 mka_cak[MACSEC_CAK_MAX_LEN]; 978 979 #define MKA_PSK_SET_CKN BIT(0) 980 #define MKA_PSK_SET_CAK BIT(1) 981 #define MKA_PSK_SET (MKA_PSK_SET_CKN | MKA_PSK_SET_CAK) 982 /** 983 * mka_psk_set - Whether mka_ckn and mka_cak are set 984 */ 985 u8 mka_psk_set; 986 #endif /* CONFIG_MACSEC */ 987 988 #ifdef CONFIG_HS20 989 int update_identifier; 990 991 /** 992 * roaming_consortium_selection - Roaming Consortium Selection 993 * 994 * The matching Roaming Consortium OI that was used to generate this 995 * network profile. 996 */ 997 u8 *roaming_consortium_selection; 998 999 /** 1000 * roaming_consortium_selection_len - roaming_consortium_selection len 1001 */ 1002 size_t roaming_consortium_selection_len; 1003 #endif /* CONFIG_HS20 */ 1004 1005 unsigned int wps_run; 1006 1007 /** 1008 * mac_addr - MAC address policy 1009 * 1010 * 0 = use permanent MAC address 1011 * 1 = use random MAC address for each ESS connection 1012 * 2 = like 1, but maintain OUI (with local admin bit set) 1013 * 3 = use dedicated/pregenerated MAC address (see mac_value) 1014 * 1015 * Internally, special value -1 is used to indicate that the parameter 1016 * was not specified in the configuration (i.e., default behavior is 1017 * followed). 1018 */ 1019 enum wpas_mac_addr_style mac_addr; 1020 1021 /** 1022 * mac_value - Specific MAC address to be used 1023 * 1024 * When mac_addr policy is equal to 3 this is the value of the MAC 1025 * address that should be used. 1026 */ 1027 u8 mac_value[ETH_ALEN]; 1028 1029 /** 1030 * no_auto_peer - Do not automatically peer with compatible mesh peers 1031 * 1032 * When unset, the reception of a beacon from a another mesh peer in 1033 * this MBSS will trigger a peering attempt. 1034 */ 1035 int no_auto_peer; 1036 1037 /** 1038 * mesh_rssi_threshold - Set mesh parameter mesh_rssi_threshold (dBm) 1039 * 1040 * -255..-1 = threshold value in dBm 1041 * 0 = not using RSSI threshold 1042 * 1 = do not change driver default 1043 */ 1044 int mesh_rssi_threshold; 1045 1046 /** 1047 * wps_disabled - WPS disabled in AP mode 1048 * 1049 * 0 = WPS enabled and configured (default) 1050 * 1 = WPS disabled 1051 */ 1052 int wps_disabled; 1053 1054 /** 1055 * fils_dh_group - FILS DH Group 1056 * 1057 * 0 = PFS disabled with FILS shared key authentication 1058 * 1-65535 DH Group to use for FILS PFS 1059 */ 1060 int fils_dh_group; 1061 1062 /** 1063 * dpp_connector - DPP Connector (signedConnector as string) 1064 */ 1065 char *dpp_connector; 1066 1067 /** 1068 * dpp_netaccesskey - DPP netAccessKey (own private key) 1069 */ 1070 u8 *dpp_netaccesskey; 1071 1072 /** 1073 * dpp_netaccesskey_len - DPP netAccessKey length in octets 1074 */ 1075 size_t dpp_netaccesskey_len; 1076 1077 /** 1078 * net_access_key_expiry - DPP netAccessKey expiry in UNIX time stamp 1079 * 1080 * 0 indicates no expiration. 1081 */ 1082 unsigned int dpp_netaccesskey_expiry; 1083 1084 /** 1085 * dpp_csign - C-sign-key (Configurator public key) 1086 */ 1087 u8 *dpp_csign; 1088 1089 /** 1090 * dpp_csign_len - C-sign-key length in octets 1091 */ 1092 size_t dpp_csign_len; 1093 1094 /** 1095 * dpp_pp_key - ppKey (Configurator privacy protection public key) 1096 */ 1097 u8 *dpp_pp_key; 1098 1099 /** 1100 * dpp_pp_key_len - ppKey length in octets 1101 */ 1102 size_t dpp_pp_key_len; 1103 1104 /** 1105 * dpp_pfs - DPP PFS 1106 * 0: allow PFS to be used or not used 1107 * 1: require PFS to be used (note: not compatible with DPP R1) 1108 * 2: do not allow PFS to be used 1109 */ 1110 int dpp_pfs; 1111 1112 /** 1113 * dpp_pfs_fallback - DPP PFS fallback selection 1114 * 1115 * This is an internally used variable (i.e., not used in external 1116 * configuration) to track state of the DPP PFS fallback mechanism. 1117 */ 1118 int dpp_pfs_fallback; 1119 1120 /** 1121 * dpp_connector_privacy - Network introduction type 1122 * 0: unprotected variant from DPP R1 1123 * 1: privacy protecting (station Connector encrypted) variant from 1124 * DPP R3 1125 */ 1126 int dpp_connector_privacy; 1127 1128 /** 1129 * owe_group - OWE DH Group 1130 * 1131 * 0 = use default (19) first and then try all supported groups one by 1132 * one if AP rejects the selected group 1133 * 1-65535 DH Group to use for OWE 1134 * 1135 * Groups 19 (NIST P-256), 20 (NIST P-384), and 21 (NIST P-521) are 1136 * currently supported. 1137 */ 1138 int owe_group; 1139 1140 /** 1141 * owe_only - OWE-only mode (disable transition mode) 1142 * 1143 * 0 = enable transition mode (allow connection to either OWE or open 1144 * BSS) 1145 * 1 = disable transition mode (allow connection only with OWE) 1146 */ 1147 int owe_only; 1148 1149 /** 1150 * owe_ptk_workaround - OWE PTK derivation workaround 1151 * 1152 * Initial OWE implementation used SHA256 when deriving the PTK for all 1153 * OWE groups. This was supposed to change to SHA384 for group 20 and 1154 * SHA512 for group 21. This parameter can be used to enable older 1155 * behavior mainly for testing purposes. There is no impact to group 19 1156 * behavior, but if enabled, this will make group 20 and 21 cases use 1157 * SHA256-based PTK derivation which will not work with the updated 1158 * OWE implementation on the AP side. 1159 */ 1160 int owe_ptk_workaround; 1161 1162 /** 1163 * owe_transition_bss_select_count - OWE transition BSS select count 1164 * 1165 * This is an internally used variable (i.e., not used in external 1166 * configuration) to track the number of selection attempts done for 1167 * OWE BSS in transition mode. This allows fallback to an open BSS if 1168 * the selection attempts for OWE BSS exceed the configured threshold. 1169 */ 1170 int owe_transition_bss_select_count; 1171 1172 /** 1173 * multi_ap_backhaul_sta - Multi-AP backhaul STA 1174 * 0 = normal (non-Multi-AP) station 1175 * 1 = Multi-AP backhaul station 1176 */ 1177 int multi_ap_backhaul_sta; 1178 1179 /** 1180 * ft_eap_pmksa_caching - Whether FT-EAP PMKSA caching is allowed 1181 * 0 = do not try to use PMKSA caching with FT-EAP 1182 * 1 = try to use PMKSA caching with FT-EAP 1183 * 1184 * This controls whether to try to use PMKSA caching with FT-EAP for the 1185 * FT initial mobility domain association. 1186 */ 1187 int ft_eap_pmksa_caching; 1188 1189 /** 1190 * beacon_prot - Whether Beacon protection is enabled 1191 * 1192 * This depends on management frame protection (ieee80211w) being 1193 * enabled. 1194 */ 1195 int beacon_prot; 1196 1197 /** 1198 * transition_disable - Transition Disable indication 1199 * The AP can notify authenticated stations to disable transition mode 1200 * in their network profiles when the network has completed transition 1201 * steps, i.e., once sufficiently large number of APs in the ESS have 1202 * been updated to support the more secure alternative. When this 1203 * indication is used, the stations are expected to automatically 1204 * disable transition mode and less secure security options. This 1205 * includes use of WEP, TKIP (including use of TKIP as the group 1206 * cipher), and connections without PMF. 1207 * Bitmap bits: 1208 * bit 0 (0x01): WPA3-Personal (i.e., disable WPA2-Personal = WPA-PSK 1209 * and only allow SAE to be used) 1210 * bit 1 (0x02): SAE-PK (disable SAE without use of SAE-PK) 1211 * bit 2 (0x04): WPA3-Enterprise (move to requiring PMF) 1212 * bit 3 (0x08): Enhanced Open (disable use of open network; require 1213 * OWE) 1214 */ 1215 u8 transition_disable; 1216 1217 /** 1218 * sae_pk - SAE-PK mode 1219 * 0 = automatic SAE/SAE-PK selection based on password; enable 1220 * transition mode (allow SAE authentication without SAE-PK) 1221 * 1 = SAE-PK only (disable transition mode; allow SAE authentication 1222 * only with SAE-PK) 1223 * 2 = disable SAE-PK (allow SAE authentication only without SAE-PK) 1224 */ 1225 enum sae_pk_mode sae_pk; 1226 1227 /** 1228 * was_recently_reconfigured - Whether this SSID config has been changed 1229 * recently 1230 * 1231 * This is an internally used variable, i.e., not used in external 1232 * configuration. 1233 */ 1234 bool was_recently_reconfigured; 1235 1236 /** 1237 * sae_pwe - SAE mechanism for PWE derivation 1238 * 1239 * Internally, special value 4 (DEFAULT_SAE_PWE) is used to indicate 1240 * that the parameter is not set and the global sae_pwe value needs to 1241 * be considered. 1242 * 1243 * 0 = hunting-and-pecking loop only 1244 * 1 = hash-to-element only 1245 * 2 = both hunting-and-pecking loop and hash-to-element enabled 1246 */ 1247 enum sae_pwe sae_pwe; 1248 1249 /** 1250 * disable_eht - Disable EHT (IEEE 802.11be) for this network 1251 * 1252 * By default, use it if it is available, but this can be configured 1253 * to 1 to have it disabled. 1254 */ 1255 int disable_eht; 1256 1257 /** 1258 * enable_4addr_mode - Set 4addr mode after association 1259 * 0 = Do not attempt to set 4addr mode 1260 * 1 = Try to set 4addr mode after association 1261 * 1262 * Linux requires that an interface is set to 4addr mode before it can 1263 * be added to a bridge. Set this to 1 for networks where you intent 1264 * to use the interface in a bridge. 1265 */ 1266 int enable_4addr_mode; 1267 }; 1268 1269 #endif /* CONFIG_SSID_H */ 1270