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