config.h 35 KB

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