contrib/wpa/wpa_supplicant/config_ssid.h

   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
  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 #define DEFAULT_FRAGMENT_SIZE 1398
  25
  26 #define DEFAULT_BG_SCAN_PERIOD -1
  27 #define DEFAULT_MESH_MAX_RETRIES 2
  28 #define DEFAULT_MESH_RETRY_TIMEOUT 40
  29 #define DEFAULT_MESH_CONFIRM_TIMEOUT 40
  30 #define DEFAULT_MESH_HOLDING_TIMEOUT 40
  31 #define DEFAULT_MESH_RSSI_THRESHOLD 1 /* no change */
  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_TX_STBC -1 /* no change */
  37 #define DEFAULT_RX_STBC -1 /* no change */
  38 #define DEFAULT_DISABLE_MAX_AMSDU -1 /* no change */
  39 #define DEFAULT_AMPDU_FACTOR -1 /* no change */
  40 #define DEFAULT_AMPDU_DENSITY -1 /* no change */
  41 #define DEFAULT_USER_SELECTED_SIM 1
  42 #define DEFAULT_MAX_OPER_CHWIDTH -1
  43
  44 struct psk_list_entry {
  45         struct dl_list list;
  46         u8 addr[ETH_ALEN];
  47         u8 psk[32];
  48         u8 p2p;
  49 };
  50
  51 /**
  52  * struct wpa_ssid - Network configuration data
  53  *
  54  * This structure includes all the configuration variables for a network. This
  55  * data is included in the per-interface configuration data as an element of
  56  * the network list, struct wpa_config::ssid. Each network block in the
  57  * configuration is mapped to a struct wpa_ssid instance.
  58  */
  59 struct wpa_ssid {
  60         /**
  61          * next - Next network in global list
  62          *
  63          * This pointer can be used to iterate over all networks. The head of
  64          * this list is stored in the ssid field of struct wpa_config.
  65          */
  66         struct wpa_ssid *next;
  67
  68         /**
  69          * pnext - Next network in per-priority list
  70          *
  71          * This pointer can be used to iterate over all networks in the same
  72          * priority class. The heads of these list are stored in the pssid
  73          * fields of struct wpa_config.
  74          */
  75         struct wpa_ssid *pnext;
  76
  77         /**
  78          * id - Unique id for the network
  79          *
  80          * This identifier is used as a unique identifier for each network
  81          * block when using the control interface. Each network is allocated an
  82          * id when it is being created, either when reading the configuration
  83          * file or when a new network is added through the control interface.
  84          */
  85         int id;
  86
  87         /**
  88          * priority - Priority group
  89          *
  90          * By default, all networks will get same priority group (0). If some
  91          * of the networks are more desirable, this field can be used to change
  92          * the order in which wpa_supplicant goes through the networks when
  93          * selecting a BSS. The priority groups will be iterated in decreasing
  94          * priority (i.e., the larger the priority value, the sooner the
  95          * network is matched against the scan results). Within each priority
  96          * group, networks will be selected based on security policy, signal
  97          * strength, etc.
  98          *
  99          * Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are
 100          * not using this priority to select the order for scanning. Instead,
 101          * they try the networks in the order that used in the configuration
 102          * file.
 103          */
 104         int priority;
 105
 106         /**
 107          * ssid - Service set identifier (network name)
 108          *
 109          * This is the SSID for the network. For wireless interfaces, this is
 110          * used to select which network will be used. If set to %NULL (or
 111          * ssid_len=0), any SSID can be used. For wired interfaces, this must
 112          * be set to %NULL. Note: SSID may contain any characters, even nul
 113          * (ASCII 0) and as such, this should not be assumed to be a nul
 114          * terminated string. ssid_len defines how many characters are valid
 115          * and the ssid field is not guaranteed to be nul terminated.
 116          */
 117         u8 *ssid;
 118
 119         /**
 120          * ssid_len - Length of the SSID
 121          */
 122         size_t ssid_len;
 123
 124         /**
 125          * bssid - BSSID
 126          *
 127          * If set, this network block is used only when associating with the AP
 128          * using the configured BSSID
 129          *
 130          * If this is a persistent P2P group (disabled == 2), this is the GO
 131          * Device Address.
 132          */
 133         u8 bssid[ETH_ALEN];
 134
 135         /**
 136          * bssid_blacklist - List of inacceptable BSSIDs
 137          */
 138         u8 *bssid_blacklist;
 139         size_t num_bssid_blacklist;
 140
 141         /**
 142          * bssid_blacklist - List of acceptable BSSIDs
 143          */
 144         u8 *bssid_whitelist;
 145         size_t num_bssid_whitelist;
 146
 147         /**
 148          * bssid_set - Whether BSSID is configured for this network
 149          */
 150         int bssid_set;
 151
 152         /**
 153          * bssid_hint - BSSID hint
 154          *
 155          * If set, this is configured to the driver as a preferred initial BSSID
 156          * while connecting to this network.
 157          */
 158         u8 bssid_hint[ETH_ALEN];
 159
 160         /**
 161          * bssid_hint_set - Whether BSSID hint is configured for this network
 162          */
 163         int bssid_hint_set;
 164
 165         /**
 166          * go_p2p_dev_addr - GO's P2P Device Address or all zeros if not set
 167          */
 168         u8 go_p2p_dev_addr[ETH_ALEN];
 169
 170         /**
 171          * psk - WPA pre-shared key (256 bits)
 172          */
 173         u8 psk[32];
 174
 175         /**
 176          * psk_set - Whether PSK field is configured
 177          */
 178         int psk_set;
 179
 180         /**
 181          * passphrase - WPA ASCII passphrase
 182          *
 183          * If this is set, psk will be generated using the SSID and passphrase
 184          * configured for the network. ASCII passphrase must be between 8 and
 185          * 63 characters (inclusive).
 186          */
 187         char *passphrase;
 188
 189         /**
 190          * sae_password - SAE password
 191          *
 192          * This parameter can be used to set a password for SAE. By default, the
 193          * passphrase value is used if this separate parameter is not used, but
 194          * passphrase follows the WPA-PSK constraints (8..63 characters) even
 195          * though SAE passwords do not have such constraints.
 196          */
 197         char *sae_password;
 198
 199         /**
 200          * sae_password_id - SAE password identifier
 201          *
 202          * This parameter can be used to identify a specific SAE password. If
 203          * not included, the default SAE password is used instead.
 204          */
 205         char *sae_password_id;
 206
 207         /**
 208          * ext_psk - PSK/passphrase name in external storage
 209          *
 210          * If this is set, PSK/passphrase will be fetched from external storage
 211          * when requesting association with the network.
 212          */
 213         char *ext_psk;
 214
 215         /**
 216          * mem_only_psk - Whether to keep PSK/passphrase only in memory
 217          *
 218          * 0 = allow psk/passphrase to be stored to the configuration file
 219          * 1 = do not store psk/passphrase to the configuration file
 220          */
 221         int mem_only_psk;
 222
 223         /**
 224          * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_*
 225          */
 226         int pairwise_cipher;
 227
 228         /**
 229          * group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_*
 230          */
 231         int group_cipher;
 232
 233         /**
 234          * group_mgmt_cipher - Bitfield of allowed group management ciphers
 235          *
 236          * This is a bitfield of WPA_CIPHER_AES_128_CMAC and WPA_CIPHER_BIP_*
 237          * values. If 0, no constraint is used for the cipher, i.e., whatever
 238          * the AP uses is accepted.
 239          */
 240         int group_mgmt_cipher;
 241
 242         /**
 243          * key_mgmt - Bitfield of allowed key management protocols
 244          *
 245          * WPA_KEY_MGMT_*
 246          */
 247         int key_mgmt;
 248
 249         /**
 250          * bg_scan_period - Background scan period in seconds, 0 to disable, or
 251          * -1 to indicate no change to default driver configuration
 252          */
 253         int bg_scan_period;
 254
 255         /**
 256          * proto - Bitfield of allowed protocols, WPA_PROTO_*
 257          */
 258         int proto;
 259
 260         /**
 261          * auth_alg -  Bitfield of allowed authentication algorithms
 262          *
 263          * WPA_AUTH_ALG_*
 264          */
 265         int auth_alg;
 266
 267         /**
 268          * scan_ssid - Scan this SSID with Probe Requests
 269          *
 270          * scan_ssid can be used to scan for APs using hidden SSIDs.
 271          * Note: Many drivers do not support this. ap_mode=2 can be used with
 272          * such drivers to use hidden SSIDs. Note2: Most nl80211-based drivers
 273          * do support scan_ssid=1 and that should be used with them instead of
 274          * ap_scan=2.
 275          */
 276         int scan_ssid;
 277
 278 #ifdef IEEE8021X_EAPOL
 279 #define EAPOL_FLAG_REQUIRE_KEY_UNICAST BIT(0)
 280 #define EAPOL_FLAG_REQUIRE_KEY_BROADCAST BIT(1)
 281         /**
 282          * eapol_flags - Bit field of IEEE 802.1X/EAPOL options (EAPOL_FLAG_*)
 283          */
 284         int eapol_flags;
 285
 286         /**
 287          * eap - EAP peer configuration for this network
 288          */
 289         struct eap_peer_config eap;
 290 #endif /* IEEE8021X_EAPOL */
 291
 292 #define NUM_WEP_KEYS 4
 293 #define MAX_WEP_KEY_LEN 16
 294         /**
 295          * wep_key - WEP keys
 296          */
 297         u8 wep_key[NUM_WEP_KEYS][MAX_WEP_KEY_LEN];
 298
 299         /**
 300          * wep_key_len - WEP key lengths
 301          */
 302         size_t wep_key_len[NUM_WEP_KEYS];
 303
 304         /**
 305          * wep_tx_keyidx - Default key index for TX frames using WEP
 306          */
 307         int wep_tx_keyidx;
 308
 309         /**
 310          * proactive_key_caching - Enable proactive key caching
 311          *
 312          * This field can be used to enable proactive key caching which is also
 313          * known as opportunistic PMKSA caching for WPA2. This is disabled (0)
 314          * by default unless default value is changed with the global okc=1
 315          * parameter. Enable by setting this to 1.
 316          *
 317          * Proactive key caching is used to make supplicant assume that the APs
 318          * are using the same PMK and generate PMKSA cache entries without
 319          * doing RSN pre-authentication. This requires support from the AP side
 320          * and is normally used with wireless switches that co-locate the
 321          * authenticator.
 322          *
 323          * Internally, special value -1 is used to indicate that the parameter
 324          * was not specified in the configuration (i.e., default behavior is
 325          * followed).
 326          */
 327         int proactive_key_caching;
 328
 329         /**
 330          * mixed_cell - Whether mixed cells are allowed
 331          *
 332          * This option can be used to configure whether so called mixed cells,
 333          * i.e., networks that use both plaintext and encryption in the same
 334          * SSID, are allowed. This is disabled (0) by default. Enable by
 335          * setting this to 1.
 336          */
 337         int mixed_cell;
 338
 339 #ifdef IEEE8021X_EAPOL
 340
 341         /**
 342          * leap - Number of EAP methods using LEAP
 343          *
 344          * This field should be set to 1 if LEAP is enabled. This is used to
 345          * select IEEE 802.11 authentication algorithm.
 346          */
 347         int leap;
 348
 349         /**
 350          * non_leap - Number of EAP methods not using LEAP
 351          *
 352          * This field should be set to >0 if any EAP method other than LEAP is
 353          * enabled. This is used to select IEEE 802.11 authentication
 354          * algorithm.
 355          */
 356         int non_leap;
 357
 358         /**
 359          * eap_workaround - EAP workarounds enabled
 360          *
 361          * wpa_supplicant supports number of "EAP workarounds" to work around
 362          * interoperability issues with incorrectly behaving authentication
 363          * servers. This is recommended to be enabled by default because some
 364          * of the issues are present in large number of authentication servers.
 365          *
 366          * Strict EAP conformance mode can be configured by disabling
 367          * workarounds with eap_workaround = 0.
 368          */
 369         unsigned int eap_workaround;
 370
 371 #endif /* IEEE8021X_EAPOL */
 372
 373         /**
 374          * mode - IEEE 802.11 operation mode (Infrastucture/IBSS)
 375          *
 376          * 0 = infrastructure (Managed) mode, i.e., associate with an AP.
 377          *
 378          * 1 = IBSS (ad-hoc, peer-to-peer)
 379          *
 380          * 2 = AP (access point)
 381          *
 382          * 3 = P2P Group Owner (can be set in the configuration file)
 383          *
 384          * 4 = P2P Group Formation (used internally; not in configuration
 385          * files)
 386          *
 387          * 5 = Mesh
 388          *
 389          * Note: IBSS can only be used with key_mgmt NONE (plaintext and static
 390          * WEP) and WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE
 391          * (fixed group key TKIP/CCMP) is available for backwards compatibility,
 392          * but its use is deprecated. WPA-None requires following network block
 393          * options: proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or
 394          * CCMP, but not both), and psk must also be set (either directly or
 395          * using ASCII passphrase).
 396          */
 397         enum wpas_mode {
 398                 WPAS_MODE_INFRA = 0,
 399                 WPAS_MODE_IBSS = 1,
 400                 WPAS_MODE_AP = 2,
 401                 WPAS_MODE_P2P_GO = 3,
 402                 WPAS_MODE_P2P_GROUP_FORMATION = 4,
 403                 WPAS_MODE_MESH = 5,
 404         } mode;
 405
 406         /**
 407          * pbss - Whether to use PBSS. Relevant to DMG networks only.
 408          * 0 = do not use PBSS
 409          * 1 = use PBSS
 410          * 2 = don't care (not allowed in AP mode)
 411          * Used together with mode configuration. When mode is AP, it
 412          * means to start a PCP instead of a regular AP. When mode is INFRA it
 413          * means connect to a PCP instead of AP. In this mode you can also
 414          * specify 2 (don't care) meaning connect to either AP or PCP.
 415          * P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in DMG network.
 416          */
 417         int pbss;
 418
 419         /**
 420          * disabled - Whether this network is currently disabled
 421          *
 422          * 0 = this network can be used (default).
 423          * 1 = this network block is disabled (can be enabled through
 424          * ctrl_iface, e.g., with wpa_cli or wpa_gui).
 425          * 2 = this network block includes parameters for a persistent P2P
 426          * group (can be used with P2P ctrl_iface commands)
 427          */
 428         int disabled;
 429
 430         /**
 431          * disabled_for_connect - Whether this network was temporarily disabled
 432          *
 433          * This flag is used to reenable all the temporarily disabled networks
 434          * after either the success or failure of a WPS connection.
 435          */
 436         int disabled_for_connect;
 437
 438         /**
 439          * id_str - Network identifier string for external scripts
 440          *
 441          * This value is passed to external ctrl_iface monitors in
 442          * WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR
 443          * environment variable for action scripts.
 444          */
 445         char *id_str;
 446
 447 #ifdef CONFIG_IEEE80211W
 448         /**
 449          * ieee80211w - Whether management frame protection is enabled
 450          *
 451          * This value is used to configure policy for management frame
 452          * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required.
 453          * This is disabled by default unless the default value has been changed
 454          * with the global pmf=1/2 parameter.
 455          *
 456          * Internally, special value 3 is used to indicate that the parameter
 457          * was not specified in the configuration (i.e., default behavior is
 458          * followed).
 459          */
 460         enum mfp_options ieee80211w;
 461 #endif /* CONFIG_IEEE80211W */
 462
 463 #ifdef CONFIG_OCV
 464         /**
 465          * ocv - Enable/disable operating channel validation
 466          *
 467          * If this parameter is set to 1, stations will exchange OCI element
 468          * to cryptographically verify the operating channel. Setting this
 469          * parameter to 0 disables this option. Default value: 0.
 470          */
 471         int ocv;
 472 #endif /* CONFIG_OCV */
 473
 474         /**
 475          * frequency - Channel frequency in megahertz (MHz) for IBSS
 476          *
 477          * This value is used to configure the initial channel for IBSS (adhoc)
 478          * networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in
 479          * the infrastructure mode. In addition, this value is only used by the
 480          * station that creates the IBSS. If an IBSS network with the
 481          * configured SSID is already present, the frequency of the network
 482          * will be used instead of this configured value.
 483          */
 484         int frequency;
 485
 486         /**
 487          * fixed_freq - Use fixed frequency for IBSS
 488          */
 489         int fixed_freq;
 490
 491 #ifdef CONFIG_ACS
 492         /**
 493          * ACS - Automatic Channel Selection for AP mode
 494          *
 495          * If present, it will be handled together with frequency.
 496          * frequency will be used to determine hardware mode only, when it is
 497          * used for both hardware mode and channel when used alone. This will
 498          * force the channel to be set to 0, thus enabling ACS.
 499          */
 500         int acs;
 501 #endif /* CONFIG_ACS */
 502
 503         /**
 504          * mesh_basic_rates - BSS Basic rate set for mesh network
 505          *
 506          */
 507         int *mesh_basic_rates;
 508
 509         /**
 510          * Mesh network plink parameters
 511          */
 512         int dot11MeshMaxRetries;
 513         int dot11MeshRetryTimeout; /* msec */
 514         int dot11MeshConfirmTimeout; /* msec */
 515         int dot11MeshHoldingTimeout; /* msec */
 516
 517         int ht;
 518         int ht40;
 519
 520         int vht;
 521
 522         int he;
 523
 524         int max_oper_chwidth;
 525
 526         unsigned int vht_center_freq1;
 527         unsigned int vht_center_freq2;
 528
 529         /**
 530          * wpa_ptk_rekey - Maximum lifetime for PTK in seconds
 531          *
 532          * This value can be used to enforce rekeying of PTK to mitigate some
 533          * attacks against TKIP deficiencies.
 534          */
 535         int wpa_ptk_rekey;
 536
 537         /**
 538          * group_rekey - Group rekeying time in seconds
 539          *
 540          * This value, if non-zero, is used as the dot11RSNAConfigGroupRekeyTime
 541          * parameter when operating in Authenticator role in IBSS.
 542          */
 543         int group_rekey;
 544
 545         /**
 546          * scan_freq - Array of frequencies to scan or %NULL for all
 547          *
 548          * This is an optional zero-terminated array of frequencies in
 549          * megahertz (MHz) to include in scan requests when searching for this
 550          * network. This can be used to speed up scanning when the network is
 551          * known to not use all possible channels.
 552          */
 553         int *scan_freq;
 554
 555         /**
 556          * bgscan - Background scan and roaming parameters or %NULL if none
 557          *
 558          * This is an optional set of parameters for background scanning and
 559          * roaming within a network (ESS) in following format:
 560          * <bgscan module name>:<module parameters>
 561          */
 562         char *bgscan;
 563
 564         /**
 565          * ignore_broadcast_ssid - Hide SSID in AP mode
 566          *
 567          * Send empty SSID in beacons and ignore probe request frames that do
 568          * not specify full SSID, i.e., require stations to know SSID.
 569          * default: disabled (0)
 570          * 1 = send empty (length=0) SSID in beacon and ignore probe request
 571          * for broadcast SSID
 572          * 2 = clear SSID (ASCII 0), but keep the original length (this may be
 573          * required with some clients that do not support empty SSID) and
 574          * ignore probe requests for broadcast SSID
 575          */
 576         int ignore_broadcast_ssid;
 577
 578         /**
 579          * freq_list - Array of allowed frequencies or %NULL for all
 580          *
 581          * This is an optional zero-terminated array of frequencies in
 582          * megahertz (MHz) to allow for selecting the BSS. If set, scan results
 583          * that do not match any of the specified frequencies are not
 584          * considered when selecting a BSS.
 585          */
 586         int *freq_list;
 587
 588         /**
 589          * p2p_client_list - List of P2P Clients in a persistent group (GO)
 590          *
 591          * This is a list of P2P Clients (P2P Device Address) that have joined
 592          * the persistent group. This is maintained on the GO for persistent
 593          * group entries (disabled == 2).
 594          */
 595         u8 *p2p_client_list;
 596
 597         /**
 598          * num_p2p_clients - Number of entries in p2p_client_list
 599          */
 600         size_t num_p2p_clients;
 601
 602 #ifndef P2P_MAX_STORED_CLIENTS
 603 #define P2P_MAX_STORED_CLIENTS 100
 604 #endif /* P2P_MAX_STORED_CLIENTS */
 605
 606         /**
 607          * psk_list - Per-client PSKs (struct psk_list_entry)
 608          */
 609         struct dl_list psk_list;
 610
 611         /**
 612          * p2p_group - Network generated as a P2P group (used internally)
 613          */
 614         int p2p_group;
 615
 616         /**
 617          * p2p_persistent_group - Whether this is a persistent group
 618          */
 619         int p2p_persistent_group;
 620
 621         /**
 622          * temporary - Whether this network is temporary and not to be saved
 623          */
 624         int temporary;
 625
 626         /**
 627          * export_keys - Whether keys may be exported
 628          *
 629          * This attribute will be set when keys are determined through
 630          * WPS or similar so that they may be exported.
 631          */
 632         int export_keys;
 633
 634 #ifdef CONFIG_HT_OVERRIDES
 635         /**
 636          * disable_ht - Disable HT (IEEE 802.11n) for this network
 637          *
 638          * By default, use it if it is available, but this can be configured
 639          * to 1 to have it disabled.
 640          */
 641         int disable_ht;
 642
 643         /**
 644          * disable_ht40 - Disable HT40 for this network
 645          *
 646          * By default, use it if it is available, but this can be configured
 647          * to 1 to have it disabled.
 648          */
 649         int disable_ht40;
 650
 651         /**
 652          * disable_sgi - Disable SGI (Short Guard Interval) for this network
 653          *
 654          * By default, use it if it is available, but this can be configured
 655          * to 1 to have it disabled.
 656          */
 657         int disable_sgi;
 658
 659         /**
 660          * disable_ldpc - Disable LDPC for this network
 661          *
 662          * By default, use it if it is available, but this can be configured
 663          * to 1 to have it disabled.
 664          */
 665         int disable_ldpc;
 666
 667         /**
 668          * ht40_intolerant - Indicate 40 MHz intolerant for this network
 669          */
 670         int ht40_intolerant;
 671
 672         /**
 673          * disable_max_amsdu - Disable MAX A-MSDU
 674          *
 675          * A-MDSU will be 3839 bytes when disabled, or 7935
 676          * when enabled (assuming it is otherwise supported)
 677          * -1 (default) means do not apply any settings to the kernel.
 678          */
 679         int disable_max_amsdu;
 680
 681         /**
 682          * ampdu_factor - Maximum A-MPDU Length Exponent
 683          *
 684          * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
 685          */
 686         int ampdu_factor;
 687
 688         /**
 689          * ampdu_density - Minimum A-MPDU Start Spacing
 690          *
 691          * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
 692          */
 693         int ampdu_density;
 694
 695         /**
 696          * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000...
 697          *
 698          * By default (empty string): Use whatever the OS has configured.
 699          */
 700         char *ht_mcs;
 701
 702         /**
 703          * tx_stbc - Indicate STBC support for TX streams
 704          *
 705          * Value: -1..1, by default (-1): use whatever the OS or card has
 706          * configured. See IEEE Std 802.11-2016, 9.4.2.56.2.
 707          */
 708         int tx_stbc;
 709
 710         /**
 711          * rx_stbc - Indicate STBC support for RX streams
 712          *
 713          * Value: -1..3, by default (-1): use whatever the OS or card has
 714          * configured. See IEEE Std 802.11-2016, 9.4.2.56.2.
 715          */
 716         int rx_stbc;
 717 #endif /* CONFIG_HT_OVERRIDES */
 718
 719 #ifdef CONFIG_VHT_OVERRIDES
 720         /**
 721          * disable_vht - Disable VHT (IEEE 802.11ac) 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_vht;
 727
 728         /**
 729          * vht_capa - VHT capabilities to use
 730          */
 731         unsigned int vht_capa;
 732
 733         /**
 734          * vht_capa_mask - mask for VHT capabilities
 735          */
 736         unsigned int vht_capa_mask;
 737
 738         int vht_rx_mcs_nss_1, vht_rx_mcs_nss_2,
 739             vht_rx_mcs_nss_3, vht_rx_mcs_nss_4,
 740             vht_rx_mcs_nss_5, vht_rx_mcs_nss_6,
 741             vht_rx_mcs_nss_7, vht_rx_mcs_nss_8;
 742         int vht_tx_mcs_nss_1, vht_tx_mcs_nss_2,
 743             vht_tx_mcs_nss_3, vht_tx_mcs_nss_4,
 744             vht_tx_mcs_nss_5, vht_tx_mcs_nss_6,
 745             vht_tx_mcs_nss_7, vht_tx_mcs_nss_8;
 746 #endif /* CONFIG_VHT_OVERRIDES */
 747
 748         /**
 749          * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
 750          *
 751          * This timeout value is used in AP mode to clean up inactive stations.
 752          * By default: 300 seconds.
 753          */
 754         int ap_max_inactivity;
 755
 756         /**
 757          * dtim_period - DTIM period in Beacon intervals
 758          * By default: 2
 759          */
 760         int dtim_period;
 761
 762         /**
 763          * beacon_int - Beacon interval (default: 100 TU)
 764          */
 765         int beacon_int;
 766
 767         /**
 768          * auth_failures - Number of consecutive authentication failures
 769          */
 770         unsigned int auth_failures;
 771
 772         /**
 773          * disabled_until - Network block disabled until this time if non-zero
 774          */
 775         struct os_reltime disabled_until;
 776
 777         /**
 778          * parent_cred - Pointer to parent wpa_cred entry
 779          *
 780          * This pointer can be used to delete temporary networks when a wpa_cred
 781          * that was used to create them is removed. This pointer should not be
 782          * dereferences since it may not be updated in all cases.
 783          */
 784         void *parent_cred;
 785
 786 #ifdef CONFIG_MACSEC
 787         /**
 788          * macsec_policy - Determines the policy for MACsec secure session
 789          *
 790          * 0: MACsec not in use (default)
 791          * 1: MACsec enabled - Should secure, accept key server's advice to
 792          *    determine whether to use a secure session or not.
 793          */
 794         int macsec_policy;
 795
 796         /**
 797          * macsec_integ_only - Determines how MACsec are transmitted
 798          *
 799          * This setting applies only when MACsec is in use, i.e.,
 800          *  - macsec_policy is enabled
 801          *  - the key server has decided to enable MACsec
 802          *
 803          * 0: Encrypt traffic (default)
 804          * 1: Integrity only
 805          */
 806         int macsec_integ_only;
 807
 808         /**
 809          * macsec_replay_protect - Enable MACsec replay protection
 810          *
 811          * This setting applies only when MACsec is in use, i.e.,
 812          *  - macsec_policy is enabled
 813          *  - the key server has decided to enable MACsec
 814          *
 815          * 0: Replay protection disabled (default)
 816          * 1: Replay protection enabled
 817          */
 818         int macsec_replay_protect;
 819
 820         /**
 821          * macsec_replay_window - MACsec replay protection window
 822          *
 823          * A window in which replay is tolerated, to allow receipt of frames
 824          * that have been misordered by the network.
 825          *
 826          * This setting applies only when MACsec replay protection active, i.e.,
 827          *  - macsec_replay_protect is enabled
 828          *  - the key server has decided to enable MACsec
 829          *
 830          * 0: No replay window, strict check (default)
 831          * 1..2^32-1: number of packets that could be misordered
 832          */
 833         u32 macsec_replay_window;
 834
 835         /**
 836          * macsec_port - MACsec port (in SCI)
 837          *
 838          * Port component of the SCI.
 839          *
 840          * Range: 1-65534 (default: 1)
 841          */
 842         int macsec_port;
 843
 844         /**
 845          * mka_priority - Priority of MKA Actor
 846          *
 847          * Range: 0-255 (default: 255)
 848          */
 849         int mka_priority;
 850
 851         /**
 852          * mka_ckn - MKA pre-shared CKN
 853          */
 854 #define MACSEC_CKN_MAX_LEN 32
 855         size_t mka_ckn_len;
 856         u8 mka_ckn[MACSEC_CKN_MAX_LEN];
 857
 858         /**
 859          * mka_cak - MKA pre-shared CAK
 860          */
 861 #define MACSEC_CAK_MAX_LEN 32
 862         size_t mka_cak_len;
 863         u8 mka_cak[MACSEC_CAK_MAX_LEN];
 864
 865 #define MKA_PSK_SET_CKN BIT(0)
 866 #define MKA_PSK_SET_CAK BIT(1)
 867 #define MKA_PSK_SET (MKA_PSK_SET_CKN | MKA_PSK_SET_CAK)
 868         /**
 869          * mka_psk_set - Whether mka_ckn and mka_cak are set
 870          */
 871         u8 mka_psk_set;
 872 #endif /* CONFIG_MACSEC */
 873
 874 #ifdef CONFIG_HS20
 875         int update_identifier;
 876
 877         /**
 878          * roaming_consortium_selection - Roaming Consortium Selection
 879          *
 880          * The matching Roaming Consortium OI that was used to generate this
 881          * network profile.
 882          */
 883         u8 *roaming_consortium_selection;
 884
 885         /**
 886          * roaming_consortium_selection_len - roaming_consortium_selection len
 887          */
 888         size_t roaming_consortium_selection_len;
 889 #endif /* CONFIG_HS20 */
 890
 891         unsigned int wps_run;
 892
 893         /**
 894          * mac_addr - MAC address policy
 895          *
 896          * 0 = use permanent MAC address
 897          * 1 = use random MAC address for each ESS connection
 898          * 2 = like 1, but maintain OUI (with local admin bit set)
 899          *
 900          * Internally, special value -1 is used to indicate that the parameter
 901          * was not specified in the configuration (i.e., default behavior is
 902          * followed).
 903          */
 904         int mac_addr;
 905
 906         /**
 907          * no_auto_peer - Do not automatically peer with compatible mesh peers
 908          *
 909          * When unset, the reception of a beacon from a another mesh peer in
 910          * this MBSS will trigger a peering attempt.
 911          */
 912         int no_auto_peer;
 913
 914         /**
 915          * mesh_rssi_threshold - Set mesh parameter mesh_rssi_threshold (dBm)
 916          *
 917          * -255..-1 = threshold value in dBm
 918          * 0 = not using RSSI threshold
 919          * 1 = do not change driver default
 920          */
 921         int mesh_rssi_threshold;
 922
 923         /**
 924          * wps_disabled - WPS disabled in AP mode
 925          *
 926          * 0 = WPS enabled and configured (default)
 927          * 1 = WPS disabled
 928          */
 929         int wps_disabled;
 930
 931         /**
 932          * fils_dh_group - FILS DH Group
 933          *
 934          * 0 = PFS disabled with FILS shared key authentication
 935          * 1-65535 DH Group to use for FILS PFS
 936          */
 937         int fils_dh_group;
 938
 939         /**
 940          * dpp_connector - DPP Connector (signedConnector as string)
 941          */
 942         char *dpp_connector;
 943
 944         /**
 945          * dpp_netaccesskey - DPP netAccessKey (own private key)
 946          */
 947         u8 *dpp_netaccesskey;
 948
 949         /**
 950          * dpp_netaccesskey_len - DPP netAccessKey length in octets
 951          */
 952         size_t dpp_netaccesskey_len;
 953
 954         /**
 955          * net_access_key_expiry - DPP netAccessKey expiry in UNIX time stamp
 956          *
 957          * 0 indicates no expiration.
 958          */
 959         unsigned int dpp_netaccesskey_expiry;
 960
 961         /**
 962          * dpp_csign - C-sign-key (Configurator public key)
 963          */
 964         u8 *dpp_csign;
 965
 966         /**
 967          * dpp_csign_len - C-sign-key length in octets
 968          */
 969         size_t dpp_csign_len;
 970
 971         /**
 972          * owe_group - OWE DH Group
 973          *
 974          * 0 = use default (19) first and then try all supported groups one by
 975          *      one if AP rejects the selected group
 976          * 1-65535 DH Group to use for OWE
 977          *
 978          * Groups 19 (NIST P-256), 20 (NIST P-384), and 21 (NIST P-521) are
 979          * currently supported.
 980          */
 981         int owe_group;
 982
 983         /**
 984          * owe_only - OWE-only mode (disable transition mode)
 985          *
 986          * 0 = enable transition mode (allow connection to either OWE or open
 987          *      BSS)
 988          * 1 = disable transition mode (allow connection only with OWE)
 989          */
 990         int owe_only;
 991
 992         /**
 993          * owe_transition_bss_select_count - OWE transition BSS select count
 994          *
 995          * This is an internally used variable (i.e., not used in external
 996          * configuration) to track the number of selection attempts done for
 997          * OWE BSS in transition mode. This allows fallback to an open BSS if
 998          * the selection attempts for OWE BSS exceed the configured threshold.
 999          */
1000         int owe_transition_bss_select_count;
1001
1002         /**
1003          * multi_ap_backhaul_sta - Multi-AP backhaul STA
1004          * 0 = normal (non-Multi-AP) station
1005          * 1 = Multi-AP backhaul station
1006          */
1007         int multi_ap_backhaul_sta;
1008 };
1009
1010 #endif /* CONFIG_SSID_H */