config.h 37 KB

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