wpa_supplicant/config.h

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