Interworking: Add GET_CRED ctrl_iface command
[mech_eap.git] / wpa_supplicant / config.h
index 0dcb4c8..a398049 100644 (file)
 #define DEFAULT_FAST_REAUTH 1
 #define DEFAULT_P2P_GO_INTENT 7
 #define DEFAULT_P2P_INTRA_BSS 1
+#define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60)
 #define DEFAULT_BSS_MAX_COUNT 200
 #define DEFAULT_BSS_EXPIRATION_AGE 180
 #define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
 #define DEFAULT_MAX_NUM_STA 128
 #define DEFAULT_ACCESS_NETWORK_TYPE 15
+#define DEFAULT_SCAN_CUR_FREQ 0
 
 #include "config_ssid.h"
 #include "wps/wps.h"
+#include "common/ieee802_11_common.h"
 
 
 struct wpa_cred {
@@ -49,6 +52,11 @@ struct wpa_cred {
        int id;
 
        /**
+        * temporary - Whether this credential is temporary and not to be saved
+        */
+       int temporary;
+
+       /**
         * priority - Priority group
         *
         * By default, all networks and credentials get the same priority group
@@ -61,6 +69,11 @@ struct wpa_cred {
        int priority;
 
        /**
+        * pcsc - Use PC/SC and SIM/USIM card
+        */
+       int pcsc;
+
+       /**
         * realm - Home Realm for Interworking
         */
        char *realm;
@@ -76,6 +89,11 @@ struct wpa_cred {
        char *password;
 
        /**
+        * ext_password - Whether password is a name for external storage
+        */
+       int ext_password;
+
+       /**
         * ca_cert - CA certificate for Interworking network selection
         */
        char *ca_cert;
@@ -137,12 +155,139 @@ struct wpa_cred {
        char *milenage;
 
        /**
-        * domain - Home service provider FQDN
+        * domain_suffix_match - Constraint for server domain name
+        *
+        * If set, this FQDN is used as a suffix match requirement for the AAA
+        * server certificate in SubjectAltName dNSName element(s). If a
+        * matching dNSName is found, this constraint is met. If no dNSName
+        * values are present, this constraint is matched against SubjetName CN
+        * using same suffix match comparison. Suffix match here means that the
+        * host/domain name is compared one label at a time starting from the
+        * top-level domain and all the labels in @domain_suffix_match shall be
+        * included in the certificate. The certificate may include additional
+        * sub-level labels in addition to the required labels.
+        *
+        * For example, domain_suffix_match=example.com would match
+        * test.example.com but would not match test-example.com.
+        */
+       char *domain_suffix_match;
+
+       /**
+        * domain - Home service provider FQDN(s)
         *
         * This is used to compare against the Domain Name List to figure out
-        * whether the AP is operated by the Home SP.
+        * whether the AP is operated by the Home SP. Multiple domain entries
+        * can be used to configure alternative FQDNs that will be considered
+        * home networks.
+        */
+       char **domain;
+
+       /**
+        * num_domain - Number of FQDNs in the domain array
+        */
+       size_t num_domain;
+
+       /**
+        * roaming_consortium - Roaming Consortium OI
+        *
+        * If roaming_consortium_len is non-zero, this field contains the
+        * Roaming Consortium OI that can be used to determine which access
+        * points support authentication with this credential. This is an
+        * alternative to the use of the realm parameter. When using Roaming
+        * Consortium to match the network, the EAP parameters need to be
+        * pre-configured with the credential since the NAI Realm information
+        * may not be available or fetched.
+        */
+       u8 roaming_consortium[15];
+
+       /**
+        * roaming_consortium_len - Length of roaming_consortium
+        */
+       size_t roaming_consortium_len;
+
+       u8 required_roaming_consortium[15];
+       size_t required_roaming_consortium_len;
+
+       /**
+        * eap_method - EAP method to use
+        *
+        * Pre-configured EAP method to use with this credential or %NULL to
+        * indicate no EAP method is selected, i.e., the method will be
+        * selected automatically based on ANQP information.
+        */
+       struct eap_method_type *eap_method;
+
+       /**
+        * phase1 - Phase 1 (outer authentication) parameters
+        *
+        * Pre-configured EAP parameters or %NULL.
+        */
+       char *phase1;
+
+       /**
+        * phase2 - Phase 2 (inner authentication) parameters
+        *
+        * Pre-configured EAP parameters or %NULL.
+        */
+       char *phase2;
+
+       struct excluded_ssid {
+               u8 ssid[MAX_SSID_LEN];
+               size_t ssid_len;
+       } *excluded_ssid;
+       size_t num_excluded_ssid;
+
+       struct roaming_partner {
+               char fqdn[128];
+               int exact_match;
+               u8 priority;
+               char country[3];
+       } *roaming_partner;
+       size_t num_roaming_partner;
+
+       int update_identifier;
+
+       /**
+        * provisioning_sp - FQDN of the SP that provisioned the credential
+        */
+       char *provisioning_sp;
+
+       /**
+        * sp_priority - Credential priority within a provisioning SP
+        *
+        * This is the priority of the credential among all credentials
+        * provisionined by the same SP (i.e., for entries that have identical
+        * provisioning_sp value). The range of this priority is 0-255 with 0
+        * being the highest and 255 the lower priority.
+        */
+       int sp_priority;
+
+       unsigned int min_dl_bandwidth_home;
+       unsigned int min_ul_bandwidth_home;
+       unsigned int min_dl_bandwidth_roaming;
+       unsigned int min_ul_bandwidth_roaming;
+
+       /**
+        * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
+        * This value is used as the maximum channel utilization for network
+        * selection purposes for home networks. If the AP does not advertise
+        * BSS Load or if the limit would prevent any connection, this
+        * constraint will be ignored.
+        */
+       unsigned int max_bss_load;
+
+       unsigned int num_req_conn_capab;
+       u8 *req_conn_capab_proto;
+       int **req_conn_capab_port;
+
+       /**
+        * ocsp - Whether to use/require OCSP to check server certificate
+        *
+        * 0 = do not use OCSP stapling (TLS certificate status extension)
+        * 1 = try to use OCSP stapling, but not require response
+        * 2 = require valid OCSP stapling response
         */
-       char *domain;
+       int ocsp;
 };
 
 
@@ -159,6 +304,9 @@ struct wpa_cred {
 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
+#define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
+#define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
+#define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
 
 /**
  * struct wpa_config - wpa_supplicant configuration data
@@ -238,6 +386,27 @@ struct wpa_config {
        int ap_scan;
 
        /**
+        * bgscan - Background scan and roaming parameters or %NULL if none
+        *
+        * This is an optional set of parameters for background scanning and
+        * roaming within a network (ESS). For more detailed information see
+        * ssid block documentation.
+        *
+        * The variable defines default bgscan behavior for all BSS station
+        * networks except for those which have their own bgscan configuration.
+        */
+        char *bgscan;
+
+       /**
+        * disable_scan_offload - Disable automatic offloading of scan requests
+        *
+        * By default, %wpa_supplicant tries to offload scanning if the driver
+        * indicates support for this (sched_scan). This configuration
+        * parameter can be used to disable this offloading mechanism.
+        */
+       int disable_scan_offload;
+
+       /**
         * ctrl_interface - Parameters for the control interface
         *
         * If this is specified, %wpa_supplicant will open a control interface
@@ -353,6 +522,11 @@ struct wpa_config {
        char *pcsc_pin;
 
        /**
+        * external_sim - Use external processing for SIM/USIM operations
+        */
+       int external_sim;
+
+       /**
         * driver_param - Driver interface parameters
         *
         * This text string is passed to the selected driver interface with the
@@ -498,6 +672,13 @@ struct wpa_config {
        char *p2p_ssid_postfix;
        int persistent_reconnect;
        int p2p_intra_bss;
+       unsigned int num_p2p_pref_chan;
+       struct p2p_channel *p2p_pref_chan;
+       struct wpa_freq_range_list p2p_no_go_freq;
+       int p2p_add_cli_chan;
+       int p2p_ignore_shared_freq;
+
+       struct wpabuf *wps_vendor_ext_m1;
 
 #define MAX_WPS_VENDOR_EXT 10
        /**
@@ -516,9 +697,12 @@ struct wpa_config {
         * state indefinitely until explicitly removed. As a P2P client, the
         * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
         * this parameter is mainly meant for GO use and for P2P client, it can
-        * only be used to reduce the default timeout to smaller value.
+        * only be used to reduce the default timeout to smaller value. A
+        * special value -1 can be used to configure immediate removal of the
+        * group for P2P client role on any disconnection after the data
+        * connection has been established.
         */
-       unsigned int p2p_group_idle;
+       int p2p_group_idle;
 
        /**
         * bss_max_count - Maximum number of BSS entries to keep in memory
@@ -553,11 +737,35 @@ struct wpa_config {
        int filter_ssids;
 
        /**
+        * filter_rssi - RSSI-based scan result filtering
+        *
+        * 0 = do not filter scan results
+        * -n = filter scan results below -n dBm
+        */
+       int filter_rssi;
+
+       /**
         * max_num_sta - Maximum number of STAs in an AP/P2P GO
         */
        unsigned int max_num_sta;
 
        /**
+        * freq_list - Array of allowed scan frequencies or %NULL for all
+        *
+        * This is an optional zero-terminated array of frequencies in
+        * megahertz (MHz) to allow for narrowing scanning range.
+        */
+       int *freq_list;
+
+       /**
+        * scan_cur_freq - Whether to scan only the current channel
+        *
+        * If true, attempt to scan only the current channel if any other
+        * VIFs on this radio are already associated on a particular channel.
+        */
+       int scan_cur_freq;
+
+       /**
         * changed_parameters - Bitmap of changed parameters since last update
         */
        unsigned int changed_parameters;
@@ -589,6 +797,223 @@ struct wpa_config {
         * Homogeneous ESS. This is used only if interworking is enabled.
         */
        u8 hessid[ETH_ALEN];
+
+       /**
+        * hs20 - Hotspot 2.0
+        */
+       int hs20;
+
+       /**
+        * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
+        *
+        * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
+        * by acting as a Registrar and using M1 from the AP. The config
+        * methods attribute in that message is supposed to indicate only the
+        * configuration method supported by the AP in Enrollee role, i.e., to
+        * add an external Registrar. For that case, PBC shall not be used and
+        * as such, the PushButton config method is removed from M1 by default.
+        * If pbc_in_m1=1 is included in the configuration file, the PushButton
+        * config method is left in M1 (if included in config_methods
+        * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
+        * a label in the AP).
+        */
+       int pbc_in_m1;
+
+       /**
+        * autoscan - Automatic scan parameters or %NULL if none
+        *
+        * This is an optional set of parameters for automatic scanning
+        * within an interface in following format:
+        * <autoscan module name>:<module parameters>
+        */
+       char *autoscan;
+
+       /**
+        * wps_nfc_pw_from_config - NFC Device Password was read from config
+        *
+        * This parameter can be determined whether the NFC Device Password was
+        * included in the configuration (1) or generated dynamically (0). Only
+        * the former case is re-written back to the configuration file.
+        */
+       int wps_nfc_pw_from_config;
+
+       /**
+        * wps_nfc_dev_pw_id - NFC Device Password ID for password token
+        */
+       int wps_nfc_dev_pw_id;
+
+       /**
+        * wps_nfc_dh_pubkey - NFC DH Public Key for password token
+        */
+       struct wpabuf *wps_nfc_dh_pubkey;
+
+       /**
+        * wps_nfc_dh_privkey - NFC DH Private Key for password token
+        */
+       struct wpabuf *wps_nfc_dh_privkey;
+
+       /**
+        * wps_nfc_dev_pw - NFC Device Password for password token
+        */
+       struct wpabuf *wps_nfc_dev_pw;
+
+       /**
+        * ext_password_backend - External password backend or %NULL if none
+        *
+        * format: <backend name>[:<optional backend parameters>]
+        */
+       char *ext_password_backend;
+
+       /*
+        * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
+        *
+        * This timeout value is used in P2P GO mode to clean up
+        * inactive stations.
+        * By default: 300 seconds.
+        */
+       int p2p_go_max_inactivity;
+
+       struct hostapd_wmm_ac_params wmm_ac_params[4];
+
+       /**
+        * auto_interworking - Whether to use network selection automatically
+        *
+        * 0 = do not automatically go through Interworking network selection
+        *     (i.e., require explicit interworking_select command for this)
+        * 1 = perform Interworking network selection if one or more
+        *     credentials have been configured and scan did not find a
+        *     matching network block
+        */
+       int auto_interworking;
+
+       /**
+        * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
+        *
+        * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
+        * Note that regulatory constraints and driver capabilities are
+        * consulted anyway, so setting it to 1 can't do real harm.
+        * By default: 0 (disabled)
+        */
+       int p2p_go_ht40;
+
+       /**
+        * p2p_go_vht - Default mode for VHT enable when operating as GO
+        *
+        * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
+        * Note that regulatory constraints and driver capabilities are
+        * consulted anyway, so setting it to 1 can't do real harm.
+        * By default: 0 (disabled)
+        */
+       int p2p_go_vht;
+
+       /**
+        * p2p_disabled - Whether P2P operations are disabled for this interface
+        */
+       int p2p_disabled;
+
+       /**
+        * p2p_no_group_iface - Whether group interfaces can be used
+        *
+        * By default, wpa_supplicant will create a separate interface for P2P
+        * group operations if the driver supports this. This functionality can
+        * be disabled by setting this parameter to 1. In that case, the same
+        * interface that was used for the P2P management operations is used
+        * also for the group operation.
+        */
+       int p2p_no_group_iface;
+
+       /**
+        * okc - Whether to enable opportunistic key caching by default
+        *
+        * By default, OKC is disabled unless enabled by the per-network
+        * proactive_key_caching=1 parameter. okc=1 can be used to change this
+        * default behavior.
+        */
+       int okc;
+
+       /**
+        * pmf - Whether to enable/require PMF by default
+        *
+        * By default, PMF is disabled unless enabled by the per-network
+        * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
+        * this default behavior.
+        */
+       enum mfp_options pmf;
+
+       /**
+        * sae_groups - Preference list of enabled groups for SAE
+        *
+        * By default (if this parameter is not set), the mandatory group 19
+        * (ECC group defined over a 256-bit prime order field) is preferred,
+        * but other groups are also enabled. If this parameter is set, the
+        * groups will be tried in the indicated order.
+        */
+       int *sae_groups;
+
+       /**
+        * dtim_period - Default DTIM period in Beacon intervals
+        *
+        * This parameter can be used to set the default value for network
+        * blocks that do not specify dtim_period.
+        */
+       int dtim_period;
+
+       /**
+        * beacon_int - Default Beacon interval in TU
+        *
+        * This parameter can be used to set the default value for network
+        * blocks that do not specify beacon_int.
+        */
+       int beacon_int;
+
+       /**
+        * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
+        *
+        * This parameter can be used to define additional vendor specific
+        * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
+        * format for these element(s) is a hexdump of the raw information
+        * elements (id+len+payload for one or more elements).
+        */
+       struct wpabuf *ap_vendor_elements;
+
+       /**
+        * ignore_old_scan_res - Ignore scan results older than request
+        *
+        * The driver may have a cache of scan results that makes it return
+        * information that is older than our scan trigger. This parameter can
+        * be used to configure such old information to be ignored instead of
+        * allowing it to update the internal BSS table.
+        */
+       int ignore_old_scan_res;
+
+       /**
+        * sched_scan_interval -  schedule scan interval
+        */
+       unsigned int sched_scan_interval;
+
+       /**
+        * tdls_external_control - External control for TDLS setup requests
+        *
+        * Enable TDLS mode where external programs are given the control
+        * to specify the TDLS link to get established to the driver. The
+        * driver requests the TDLS setup to the supplicant only for the
+        * specified TDLS peers.
+        */
+       int tdls_external_control;
+
+       u8 ip_addr_go[4];
+       u8 ip_addr_mask[4];
+       u8 ip_addr_start[4];
+       u8 ip_addr_end[4];
+
+       /**
+        * osu_dir - OSU provider information directory
+        *
+        * If set, allow FETCH_OSU control interface command to be used to fetch
+        * OSU provider information into all APs and store the results in this
+        * directory.
+        */
+       char *osu_dir;
 };
 
 
@@ -620,6 +1045,7 @@ void wpa_config_set_blob(struct wpa_config *config,
                         struct wpa_config_blob *blob);
 void wpa_config_free_blob(struct wpa_config_blob *blob);
 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
+void wpa_config_flush_blobs(struct wpa_config *config);
 
 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
@@ -627,6 +1053,7 @@ int wpa_config_remove_cred(struct wpa_config *config, int id);
 void wpa_config_free_cred(struct wpa_cred *cred);
 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
                        const char *value, int line);
+char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
 
 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
                                           const char *driver_param);
@@ -647,6 +1074,7 @@ int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
  * wpa_config_read - Read and parse configuration database
  * @name: Name of the configuration (e.g., path and file name for the
  * configuration file)
+ * @cfgp: Pointer to previously allocated configuration data or %NULL if none
  * Returns: Pointer to allocated configuration data or %NULL on failure
  *
  * This function reads configuration data, parses its contents, and allocates
@@ -655,7 +1083,7 @@ int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
  *
  * Each configuration backend needs to implement this function.
  */
-struct wpa_config * wpa_config_read(const char *name);
+struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp);
 
 /**
  * wpa_config_write - Write or update configuration data