config.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475
  1. /*
  2. * WPA Supplicant / Configuration file structures
  3. * Copyright (c) 2003-2005, Jouni Malinen <j@w1.fi>
  4. *
  5. * This program is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License version 2 as
  7. * published by the Free Software Foundation.
  8. *
  9. * Alternatively, this software may be distributed under the terms of BSD
  10. * license.
  11. *
  12. * See README and COPYING for more details.
  13. */
  14. #ifndef CONFIG_H
  15. #define CONFIG_H
  16. #define DEFAULT_EAPOL_VERSION 1
  17. #ifdef CONFIG_NO_SCAN_PROCESSING
  18. #define DEFAULT_AP_SCAN 2
  19. #else /* CONFIG_NO_SCAN_PROCESSING */
  20. #define DEFAULT_AP_SCAN 1
  21. #endif /* CONFIG_NO_SCAN_PROCESSING */
  22. #define DEFAULT_FAST_REAUTH 1
  23. #define DEFAULT_P2P_GO_INTENT 7
  24. #define DEFAULT_P2P_INTRA_BSS 1
  25. #define DEFAULT_BSS_MAX_COUNT 200
  26. #define DEFAULT_MAX_NUM_STA 128
  27. #include "config_ssid.h"
  28. #define CFG_CHANGED_DEVICE_NAME BIT(0)
  29. #define CFG_CHANGED_CONFIG_METHODS BIT(1)
  30. #define CFG_CHANGED_DEVICE_TYPE BIT(2)
  31. #define CFG_CHANGED_OS_VERSION BIT(3)
  32. #define CFG_CHANGED_UUID BIT(4)
  33. #define CFG_CHANGED_COUNTRY BIT(5)
  34. #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
  35. #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
  36. #define CFG_CHANGED_WPS_STRING BIT(8)
  37. #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
  38. /**
  39. * struct wpa_config - wpa_supplicant configuration data
  40. *
  41. * This data structure is presents the per-interface (radio) configuration
  42. * data. In many cases, there is only one struct wpa_config instance, but if
  43. * more than one network interface is being controlled, one instance is used
  44. * for each.
  45. */
  46. struct wpa_config {
  47. /**
  48. * ssid - Head of the global network list
  49. *
  50. * This is the head for the list of all the configured networks.
  51. */
  52. struct wpa_ssid *ssid;
  53. /**
  54. * pssid - Per-priority network lists (in priority order)
  55. */
  56. struct wpa_ssid **pssid;
  57. /**
  58. * num_prio - Number of different priorities used in the pssid lists
  59. *
  60. * This indicates how many per-priority network lists are included in
  61. * pssid.
  62. */
  63. int num_prio;
  64. /**
  65. * eapol_version - IEEE 802.1X/EAPOL version number
  66. *
  67. * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
  68. * defines EAPOL version 2. However, there are many APs that do not
  69. * handle the new version number correctly (they seem to drop the
  70. * frames completely). In order to make wpa_supplicant interoperate
  71. * with these APs, the version number is set to 1 by default. This
  72. * configuration value can be used to set it to the new version (2).
  73. */
  74. int eapol_version;
  75. /**
  76. * ap_scan - AP scanning/selection
  77. *
  78. * By default, wpa_supplicant requests driver to perform AP
  79. * scanning and then uses the scan results to select a
  80. * suitable AP. Another alternative is to allow the driver to
  81. * take care of AP scanning and selection and use
  82. * wpa_supplicant just to process EAPOL frames based on IEEE
  83. * 802.11 association information from the driver.
  84. *
  85. * 1: wpa_supplicant initiates scanning and AP selection (default).
  86. *
  87. * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
  88. * association parameters (e.g., WPA IE generation); this mode can
  89. * also be used with non-WPA drivers when using IEEE 802.1X mode;
  90. * do not try to associate with APs (i.e., external program needs
  91. * to control association). This mode must also be used when using
  92. * wired Ethernet drivers.
  93. *
  94. * 2: like 0, but associate with APs using security policy and SSID
  95. * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
  96. * drivers to enable operation with hidden SSIDs and optimized roaming;
  97. * in this mode, the network blocks in the configuration are tried
  98. * one by one until the driver reports successful association; each
  99. * network block should have explicit security policy (i.e., only one
  100. * option in the lists) for key_mgmt, pairwise, group, proto variables.
  101. */
  102. int ap_scan;
  103. /**
  104. * ctrl_interface - Parameters for the control interface
  105. *
  106. * If this is specified, %wpa_supplicant will open a control interface
  107. * that is available for external programs to manage %wpa_supplicant.
  108. * The meaning of this string depends on which control interface
  109. * mechanism is used. For all cases, the existance of this parameter
  110. * in configuration is used to determine whether the control interface
  111. * is enabled.
  112. *
  113. * For UNIX domain sockets (default on Linux and BSD): This is a
  114. * directory that will be created for UNIX domain sockets for listening
  115. * to requests from external programs (CLI/GUI, etc.) for status
  116. * information and configuration. The socket file will be named based
  117. * on the interface name, so multiple %wpa_supplicant processes can be
  118. * run at the same time if more than one interface is used.
  119. * /var/run/wpa_supplicant is the recommended directory for sockets and
  120. * by default, wpa_cli will use it when trying to connect with
  121. * %wpa_supplicant.
  122. *
  123. * Access control for the control interface can be configured
  124. * by setting the directory to allow only members of a group
  125. * to use sockets. This way, it is possible to run
  126. * %wpa_supplicant as root (since it needs to change network
  127. * configuration and open raw sockets) and still allow GUI/CLI
  128. * components to be run as non-root users. However, since the
  129. * control interface can be used to change the network
  130. * configuration, this access needs to be protected in many
  131. * cases. By default, %wpa_supplicant is configured to use gid
  132. * 0 (root). If you want to allow non-root users to use the
  133. * control interface, add a new group and change this value to
  134. * match with that group. Add users that should have control
  135. * interface access to this group.
  136. *
  137. * When configuring both the directory and group, use following format:
  138. * DIR=/var/run/wpa_supplicant GROUP=wheel
  139. * DIR=/var/run/wpa_supplicant GROUP=0
  140. * (group can be either group name or gid)
  141. *
  142. * For UDP connections (default on Windows): The value will be ignored.
  143. * This variable is just used to select that the control interface is
  144. * to be created. The value can be set to, e.g., udp
  145. * (ctrl_interface=udp).
  146. *
  147. * For Windows Named Pipe: This value can be used to set the security
  148. * descriptor for controlling access to the control interface. Security
  149. * descriptor can be set using Security Descriptor String Format (see
  150. * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
  151. * The descriptor string needs to be prefixed with SDDL=. For example,
  152. * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
  153. * all connections).
  154. */
  155. char *ctrl_interface;
  156. /**
  157. * ctrl_interface_group - Control interface group (DEPRECATED)
  158. *
  159. * This variable is only used for backwards compatibility. Group for
  160. * UNIX domain sockets should now be specified using GROUP=group in
  161. * ctrl_interface variable.
  162. */
  163. char *ctrl_interface_group;
  164. /**
  165. * fast_reauth - EAP fast re-authentication (session resumption)
  166. *
  167. * By default, fast re-authentication is enabled for all EAP methods
  168. * that support it. This variable can be used to disable fast
  169. * re-authentication (by setting fast_reauth=0). Normally, there is no
  170. * need to disable fast re-authentication.
  171. */
  172. int fast_reauth;
  173. /**
  174. * opensc_engine_path - Path to the OpenSSL engine for opensc
  175. *
  176. * This is an OpenSSL specific configuration option for loading OpenSC
  177. * engine (engine_opensc.so); if %NULL, this engine is not loaded.
  178. */
  179. char *opensc_engine_path;
  180. /**
  181. * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
  182. *
  183. * This is an OpenSSL specific configuration option for loading PKCS#11
  184. * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
  185. */
  186. char *pkcs11_engine_path;
  187. /**
  188. * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
  189. *
  190. * This is an OpenSSL specific configuration option for configuring
  191. * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
  192. * module is not loaded.
  193. */
  194. char *pkcs11_module_path;
  195. /**
  196. * driver_param - Driver interface parameters
  197. *
  198. * This text string is passed to the selected driver interface with the
  199. * optional struct wpa_driver_ops::set_param() handler. This can be
  200. * used to configure driver specific options without having to add new
  201. * driver interface functionality.
  202. */
  203. char *driver_param;
  204. /**
  205. * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
  206. *
  207. * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
  208. * cache (unit: seconds).
  209. */
  210. unsigned int dot11RSNAConfigPMKLifetime;
  211. /**
  212. * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
  213. *
  214. * dot11 MIB variable for the percentage of the PMK lifetime
  215. * that should expire before an IEEE 802.1X reauthentication occurs.
  216. */
  217. unsigned int dot11RSNAConfigPMKReauthThreshold;
  218. /**
  219. * dot11RSNAConfigSATimeout - Security association timeout
  220. *
  221. * dot11 MIB variable for the maximum time a security association
  222. * shall take to set up (unit: seconds).
  223. */
  224. unsigned int dot11RSNAConfigSATimeout;
  225. /**
  226. * update_config - Is wpa_supplicant allowed to update configuration
  227. *
  228. * This variable control whether wpa_supplicant is allow to re-write
  229. * its configuration with wpa_config_write(). If this is zero,
  230. * configuration data is only changed in memory and the external data
  231. * is not overriden. If this is non-zero, wpa_supplicant will update
  232. * the configuration data (e.g., a file) whenever configuration is
  233. * changed. This update may replace the old configuration which can
  234. * remove comments from it in case of a text file configuration.
  235. */
  236. int update_config;
  237. /**
  238. * blobs - Configuration blobs
  239. */
  240. struct wpa_config_blob *blobs;
  241. /**
  242. * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
  243. */
  244. u8 uuid[16];
  245. /**
  246. * device_name - Device Name (WPS)
  247. * User-friendly description of device; up to 32 octets encoded in
  248. * UTF-8
  249. */
  250. char *device_name;
  251. /**
  252. * manufacturer - Manufacturer (WPS)
  253. * The manufacturer of the device (up to 64 ASCII characters)
  254. */
  255. char *manufacturer;
  256. /**
  257. * model_name - Model Name (WPS)
  258. * Model of the device (up to 32 ASCII characters)
  259. */
  260. char *model_name;
  261. /**
  262. * model_number - Model Number (WPS)
  263. * Additional device description (up to 32 ASCII characters)
  264. */
  265. char *model_number;
  266. /**
  267. * serial_number - Serial Number (WPS)
  268. * Serial number of the device (up to 32 characters)
  269. */
  270. char *serial_number;
  271. /**
  272. * device_type - Primary Device Type (WPS)
  273. * Used format: categ-OUI-subcateg
  274. * categ = Category as an integer value
  275. * OUI = OUI and type octet as a 4-octet hex-encoded value;
  276. * 0050F204 for default WPS OUI
  277. * subcateg = OUI-specific Sub Category as an integer value
  278. * Examples:
  279. * 1-0050F204-1 (Computer / PC)
  280. * 1-0050F204-2 (Computer / Server)
  281. * 5-0050F204-1 (Storage / NAS)
  282. * 6-0050F204-1 (Network Infrastructure / AP)
  283. */
  284. char *device_type;
  285. /**
  286. * config_methods - Config Methods
  287. *
  288. * This is a space-separated list of supported WPS configuration
  289. * methods. For example, "label virtual_display virtual_push_button
  290. * keypad".
  291. * Available methods: usba ethernet label display ext_nfc_token
  292. * int_nfc_token nfc_interface push_button keypad
  293. * virtual_display physical_display
  294. * virtual_push_button physical_push_button.
  295. */
  296. char *config_methods;
  297. /**
  298. * os_version - OS Version (WPS)
  299. * 4-octet operating system version number
  300. */
  301. u8 os_version[4];
  302. /**
  303. * country - Country code
  304. *
  305. * This is the ISO/IEC alpha2 country code for which we are operating
  306. * in
  307. */
  308. char country[2];
  309. /**
  310. * wps_cred_processing - Credential processing
  311. *
  312. * 0 = process received credentials internally
  313. * 1 = do not process received credentials; just pass them over
  314. * ctrl_iface to external program(s)
  315. * 2 = process received credentials internally and pass them over
  316. * ctrl_iface to external program(s)
  317. */
  318. int wps_cred_processing;
  319. #define MAX_SEC_DEVICE_TYPES 5
  320. /**
  321. * sec_device_type - Secondary Device Types (P2P)
  322. * See device_type for the format used with these.
  323. */
  324. char *sec_device_type[MAX_SEC_DEVICE_TYPES];
  325. int p2p_listen_reg_class;
  326. int p2p_listen_channel;
  327. int p2p_oper_reg_class;
  328. int p2p_oper_channel;
  329. int p2p_go_intent;
  330. char *p2p_ssid_postfix;
  331. int persistent_reconnect;
  332. int p2p_intra_bss;
  333. /**
  334. * p2p_group_idle - Maximum idle time in seconds for P2P group
  335. *
  336. * This value controls how long a P2P group is maintained after there
  337. * is no other members in the group. As a GO, this means no associated
  338. * stations in the group. As a P2P client, this means no GO seen in
  339. * scan results. The maximum idle time is specified in seconds with 0
  340. * indicating no time limit, i.e., the P2P group remains in active
  341. * state indefinitely until explicitly removed.
  342. */
  343. unsigned int p2p_group_idle;
  344. /**
  345. * bss_max_count - Maximum number of BSS entries to keep in memory
  346. */
  347. unsigned int bss_max_count;
  348. /**
  349. * filter_ssids - SSID-based scan result filtering
  350. *
  351. * 0 = do not filter scan results
  352. * 1 = only include configured SSIDs in scan results/BSS table
  353. */
  354. int filter_ssids;
  355. /**
  356. * max_num_sta - Maximum number of STAs in an AP/P2P GO
  357. */
  358. unsigned int max_num_sta;
  359. /**
  360. * changed_parameters - Bitmap of changed parameters since last update
  361. */
  362. unsigned int changed_parameters;
  363. };
  364. /* Prototypes for common functions from config.c */
  365. void wpa_config_free(struct wpa_config *ssid);
  366. void wpa_config_free_ssid(struct wpa_ssid *ssid);
  367. struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
  368. struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
  369. int wpa_config_remove_network(struct wpa_config *config, int id);
  370. void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
  371. int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
  372. int line);
  373. char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
  374. char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
  375. char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
  376. void wpa_config_update_psk(struct wpa_ssid *ssid);
  377. int wpa_config_add_prio_network(struct wpa_config *config,
  378. struct wpa_ssid *ssid);
  379. int wpa_config_update_prio_list(struct wpa_config *config);
  380. const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
  381. const char *name);
  382. void wpa_config_set_blob(struct wpa_config *config,
  383. struct wpa_config_blob *blob);
  384. void wpa_config_free_blob(struct wpa_config_blob *blob);
  385. int wpa_config_remove_blob(struct wpa_config *config, const char *name);
  386. struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
  387. const char *driver_param);
  388. #ifndef CONFIG_NO_STDOUT_DEBUG
  389. void wpa_config_debug_dump_networks(struct wpa_config *config);
  390. #else /* CONFIG_NO_STDOUT_DEBUG */
  391. #define wpa_config_debug_dump_networks(c) do { } while (0)
  392. #endif /* CONFIG_NO_STDOUT_DEBUG */
  393. /* Prototypes for common functions from config.c */
  394. int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
  395. /* Prototypes for backend specific functions from the selected config_*.c */
  396. /**
  397. * wpa_config_read - Read and parse configuration database
  398. * @name: Name of the configuration (e.g., path and file name for the
  399. * configuration file)
  400. * Returns: Pointer to allocated configuration data or %NULL on failure
  401. *
  402. * This function reads configuration data, parses its contents, and allocates
  403. * data structures needed for storing configuration information. The allocated
  404. * data can be freed with wpa_config_free().
  405. *
  406. * Each configuration backend needs to implement this function.
  407. */
  408. struct wpa_config * wpa_config_read(const char *name);
  409. /**
  410. * wpa_config_write - Write or update configuration data
  411. * @name: Name of the configuration (e.g., path and file name for the
  412. * configuration file)
  413. * @config: Configuration data from wpa_config_read()
  414. * Returns: 0 on success, -1 on failure
  415. *
  416. * This function write all configuration data into an external database (e.g.,
  417. * a text file) in a format that can be read with wpa_config_read(). This can
  418. * be used to allow wpa_supplicant to update its configuration, e.g., when a
  419. * new network is added or a password is changed.
  420. *
  421. * Each configuration backend needs to implement this function.
  422. */
  423. int wpa_config_write(const char *name, struct wpa_config *config);
  424. #endif /* CONFIG_H */