config.h 30 KB

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