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