config.h 35 KB

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