1/* 2 * WPA Supplicant / Configuration file structures 3 * Copyright (c) 2003-2012, 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_H 10#define CONFIG_H 11 12#define DEFAULT_EAPOL_VERSION 1 13#ifdef CONFIG_NO_SCAN_PROCESSING 14#define DEFAULT_AP_SCAN 2 15#else /* CONFIG_NO_SCAN_PROCESSING */ 16#define DEFAULT_AP_SCAN 1 17#endif /* CONFIG_NO_SCAN_PROCESSING */ 18#define DEFAULT_USER_MPM 1 19#define DEFAULT_MAX_PEER_LINKS 99 20#define DEFAULT_MESH_MAX_INACTIVITY 300 21#define DEFAULT_FAST_REAUTH 1 22#define DEFAULT_P2P_GO_INTENT 7 23#define DEFAULT_P2P_INTRA_BSS 1 24#define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60) 25#define DEFAULT_P2P_OPTIMIZE_LISTEN_CHAN 0 26#define DEFAULT_BSS_MAX_COUNT 200 27#define DEFAULT_BSS_EXPIRATION_AGE 180 28#define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2 29#define DEFAULT_MAX_NUM_STA 128 30#define DEFAULT_ACCESS_NETWORK_TYPE 15 31#define DEFAULT_SCAN_CUR_FREQ 0 32#define DEFAULT_P2P_SEARCH_DELAY 500 33#define DEFAULT_RAND_ADDR_LIFETIME 60 34#define DEFAULT_KEY_MGMT_OFFLOAD 1 35#define DEFAULT_CERT_IN_CB 1 36#define DEFAULT_P2P_GO_CTWINDOW 0 37 38#include "config_ssid.h" 39#include "wps/wps.h" 40#include "common/ieee802_11_defs.h" 41#include "common/ieee802_11_common.h" 42 43 44struct wpa_cred { 45 /** 46 * next - Next credential in the list 47 * 48 * This pointer can be used to iterate over all credentials. The head 49 * of this list is stored in the cred field of struct wpa_config. 50 */ 51 struct wpa_cred *next; 52 53 /** 54 * id - Unique id for the credential 55 * 56 * This identifier is used as a unique identifier for each credential 57 * block when using the control interface. Each credential is allocated 58 * an id when it is being created, either when reading the 59 * configuration file or when a new credential is added through the 60 * control interface. 61 */ 62 int id; 63 64 /** 65 * temporary - Whether this credential is temporary and not to be saved 66 */ 67 int temporary; 68 69 /** 70 * priority - Priority group 71 * 72 * By default, all networks and credentials get the same priority group 73 * (0). This field can be used to give higher priority for credentials 74 * (and similarly in struct wpa_ssid for network blocks) to change the 75 * Interworking automatic networking selection behavior. The matching 76 * network (based on either an enabled network block or a credential) 77 * with the highest priority value will be selected. 78 */ 79 int priority; 80 81 /** 82 * pcsc - Use PC/SC and SIM/USIM card 83 */ 84 int pcsc; 85 86 /** 87 * realm - Home Realm for Interworking 88 */ 89 char *realm; 90 91 /** 92 * username - Username for Interworking network selection 93 */ 94 char *username; 95 96 /** 97 * password - Password for Interworking network selection 98 */ 99 char *password; 100 101 /** 102 * ext_password - Whether password is a name for external storage 103 */ 104 int ext_password; 105 106 /** 107 * ca_cert - CA certificate for Interworking network selection 108 */ 109 char *ca_cert; 110 111 /** 112 * client_cert - File path to client certificate file (PEM/DER) 113 * 114 * This field is used with Interworking networking selection for a case 115 * where client certificate/private key is used for authentication 116 * (EAP-TLS). Full path to the file should be used since working 117 * directory may change when wpa_supplicant is run in the background. 118 * 119 * Alternatively, a named configuration blob can be used by setting 120 * this to blob://blob_name. 121 */ 122 char *client_cert; 123 124 /** 125 * private_key - File path to client private key file (PEM/DER/PFX) 126 * 127 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be 128 * commented out. Both the private key and certificate will be read 129 * from the PKCS#12 file in this case. Full path to the file should be 130 * used since working directory may change when wpa_supplicant is run 131 * in the background. 132 * 133 * Windows certificate store can be used by leaving client_cert out and 134 * configuring private_key in one of the following formats: 135 * 136 * cert://substring_to_match 137 * 138 * hash://certificate_thumbprint_in_hex 139 * 140 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4" 141 * 142 * Note that when running wpa_supplicant as an application, the user 143 * certificate store (My user account) is used, whereas computer store 144 * (Computer account) is used when running wpasvc as a service. 145 * 146 * Alternatively, a named configuration blob can be used by setting 147 * this to blob://blob_name. 148 */ 149 char *private_key; 150 151 /** 152 * private_key_passwd - Password for private key file 153 */ 154 char *private_key_passwd; 155 156 /** 157 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format 158 */ 159 char *imsi; 160 161 /** 162 * milenage - Milenage parameters for SIM/USIM simulator in 163 * <Ki>:<OPc>:<SQN> format 164 */ 165 char *milenage; 166 167 /** 168 * domain_suffix_match - Constraint for server domain name 169 * 170 * If set, this FQDN is used as a suffix match requirement for the AAA 171 * server certificate in SubjectAltName dNSName element(s). If a 172 * matching dNSName is found, this constraint is met. If no dNSName 173 * values are present, this constraint is matched against SubjectName CN 174 * using same suffix match comparison. Suffix match here means that the 175 * host/domain name is compared one label at a time starting from the 176 * top-level domain and all the labels in @domain_suffix_match shall be 177 * included in the certificate. The certificate may include additional 178 * sub-level labels in addition to the required labels. 179 * 180 * For example, domain_suffix_match=example.com would match 181 * test.example.com but would not match test-example.com. 182 */ 183 char *domain_suffix_match; 184 185 /** 186 * domain - Home service provider FQDN(s) 187 * 188 * This is used to compare against the Domain Name List to figure out 189 * whether the AP is operated by the Home SP. Multiple domain entries 190 * can be used to configure alternative FQDNs that will be considered 191 * home networks. 192 */ 193 char **domain; 194 195 /** 196 * num_domain - Number of FQDNs in the domain array 197 */ 198 size_t num_domain; 199 200 /** 201 * roaming_consortium - Roaming Consortium OI 202 * 203 * If roaming_consortium_len is non-zero, this field contains the 204 * Roaming Consortium OI that can be used to determine which access 205 * points support authentication with this credential. This is an 206 * alternative to the use of the realm parameter. When using Roaming 207 * Consortium to match the network, the EAP parameters need to be 208 * pre-configured with the credential since the NAI Realm information 209 * may not be available or fetched. 210 */ 211 u8 roaming_consortium[15]; 212 213 /** 214 * roaming_consortium_len - Length of roaming_consortium 215 */ 216 size_t roaming_consortium_len; 217 218 u8 required_roaming_consortium[15]; 219 size_t required_roaming_consortium_len; 220 221 /** 222 * eap_method - EAP method to use 223 * 224 * Pre-configured EAP method to use with this credential or %NULL to 225 * indicate no EAP method is selected, i.e., the method will be 226 * selected automatically based on ANQP information. 227 */ 228 struct eap_method_type *eap_method; 229 230 /** 231 * phase1 - Phase 1 (outer authentication) parameters 232 * 233 * Pre-configured EAP parameters or %NULL. 234 */ 235 char *phase1; 236 237 /** 238 * phase2 - Phase 2 (inner authentication) parameters 239 * 240 * Pre-configured EAP parameters or %NULL. 241 */ 242 char *phase2; 243 244 struct excluded_ssid { 245 u8 ssid[SSID_MAX_LEN]; 246 size_t ssid_len; 247 } *excluded_ssid; 248 size_t num_excluded_ssid; 249 250 struct roaming_partner { 251 char fqdn[128]; 252 int exact_match; 253 u8 priority; 254 char country[3]; 255 } *roaming_partner; 256 size_t num_roaming_partner; 257 258 int update_identifier; 259 260 /** 261 * provisioning_sp - FQDN of the SP that provisioned the credential 262 */ 263 char *provisioning_sp; 264 265 /** 266 * sp_priority - Credential priority within a provisioning SP 267 * 268 * This is the priority of the credential among all credentials 269 * provisionined by the same SP (i.e., for entries that have identical 270 * provisioning_sp value). The range of this priority is 0-255 with 0 271 * being the highest and 255 the lower priority. 272 */ 273 int sp_priority; 274 275 unsigned int min_dl_bandwidth_home; 276 unsigned int min_ul_bandwidth_home; 277 unsigned int min_dl_bandwidth_roaming; 278 unsigned int min_ul_bandwidth_roaming; 279 280 /** 281 * max_bss_load - Maximum BSS Load Channel Utilization (1..255) 282 * This value is used as the maximum channel utilization for network 283 * selection purposes for home networks. If the AP does not advertise 284 * BSS Load or if the limit would prevent any connection, this 285 * constraint will be ignored. 286 */ 287 unsigned int max_bss_load; 288 289 unsigned int num_req_conn_capab; 290 u8 *req_conn_capab_proto; 291 int **req_conn_capab_port; 292 293 /** 294 * ocsp - Whether to use/require OCSP to check server certificate 295 * 296 * 0 = do not use OCSP stapling (TLS certificate status extension) 297 * 1 = try to use OCSP stapling, but not require response 298 * 2 = require valid OCSP stapling response 299 */ 300 int ocsp; 301 302 /** 303 * sim_num - User selected SIM identifier 304 * 305 * This variable is used for identifying which SIM is used if the system 306 * has more than one. 307 */ 308 int sim_num; 309}; 310 311 312#define CFG_CHANGED_DEVICE_NAME BIT(0) 313#define CFG_CHANGED_CONFIG_METHODS BIT(1) 314#define CFG_CHANGED_DEVICE_TYPE BIT(2) 315#define CFG_CHANGED_OS_VERSION BIT(3) 316#define CFG_CHANGED_UUID BIT(4) 317#define CFG_CHANGED_COUNTRY BIT(5) 318#define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6) 319#define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7) 320#define CFG_CHANGED_WPS_STRING BIT(8) 321#define CFG_CHANGED_P2P_INTRA_BSS BIT(9) 322#define CFG_CHANGED_VENDOR_EXTENSION BIT(10) 323#define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11) 324#define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12) 325#define CFG_CHANGED_P2P_PREF_CHAN BIT(13) 326#define CFG_CHANGED_EXT_PW_BACKEND BIT(14) 327#define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15) 328#define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16) 329 330/** 331 * struct wpa_config - wpa_supplicant configuration data 332 * 333 * This data structure is presents the per-interface (radio) configuration 334 * data. In many cases, there is only one struct wpa_config instance, but if 335 * more than one network interface is being controlled, one instance is used 336 * for each. 337 */ 338struct wpa_config { 339 /** 340 * ssid - Head of the global network list 341 * 342 * This is the head for the list of all the configured networks. 343 */ 344 struct wpa_ssid *ssid; 345 346 /** 347 * pssid - Per-priority network lists (in priority order) 348 */ 349 struct wpa_ssid **pssid; 350 351 /** 352 * num_prio - Number of different priorities used in the pssid lists 353 * 354 * This indicates how many per-priority network lists are included in 355 * pssid. 356 */ 357 int num_prio; 358 359 /** 360 * cred - Head of the credential list 361 * 362 * This is the head for the list of all the configured credentials. 363 */ 364 struct wpa_cred *cred; 365 366 /** 367 * eapol_version - IEEE 802.1X/EAPOL version number 368 * 369 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which 370 * defines EAPOL version 2. However, there are many APs that do not 371 * handle the new version number correctly (they seem to drop the 372 * frames completely). In order to make wpa_supplicant interoperate 373 * with these APs, the version number is set to 1 by default. This 374 * configuration value can be used to set it to the new version (2). 375 */ 376 int eapol_version; 377 378 /** 379 * ap_scan - AP scanning/selection 380 * 381 * By default, wpa_supplicant requests driver to perform AP 382 * scanning and then uses the scan results to select a 383 * suitable AP. Another alternative is to allow the driver to 384 * take care of AP scanning and selection and use 385 * wpa_supplicant just to process EAPOL frames based on IEEE 386 * 802.11 association information from the driver. 387 * 388 * 1: wpa_supplicant initiates scanning and AP selection (default). 389 * 390 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11 391 * association parameters (e.g., WPA IE generation); this mode can 392 * also be used with non-WPA drivers when using IEEE 802.1X mode; 393 * do not try to associate with APs (i.e., external program needs 394 * to control association). This mode must also be used when using 395 * wired Ethernet drivers. 396 * 397 * 2: like 0, but associate with APs using security policy and SSID 398 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS 399 * drivers to enable operation with hidden SSIDs and optimized roaming; 400 * in this mode, the network blocks in the configuration are tried 401 * one by one until the driver reports successful association; each 402 * network block should have explicit security policy (i.e., only one 403 * option in the lists) for key_mgmt, pairwise, group, proto variables. 404 */ 405 int ap_scan; 406 407 /** 408 * bgscan - Background scan and roaming parameters or %NULL if none 409 * 410 * This is an optional set of parameters for background scanning and 411 * roaming within a network (ESS). For more detailed information see 412 * ssid block documentation. 413 * 414 * The variable defines default bgscan behavior for all BSS station 415 * networks except for those which have their own bgscan configuration. 416 */ 417 char *bgscan; 418 419 /** 420 * disable_scan_offload - Disable automatic offloading of scan requests 421 * 422 * By default, %wpa_supplicant tries to offload scanning if the driver 423 * indicates support for this (sched_scan). This configuration 424 * parameter can be used to disable this offloading mechanism. 425 */ 426 int disable_scan_offload; 427 428 /** 429 * ctrl_interface - Parameters for the control interface 430 * 431 * If this is specified, %wpa_supplicant will open a control interface 432 * that is available for external programs to manage %wpa_supplicant. 433 * The meaning of this string depends on which control interface 434 * mechanism is used. For all cases, the existence of this parameter 435 * in configuration is used to determine whether the control interface 436 * is enabled. 437 * 438 * For UNIX domain sockets (default on Linux and BSD): This is a 439 * directory that will be created for UNIX domain sockets for listening 440 * to requests from external programs (CLI/GUI, etc.) for status 441 * information and configuration. The socket file will be named based 442 * on the interface name, so multiple %wpa_supplicant processes can be 443 * run at the same time if more than one interface is used. 444 * /var/run/wpa_supplicant is the recommended directory for sockets and 445 * by default, wpa_cli will use it when trying to connect with 446 * %wpa_supplicant. 447 * 448 * Access control for the control interface can be configured 449 * by setting the directory to allow only members of a group 450 * to use sockets. This way, it is possible to run 451 * %wpa_supplicant as root (since it needs to change network 452 * configuration and open raw sockets) and still allow GUI/CLI 453 * components to be run as non-root users. However, since the 454 * control interface can be used to change the network 455 * configuration, this access needs to be protected in many 456 * cases. By default, %wpa_supplicant is configured to use gid 457 * 0 (root). If you want to allow non-root users to use the 458 * control interface, add a new group and change this value to 459 * match with that group. Add users that should have control 460 * interface access to this group. 461 * 462 * When configuring both the directory and group, use following format: 463 * DIR=/var/run/wpa_supplicant GROUP=wheel 464 * DIR=/var/run/wpa_supplicant GROUP=0 465 * (group can be either group name or gid) 466 * 467 * For UDP connections (default on Windows): The value will be ignored. 468 * This variable is just used to select that the control interface is 469 * to be created. The value can be set to, e.g., udp 470 * (ctrl_interface=udp). 471 * 472 * For Windows Named Pipe: This value can be used to set the security 473 * descriptor for controlling access to the control interface. Security 474 * descriptor can be set using Security Descriptor String Format (see 475 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp). 476 * The descriptor string needs to be prefixed with SDDL=. For example, 477 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject 478 * all connections). 479 */ 480 char *ctrl_interface; 481 482 /** 483 * ctrl_interface_group - Control interface group (DEPRECATED) 484 * 485 * This variable is only used for backwards compatibility. Group for 486 * UNIX domain sockets should now be specified using GROUP=group in 487 * ctrl_interface variable. 488 */ 489 char *ctrl_interface_group; 490 491 /** 492 * fast_reauth - EAP fast re-authentication (session resumption) 493 * 494 * By default, fast re-authentication is enabled for all EAP methods 495 * that support it. This variable can be used to disable fast 496 * re-authentication (by setting fast_reauth=0). Normally, there is no 497 * need to disable fast re-authentication. 498 */ 499 int fast_reauth; 500 501 /** 502 * opensc_engine_path - Path to the OpenSSL engine for opensc 503 * 504 * This is an OpenSSL specific configuration option for loading OpenSC 505 * engine (engine_opensc.so); if %NULL, this engine is not loaded. 506 */ 507 char *opensc_engine_path; 508 509 /** 510 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11 511 * 512 * This is an OpenSSL specific configuration option for loading PKCS#11 513 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded. 514 */ 515 char *pkcs11_engine_path; 516 517 /** 518 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module 519 * 520 * This is an OpenSSL specific configuration option for configuring 521 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this 522 * module is not loaded. 523 */ 524 char *pkcs11_module_path; 525 526 /** 527 * openssl_ciphers - OpenSSL cipher string 528 * 529 * This is an OpenSSL specific configuration option for configuring the 530 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the 531 * default. 532 */ 533 char *openssl_ciphers; 534 535 /** 536 * pcsc_reader - PC/SC reader name prefix 537 * 538 * If not %NULL, PC/SC reader with a name that matches this prefix is 539 * initialized for SIM/USIM access. Empty string can be used to match 540 * the first available reader. 541 */ 542 char *pcsc_reader; 543 544 /** 545 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards 546 * 547 * This field is used to configure PIN for SIM/USIM for EAP-SIM and 548 * EAP-AKA. If left out, this will be asked through control interface. 549 */ 550 char *pcsc_pin; 551 552 /** 553 * external_sim - Use external processing for SIM/USIM operations 554 */ 555 int external_sim; 556 557 /** 558 * driver_param - Driver interface parameters 559 * 560 * This text string is passed to the selected driver interface with the 561 * optional struct wpa_driver_ops::set_param() handler. This can be 562 * used to configure driver specific options without having to add new 563 * driver interface functionality. 564 */ 565 char *driver_param; 566 567 /** 568 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK 569 * 570 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK 571 * cache (unit: seconds). 572 */ 573 unsigned int dot11RSNAConfigPMKLifetime; 574 575 /** 576 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold 577 * 578 * dot11 MIB variable for the percentage of the PMK lifetime 579 * that should expire before an IEEE 802.1X reauthentication occurs. 580 */ 581 unsigned int dot11RSNAConfigPMKReauthThreshold; 582 583 /** 584 * dot11RSNAConfigSATimeout - Security association timeout 585 * 586 * dot11 MIB variable for the maximum time a security association 587 * shall take to set up (unit: seconds). 588 */ 589 unsigned int dot11RSNAConfigSATimeout; 590 591 /** 592 * update_config - Is wpa_supplicant allowed to update configuration 593 * 594 * This variable control whether wpa_supplicant is allow to re-write 595 * its configuration with wpa_config_write(). If this is zero, 596 * configuration data is only changed in memory and the external data 597 * is not overriden. If this is non-zero, wpa_supplicant will update 598 * the configuration data (e.g., a file) whenever configuration is 599 * changed. This update may replace the old configuration which can 600 * remove comments from it in case of a text file configuration. 601 */ 602 int update_config; 603 604 /** 605 * blobs - Configuration blobs 606 */ 607 struct wpa_config_blob *blobs; 608 609 /** 610 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS 611 */ 612 u8 uuid[16]; 613 614 /** 615 * device_name - Device Name (WPS) 616 * User-friendly description of device; up to 32 octets encoded in 617 * UTF-8 618 */ 619 char *device_name; 620 621 /** 622 * manufacturer - Manufacturer (WPS) 623 * The manufacturer of the device (up to 64 ASCII characters) 624 */ 625 char *manufacturer; 626 627 /** 628 * model_name - Model Name (WPS) 629 * Model of the device (up to 32 ASCII characters) 630 */ 631 char *model_name; 632 633 /** 634 * model_number - Model Number (WPS) 635 * Additional device description (up to 32 ASCII characters) 636 */ 637 char *model_number; 638 639 /** 640 * serial_number - Serial Number (WPS) 641 * Serial number of the device (up to 32 characters) 642 */ 643 char *serial_number; 644 645 /** 646 * device_type - Primary Device Type (WPS) 647 */ 648 u8 device_type[WPS_DEV_TYPE_LEN]; 649 650 /** 651 * config_methods - Config Methods 652 * 653 * This is a space-separated list of supported WPS configuration 654 * methods. For example, "label virtual_display virtual_push_button 655 * keypad". 656 * Available methods: usba ethernet label display ext_nfc_token 657 * int_nfc_token nfc_interface push_button keypad 658 * virtual_display physical_display 659 * virtual_push_button physical_push_button. 660 */ 661 char *config_methods; 662 663 /** 664 * os_version - OS Version (WPS) 665 * 4-octet operating system version number 666 */ 667 u8 os_version[4]; 668 669 /** 670 * country - Country code 671 * 672 * This is the ISO/IEC alpha2 country code for which we are operating 673 * in 674 */ 675 char country[2]; 676 677 /** 678 * wps_cred_processing - Credential processing 679 * 680 * 0 = process received credentials internally 681 * 1 = do not process received credentials; just pass them over 682 * ctrl_iface to external program(s) 683 * 2 = process received credentials internally and pass them over 684 * ctrl_iface to external program(s) 685 */ 686 int wps_cred_processing; 687 688#define MAX_SEC_DEVICE_TYPES 5 689 /** 690 * sec_device_types - Secondary Device Types (P2P) 691 */ 692 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN]; 693 int num_sec_device_types; 694 695 int p2p_listen_reg_class; 696 int p2p_listen_channel; 697 int p2p_oper_reg_class; 698 int p2p_oper_channel; 699 int p2p_go_intent; 700 char *p2p_ssid_postfix; 701 int persistent_reconnect; 702 int p2p_intra_bss; 703 unsigned int num_p2p_pref_chan; 704 struct p2p_channel *p2p_pref_chan; 705 struct wpa_freq_range_list p2p_no_go_freq; 706 int p2p_add_cli_chan; 707 int p2p_ignore_shared_freq; 708 int p2p_optimize_listen_chan; 709 710 struct wpabuf *wps_vendor_ext_m1; 711 712#define MAX_WPS_VENDOR_EXT 10 713 /** 714 * wps_vendor_ext - Vendor extension attributes in WPS 715 */ 716 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT]; 717 718 /** 719 * p2p_group_idle - Maximum idle time in seconds for P2P group 720 * 721 * This value controls how long a P2P group is maintained after there 722 * is no other members in the group. As a GO, this means no associated 723 * stations in the group. As a P2P client, this means no GO seen in 724 * scan results. The maximum idle time is specified in seconds with 0 725 * indicating no time limit, i.e., the P2P group remains in active 726 * state indefinitely until explicitly removed. As a P2P client, the 727 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e., 728 * this parameter is mainly meant for GO use and for P2P client, it can 729 * only be used to reduce the default timeout to smaller value. A 730 * special value -1 can be used to configure immediate removal of the 731 * group for P2P client role on any disconnection after the data 732 * connection has been established. 733 */ 734 int p2p_group_idle; 735 736 /** 737 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO 738 * 739 * This parameter controls the length of the random passphrase that is 740 * generated at the GO. 741 */ 742 unsigned int p2p_passphrase_len; 743 744 /** 745 * bss_max_count - Maximum number of BSS entries to keep in memory 746 */ 747 unsigned int bss_max_count; 748 749 /** 750 * bss_expiration_age - BSS entry age after which it can be expired 751 * 752 * This value controls the time in seconds after which a BSS entry 753 * gets removed if it has not been updated or is not in use. 754 */ 755 unsigned int bss_expiration_age; 756 757 /** 758 * bss_expiration_scan_count - Expire BSS after number of scans 759 * 760 * If the BSS entry has not been seen in this many scans, it will be 761 * removed. A value of 1 means that entry is removed after the first 762 * scan in which the BSSID is not seen. Larger values can be used 763 * to avoid BSS entries disappearing if they are not visible in 764 * every scan (e.g., low signal quality or interference). 765 */ 766 unsigned int bss_expiration_scan_count; 767 768 /** 769 * filter_ssids - SSID-based scan result filtering 770 * 771 * 0 = do not filter scan results 772 * 1 = only include configured SSIDs in scan results/BSS table 773 */ 774 int filter_ssids; 775 776 /** 777 * filter_rssi - RSSI-based scan result filtering 778 * 779 * 0 = do not filter scan results 780 * -n = filter scan results below -n dBm 781 */ 782 int filter_rssi; 783 784 /** 785 * max_num_sta - Maximum number of STAs in an AP/P2P GO 786 */ 787 unsigned int max_num_sta; 788 789 /** 790 * freq_list - Array of allowed scan frequencies or %NULL for all 791 * 792 * This is an optional zero-terminated array of frequencies in 793 * megahertz (MHz) to allow for narrowing scanning range. 794 */ 795 int *freq_list; 796 797 /** 798 * scan_cur_freq - Whether to scan only the current channel 799 * 800 * If true, attempt to scan only the current channel if any other 801 * VIFs on this radio are already associated on a particular channel. 802 */ 803 int scan_cur_freq; 804 805 /** 806 * changed_parameters - Bitmap of changed parameters since last update 807 */ 808 unsigned int changed_parameters; 809 810 /** 811 * disassoc_low_ack - Disassocicate stations with massive packet loss 812 */ 813 int disassoc_low_ack; 814 815 /** 816 * interworking - Whether Interworking (IEEE 802.11u) is enabled 817 */ 818 int interworking; 819 820 /** 821 * access_network_type - Access Network Type 822 * 823 * When Interworking is enabled, scans will be limited to APs that 824 * advertise the specified Access Network Type (0..15; with 15 825 * indicating wildcard match). 826 */ 827 int access_network_type; 828 829 /** 830 * hessid - Homogenous ESS identifier 831 * 832 * If this is set (any octet is non-zero), scans will be used to 833 * request response only from BSSes belonging to the specified 834 * Homogeneous ESS. This is used only if interworking is enabled. 835 */ 836 u8 hessid[ETH_ALEN]; 837 838 /** 839 * hs20 - Hotspot 2.0 840 */ 841 int hs20; 842 843 /** 844 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7 845 * 846 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities 847 * by acting as a Registrar and using M1 from the AP. The config 848 * methods attribute in that message is supposed to indicate only the 849 * configuration method supported by the AP in Enrollee role, i.e., to 850 * add an external Registrar. For that case, PBC shall not be used and 851 * as such, the PushButton config method is removed from M1 by default. 852 * If pbc_in_m1=1 is included in the configuration file, the PushButton 853 * config method is left in M1 (if included in config_methods 854 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from 855 * a label in the AP). 856 */ 857 int pbc_in_m1; 858 859 /** 860 * autoscan - Automatic scan parameters or %NULL if none 861 * 862 * This is an optional set of parameters for automatic scanning 863 * within an interface in following format: 864 * <autoscan module name>:<module parameters> 865 */ 866 char *autoscan; 867 868 /** 869 * wps_nfc_pw_from_config - NFC Device Password was read from config 870 * 871 * This parameter can be determined whether the NFC Device Password was 872 * included in the configuration (1) or generated dynamically (0). Only 873 * the former case is re-written back to the configuration file. 874 */ 875 int wps_nfc_pw_from_config; 876 877 /** 878 * wps_nfc_dev_pw_id - NFC Device Password ID for password token 879 */ 880 int wps_nfc_dev_pw_id; 881 882 /** 883 * wps_nfc_dh_pubkey - NFC DH Public Key for password token 884 */ 885 struct wpabuf *wps_nfc_dh_pubkey; 886 887 /** 888 * wps_nfc_dh_privkey - NFC DH Private Key for password token 889 */ 890 struct wpabuf *wps_nfc_dh_privkey; 891 892 /** 893 * wps_nfc_dev_pw - NFC Device Password for password token 894 */ 895 struct wpabuf *wps_nfc_dev_pw; 896 897 /** 898 * ext_password_backend - External password backend or %NULL if none 899 * 900 * format: <backend name>[:<optional backend parameters>] 901 */ 902 char *ext_password_backend; 903 904 /* 905 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity 906 * 907 * This timeout value is used in P2P GO mode to clean up 908 * inactive stations. 909 * By default: 300 seconds. 910 */ 911 int p2p_go_max_inactivity; 912 913 struct hostapd_wmm_ac_params wmm_ac_params[4]; 914 915 /** 916 * auto_interworking - Whether to use network selection automatically 917 * 918 * 0 = do not automatically go through Interworking network selection 919 * (i.e., require explicit interworking_select command for this) 920 * 1 = perform Interworking network selection if one or more 921 * credentials have been configured and scan did not find a 922 * matching network block 923 */ 924 int auto_interworking; 925 926 /** 927 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO. 928 * 929 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite. 930 * Note that regulatory constraints and driver capabilities are 931 * consulted anyway, so setting it to 1 can't do real harm. 932 * By default: 0 (disabled) 933 */ 934 int p2p_go_ht40; 935 936 /** 937 * p2p_go_vht - Default mode for VHT enable when operating as GO 938 * 939 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite. 940 * Note that regulatory constraints and driver capabilities are 941 * consulted anyway, so setting it to 1 can't do real harm. 942 * By default: 0 (disabled) 943 */ 944 int p2p_go_vht; 945 946 /** 947 * p2p_go_ctwindow - CTWindow to use when operating as GO 948 * 949 * By default: 0 (no CTWindow). Values 0-127 can be used to indicate 950 * the length of the CTWindow in TUs. 951 */ 952 int p2p_go_ctwindow; 953 954 /** 955 * p2p_disabled - Whether P2P operations are disabled for this interface 956 */ 957 int p2p_disabled; 958 959 /** 960 * p2p_no_group_iface - Whether group interfaces can be used 961 * 962 * By default, wpa_supplicant will create a separate interface for P2P 963 * group operations if the driver supports this. This functionality can 964 * be disabled by setting this parameter to 1. In that case, the same 965 * interface that was used for the P2P management operations is used 966 * also for the group operation. 967 */ 968 int p2p_no_group_iface; 969 970 /** 971 * p2p_cli_probe - Enable/disable P2P CLI probe request handling 972 * 973 * If this parameter is set to 1, a connected P2P Client will receive 974 * and handle Probe Request frames. Setting this parameter to 0 975 * disables this option. Default value: 0. 976 * 977 * Note: Setting this property at run time takes effect on the following 978 * interface state transition to/from the WPA_COMPLETED state. 979 */ 980 int p2p_cli_probe; 981 982 /** 983 * okc - Whether to enable opportunistic key caching by default 984 * 985 * By default, OKC is disabled unless enabled by the per-network 986 * proactive_key_caching=1 parameter. okc=1 can be used to change this 987 * default behavior. 988 */ 989 int okc; 990 991 /** 992 * pmf - Whether to enable/require PMF by default 993 * 994 * By default, PMF is disabled unless enabled by the per-network 995 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change 996 * this default behavior. 997 */ 998 enum mfp_options pmf; 999 1000 /** 1001 * sae_groups - Preference list of enabled groups for SAE 1002 * 1003 * By default (if this parameter is not set), the mandatory group 19 1004 * (ECC group defined over a 256-bit prime order field) is preferred, 1005 * but other groups are also enabled. If this parameter is set, the 1006 * groups will be tried in the indicated order. 1007 */ 1008 int *sae_groups; 1009 1010 /** 1011 * dtim_period - Default DTIM period in Beacon intervals 1012 * 1013 * This parameter can be used to set the default value for network 1014 * blocks that do not specify dtim_period. 1015 */ 1016 int dtim_period; 1017 1018 /** 1019 * beacon_int - Default Beacon interval in TU 1020 * 1021 * This parameter can be used to set the default value for network 1022 * blocks that do not specify beacon_int. 1023 */ 1024 int beacon_int; 1025 1026 /** 1027 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp 1028 * 1029 * This parameter can be used to define additional vendor specific 1030 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The 1031 * format for these element(s) is a hexdump of the raw information 1032 * elements (id+len+payload for one or more elements). 1033 */ 1034 struct wpabuf *ap_vendor_elements; 1035 1036 /** 1037 * ignore_old_scan_res - Ignore scan results older than request 1038 * 1039 * The driver may have a cache of scan results that makes it return 1040 * information that is older than our scan trigger. This parameter can 1041 * be used to configure such old information to be ignored instead of 1042 * allowing it to update the internal BSS table. 1043 */ 1044 int ignore_old_scan_res; 1045 1046 /** 1047 * sched_scan_interval - schedule scan interval 1048 */ 1049 unsigned int sched_scan_interval; 1050 1051 /** 1052 * tdls_external_control - External control for TDLS setup requests 1053 * 1054 * Enable TDLS mode where external programs are given the control 1055 * to specify the TDLS link to get established to the driver. The 1056 * driver requests the TDLS setup to the supplicant only for the 1057 * specified TDLS peers. 1058 */ 1059 int tdls_external_control; 1060 1061 u8 ip_addr_go[4]; 1062 u8 ip_addr_mask[4]; 1063 u8 ip_addr_start[4]; 1064 u8 ip_addr_end[4]; 1065 1066 /** 1067 * osu_dir - OSU provider information directory 1068 * 1069 * If set, allow FETCH_OSU control interface command to be used to fetch 1070 * OSU provider information into all APs and store the results in this 1071 * directory. 1072 */ 1073 char *osu_dir; 1074 1075 /** 1076 * wowlan_triggers - Wake-on-WLAN triggers 1077 * 1078 * If set, these wowlan triggers will be configured. 1079 */ 1080 char *wowlan_triggers; 1081 1082 /** 1083 * p2p_search_delay - Extra delay between concurrent search iterations 1084 * 1085 * Add extra delay (in milliseconds) between search iterations when 1086 * there is a concurrent operation to make p2p_find friendlier to 1087 * concurrent operations by avoiding it from taking 100% of radio 1088 * resources. 1089 */ 1090 unsigned int p2p_search_delay; 1091 1092 /** 1093 * mac_addr - MAC address policy default 1094 * 1095 * 0 = use permanent MAC address 1096 * 1 = use random MAC address for each ESS connection 1097 * 2 = like 1, but maintain OUI (with local admin bit set) 1098 * 1099 * By default, permanent MAC address is used unless policy is changed by 1100 * the per-network mac_addr parameter. Global mac_addr=1 can be used to 1101 * change this default behavior. 1102 */ 1103 int mac_addr; 1104 1105 /** 1106 * rand_addr_lifetime - Lifetime of random MAC address in seconds 1107 */ 1108 unsigned int rand_addr_lifetime; 1109 1110 /** 1111 * preassoc_mac_addr - Pre-association MAC address policy 1112 * 1113 * 0 = use permanent MAC address 1114 * 1 = use random MAC address 1115 * 2 = like 1, but maintain OUI (with local admin bit set) 1116 */ 1117 int preassoc_mac_addr; 1118 1119 /** 1120 * key_mgmt_offload - Use key management offload 1121 * 1122 * Key management offload should be used if the device supports it. 1123 * Key management offload is the capability of a device operating as 1124 * a station to do the exchange necessary to establish temporal keys 1125 * during initial RSN connection, after roaming, or during a PTK 1126 * rekeying operation. 1127 */ 1128 int key_mgmt_offload; 1129 1130 /** 1131 * user_mpm - MPM residency 1132 * 1133 * 0: MPM lives in driver. 1134 * 1: wpa_supplicant handles peering and station allocation. 1135 * 1136 * If AMPE or SAE is enabled, the MPM is always in userspace. 1137 */ 1138 int user_mpm; 1139 1140 /** 1141 * max_peer_links - Maximum number of peer links 1142 * 1143 * Maximum number of mesh peering currently maintained by the STA. 1144 */ 1145 int max_peer_links; 1146 1147 /** 1148 * cert_in_cb - Whether to include a peer certificate dump in events 1149 * 1150 * This controls whether peer certificates for authentication server and 1151 * its certificate chain are included in EAP peer certificate events. 1152 */ 1153 int cert_in_cb; 1154 1155 /** 1156 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity 1157 * 1158 * This timeout value is used in mesh STA to clean up inactive stations. 1159 * By default: 300 seconds. 1160 */ 1161 int mesh_max_inactivity; 1162 1163 /** 1164 * passive_scan - Whether to force passive scan for network connection 1165 * 1166 * This parameter can be used to force only passive scanning to be used 1167 * for network connection cases. It should be noted that this will slow 1168 * down scan operations and reduce likelihood of finding the AP. In 1169 * addition, some use cases will override this due to functional 1170 * requirements, e.g., for finding an AP that uses hidden SSID 1171 * (scan_ssid=1) or P2P device discovery. 1172 */ 1173 int passive_scan; 1174 1175 /** 1176 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS 1177 */ 1178 int reassoc_same_bss_optim; 1179 1180 /** 1181 * wps_priority - Priority for the networks added through WPS 1182 * 1183 * This priority value will be set to each network profile that is added 1184 * by executing the WPS protocol. 1185 */ 1186 int wps_priority; 1187}; 1188 1189 1190/* Prototypes for common functions from config.c */ 1191 1192void wpa_config_free(struct wpa_config *ssid); 1193void wpa_config_free_ssid(struct wpa_ssid *ssid); 1194void wpa_config_foreach_network(struct wpa_config *config, 1195 void (*func)(void *, struct wpa_ssid *), 1196 void *arg); 1197struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id); 1198struct wpa_ssid * wpa_config_add_network(struct wpa_config *config); 1199int wpa_config_remove_network(struct wpa_config *config, int id); 1200void wpa_config_set_network_defaults(struct wpa_ssid *ssid); 1201int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value, 1202 int line); 1203int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var, 1204 const char *value); 1205int wpa_config_dump_values(struct wpa_config *config, char *buf, 1206 size_t buflen); 1207int wpa_config_get_value(const char *name, struct wpa_config *config, 1208 char *buf, size_t buflen); 1209 1210char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys); 1211char * wpa_config_get(struct wpa_ssid *ssid, const char *var); 1212char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var); 1213void wpa_config_update_psk(struct wpa_ssid *ssid); 1214int wpa_config_add_prio_network(struct wpa_config *config, 1215 struct wpa_ssid *ssid); 1216int wpa_config_update_prio_list(struct wpa_config *config); 1217const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config, 1218 const char *name); 1219void wpa_config_set_blob(struct wpa_config *config, 1220 struct wpa_config_blob *blob); 1221void wpa_config_free_blob(struct wpa_config_blob *blob); 1222int wpa_config_remove_blob(struct wpa_config *config, const char *name); 1223void wpa_config_flush_blobs(struct wpa_config *config); 1224 1225struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id); 1226struct wpa_cred * wpa_config_add_cred(struct wpa_config *config); 1227int wpa_config_remove_cred(struct wpa_config *config, int id); 1228void wpa_config_free_cred(struct wpa_cred *cred); 1229int wpa_config_set_cred(struct wpa_cred *cred, const char *var, 1230 const char *value, int line); 1231char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var); 1232 1233struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface, 1234 const char *driver_param); 1235#ifndef CONFIG_NO_STDOUT_DEBUG 1236void wpa_config_debug_dump_networks(struct wpa_config *config); 1237#else /* CONFIG_NO_STDOUT_DEBUG */ 1238#define wpa_config_debug_dump_networks(c) do { } while (0) 1239#endif /* CONFIG_NO_STDOUT_DEBUG */ 1240 1241 1242/* Prototypes for common functions from config.c */ 1243int wpa_config_process_global(struct wpa_config *config, char *pos, int line); 1244 1245 1246/* Prototypes for backend specific functions from the selected config_*.c */ 1247 1248/** 1249 * wpa_config_read - Read and parse configuration database 1250 * @name: Name of the configuration (e.g., path and file name for the 1251 * configuration file) 1252 * @cfgp: Pointer to previously allocated configuration data or %NULL if none 1253 * Returns: Pointer to allocated configuration data or %NULL on failure 1254 * 1255 * This function reads configuration data, parses its contents, and allocates 1256 * data structures needed for storing configuration information. The allocated 1257 * data can be freed with wpa_config_free(). 1258 * 1259 * Each configuration backend needs to implement this function. 1260 */ 1261struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp); 1262 1263/** 1264 * wpa_config_write - Write or update configuration data 1265 * @name: Name of the configuration (e.g., path and file name for the 1266 * configuration file) 1267 * @config: Configuration data from wpa_config_read() 1268 * Returns: 0 on success, -1 on failure 1269 * 1270 * This function write all configuration data into an external database (e.g., 1271 * a text file) in a format that can be read with wpa_config_read(). This can 1272 * be used to allow wpa_supplicant to update its configuration, e.g., when a 1273 * new network is added or a password is changed. 1274 * 1275 * Each configuration backend needs to implement this function. 1276 */ 1277int wpa_config_write(const char *name, struct wpa_config *config); 1278 1279#endif /* CONFIG_H */ 1280