wpa_supplicant/config.h

   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
   9 #ifndef CONFIG_H
  10 #define CONFIG_H
  11
  12 #define DEFAULT_EAPOL_VERSION 1
  13 #ifdef CONFIG_NO_SCAN_PROCESSING
  14 #define DEFAULT_AP_SCAN 2
  15 #else /* CONFIG_NO_SCAN_PROCESSING */
  16 #define DEFAULT_AP_SCAN 1
  17 #endif /* CONFIG_NO_SCAN_PROCESSING */
  18 #define DEFAULT_FAST_REAUTH 1
  19 #define DEFAULT_P2P_GO_INTENT 7
  20 #define DEFAULT_P2P_INTRA_BSS 1
  21 #define DEFAULT_BSS_MAX_COUNT 200
  22 #define DEFAULT_BSS_EXPIRATION_AGE 180
  23 #define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
  24 #define DEFAULT_MAX_NUM_STA 128
  25 #define DEFAULT_ACCESS_NETWORK_TYPE 15
  26
  27 #include "config_ssid.h"
  28 #include "wps/wps.h"
  29
  30
  31 struct wpa_cred {
  32         /**
  33          * next - Next credential in the list
  34          *
  35          * This pointer can be used to iterate over all credentials. The head
  36          * of this list is stored in the cred field of struct wpa_config.
  37          */
  38         struct wpa_cred *next;
  39
  40         /**
  41          * id - Unique id for the credential
  42          *
  43          * This identifier is used as a unique identifier for each credential
  44          * block when using the control interface. Each credential is allocated
  45          * an id when it is being created, either when reading the
  46          * configuration file or when a new credential is added through the
  47          * control interface.
  48          */
  49         int id;
  50
  51         /**
  52          * priority - Priority group
  53          *
  54          * By default, all networks and credentials get the same priority group
  55          * (0). This field can be used to give higher priority for credentials
  56          * (and similarly in struct wpa_ssid for network blocks) to change the
  57          * Interworking automatic networking selection behavior. The matching
  58          * network (based on either an enabled network block or a credential)
  59          * with the highest priority value will be selected.
  60          */
  61         int priority;
  62
  63         /**
  64          * realm - Home Realm for Interworking
  65          */
  66         char *realm;
  67
  68         /**
  69          * username - Username for Interworking network selection
  70          */
  71         char *username;
  72
  73         /**
  74          * password - Password for Interworking network selection
  75          */
  76         char *password;
  77
  78         /**
  79          * ca_cert - CA certificate for Interworking network selection
  80          */
  81         char *ca_cert;
  82
  83         /**
  84          * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
  85          */
  86         char *imsi;
  87
  88         /**
  89          * milenage - Milenage parameters for SIM/USIM simulator in
  90          *      <Ki>:<OPc>:<SQN> format
  91          */
  92         char *milenage;
  93
  94         /**
  95          * domain - Home service provider FQDN
  96          *
  97          * This is used to compare against the Domain Name List to figure out
  98          * whether the AP is operated by the Home SP.
  99          */
 100         char *domain;
 101 };
 102
 103
 104 #define CFG_CHANGED_DEVICE_NAME BIT(0)
 105 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
 106 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
 107 #define CFG_CHANGED_OS_VERSION BIT(3)
 108 #define CFG_CHANGED_UUID BIT(4)
 109 #define CFG_CHANGED_COUNTRY BIT(5)
 110 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
 111 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
 112 #define CFG_CHANGED_WPS_STRING BIT(8)
 113 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
 114 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
 115 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
 116 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
 117
 118 /**
 119  * struct wpa_config - wpa_supplicant configuration data
 120  *
 121  * This data structure is presents the per-interface (radio) configuration
 122  * data. In many cases, there is only one struct wpa_config instance, but if
 123  * more than one network interface is being controlled, one instance is used
 124  * for each.
 125  */
 126 struct wpa_config {
 127         /**
 128          * ssid - Head of the global network list
 129          *
 130          * This is the head for the list of all the configured networks.
 131          */
 132         struct wpa_ssid *ssid;
 133
 134         /**
 135          * pssid - Per-priority network lists (in priority order)
 136          */
 137         struct wpa_ssid **pssid;
 138
 139         /**
 140          * num_prio - Number of different priorities used in the pssid lists
 141          *
 142          * This indicates how many per-priority network lists are included in
 143          * pssid.
 144          */
 145         int num_prio;
 146
 147         /**
 148          * cred - Head of the credential list
 149          *
 150          * This is the head for the list of all the configured credentials.
 151          */
 152         struct wpa_cred *cred;
 153
 154         /**
 155          * eapol_version - IEEE 802.1X/EAPOL version number
 156          *
 157          * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
 158          * defines EAPOL version 2. However, there are many APs that do not
 159          * handle the new version number correctly (they seem to drop the
 160          * frames completely). In order to make wpa_supplicant interoperate
 161          * with these APs, the version number is set to 1 by default. This
 162          * configuration value can be used to set it to the new version (2).
 163          */
 164         int eapol_version;
 165
 166         /**
 167          * ap_scan - AP scanning/selection
 168          *
 169          * By default, wpa_supplicant requests driver to perform AP
 170          * scanning and then uses the scan results to select a
 171          * suitable AP. Another alternative is to allow the driver to
 172          * take care of AP scanning and selection and use
 173          * wpa_supplicant just to process EAPOL frames based on IEEE
 174          * 802.11 association information from the driver.
 175          *
 176          * 1: wpa_supplicant initiates scanning and AP selection (default).
 177          *
 178          * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
 179          * association parameters (e.g., WPA IE generation); this mode can
 180          * also be used with non-WPA drivers when using IEEE 802.1X mode;
 181          * do not try to associate with APs (i.e., external program needs
 182          * to control association). This mode must also be used when using
 183          * wired Ethernet drivers.
 184          *
 185          * 2: like 0, but associate with APs using security policy and SSID
 186          * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
 187          * drivers to enable operation with hidden SSIDs and optimized roaming;
 188          * in this mode, the network blocks in the configuration are tried
 189          * one by one until the driver reports successful association; each
 190          * network block should have explicit security policy (i.e., only one
 191          * option in the lists) for key_mgmt, pairwise, group, proto variables.
 192          */
 193         int ap_scan;
 194
 195         /**
 196          * ctrl_interface - Parameters for the control interface
 197          *
 198          * If this is specified, %wpa_supplicant will open a control interface
 199          * that is available for external programs to manage %wpa_supplicant.
 200          * The meaning of this string depends on which control interface
 201          * mechanism is used. For all cases, the existence of this parameter
 202          * in configuration is used to determine whether the control interface
 203          * is enabled.
 204          *
 205          * For UNIX domain sockets (default on Linux and BSD): This is a
 206          * directory that will be created for UNIX domain sockets for listening
 207          * to requests from external programs (CLI/GUI, etc.) for status
 208          * information and configuration. The socket file will be named based
 209          * on the interface name, so multiple %wpa_supplicant processes can be
 210          * run at the same time if more than one interface is used.
 211          * /var/run/wpa_supplicant is the recommended directory for sockets and
 212          * by default, wpa_cli will use it when trying to connect with
 213          * %wpa_supplicant.
 214          *
 215          * Access control for the control interface can be configured
 216          * by setting the directory to allow only members of a group
 217          * to use sockets. This way, it is possible to run
 218          * %wpa_supplicant as root (since it needs to change network
 219          * configuration and open raw sockets) and still allow GUI/CLI
 220          * components to be run as non-root users. However, since the
 221          * control interface can be used to change the network
 222          * configuration, this access needs to be protected in many
 223          * cases. By default, %wpa_supplicant is configured to use gid
 224          * 0 (root). If you want to allow non-root users to use the
 225          * control interface, add a new group and change this value to
 226          * match with that group. Add users that should have control
 227          * interface access to this group.
 228          *
 229          * When configuring both the directory and group, use following format:
 230          * DIR=/var/run/wpa_supplicant GROUP=wheel
 231          * DIR=/var/run/wpa_supplicant GROUP=0
 232          * (group can be either group name or gid)
 233          *
 234          * For UDP connections (default on Windows): The value will be ignored.
 235          * This variable is just used to select that the control interface is
 236          * to be created. The value can be set to, e.g., udp
 237          * (ctrl_interface=udp).
 238          *
 239          * For Windows Named Pipe: This value can be used to set the security
 240          * descriptor for controlling access to the control interface. Security
 241          * descriptor can be set using Security Descriptor String Format (see
 242          * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
 243          * The descriptor string needs to be prefixed with SDDL=. For example,
 244          * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
 245          * all connections).
 246          */
 247         char *ctrl_interface;
 248
 249         /**
 250          * ctrl_interface_group - Control interface group (DEPRECATED)
 251          *
 252          * This variable is only used for backwards compatibility. Group for
 253          * UNIX domain sockets should now be specified using GROUP=group in
 254          * ctrl_interface variable.
 255          */
 256         char *ctrl_interface_group;
 257
 258         /**
 259          * fast_reauth - EAP fast re-authentication (session resumption)
 260          *
 261          * By default, fast re-authentication is enabled for all EAP methods
 262          * that support it. This variable can be used to disable fast
 263          * re-authentication (by setting fast_reauth=0). Normally, there is no
 264          * need to disable fast re-authentication.
 265          */
 266         int fast_reauth;
 267
 268         /**
 269          * opensc_engine_path - Path to the OpenSSL engine for opensc
 270          *
 271          * This is an OpenSSL specific configuration option for loading OpenSC
 272          * engine (engine_opensc.so); if %NULL, this engine is not loaded.
 273          */
 274         char *opensc_engine_path;
 275
 276         /**
 277          * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
 278          *
 279          * This is an OpenSSL specific configuration option for loading PKCS#11
 280          * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
 281          */
 282         char *pkcs11_engine_path;
 283
 284         /**
 285          * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
 286          *
 287          * This is an OpenSSL specific configuration option for configuring
 288          * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
 289          * module is not loaded.
 290          */
 291         char *pkcs11_module_path;
 292
 293         /**
 294          * pcsc_reader - PC/SC reader name prefix
 295          *
 296          * If not %NULL, PC/SC reader with a name that matches this prefix is
 297          * initialized for SIM/USIM access. Empty string can be used to match
 298          * the first available reader.
 299          */
 300         char *pcsc_reader;
 301
 302         /**
 303          * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
 304          *
 305          * This field is used to configure PIN for SIM/USIM for EAP-SIM and
 306          * EAP-AKA. If left out, this will be asked through control interface.
 307          */
 308         char *pcsc_pin;
 309
 310         /**
 311          * driver_param - Driver interface parameters
 312          *
 313          * This text string is passed to the selected driver interface with the
 314          * optional struct wpa_driver_ops::set_param() handler. This can be
 315          * used to configure driver specific options without having to add new
 316          * driver interface functionality.
 317          */
 318         char *driver_param;
 319
 320         /**
 321          * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
 322          *
 323          * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
 324          * cache (unit: seconds).
 325          */
 326         unsigned int dot11RSNAConfigPMKLifetime;
 327
 328         /**
 329          * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
 330          *
 331          * dot11 MIB variable for the percentage of the PMK lifetime
 332          * that should expire before an IEEE 802.1X reauthentication occurs.
 333          */
 334         unsigned int dot11RSNAConfigPMKReauthThreshold;
 335
 336         /**
 337          * dot11RSNAConfigSATimeout - Security association timeout
 338          *
 339          * dot11 MIB variable for the maximum time a security association
 340          * shall take to set up (unit: seconds).
 341          */
 342         unsigned int dot11RSNAConfigSATimeout;
 343
 344         /**
 345          * update_config - Is wpa_supplicant allowed to update configuration
 346          *
 347          * This variable control whether wpa_supplicant is allow to re-write
 348          * its configuration with wpa_config_write(). If this is zero,
 349          * configuration data is only changed in memory and the external data
 350          * is not overriden. If this is non-zero, wpa_supplicant will update
 351          * the configuration data (e.g., a file) whenever configuration is
 352          * changed. This update may replace the old configuration which can
 353          * remove comments from it in case of a text file configuration.
 354          */
 355         int update_config;
 356
 357         /**
 358          * blobs - Configuration blobs
 359          */
 360         struct wpa_config_blob *blobs;
 361
 362         /**
 363          * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
 364          */
 365         u8 uuid[16];
 366
 367         /**
 368          * device_name - Device Name (WPS)
 369          * User-friendly description of device; up to 32 octets encoded in
 370          * UTF-8
 371          */
 372         char *device_name;
 373
 374         /**
 375          * manufacturer - Manufacturer (WPS)
 376          * The manufacturer of the device (up to 64 ASCII characters)
 377          */
 378         char *manufacturer;
 379
 380         /**
 381          * model_name - Model Name (WPS)
 382          * Model of the device (up to 32 ASCII characters)
 383          */
 384         char *model_name;
 385
 386         /**
 387          * model_number - Model Number (WPS)
 388          * Additional device description (up to 32 ASCII characters)
 389          */
 390         char *model_number;
 391
 392         /**
 393          * serial_number - Serial Number (WPS)
 394          * Serial number of the device (up to 32 characters)
 395          */
 396         char *serial_number;
 397
 398         /**
 399          * device_type - Primary Device Type (WPS)
 400          */
 401         u8 device_type[WPS_DEV_TYPE_LEN];
 402
 403         /**
 404          * config_methods - Config Methods
 405          *
 406          * This is a space-separated list of supported WPS configuration
 407          * methods. For example, "label virtual_display virtual_push_button
 408          * keypad".
 409          * Available methods: usba ethernet label display ext_nfc_token
 410          * int_nfc_token nfc_interface push_button keypad
 411          * virtual_display physical_display
 412          * virtual_push_button physical_push_button.
 413          */
 414         char *config_methods;
 415
 416         /**
 417          * os_version - OS Version (WPS)
 418          * 4-octet operating system version number
 419          */
 420         u8 os_version[4];
 421
 422         /**
 423          * country - Country code
 424          *
 425          * This is the ISO/IEC alpha2 country code for which we are operating
 426          * in
 427          */
 428         char country[2];
 429
 430         /**
 431          * wps_cred_processing - Credential processing
 432          *
 433          *   0 = process received credentials internally
 434          *   1 = do not process received credentials; just pass them over
 435          *      ctrl_iface to external program(s)
 436          *   2 = process received credentials internally and pass them over
 437          *      ctrl_iface to external program(s)
 438          */
 439         int wps_cred_processing;
 440
 441 #define MAX_SEC_DEVICE_TYPES 5
 442         /**
 443          * sec_device_types - Secondary Device Types (P2P)
 444          */
 445         u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
 446         int num_sec_device_types;
 447
 448         int p2p_listen_reg_class;
 449         int p2p_listen_channel;
 450         int p2p_oper_reg_class;
 451         int p2p_oper_channel;
 452         int p2p_go_intent;
 453         char *p2p_ssid_postfix;
 454         int persistent_reconnect;
 455         int p2p_intra_bss;
 456
 457 #define MAX_WPS_VENDOR_EXT 10
 458         /**
 459          * wps_vendor_ext - Vendor extension attributes in WPS
 460          */
 461         struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
 462
 463         /**
 464          * p2p_group_idle - Maximum idle time in seconds for P2P group
 465          *
 466          * This value controls how long a P2P group is maintained after there
 467          * is no other members in the group. As a GO, this means no associated
 468          * stations in the group. As a P2P client, this means no GO seen in
 469          * scan results. The maximum idle time is specified in seconds with 0
 470          * indicating no time limit, i.e., the P2P group remains in active
 471          * state indefinitely until explicitly removed. As a P2P client, the
 472          * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
 473          * this parameter is mainly meant for GO use and for P2P client, it can
 474          * only be used to reduce the default timeout to smaller value.
 475          */
 476         unsigned int p2p_group_idle;
 477
 478         /**
 479          * bss_max_count - Maximum number of BSS entries to keep in memory
 480          */
 481         unsigned int bss_max_count;
 482
 483         /**
 484          * bss_expiration_age - BSS entry age after which it can be expired
 485          *
 486          * This value controls the time in seconds after which a BSS entry
 487          * gets removed if it has not been updated or is not in use.
 488          */
 489         unsigned int bss_expiration_age;
 490
 491         /**
 492          * bss_expiration_scan_count - Expire BSS after number of scans
 493          *
 494          * If the BSS entry has not been seen in this many scans, it will be
 495          * removed. A value of 1 means that entry is removed after the first
 496          * scan in which the BSSID is not seen. Larger values can be used
 497          * to avoid BSS entries disappearing if they are not visible in
 498          * every scan (e.g., low signal quality or interference).
 499          */
 500         unsigned int bss_expiration_scan_count;
 501
 502         /**
 503          * filter_ssids - SSID-based scan result filtering
 504          *
 505          *   0 = do not filter scan results
 506          *   1 = only include configured SSIDs in scan results/BSS table
 507          */
 508         int filter_ssids;
 509
 510         /**
 511          * max_num_sta - Maximum number of STAs in an AP/P2P GO
 512          */
 513         unsigned int max_num_sta;
 514
 515         /**
 516          * changed_parameters - Bitmap of changed parameters since last update
 517          */
 518         unsigned int changed_parameters;
 519
 520         /**
 521          * disassoc_low_ack - Disassocicate stations with massive packet loss
 522          */
 523         int disassoc_low_ack;
 524
 525         /**
 526          * interworking - Whether Interworking (IEEE 802.11u) is enabled
 527          */
 528         int interworking;
 529
 530         /**
 531          * access_network_type - Access Network Type
 532          *
 533          * When Interworking is enabled, scans will be limited to APs that
 534          * advertise the specified Access Network Type (0..15; with 15
 535          * indicating wildcard match).
 536          */
 537         int access_network_type;
 538
 539         /**
 540          * hessid - Homogenous ESS identifier
 541          *
 542          * If this is set (any octet is non-zero), scans will be used to
 543          * request response only from BSSes belonging to the specified
 544          * Homogeneous ESS. This is used only if interworking is enabled.
 545          */
 546         u8 hessid[ETH_ALEN];
 547 };
 548
 549
 550 /* Prototypes for common functions from config.c */
 551
 552 void wpa_config_free(struct wpa_config *ssid);
 553 void wpa_config_free_ssid(struct wpa_ssid *ssid);
 554 void wpa_config_foreach_network(struct wpa_config *config,
 555                                 void (*func)(void *, struct wpa_ssid *),
 556                                 void *arg);
 557 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
 558 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
 559 int wpa_config_remove_network(struct wpa_config *config, int id);
 560 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
 561 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
 562                    int line);
 563 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
 564                           const char *value);
 565 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
 566 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
 567 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
 568 void wpa_config_update_psk(struct wpa_ssid *ssid);
 569 int wpa_config_add_prio_network(struct wpa_config *config,
 570                                 struct wpa_ssid *ssid);
 571 int wpa_config_update_prio_list(struct wpa_config *config);
 572 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
 573                                                    const char *name);
 574 void wpa_config_set_blob(struct wpa_config *config,
 575                          struct wpa_config_blob *blob);
 576 void wpa_config_free_blob(struct wpa_config_blob *blob);
 577 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
 578
 579 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
 580 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
 581 int wpa_config_remove_cred(struct wpa_config *config, int id);
 582 void wpa_config_free_cred(struct wpa_cred *cred);
 583 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
 584                         const char *value, int line);
 585
 586 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
 587                                            const char *driver_param);
 588 #ifndef CONFIG_NO_STDOUT_DEBUG
 589 void wpa_config_debug_dump_networks(struct wpa_config *config);
 590 #else /* CONFIG_NO_STDOUT_DEBUG */
 591 #define wpa_config_debug_dump_networks(c) do { } while (0)
 592 #endif /* CONFIG_NO_STDOUT_DEBUG */
 593
 594
 595 /* Prototypes for common functions from config.c */
 596 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
 597
 598
 599 /* Prototypes for backend specific functions from the selected config_*.c */
 600
 601 /**
 602  * wpa_config_read - Read and parse configuration database
 603  * @name: Name of the configuration (e.g., path and file name for the
 604  * configuration file)
 605  * Returns: Pointer to allocated configuration data or %NULL on failure
 606  *
 607  * This function reads configuration data, parses its contents, and allocates
 608  * data structures needed for storing configuration information. The allocated
 609  * data can be freed with wpa_config_free().
 610  *
 611  * Each configuration backend needs to implement this function.
 612  */
 613 struct wpa_config * wpa_config_read(const char *name);
 614
 615 /**
 616  * wpa_config_write - Write or update configuration data
 617  * @name: Name of the configuration (e.g., path and file name for the
 618  * configuration file)
 619  * @config: Configuration data from wpa_config_read()
 620  * Returns: 0 on success, -1 on failure
 621  *
 622  * This function write all configuration data into an external database (e.g.,
 623  * a text file) in a format that can be read with wpa_config_read(). This can
 624  * be used to allow wpa_supplicant to update its configuration, e.g., when a
 625  * new network is added or a password is changed.
 626  *
 627  * Each configuration backend needs to implement this function.
 628  */
 629 int wpa_config_write(const char *name, struct wpa_config *config);
 630
 631 #endif /* CONFIG_H */