wpa_supplicant/config.h

   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_FAST_REAUTH 1
  19 #define DEFAULT_P2P_GO_INTENT 7
  20 #define DEFAULT_P2P_INTRA_BSS 1
  21 #define DEFAULT_BSS_MAX_COUNT 200
  22 #define DEFAULT_BSS_EXPIRATION_AGE 180
  23 #define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
  24 #define DEFAULT_MAX_NUM_STA 128
  25 #define DEFAULT_ACCESS_NETWORK_TYPE 15
  26
  27 #include "config_ssid.h"
  28 #include "wps/wps.h"
  29
  30
  31 struct wpa_cred {
  32         /**
  33          * next - Next credential in the list
  34          *
  35          * This pointer can be used to iterate over all credentials. The head
  36          * of this list is stored in the cred field of struct wpa_config.
  37          */
  38         struct wpa_cred *next;
  39
  40         /**
  41          * id - Unique id for the credential
  42          *
  43          * This identifier is used as a unique identifier for each credential
  44          * block when using the control interface. Each credential is allocated
  45          * an id when it is being created, either when reading the
  46          * configuration file or when a new credential is added through the
  47          * control interface.
  48          */
  49         int id;
  50
  51         /**
  52          * priority - Priority group
  53          *
  54          * By default, all networks and credentials get the same priority group
  55          * (0). This field can be used to give higher priority for credentials
  56          * (and similarly in struct wpa_ssid for network blocks) to change the
  57          * Interworking automatic networking selection behavior. The matching
  58          * network (based on either an enabled network block or a credential)
  59          * with the highest priority value will be selected.
  60          */
  61         int priority;
  62
  63         /**
  64          * pcsc - Use PC/SC and SIM/USIM card
  65          */
  66         int pcsc;
  67
  68         /**
  69          * realm - Home Realm for Interworking
  70          */
  71         char *realm;
  72
  73         /**
  74          * username - Username for Interworking network selection
  75          */
  76         char *username;
  77
  78         /**
  79          * password - Password for Interworking network selection
  80          */
  81         char *password;
  82
  83         /**
  84          * ext_password - Whether password is a name for external storage
  85          */
  86         int ext_password;
  87
  88         /**
  89          * ca_cert - CA certificate for Interworking network selection
  90          */
  91         char *ca_cert;
  92
  93         /**
  94          * client_cert - File path to client certificate file (PEM/DER)
  95          *
  96          * This field is used with Interworking networking selection for a case
  97          * where client certificate/private key is used for authentication
  98          * (EAP-TLS). Full path to the file should be used since working
  99          * directory may change when wpa_supplicant is run in the background.
 100          *
 101          * Alternatively, a named configuration blob can be used by setting
 102          * this to blob://blob_name.
 103          */
 104         char *client_cert;
 105
 106         /**
 107          * private_key - File path to client private key file (PEM/DER/PFX)
 108          *
 109          * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
 110          * commented out. Both the private key and certificate will be read
 111          * from the PKCS#12 file in this case. Full path to the file should be
 112          * used since working directory may change when wpa_supplicant is run
 113          * in the background.
 114          *
 115          * Windows certificate store can be used by leaving client_cert out and
 116          * configuring private_key in one of the following formats:
 117          *
 118          * cert://substring_to_match
 119          *
 120          * hash://certificate_thumbprint_in_hex
 121          *
 122          * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
 123          *
 124          * Note that when running wpa_supplicant as an application, the user
 125          * certificate store (My user account) is used, whereas computer store
 126          * (Computer account) is used when running wpasvc as a service.
 127          *
 128          * Alternatively, a named configuration blob can be used by setting
 129          * this to blob://blob_name.
 130          */
 131         char *private_key;
 132
 133         /**
 134          * private_key_passwd - Password for private key file
 135          */
 136         char *private_key_passwd;
 137
 138         /**
 139          * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
 140          */
 141         char *imsi;
 142
 143         /**
 144          * milenage - Milenage parameters for SIM/USIM simulator in
 145          *      <Ki>:<OPc>:<SQN> format
 146          */
 147         char *milenage;
 148
 149         /**
 150          * domain - Home service provider FQDN
 151          *
 152          * This is used to compare against the Domain Name List to figure out
 153          * whether the AP is operated by the Home SP.
 154          */
 155         char *domain;
 156
 157         /**
 158          * roaming_consortium - Roaming Consortium OI
 159          *
 160          * If roaming_consortium_len is non-zero, this field contains the
 161          * Roaming Consortium OI that can be used to determine which access
 162          * points support authentication with this credential. This is an
 163          * alternative to the use of the realm parameter. When using Roaming
 164          * Consortium to match the network, the EAP parameters need to be
 165          * pre-configured with the credential since the NAI Realm information
 166          * may not be available or fetched.
 167          */
 168         u8 roaming_consortium[15];
 169
 170         /**
 171          * roaming_consortium_len - Length of roaming_consortium
 172          */
 173         size_t roaming_consortium_len;
 174
 175         /**
 176          * eap_method - EAP method to use
 177          *
 178          * Pre-configured EAP method to use with this credential or %NULL to
 179          * indicate no EAP method is selected, i.e., the method will be
 180          * selected automatically based on ANQP information.
 181          */
 182         struct eap_method_type *eap_method;
 183
 184         /**
 185          * phase1 - Phase 1 (outer authentication) parameters
 186          *
 187          * Pre-configured EAP parameters or %NULL.
 188          */
 189         char *phase1;
 190
 191         /**
 192          * phase2 - Phase 2 (inner authentication) parameters
 193          *
 194          * Pre-configured EAP parameters or %NULL.
 195          */
 196         char *phase2;
 197 };
 198
 199
 200 #define CFG_CHANGED_DEVICE_NAME BIT(0)
 201 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
 202 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
 203 #define CFG_CHANGED_OS_VERSION BIT(3)
 204 #define CFG_CHANGED_UUID BIT(4)
 205 #define CFG_CHANGED_COUNTRY BIT(5)
 206 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
 207 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
 208 #define CFG_CHANGED_WPS_STRING BIT(8)
 209 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
 210 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
 211 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
 212 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
 213 #define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
 214 #define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
 215
 216 /**
 217  * struct wpa_config - wpa_supplicant configuration data
 218  *
 219  * This data structure is presents the per-interface (radio) configuration
 220  * data. In many cases, there is only one struct wpa_config instance, but if
 221  * more than one network interface is being controlled, one instance is used
 222  * for each.
 223  */
 224 struct wpa_config {
 225         /**
 226          * ssid - Head of the global network list
 227          *
 228          * This is the head for the list of all the configured networks.
 229          */
 230         struct wpa_ssid *ssid;
 231
 232         /**
 233          * pssid - Per-priority network lists (in priority order)
 234          */
 235         struct wpa_ssid **pssid;
 236
 237         /**
 238          * num_prio - Number of different priorities used in the pssid lists
 239          *
 240          * This indicates how many per-priority network lists are included in
 241          * pssid.
 242          */
 243         int num_prio;
 244
 245         /**
 246          * cred - Head of the credential list
 247          *
 248          * This is the head for the list of all the configured credentials.
 249          */
 250         struct wpa_cred *cred;
 251
 252         /**
 253          * eapol_version - IEEE 802.1X/EAPOL version number
 254          *
 255          * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
 256          * defines EAPOL version 2. However, there are many APs that do not
 257          * handle the new version number correctly (they seem to drop the
 258          * frames completely). In order to make wpa_supplicant interoperate
 259          * with these APs, the version number is set to 1 by default. This
 260          * configuration value can be used to set it to the new version (2).
 261          */
 262         int eapol_version;
 263
 264         /**
 265          * ap_scan - AP scanning/selection
 266          *
 267          * By default, wpa_supplicant requests driver to perform AP
 268          * scanning and then uses the scan results to select a
 269          * suitable AP. Another alternative is to allow the driver to
 270          * take care of AP scanning and selection and use
 271          * wpa_supplicant just to process EAPOL frames based on IEEE
 272          * 802.11 association information from the driver.
 273          *
 274          * 1: wpa_supplicant initiates scanning and AP selection (default).
 275          *
 276          * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
 277          * association parameters (e.g., WPA IE generation); this mode can
 278          * also be used with non-WPA drivers when using IEEE 802.1X mode;
 279          * do not try to associate with APs (i.e., external program needs
 280          * to control association). This mode must also be used when using
 281          * wired Ethernet drivers.
 282          *
 283          * 2: like 0, but associate with APs using security policy and SSID
 284          * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
 285          * drivers to enable operation with hidden SSIDs and optimized roaming;
 286          * in this mode, the network blocks in the configuration are tried
 287          * one by one until the driver reports successful association; each
 288          * network block should have explicit security policy (i.e., only one
 289          * option in the lists) for key_mgmt, pairwise, group, proto variables.
 290          */
 291         int ap_scan;
 292
 293         /**
 294          * disable_scan_offload - Disable automatic offloading of scan requests
 295          *
 296          * By default, %wpa_supplicant tries to offload scanning if the driver
 297          * indicates support for this (sched_scan). This configuration
 298          * parameter can be used to disable this offloading mechanism.
 299          */
 300         int disable_scan_offload;
 301
 302         /**
 303          * ctrl_interface - Parameters for the control interface
 304          *
 305          * If this is specified, %wpa_supplicant will open a control interface
 306          * that is available for external programs to manage %wpa_supplicant.
 307          * The meaning of this string depends on which control interface
 308          * mechanism is used. For all cases, the existence of this parameter
 309          * in configuration is used to determine whether the control interface
 310          * is enabled.
 311          *
 312          * For UNIX domain sockets (default on Linux and BSD): This is a
 313          * directory that will be created for UNIX domain sockets for listening
 314          * to requests from external programs (CLI/GUI, etc.) for status
 315          * information and configuration. The socket file will be named based
 316          * on the interface name, so multiple %wpa_supplicant processes can be
 317          * run at the same time if more than one interface is used.
 318          * /var/run/wpa_supplicant is the recommended directory for sockets and
 319          * by default, wpa_cli will use it when trying to connect with
 320          * %wpa_supplicant.
 321          *
 322          * Access control for the control interface can be configured
 323          * by setting the directory to allow only members of a group
 324          * to use sockets. This way, it is possible to run
 325          * %wpa_supplicant as root (since it needs to change network
 326          * configuration and open raw sockets) and still allow GUI/CLI
 327          * components to be run as non-root users. However, since the
 328          * control interface can be used to change the network
 329          * configuration, this access needs to be protected in many
 330          * cases. By default, %wpa_supplicant is configured to use gid
 331          * 0 (root). If you want to allow non-root users to use the
 332          * control interface, add a new group and change this value to
 333          * match with that group. Add users that should have control
 334          * interface access to this group.
 335          *
 336          * When configuring both the directory and group, use following format:
 337          * DIR=/var/run/wpa_supplicant GROUP=wheel
 338          * DIR=/var/run/wpa_supplicant GROUP=0
 339          * (group can be either group name or gid)
 340          *
 341          * For UDP connections (default on Windows): The value will be ignored.
 342          * This variable is just used to select that the control interface is
 343          * to be created. The value can be set to, e.g., udp
 344          * (ctrl_interface=udp).
 345          *
 346          * For Windows Named Pipe: This value can be used to set the security
 347          * descriptor for controlling access to the control interface. Security
 348          * descriptor can be set using Security Descriptor String Format (see
 349          * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
 350          * The descriptor string needs to be prefixed with SDDL=. For example,
 351          * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
 352          * all connections).
 353          */
 354         char *ctrl_interface;
 355
 356         /**
 357          * ctrl_interface_group - Control interface group (DEPRECATED)
 358          *
 359          * This variable is only used for backwards compatibility. Group for
 360          * UNIX domain sockets should now be specified using GROUP=group in
 361          * ctrl_interface variable.
 362          */
 363         char *ctrl_interface_group;
 364
 365         /**
 366          * fast_reauth - EAP fast re-authentication (session resumption)
 367          *
 368          * By default, fast re-authentication is enabled for all EAP methods
 369          * that support it. This variable can be used to disable fast
 370          * re-authentication (by setting fast_reauth=0). Normally, there is no
 371          * need to disable fast re-authentication.
 372          */
 373         int fast_reauth;
 374
 375         /**
 376          * opensc_engine_path - Path to the OpenSSL engine for opensc
 377          *
 378          * This is an OpenSSL specific configuration option for loading OpenSC
 379          * engine (engine_opensc.so); if %NULL, this engine is not loaded.
 380          */
 381         char *opensc_engine_path;
 382
 383         /**
 384          * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
 385          *
 386          * This is an OpenSSL specific configuration option for loading PKCS#11
 387          * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
 388          */
 389         char *pkcs11_engine_path;
 390
 391         /**
 392          * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
 393          *
 394          * This is an OpenSSL specific configuration option for configuring
 395          * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
 396          * module is not loaded.
 397          */
 398         char *pkcs11_module_path;
 399
 400         /**
 401          * pcsc_reader - PC/SC reader name prefix
 402          *
 403          * If not %NULL, PC/SC reader with a name that matches this prefix is
 404          * initialized for SIM/USIM access. Empty string can be used to match
 405          * the first available reader.
 406          */
 407         char *pcsc_reader;
 408
 409         /**
 410          * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
 411          *
 412          * This field is used to configure PIN for SIM/USIM for EAP-SIM and
 413          * EAP-AKA. If left out, this will be asked through control interface.
 414          */
 415         char *pcsc_pin;
 416
 417         /**
 418          * driver_param - Driver interface parameters
 419          *
 420          * This text string is passed to the selected driver interface with the
 421          * optional struct wpa_driver_ops::set_param() handler. This can be
 422          * used to configure driver specific options without having to add new
 423          * driver interface functionality.
 424          */
 425         char *driver_param;
 426
 427         /**
 428          * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
 429          *
 430          * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
 431          * cache (unit: seconds).
 432          */
 433         unsigned int dot11RSNAConfigPMKLifetime;
 434
 435         /**
 436          * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
 437          *
 438          * dot11 MIB variable for the percentage of the PMK lifetime
 439          * that should expire before an IEEE 802.1X reauthentication occurs.
 440          */
 441         unsigned int dot11RSNAConfigPMKReauthThreshold;
 442
 443         /**
 444          * dot11RSNAConfigSATimeout - Security association timeout
 445          *
 446          * dot11 MIB variable for the maximum time a security association
 447          * shall take to set up (unit: seconds).
 448          */
 449         unsigned int dot11RSNAConfigSATimeout;
 450
 451         /**
 452          * update_config - Is wpa_supplicant allowed to update configuration
 453          *
 454          * This variable control whether wpa_supplicant is allow to re-write
 455          * its configuration with wpa_config_write(). If this is zero,
 456          * configuration data is only changed in memory and the external data
 457          * is not overriden. If this is non-zero, wpa_supplicant will update
 458          * the configuration data (e.g., a file) whenever configuration is
 459          * changed. This update may replace the old configuration which can
 460          * remove comments from it in case of a text file configuration.
 461          */
 462         int update_config;
 463
 464         /**
 465          * blobs - Configuration blobs
 466          */
 467         struct wpa_config_blob *blobs;
 468
 469         /**
 470          * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
 471          */
 472         u8 uuid[16];
 473
 474         /**
 475          * device_name - Device Name (WPS)
 476          * User-friendly description of device; up to 32 octets encoded in
 477          * UTF-8
 478          */
 479         char *device_name;
 480
 481         /**
 482          * manufacturer - Manufacturer (WPS)
 483          * The manufacturer of the device (up to 64 ASCII characters)
 484          */
 485         char *manufacturer;
 486
 487         /**
 488          * model_name - Model Name (WPS)
 489          * Model of the device (up to 32 ASCII characters)
 490          */
 491         char *model_name;
 492
 493         /**
 494          * model_number - Model Number (WPS)
 495          * Additional device description (up to 32 ASCII characters)
 496          */
 497         char *model_number;
 498
 499         /**
 500          * serial_number - Serial Number (WPS)
 501          * Serial number of the device (up to 32 characters)
 502          */
 503         char *serial_number;
 504
 505         /**
 506          * device_type - Primary Device Type (WPS)
 507          */
 508         u8 device_type[WPS_DEV_TYPE_LEN];
 509
 510         /**
 511          * config_methods - Config Methods
 512          *
 513          * This is a space-separated list of supported WPS configuration
 514          * methods. For example, "label virtual_display virtual_push_button
 515          * keypad".
 516          * Available methods: usba ethernet label display ext_nfc_token
 517          * int_nfc_token nfc_interface push_button keypad
 518          * virtual_display physical_display
 519          * virtual_push_button physical_push_button.
 520          */
 521         char *config_methods;
 522
 523         /**
 524          * os_version - OS Version (WPS)
 525          * 4-octet operating system version number
 526          */
 527         u8 os_version[4];
 528
 529         /**
 530          * country - Country code
 531          *
 532          * This is the ISO/IEC alpha2 country code for which we are operating
 533          * in
 534          */
 535         char country[2];
 536
 537         /**
 538          * wps_cred_processing - Credential processing
 539          *
 540          *   0 = process received credentials internally
 541          *   1 = do not process received credentials; just pass them over
 542          *      ctrl_iface to external program(s)
 543          *   2 = process received credentials internally and pass them over
 544          *      ctrl_iface to external program(s)
 545          */
 546         int wps_cred_processing;
 547
 548 #define MAX_SEC_DEVICE_TYPES 5
 549         /**
 550          * sec_device_types - Secondary Device Types (P2P)
 551          */
 552         u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
 553         int num_sec_device_types;
 554
 555         int p2p_listen_reg_class;
 556         int p2p_listen_channel;
 557         int p2p_oper_reg_class;
 558         int p2p_oper_channel;
 559         int p2p_go_intent;
 560         char *p2p_ssid_postfix;
 561         int persistent_reconnect;
 562         int p2p_intra_bss;
 563         unsigned int num_p2p_pref_chan;
 564         struct p2p_channel *p2p_pref_chan;
 565
 566         struct wpabuf *wps_vendor_ext_m1;
 567
 568 #define MAX_WPS_VENDOR_EXT 10
 569         /**
 570          * wps_vendor_ext - Vendor extension attributes in WPS
 571          */
 572         struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
 573
 574         /**
 575          * p2p_group_idle - Maximum idle time in seconds for P2P group
 576          *
 577          * This value controls how long a P2P group is maintained after there
 578          * is no other members in the group. As a GO, this means no associated
 579          * stations in the group. As a P2P client, this means no GO seen in
 580          * scan results. The maximum idle time is specified in seconds with 0
 581          * indicating no time limit, i.e., the P2P group remains in active
 582          * state indefinitely until explicitly removed. As a P2P client, the
 583          * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
 584          * this parameter is mainly meant for GO use and for P2P client, it can
 585          * only be used to reduce the default timeout to smaller value. A
 586          * special value -1 can be used to configure immediate removal of the
 587          * group for P2P client role on any disconnection after the data
 588          * connection has been established.
 589          */
 590         int p2p_group_idle;
 591
 592         /**
 593          * bss_max_count - Maximum number of BSS entries to keep in memory
 594          */
 595         unsigned int bss_max_count;
 596
 597         /**
 598          * bss_expiration_age - BSS entry age after which it can be expired
 599          *
 600          * This value controls the time in seconds after which a BSS entry
 601          * gets removed if it has not been updated or is not in use.
 602          */
 603         unsigned int bss_expiration_age;
 604
 605         /**
 606          * bss_expiration_scan_count - Expire BSS after number of scans
 607          *
 608          * If the BSS entry has not been seen in this many scans, it will be
 609          * removed. A value of 1 means that entry is removed after the first
 610          * scan in which the BSSID is not seen. Larger values can be used
 611          * to avoid BSS entries disappearing if they are not visible in
 612          * every scan (e.g., low signal quality or interference).
 613          */
 614         unsigned int bss_expiration_scan_count;
 615
 616         /**
 617          * filter_ssids - SSID-based scan result filtering
 618          *
 619          *   0 = do not filter scan results
 620          *   1 = only include configured SSIDs in scan results/BSS table
 621          */
 622         int filter_ssids;
 623
 624         /**
 625          * filter_rssi - RSSI-based scan result filtering
 626          *
 627          * 0 = do not filter scan results
 628          * -n = filter scan results below -n dBm
 629          */
 630         int filter_rssi;
 631
 632         /**
 633          * max_num_sta - Maximum number of STAs in an AP/P2P GO
 634          */
 635         unsigned int max_num_sta;
 636
 637         /**
 638          * changed_parameters - Bitmap of changed parameters since last update
 639          */
 640         unsigned int changed_parameters;
 641
 642         /**
 643          * disassoc_low_ack - Disassocicate stations with massive packet loss
 644          */
 645         int disassoc_low_ack;
 646
 647         /**
 648          * interworking - Whether Interworking (IEEE 802.11u) is enabled
 649          */
 650         int interworking;
 651
 652         /**
 653          * access_network_type - Access Network Type
 654          *
 655          * When Interworking is enabled, scans will be limited to APs that
 656          * advertise the specified Access Network Type (0..15; with 15
 657          * indicating wildcard match).
 658          */
 659         int access_network_type;
 660
 661         /**
 662          * hessid - Homogenous ESS identifier
 663          *
 664          * If this is set (any octet is non-zero), scans will be used to
 665          * request response only from BSSes belonging to the specified
 666          * Homogeneous ESS. This is used only if interworking is enabled.
 667          */
 668         u8 hessid[ETH_ALEN];
 669
 670         /**
 671          * hs20 - Hotspot 2.0
 672          */
 673         int hs20;
 674
 675         /**
 676          * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
 677          *
 678          * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
 679          * by acting as a Registrar and using M1 from the AP. The config
 680          * methods attribute in that message is supposed to indicate only the
 681          * configuration method supported by the AP in Enrollee role, i.e., to
 682          * add an external Registrar. For that case, PBC shall not be used and
 683          * as such, the PushButton config method is removed from M1 by default.
 684          * If pbc_in_m1=1 is included in the configuration file, the PushButton
 685          * config method is left in M1 (if included in config_methods
 686          * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
 687          * a label in the AP).
 688          */
 689         int pbc_in_m1;
 690
 691         /**
 692          * autoscan - Automatic scan parameters or %NULL if none
 693          *
 694          * This is an optional set of parameters for automatic scanning
 695          * within an interface in following format:
 696          * <autoscan module name>:<module parameters>
 697          */
 698         char *autoscan;
 699
 700         /**
 701          * wps_nfc_dev_pw_id - NFC Device Password ID for password token
 702          */
 703         int wps_nfc_dev_pw_id;
 704
 705         /**
 706          * wps_nfc_dh_pubkey - NFC DH Public Key for password token
 707          */
 708         struct wpabuf *wps_nfc_dh_pubkey;
 709
 710         /**
 711          * wps_nfc_dh_pubkey - NFC DH Private Key for password token
 712          */
 713         struct wpabuf *wps_nfc_dh_privkey;
 714
 715         /**
 716          * wps_nfc_dh_pubkey - NFC Device Password for password token
 717          */
 718         struct wpabuf *wps_nfc_dev_pw;
 719
 720         /**
 721          * ext_password_backend - External password backend or %NULL if none
 722          *
 723          * format: <backend name>[:<optional backend parameters>]
 724          */
 725         char *ext_password_backend;
 726 };
 727
 728
 729 /* Prototypes for common functions from config.c */
 730
 731 void wpa_config_free(struct wpa_config *ssid);
 732 void wpa_config_free_ssid(struct wpa_ssid *ssid);
 733 void wpa_config_foreach_network(struct wpa_config *config,
 734                                 void (*func)(void *, struct wpa_ssid *),
 735                                 void *arg);
 736 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
 737 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
 738 int wpa_config_remove_network(struct wpa_config *config, int id);
 739 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
 740 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
 741                    int line);
 742 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
 743                           const char *value);
 744 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
 745 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
 746 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
 747 void wpa_config_update_psk(struct wpa_ssid *ssid);
 748 int wpa_config_add_prio_network(struct wpa_config *config,
 749                                 struct wpa_ssid *ssid);
 750 int wpa_config_update_prio_list(struct wpa_config *config);
 751 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
 752                                                    const char *name);
 753 void wpa_config_set_blob(struct wpa_config *config,
 754                          struct wpa_config_blob *blob);
 755 void wpa_config_free_blob(struct wpa_config_blob *blob);
 756 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
 757
 758 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
 759 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
 760 int wpa_config_remove_cred(struct wpa_config *config, int id);
 761 void wpa_config_free_cred(struct wpa_cred *cred);
 762 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
 763                         const char *value, int line);
 764
 765 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
 766                                            const char *driver_param);
 767 #ifndef CONFIG_NO_STDOUT_DEBUG
 768 void wpa_config_debug_dump_networks(struct wpa_config *config);
 769 #else /* CONFIG_NO_STDOUT_DEBUG */
 770 #define wpa_config_debug_dump_networks(c) do { } while (0)
 771 #endif /* CONFIG_NO_STDOUT_DEBUG */
 772
 773
 774 /* Prototypes for common functions from config.c */
 775 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
 776
 777
 778 /* Prototypes for backend specific functions from the selected config_*.c */
 779
 780 /**
 781  * wpa_config_read - Read and parse configuration database
 782  * @name: Name of the configuration (e.g., path and file name for the
 783  * configuration file)
 784  * Returns: Pointer to allocated configuration data or %NULL on failure
 785  *
 786  * This function reads configuration data, parses its contents, and allocates
 787  * data structures needed for storing configuration information. The allocated
 788  * data can be freed with wpa_config_free().
 789  *
 790  * Each configuration backend needs to implement this function.
 791  */
 792 struct wpa_config * wpa_config_read(const char *name);
 793
 794 /**
 795  * wpa_config_write - Write or update configuration data
 796  * @name: Name of the configuration (e.g., path and file name for the
 797  * configuration file)
 798  * @config: Configuration data from wpa_config_read()
 799  * Returns: 0 on success, -1 on failure
 800  *
 801  * This function write all configuration data into an external database (e.g.,
 802  * a text file) in a format that can be read with wpa_config_read(). This can
 803  * be used to allow wpa_supplicant to update its configuration, e.g., when a
 804  * new network is added or a password is changed.
 805  *
 806  * Each configuration backend needs to implement this function.
 807  */
 808 int wpa_config_write(const char *name, struct wpa_config *config);
 809
 810 #endif /* CONFIG_H */