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