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