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