config.h 32 KB

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