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