[thirdparty/hostap.git] / wpa_supplicant / wpa_supplicant_i.h

/*
 * wpa_supplicant - Internal definitions
 * Copyright (c) 2003-2010, Jouni Malinen <j@w1.fi>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Alternatively, this software may be distributed under the terms of BSD
 * license.
 *
 * See README and COPYING for more details.
 */

#ifndef WPA_SUPPLICANT_I_H
#define WPA_SUPPLICANT_I_H

#include "utils/list.h"
#include "common/defs.h"
#include "config_ssid.h"

extern const char *wpa_supplicant_version;
extern const char *wpa_supplicant_license;
#ifndef CONFIG_NO_STDOUT_DEBUG
extern const char *wpa_supplicant_full_license1;
extern const char *wpa_supplicant_full_license2;
extern const char *wpa_supplicant_full_license3;
extern const char *wpa_supplicant_full_license4;
extern const char *wpa_supplicant_full_license5;
#endif /* CONFIG_NO_STDOUT_DEBUG */

struct wpa_sm;
struct wpa_supplicant;
struct ibss_rsn;
struct scan_info;
struct wpa_bss;
struct wpa_scan_results;
struct hostapd_hw_modes;
struct wpa_driver_associate_params;

/*
 * Forward declarations of private structures used within the ctrl_iface
 * backends. Other parts of wpa_supplicant do not have access to data stored in
 * these structures.
 */
struct ctrl_iface_priv;
struct ctrl_iface_global_priv;
struct wpas_dbus_priv;

/**
 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
 */
struct wpa_interface {
	/**
	 * confname - Configuration name (file or profile) name
	 *
	 * This can also be %NULL when a configuration file is not used. In
	 * that case, ctrl_interface must be set to allow the interface to be
	 * configured.
	 */
	const char *confname;

	/**
	 * ctrl_interface - Control interface parameter
	 *
	 * If a configuration file is not used, this variable can be used to
	 * set the ctrl_interface parameter that would have otherwise been read
	 * from the configuration file. If both confname and ctrl_interface are
	 * set, ctrl_interface is used to override the value from configuration
	 * file.
	 */
	const char *ctrl_interface;

	/**
	 * driver - Driver interface name, or %NULL to use the default driver
	 */
	const char *driver;

	/**
	 * driver_param - Driver interface parameters
	 *
	 * If a configuration file is not used, this variable can be used to
	 * set the driver_param parameters that would have otherwise been read
	 * from the configuration file. If both confname and driver_param are
	 * set, driver_param is used to override the value from configuration
	 * file.
	 */
	const char *driver_param;

	/**
	 * ifname - Interface name
	 */
	const char *ifname;

	/**
	 * bridge_ifname - Optional bridge interface name
	 *
	 * If the driver interface (ifname) is included in a Linux bridge
	 * device, the bridge interface may need to be used for receiving EAPOL
	 * frames. This can be enabled by setting this variable to enable
	 * receiving of EAPOL frames from an additional interface.
	 */
	const char *bridge_ifname;
};

/**
 * struct wpa_params - Parameters for wpa_supplicant_init()
 */
struct wpa_params {
	/**
	 * daemonize - Run %wpa_supplicant in the background
	 */
	int daemonize;

	/**
	 * wait_for_monitor - Wait for a monitor program before starting
	 */
	int wait_for_monitor;

	/**
	 * pid_file - Path to a PID (process ID) file
	 *
	 * If this and daemonize are set, process ID of the background process
	 * will be written to the specified file.
	 */
	char *pid_file;

	/**
	 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
	 */
	int wpa_debug_level;

	/**
	 * wpa_debug_show_keys - Whether keying material is included in debug
	 *
	 * This parameter can be used to allow keying material to be included
	 * in debug messages. This is a security risk and this option should
	 * not be enabled in normal configuration. If needed during
	 * development or while troubleshooting, this option can provide more
	 * details for figuring out what is happening.
	 */
	int wpa_debug_show_keys;

	/**
	 * wpa_debug_timestamp - Whether to include timestamp in debug messages
	 */
	int wpa_debug_timestamp;

	/**
	 * ctrl_interface - Global ctrl_iface path/parameter
	 */
	char *ctrl_interface;

	/**
	 * dbus_ctrl_interface - Enable the DBus control interface
	 */
	int dbus_ctrl_interface;

	/**
	 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
	 */
	const char *wpa_debug_file_path;

	/**
	 * wpa_debug_syslog - Enable log output through syslog
	 */
	int wpa_debug_syslog;

	/**
	 * override_driver - Optional driver parameter override
	 *
	 * This parameter can be used to override the driver parameter in
	 * dynamic interface addition to force a specific driver wrapper to be
	 * used instead.
	 */
	char *override_driver;

	/**
	 * override_ctrl_interface - Optional ctrl_interface override
	 *
	 * This parameter can be used to override the ctrl_interface parameter
	 * in dynamic interface addition to force a control interface to be
	 * created.
	 */
	char *override_ctrl_interface;

	/**
	 * entropy_file - Optional entropy file
	 *
	 * This parameter can be used to configure wpa_supplicant to maintain
	 * its internal entropy store over restarts.
	 */
	char *entropy_file;
};

struct p2p_srv_bonjour {
	struct dl_list list;
	struct wpabuf *query;
	struct wpabuf *resp;
};

struct p2p_srv_upnp {
	struct dl_list list;
	u8 version;
	char *service;
};

/**
 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
 *
 * This structure is initialized by calling wpa_supplicant_init() when starting
 * %wpa_supplicant.
 */
struct wpa_global {
	struct wpa_supplicant *ifaces;
	struct wpa_params params;
	struct ctrl_iface_global_priv *ctrl_iface;
	struct wpas_dbus_priv *dbus;
	void **drv_priv;
	size_t drv_count;
	struct os_time suspend_time;
	struct p2p_data *p2p;
	struct wpa_supplicant *p2p_group_formation;
	u8 p2p_dev_addr[ETH_ALEN];
	struct dl_list p2p_srv_bonjour; /* struct p2p_srv_bonjour */
	struct dl_list p2p_srv_upnp; /* struct p2p_srv_upnp */
	int p2p_disabled;
	int cross_connection;
};


enum offchannel_send_action_result {
	OFFCHANNEL_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
	OFFCHANNEL_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged
				       */,
	OFFCHANNEL_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
};

/**
 * struct wpa_supplicant - Internal data for wpa_supplicant interface
 *
 * This structure contains the internal data for core wpa_supplicant code. This
 * should be only used directly from the core code. However, a pointer to this
 * data is used from other files as an arbitrary context pointer in calls to
 * core functions.
 */
struct wpa_supplicant {
	struct wpa_global *global;
	struct wpa_supplicant *parent;
	struct wpa_supplicant *next;
	struct l2_packet_data *l2;
	struct l2_packet_data *l2_br;
	unsigned char own_addr[ETH_ALEN];
	char ifname[100];
#ifdef CONFIG_CTRL_IFACE_DBUS
	char *dbus_path;
#endif /* CONFIG_CTRL_IFACE_DBUS */
#ifdef CONFIG_CTRL_IFACE_DBUS_NEW
	char *dbus_new_path;
	char *dbus_groupobj_path;
#endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
	char bridge_ifname[16];

	char *confname;
	struct wpa_config *conf;
	int countermeasures;
	os_time_t last_michael_mic_error;
	u8 bssid[ETH_ALEN];
	u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
				     * field contains the target BSSID. */
	int reassociate; /* reassociation requested */
	int disconnected; /* all connections disabled; i.e., do no reassociate
			   * before this has been cleared */
	struct wpa_ssid *current_ssid;
	struct wpa_bss *current_bss;
	int ap_ies_from_associnfo;
	unsigned int assoc_freq;

	/* Selected configuration (based on Beacon/ProbeResp WPA IE) */
	int pairwise_cipher;
	int group_cipher;
	int key_mgmt;
	int wpa_proto;
	int mgmt_group_cipher;

	void *drv_priv; /* private data used by driver_ops */
	void *global_drv_priv;

	/* previous scan was wildcard when interleaving between
	 * wildcard scans and specific SSID scan when max_ssids=1 */
	int prev_scan_wildcard;
	struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
					  * NULL = not yet initialized (start
					  * with wildcard SSID)
					  * WILDCARD_SSID_SCAN = wildcard
					  * SSID was used in the previous scan
					  */
#define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)

	struct wpa_ssid *prev_sched_ssid; /* last SSID used in sched scan */
	int sched_scan_timeout;
	int sched_scan_interval;
	int first_sched_scan;
	int sched_scan_timed_out;

	void (*scan_res_handler)(struct wpa_supplicant *wpa_s,
				 struct wpa_scan_results *scan_res);
	struct dl_list bss; /* struct wpa_bss::list */
	struct dl_list bss_id; /* struct wpa_bss::list_id */
	size_t num_bss;
	unsigned int bss_update_idx;
	unsigned int bss_next_id;

	struct wpa_driver_ops *driver;
	int interface_removed; /* whether the network interface has been
				* removed */
	struct wpa_sm *wpa;
	struct eapol_sm *eapol;

	struct ctrl_iface_priv *ctrl_iface;

	enum wpa_states wpa_state;
	int scanning;
	int sched_scanning;
	int new_connection;
	int reassociated_connection;

	int eapol_received; /* number of EAPOL packets received after the
			     * previous association event */

	struct scard_data *scard;

	unsigned char last_eapol_src[ETH_ALEN];

	int keys_cleared;

	struct wpa_blacklist *blacklist;

	int scan_req; /* manual scan request; this forces a scan even if there
		       * are no enabled networks in the configuration */
	int scan_runs; /* number of scan runs since WPS was started */
	int *next_scan_freqs;
	int scan_interval; /* time in sec between scans to find suitable AP */
	int normal_scans; /* normal scans run before sched_scan */

	unsigned int drv_flags;

	/*
	 * A bitmap of supported protocols for probe response offload. See
	 * struct wpa_driver_capa in driver.h
	 */
	unsigned int probe_resp_offloads;

	int max_scan_ssids;
	int max_sched_scan_ssids;
	int sched_scan_supported;
	unsigned int max_match_sets;
	unsigned int max_remain_on_chan;
	unsigned int max_stations;

	int pending_mic_error_report;
	int pending_mic_error_pairwise;
	int mic_errors_seen; /* Michael MIC errors with the current PTK */

	struct wps_context *wps;
	int wps_success; /* WPS success event received */
	struct wps_er *wps_er;
	int blacklist_cleared;

	struct wpabuf *pending_eapol_rx;
	struct os_time pending_eapol_rx_time;
	u8 pending_eapol_rx_src[ETH_ALEN];

	struct ibss_rsn *ibss_rsn;

	int set_sta_uapsd;
	int sta_uapsd;
	int set_ap_uapsd;
	int ap_uapsd;

#ifdef CONFIG_SME
	struct {
		u8 ssid[32];
		size_t ssid_len;
		int freq;
		u8 assoc_req_ie[200];
		size_t assoc_req_ie_len;
		int mfp;
		int ft_used;
		u8 mobility_domain[2];
		u8 *ft_ies;
		size_t ft_ies_len;
		u8 prev_bssid[ETH_ALEN];
		int prev_bssid_set;
		int auth_alg;
		int proto;

		int sa_query_count; /* number of pending SA Query requests;
				     * 0 = no SA Query in progress */
		int sa_query_timed_out;
		u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
					* sa_query_count octets of pending
					* SA Query transaction identifiers */
		struct os_time sa_query_start;
	} sme;
#endif /* CONFIG_SME */

#ifdef CONFIG_AP
	struct hostapd_iface *ap_iface;
	void (*ap_configured_cb)(void *ctx, void *data);
	void *ap_configured_cb_ctx;
	void *ap_configured_cb_data;
#endif /* CONFIG_AP */

	unsigned int off_channel_freq;
	struct wpabuf *pending_action_tx;
	u8 pending_action_src[ETH_ALEN];
	u8 pending_action_dst[ETH_ALEN];
	u8 pending_action_bssid[ETH_ALEN];
	unsigned int pending_action_freq;
	int pending_action_no_cck;
	int pending_action_without_roc;
	void (*pending_action_tx_status_cb)(struct wpa_supplicant *wpa_s,
					    unsigned int freq, const u8 *dst,
					    const u8 *src, const u8 *bssid,
					    const u8 *data, size_t data_len,
					    enum offchannel_send_action_result
					    result);
	unsigned int roc_waiting_drv_freq;
	int action_tx_wait_time;

#ifdef CONFIG_P2P
	struct p2p_go_neg_results *go_params;
	int create_p2p_iface;
	u8 pending_interface_addr[ETH_ALEN];
	char pending_interface_name[100];
	int pending_interface_type;
	int p2p_group_idx;
	unsigned int pending_listen_freq;
	unsigned int pending_listen_duration;
	enum {
		NOT_P2P_GROUP_INTERFACE,
		P2P_GROUP_INTERFACE_PENDING,
		P2P_GROUP_INTERFACE_GO,
		P2P_GROUP_INTERFACE_CLIENT
	} p2p_group_interface;
	struct p2p_group *p2p_group;
	int p2p_long_listen; /* remaining time in long Listen state in ms */
	char p2p_pin[10];
	int p2p_wps_method;
	u8 p2p_auth_invite[ETH_ALEN];
	int p2p_sd_over_ctrl_iface;
	int p2p_in_provisioning;
	int pending_invite_ssid_id;
	int show_group_started;
	u8 go_dev_addr[ETH_ALEN];
	int pending_pd_before_join;
	u8 pending_join_iface_addr[ETH_ALEN];
	u8 pending_join_dev_addr[ETH_ALEN];
	int pending_join_wps_method;
	int p2p_join_scan_count;
	int force_long_sd;

	/*
	 * Whether cross connection is disallowed by the AP to which this
	 * interface is associated (only valid if there is an association).
	 */
	int cross_connect_disallowed;

	/*
	 * Whether this P2P group is configured to use cross connection (only
	 * valid if this is P2P GO interface). The actual cross connect packet
	 * forwarding may not be configured depending on the uplink status.
	 */
	int cross_connect_enabled;

	/* Whether cross connection forwarding is in use at the moment. */
	int cross_connect_in_use;

	/*
	 * Uplink interface name for cross connection
	 */
	char cross_connect_uplink[100];

	enum {
		P2P_GROUP_REMOVAL_UNKNOWN,
		P2P_GROUP_REMOVAL_REQUESTED,
		P2P_GROUP_REMOVAL_IDLE_TIMEOUT,
		P2P_GROUP_REMOVAL_UNAVAILABLE
	} removal_reason;

	unsigned int p2p_cb_on_scan_complete:1;
#endif /* CONFIG_P2P */

	struct wpa_ssid *bgscan_ssid;
	const struct bgscan_ops *bgscan;
	void *bgscan_priv;

	struct wpa_ssid *connect_without_scan;

	int after_wps;
	int known_wps_freq;
	unsigned int wps_freq;
	int wps_fragment_size;
	int auto_reconnect_disabled;

	 /* Channel preferences for AP/P2P GO use */
	int best_24_freq;
	int best_5_freq;
	int best_overall_freq;

	struct gas_query *gas;

#ifdef CONFIG_INTERWORKING
	unsigned int fetch_anqp_in_progress:1;
	unsigned int network_select:1;
	unsigned int auto_select:1;
#endif /* CONFIG_INTERWORKING */
	unsigned int drv_capa_known;

	struct {
		struct hostapd_hw_modes *modes;
		u16 num_modes;
		u16 flags;
	} hw;

	int pno;
};


/* wpa_supplicant.c */
void wpa_supplicant_apply_ht_overrides(
	struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid,
	struct wpa_driver_associate_params *params);

int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);

int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);

const char * wpa_supplicant_state_txt(enum wpa_states state);
int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s);
int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
			      struct wpa_bss *bss, struct wpa_ssid *ssid,
			      u8 *wpa_ie, size_t *wpa_ie_len);
void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
			      struct wpa_bss *bss,
			      struct wpa_ssid *ssid);
void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
				       struct wpa_ssid *ssid);
void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
				     int sec, int usec);
void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
			      enum wpa_states state);
struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
				   int reason_code);
void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
				 int reason_code);

void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
				   struct wpa_ssid *ssid);
void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
				    struct wpa_ssid *ssid);
void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
				   struct wpa_ssid *ssid);
int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
			       int ap_scan);
int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s,
					  unsigned int expire_age);
int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s,
					    unsigned int expire_count);
int wpa_supplicant_set_debug_params(struct wpa_global *global,
				    int debug_level, int debug_timestamp,
				    int debug_show_keys);

void wpa_show_license(void);

struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
						 struct wpa_interface *iface);
int wpa_supplicant_remove_iface(struct wpa_global *global,
				struct wpa_supplicant *wpa_s,
				int terminate);
struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
						 const char *ifname);
struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
int wpa_supplicant_run(struct wpa_global *global);
void wpa_supplicant_deinit(struct wpa_global *global);

int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
			      struct wpa_ssid *ssid);
void wpa_supplicant_terminate_proc(struct wpa_global *global);
void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
			     const u8 *buf, size_t len);
enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
enum wpa_cipher cipher_suite2driver(int cipher);
void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
void wpas_connection_failed(struct wpa_supplicant *wpa_s, const u8 *bssid);
int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s);

/* events.c */
void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
int wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
			   struct wpa_bss *selected,
			   struct wpa_ssid *ssid);
void wpa_supplicant_stop_countermeasures(void *eloop_ctx, void *sock_ctx);
void wpa_supplicant_delayed_mic_error_report(void *eloop_ctx, void *sock_ctx);

/* eap_register.c */
int eap_register_methods(void);

/**
 * Utility method to tell if a given network is a persistent group
 * @ssid: Network object
 * Returns: 1 if network is a persistent group, 0 otherwise
 */
static inline int network_is_persistent_group(struct wpa_ssid *ssid)
{
	return ((ssid->disabled == 2) || ssid->p2p_persistent_group);
}

#endif /* WPA_SUPPLICANT_I_H */
Commit	Line	Data
	1	/*
	2	* wpa_supplicant - Internal definitions
	3	* Copyright (c) 2003-2010, 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 WPA_SUPPLICANT_I_H
	16	#define WPA_SUPPLICANT_I_H
	17
	18	#include "utils/list.h"
	19	#include "common/defs.h"
	20	#include "config_ssid.h"
	21
	22	extern const char *wpa_supplicant_version;
	23	extern const char *wpa_supplicant_license;
	24	#ifndef CONFIG_NO_STDOUT_DEBUG
	25	extern const char *wpa_supplicant_full_license1;
	26	extern const char *wpa_supplicant_full_license2;
	27	extern const char *wpa_supplicant_full_license3;
	28	extern const char *wpa_supplicant_full_license4;
	29	extern const char *wpa_supplicant_full_license5;
	30	#endif /* CONFIG_NO_STDOUT_DEBUG */
	31
	32	struct wpa_sm;
	33	struct wpa_supplicant;
	34	struct ibss_rsn;
	35	struct scan_info;
	36	struct wpa_bss;
	37	struct wpa_scan_results;
	38	struct hostapd_hw_modes;
	39	struct wpa_driver_associate_params;
	40
	41	/*
	42	* Forward declarations of private structures used within the ctrl_iface
	43	* backends. Other parts of wpa_supplicant do not have access to data stored in
	44	* these structures.
	45	*/
	46	struct ctrl_iface_priv;
	47	struct ctrl_iface_global_priv;
	48	struct wpas_dbus_priv;
	49
	50	/**
	51	* struct wpa_interface - Parameters for wpa_supplicant_add_iface()
	52	*/
	53	struct wpa_interface {
	54	/**
	55	* confname - Configuration name (file or profile) name
	56	*
	57	* This can also be %NULL when a configuration file is not used. In
	58	* that case, ctrl_interface must be set to allow the interface to be
	59	* configured.
	60	*/
	61	const char *confname;
	62
	63	/**
	64	* ctrl_interface - Control interface parameter
	65	*
	66	* If a configuration file is not used, this variable can be used to
	67	* set the ctrl_interface parameter that would have otherwise been read
	68	* from the configuration file. If both confname and ctrl_interface are
	69	* set, ctrl_interface is used to override the value from configuration
	70	* file.
	71	*/
	72	const char *ctrl_interface;
	73
	74	/**
	75	* driver - Driver interface name, or %NULL to use the default driver
	76	*/
	77	const char *driver;
	78
	79	/**
	80	* driver_param - Driver interface parameters
	81	*
	82	* If a configuration file is not used, this variable can be used to
	83	* set the driver_param parameters that would have otherwise been read
	84	* from the configuration file. If both confname and driver_param are
	85	* set, driver_param is used to override the value from configuration
	86	* file.
	87	*/
	88	const char *driver_param;
	89
	90	/**
	91	* ifname - Interface name
	92	*/
	93	const char *ifname;
	94
	95	/**
	96	* bridge_ifname - Optional bridge interface name
	97	*
	98	* If the driver interface (ifname) is included in a Linux bridge
	99	* device, the bridge interface may need to be used for receiving EAPOL
	100	* frames. This can be enabled by setting this variable to enable
	101	* receiving of EAPOL frames from an additional interface.
	102	*/
	103	const char *bridge_ifname;
	104	};
	105
	106	/**
	107	* struct wpa_params - Parameters for wpa_supplicant_init()
	108	*/
	109	struct wpa_params {
	110	/**
	111	* daemonize - Run %wpa_supplicant in the background
	112	*/
	113	int daemonize;
	114
	115	/**
	116	* wait_for_monitor - Wait for a monitor program before starting
	117	*/
	118	int wait_for_monitor;
	119
	120	/**
	121	* pid_file - Path to a PID (process ID) file
	122	*
	123	* If this and daemonize are set, process ID of the background process
	124	* will be written to the specified file.
	125	*/
	126	char *pid_file;
	127
	128	/**
	129	* wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
	130	*/
	131	int wpa_debug_level;
	132
	133	/**
	134	* wpa_debug_show_keys - Whether keying material is included in debug
	135	*
	136	* This parameter can be used to allow keying material to be included
	137	* in debug messages. This is a security risk and this option should
	138	* not be enabled in normal configuration. If needed during
	139	* development or while troubleshooting, this option can provide more
	140	* details for figuring out what is happening.
	141	*/
	142	int wpa_debug_show_keys;
	143
	144	/**
	145	* wpa_debug_timestamp - Whether to include timestamp in debug messages
	146	*/
	147	int wpa_debug_timestamp;
	148
	149	/**
	150	* ctrl_interface - Global ctrl_iface path/parameter
	151	*/
	152	char *ctrl_interface;
	153
	154	/**
	155	* dbus_ctrl_interface - Enable the DBus control interface
	156	*/
	157	int dbus_ctrl_interface;
	158
	159	/**
	160	* wpa_debug_file_path - Path of debug file or %NULL to use stdout
	161	*/
	162	const char *wpa_debug_file_path;
	163
	164	/**
	165	* wpa_debug_syslog - Enable log output through syslog
	166	*/
	167	int wpa_debug_syslog;
	168
	169	/**
	170	* override_driver - Optional driver parameter override
	171	*
	172	* This parameter can be used to override the driver parameter in
	173	* dynamic interface addition to force a specific driver wrapper to be
	174	* used instead.
	175	*/
	176	char *override_driver;
	177
	178	/**
	179	* override_ctrl_interface - Optional ctrl_interface override
	180	*
	181	* This parameter can be used to override the ctrl_interface parameter
	182	* in dynamic interface addition to force a control interface to be
	183	* created.
	184	*/
	185	char *override_ctrl_interface;
	186
	187	/**
	188	* entropy_file - Optional entropy file
	189	*
	190	* This parameter can be used to configure wpa_supplicant to maintain
	191	* its internal entropy store over restarts.
	192	*/
	193	char *entropy_file;
	194	};
	195
	196	struct p2p_srv_bonjour {
	197	struct dl_list list;
	198	struct wpabuf *query;
	199	struct wpabuf *resp;
	200	};
	201
	202	struct p2p_srv_upnp {
	203	struct dl_list list;
	204	u8 version;
	205	char *service;
	206	};
	207
	208	/**
	209	* struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
	210	*
	211	* This structure is initialized by calling wpa_supplicant_init() when starting
	212	* %wpa_supplicant.
	213	*/
	214	struct wpa_global {
	215	struct wpa_supplicant *ifaces;
	216	struct wpa_params params;
	217	struct ctrl_iface_global_priv *ctrl_iface;
	218	struct wpas_dbus_priv *dbus;
	219	void **drv_priv;
	220	size_t drv_count;
	221	struct os_time suspend_time;
	222	struct p2p_data *p2p;
	223	struct wpa_supplicant *p2p_group_formation;
	224	u8 p2p_dev_addr[ETH_ALEN];
	225	struct dl_list p2p_srv_bonjour; /* struct p2p_srv_bonjour */
	226	struct dl_list p2p_srv_upnp; /* struct p2p_srv_upnp */
	227	int p2p_disabled;
	228	int cross_connection;
	229	};
	230
	231
	232	enum offchannel_send_action_result {
	233	OFFCHANNEL_SEND_ACTION_SUCCESS /* Frame was send and acknowledged */,
	234	OFFCHANNEL_SEND_ACTION_NO_ACK /* Frame was sent, but not acknowledged
	235	*/,
	236	OFFCHANNEL_SEND_ACTION_FAILED /* Frame was not sent due to a failure */
	237	};
	238
	239	/**
	240	* struct wpa_supplicant - Internal data for wpa_supplicant interface
	241	*
	242	* This structure contains the internal data for core wpa_supplicant code. This
	243	* should be only used directly from the core code. However, a pointer to this
	244	* data is used from other files as an arbitrary context pointer in calls to
	245	* core functions.
	246	*/
	247	struct wpa_supplicant {
	248	struct wpa_global *global;
	249	struct wpa_supplicant *parent;
	250	struct wpa_supplicant *next;
	251	struct l2_packet_data *l2;
	252	struct l2_packet_data *l2_br;
	253	unsigned char own_addr[ETH_ALEN];
	254	char ifname[100];
	255	#ifdef CONFIG_CTRL_IFACE_DBUS
	256	char *dbus_path;
	257	#endif /* CONFIG_CTRL_IFACE_DBUS */
	258	#ifdef CONFIG_CTRL_IFACE_DBUS_NEW
	259	char *dbus_new_path;
	260	char *dbus_groupobj_path;
	261	#endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
	262	char bridge_ifname[16];
	263
	264	char *confname;
	265	struct wpa_config *conf;
	266	int countermeasures;
	267	os_time_t last_michael_mic_error;
	268	u8 bssid[ETH_ALEN];
	269	u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
	270	* field contains the target BSSID. */
	271	int reassociate; /* reassociation requested */
	272	int disconnected; /* all connections disabled; i.e., do no reassociate
	273	* before this has been cleared */
	274	struct wpa_ssid *current_ssid;
	275	struct wpa_bss *current_bss;
	276	int ap_ies_from_associnfo;
	277	unsigned int assoc_freq;
	278
	279	/* Selected configuration (based on Beacon/ProbeResp WPA IE) */
	280	int pairwise_cipher;
	281	int group_cipher;
	282	int key_mgmt;
	283	int wpa_proto;
	284	int mgmt_group_cipher;
	285
	286	void drv_priv; / private data used by driver_ops */
	287	void *global_drv_priv;
	288
	289	/* previous scan was wildcard when interleaving between
	290	* wildcard scans and specific SSID scan when max_ssids=1 */
	291	int prev_scan_wildcard;
	292	struct wpa_ssid prev_scan_ssid; / previously scanned SSID;
	293	* NULL = not yet initialized (start
	294	* with wildcard SSID)
	295	* WILDCARD_SSID_SCAN = wildcard
	296	* SSID was used in the previous scan
	297	*/
	298	#define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
	299
	300	struct wpa_ssid prev_sched_ssid; / last SSID used in sched scan */
	301	int sched_scan_timeout;
	302	int sched_scan_interval;
	303	int first_sched_scan;
	304	int sched_scan_timed_out;
	305
	306	void (scan_res_handler)(struct wpa_supplicant wpa_s,
	307	struct wpa_scan_results *scan_res);
	308	struct dl_list bss; /* struct wpa_bss::list */
	309	struct dl_list bss_id; /* struct wpa_bss::list_id */
	310	size_t num_bss;
	311	unsigned int bss_update_idx;
	312	unsigned int bss_next_id;
	313
	314	struct wpa_driver_ops *driver;
	315	int interface_removed; /* whether the network interface has been
	316	* removed */
	317	struct wpa_sm *wpa;
	318	struct eapol_sm *eapol;
	319
	320	struct ctrl_iface_priv *ctrl_iface;
	321
	322	enum wpa_states wpa_state;
	323	int scanning;
	324	int sched_scanning;
	325	int new_connection;
	326	int reassociated_connection;
	327
	328	int eapol_received; /* number of EAPOL packets received after the
	329	* previous association event */
	330
	331	struct scard_data *scard;
	332
	333	unsigned char last_eapol_src[ETH_ALEN];
	334
	335	int keys_cleared;
	336
	337	struct wpa_blacklist *blacklist;
	338
	339	int scan_req; /* manual scan request; this forces a scan even if there
	340	* are no enabled networks in the configuration */
	341	int scan_runs; /* number of scan runs since WPS was started */
	342	int *next_scan_freqs;
	343	int scan_interval; /* time in sec between scans to find suitable AP */
	344	int normal_scans; /* normal scans run before sched_scan */
	345
	346	unsigned int drv_flags;
	347
	348	/*
	349	* A bitmap of supported protocols for probe response offload. See
	350	* struct wpa_driver_capa in driver.h
	351	*/
	352	unsigned int probe_resp_offloads;
	353
	354	int max_scan_ssids;
	355	int max_sched_scan_ssids;
	356	int sched_scan_supported;
	357	unsigned int max_match_sets;
	358	unsigned int max_remain_on_chan;
	359	unsigned int max_stations;
	360
	361	int pending_mic_error_report;
	362	int pending_mic_error_pairwise;
	363	int mic_errors_seen; /* Michael MIC errors with the current PTK */
	364
	365	struct wps_context *wps;
	366	int wps_success; /* WPS success event received */
	367	struct wps_er *wps_er;
	368	int blacklist_cleared;
	369
	370	struct wpabuf *pending_eapol_rx;
	371	struct os_time pending_eapol_rx_time;
	372	u8 pending_eapol_rx_src[ETH_ALEN];
	373
	374	struct ibss_rsn *ibss_rsn;
	375
	376	int set_sta_uapsd;
	377	int sta_uapsd;
	378	int set_ap_uapsd;
	379	int ap_uapsd;
	380
	381	#ifdef CONFIG_SME
	382	struct {
	383	u8 ssid[32];
	384	size_t ssid_len;
	385	int freq;
	386	u8 assoc_req_ie[200];
	387	size_t assoc_req_ie_len;
	388	int mfp;
	389	int ft_used;
	390	u8 mobility_domain[2];
	391	u8 *ft_ies;
	392	size_t ft_ies_len;
	393	u8 prev_bssid[ETH_ALEN];
	394	int prev_bssid_set;
	395	int auth_alg;
	396	int proto;
	397
	398	int sa_query_count; /* number of pending SA Query requests;
	399	* 0 = no SA Query in progress */
	400	int sa_query_timed_out;
	401	u8 sa_query_trans_id; / buffer of WLAN_SA_QUERY_TR_ID_LEN *
	402	* sa_query_count octets of pending
	403	* SA Query transaction identifiers */
	404	struct os_time sa_query_start;
	405	} sme;
	406	#endif /* CONFIG_SME */
	407
	408	#ifdef CONFIG_AP
	409	struct hostapd_iface *ap_iface;
	410	void (ap_configured_cb)(void ctx, void *data);
	411	void *ap_configured_cb_ctx;
	412	void *ap_configured_cb_data;
	413	#endif /* CONFIG_AP */
	414
	415	unsigned int off_channel_freq;
	416	struct wpabuf *pending_action_tx;
	417	u8 pending_action_src[ETH_ALEN];
	418	u8 pending_action_dst[ETH_ALEN];
	419	u8 pending_action_bssid[ETH_ALEN];
	420	unsigned int pending_action_freq;
	421	int pending_action_no_cck;
	422	int pending_action_without_roc;
	423	void (pending_action_tx_status_cb)(struct wpa_supplicant wpa_s,
	424	unsigned int freq, const u8 *dst,
	425	const u8 src, const u8 bssid,
	426	const u8 *data, size_t data_len,
	427	enum offchannel_send_action_result
	428	result);
	429	unsigned int roc_waiting_drv_freq;
	430	int action_tx_wait_time;
	431
	432	#ifdef CONFIG_P2P
	433	struct p2p_go_neg_results *go_params;
	434	int create_p2p_iface;
	435	u8 pending_interface_addr[ETH_ALEN];
	436	char pending_interface_name[100];
	437	int pending_interface_type;
	438	int p2p_group_idx;
	439	unsigned int pending_listen_freq;
	440	unsigned int pending_listen_duration;
	441	enum {
	442	NOT_P2P_GROUP_INTERFACE,
	443	P2P_GROUP_INTERFACE_PENDING,
	444	P2P_GROUP_INTERFACE_GO,
	445	P2P_GROUP_INTERFACE_CLIENT
	446	} p2p_group_interface;
	447	struct p2p_group *p2p_group;
	448	int p2p_long_listen; /* remaining time in long Listen state in ms */
	449	char p2p_pin[10];
	450	int p2p_wps_method;
	451	u8 p2p_auth_invite[ETH_ALEN];
	452	int p2p_sd_over_ctrl_iface;
	453	int p2p_in_provisioning;
	454	int pending_invite_ssid_id;
	455	int show_group_started;
	456	u8 go_dev_addr[ETH_ALEN];
	457	int pending_pd_before_join;
	458	u8 pending_join_iface_addr[ETH_ALEN];
	459	u8 pending_join_dev_addr[ETH_ALEN];
	460	int pending_join_wps_method;
	461	int p2p_join_scan_count;
	462	int force_long_sd;
	463
	464	/*
	465	* Whether cross connection is disallowed by the AP to which this
	466	* interface is associated (only valid if there is an association).
	467	*/
	468	int cross_connect_disallowed;
	469
	470	/*
	471	* Whether this P2P group is configured to use cross connection (only
	472	* valid if this is P2P GO interface). The actual cross connect packet
	473	* forwarding may not be configured depending on the uplink status.
	474	*/
	475	int cross_connect_enabled;
	476
	477	/* Whether cross connection forwarding is in use at the moment. */
	478	int cross_connect_in_use;
	479
	480	/*
	481	* Uplink interface name for cross connection
	482	*/
	483	char cross_connect_uplink[100];
	484
	485	enum {
	486	P2P_GROUP_REMOVAL_UNKNOWN,
	487	P2P_GROUP_REMOVAL_REQUESTED,
	488	P2P_GROUP_REMOVAL_IDLE_TIMEOUT,
	489	P2P_GROUP_REMOVAL_UNAVAILABLE
	490	} removal_reason;
	491
	492	unsigned int p2p_cb_on_scan_complete:1;
	493	#endif /* CONFIG_P2P */
	494
	495	struct wpa_ssid *bgscan_ssid;
	496	const struct bgscan_ops *bgscan;
	497	void *bgscan_priv;
	498
	499	struct wpa_ssid *connect_without_scan;
	500
	501	int after_wps;
	502	int known_wps_freq;
	503	unsigned int wps_freq;
	504	int wps_fragment_size;
	505	int auto_reconnect_disabled;
	506
	507	/* Channel preferences for AP/P2P GO use */
	508	int best_24_freq;
	509	int best_5_freq;
	510	int best_overall_freq;
	511
	512	struct gas_query *gas;
	513
	514	#ifdef CONFIG_INTERWORKING
	515	unsigned int fetch_anqp_in_progress:1;
	516	unsigned int network_select:1;
	517	unsigned int auto_select:1;
	518	#endif /* CONFIG_INTERWORKING */
	519	unsigned int drv_capa_known;
	520
	521	struct {
	522	struct hostapd_hw_modes *modes;
	523	u16 num_modes;
	524	u16 flags;
	525	} hw;
	526
	527	int pno;
	528	};
	529
	530
	531	/* wpa_supplicant.c */
	532	void wpa_supplicant_apply_ht_overrides(
	533	struct wpa_supplicant wpa_s, struct wpa_ssid ssid,
	534	struct wpa_driver_associate_params *params);
	535
	536	int wpa_set_wep_keys(struct wpa_supplicant wpa_s, struct wpa_ssid ssid);
	537
	538	int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
	539
	540	const char * wpa_supplicant_state_txt(enum wpa_states state);
	541	int wpa_supplicant_update_mac_addr(struct wpa_supplicant *wpa_s);
	542	int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
	543	int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
	544	struct wpa_bss bss, struct wpa_ssid ssid,
	545	u8 wpa_ie, size_t wpa_ie_len);
	546	void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
	547	struct wpa_bss *bss,
	548	struct wpa_ssid *ssid);
	549	void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
	550	struct wpa_ssid *ssid);
	551	void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
	552	void wpa_clear_keys(struct wpa_supplicant wpa_s, const u8 addr);
	553	void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
	554	int sec, int usec);
	555	void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
	556	enum wpa_states state);
	557	struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
	558	const char * wpa_supplicant_get_eap_mode(struct wpa_supplicant *wpa_s);
	559	void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
	560	void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
	561	int reason_code);
	562	void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
	563	int reason_code);
	564
	565	void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
	566	struct wpa_ssid *ssid);
	567	void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
	568	struct wpa_ssid *ssid);
	569	void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
	570	struct wpa_ssid *ssid);
	571	int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
	572	int ap_scan);
	573	int wpa_supplicant_set_bss_expiration_age(struct wpa_supplicant *wpa_s,
	574	unsigned int expire_age);
	575	int wpa_supplicant_set_bss_expiration_count(struct wpa_supplicant *wpa_s,
	576	unsigned int expire_count);
	577	int wpa_supplicant_set_debug_params(struct wpa_global *global,
	578	int debug_level, int debug_timestamp,
	579	int debug_show_keys);
	580
	581	void wpa_show_license(void);
	582
	583	struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
	584	struct wpa_interface *iface);
	585	int wpa_supplicant_remove_iface(struct wpa_global *global,
	586	struct wpa_supplicant *wpa_s,
	587	int terminate);
	588	struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
	589	const char *ifname);
	590	struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
	591	int wpa_supplicant_run(struct wpa_global *global);
	592	void wpa_supplicant_deinit(struct wpa_global *global);
	593
	594	int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
	595	struct wpa_ssid *ssid);
	596	void wpa_supplicant_terminate_proc(struct wpa_global *global);
	597	void wpa_supplicant_rx_eapol(void ctx, const u8 src_addr,
	598	const u8 *buf, size_t len);
	599	enum wpa_key_mgmt key_mgmt2driver(int key_mgmt);
	600	enum wpa_cipher cipher_suite2driver(int cipher);
	601	void wpa_supplicant_update_config(struct wpa_supplicant *wpa_s);
	602	void wpa_supplicant_clear_status(struct wpa_supplicant *wpa_s);
	603	void wpas_connection_failed(struct wpa_supplicant wpa_s, const u8 bssid);
	604	int wpas_driver_bss_selection(struct wpa_supplicant *wpa_s);
	605
	606	/* events.c */
	607	void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
	608	int wpa_supplicant_connect(struct wpa_supplicant *wpa_s,
	609	struct wpa_bss *selected,
	610	struct wpa_ssid *ssid);
	611	void wpa_supplicant_stop_countermeasures(void eloop_ctx, void sock_ctx);
	612	void wpa_supplicant_delayed_mic_error_report(void eloop_ctx, void sock_ctx);
	613
	614	/* eap_register.c */
	615	int eap_register_methods(void);
	616
	617	/**
	618	* Utility method to tell if a given network is a persistent group
	619	* @ssid: Network object
	620	* Returns: 1 if network is a persistent group, 0 otherwise
	621	*/
	622	static inline int network_is_persistent_group(struct wpa_ssid *ssid)
	623	{
	624	return ((ssid->disabled == 2) \|\| ssid->p2p_persistent_group);
	625	}
	626
	627	#endif /* WPA_SUPPLICANT_I_H */