config.h 39 KB

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