[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;

/*
 * 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;

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