2 * wpa_supplicant - Internal definitions
3 * Copyright (c) 2003-2007, Jouni Malinen <j@w1.fi>
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.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
15 #ifndef WPA_SUPPLICANT_I_H
16 #define WPA_SUPPLICANT_I_H
18 #include "common/defs.h"
20 extern const char *wpa_supplicant_version;
21 extern const char *wpa_supplicant_license;
22 #ifndef CONFIG_NO_STDOUT_DEBUG
23 extern const char *wpa_supplicant_full_license1;
24 extern const char *wpa_supplicant_full_license2;
25 extern const char *wpa_supplicant_full_license3;
26 extern const char *wpa_supplicant_full_license4;
27 extern const char *wpa_supplicant_full_license5;
28 #endif /* CONFIG_NO_STDOUT_DEBUG */
30 struct wpa_scan_result;
33 struct wpa_supplicant;
37 * Forward declarations of private structures used within the ctrl_iface
38 * backends. Other parts of wpa_supplicant do not have access to data stored in
41 struct ctrl_iface_priv;
42 struct ctrl_iface_global_priv;
43 struct ctrl_iface_dbus_priv;
46 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
48 struct wpa_interface {
50 * confname - Configuration name (file or profile) name
52 * This can also be %NULL when a configuration file is not used. In
53 * that case, ctrl_interface must be set to allow the interface to be
59 * ctrl_interface - Control interface parameter
61 * If a configuration file is not used, this variable can be used to
62 * set the ctrl_interface parameter that would have otherwise been read
63 * from the configuration file. If both confname and ctrl_interface are
64 * set, ctrl_interface is used to override the value from configuration
67 const char *ctrl_interface;
70 * driver - Driver interface name, or %NULL to use the default driver
75 * driver_param - Driver interface parameters
77 * If a configuration file is not used, this variable can be used to
78 * set the driver_param parameters that would have otherwise been read
79 * from the configuration file. If both confname and driver_param are
80 * set, driver_param is used to override the value from configuration
83 const char *driver_param;
86 * ifname - Interface name
91 * bridge_ifname - Optional bridge interface name
93 * If the driver interface (ifname) is included in a Linux bridge
94 * device, the bridge interface may need to be used for receiving EAPOL
95 * frames. This can be enabled by setting this variable to enable
96 * receiving of EAPOL frames from an additional interface.
98 const char *bridge_ifname;
102 * struct wpa_params - Parameters for wpa_supplicant_init()
106 * daemonize - Run %wpa_supplicant in the background
111 * wait_for_monitor - Wait for a monitor program before starting
113 int wait_for_monitor;
116 * pid_file - Path to a PID (process ID) file
118 * If this and daemonize are set, process ID of the background process
119 * will be written to the specified file.
124 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
129 * wpa_debug_show_keys - Whether keying material is included in debug
131 * This parameter can be used to allow keying material to be included
132 * in debug messages. This is a security risk and this option should
133 * not be enabled in normal configuration. If needed during
134 * development or while troubleshooting, this option can provide more
135 * details for figuring out what is happening.
137 int wpa_debug_show_keys;
140 * wpa_debug_timestamp - Whether to include timestamp in debug messages
142 int wpa_debug_timestamp;
145 * ctrl_interface - Global ctrl_iface path/parameter
147 char *ctrl_interface;
150 * dbus_ctrl_interface - Enable the DBus control interface
152 int dbus_ctrl_interface;
155 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
157 const char *wpa_debug_file_path;
160 * wpa_debug_syslog - Enable log output through syslog
162 int wpa_debug_syslog;
165 * override_driver - Optional driver parameter override
167 * This parameter can be used to override the driver parameter in
168 * dynamic interface addition to force a specific driver wrapper to be
171 char *override_driver;
174 * override_ctrl_interface - Optional ctrl_interface override
176 * This parameter can be used to override the ctrl_interface parameter
177 * in dynamic interface addition to force a control interface to be
180 char *override_ctrl_interface;
184 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
186 * This structure is initialized by calling wpa_supplicant_init() when starting
190 struct wpa_supplicant *ifaces;
191 struct wpa_params params;
192 struct ctrl_iface_global_priv *ctrl_iface;
193 struct ctrl_iface_dbus_priv *dbus_ctrl_iface;
199 struct wpa_client_mlme {
200 #ifdef CONFIG_CLIENT_MLME
202 IEEE80211_DISABLED, IEEE80211_AUTHENTICATE,
203 IEEE80211_ASSOCIATE, IEEE80211_ASSOCIATED,
204 IEEE80211_IBSS_SEARCH, IEEE80211_IBSS_JOINED
206 u8 prev_bssid[ETH_ALEN];
211 u8 *extra_ie; /* to be added to the end of AssocReq */
213 u8 *extra_probe_ie; /* to be added to the end of ProbeReq */
214 size_t extra_probe_ie_len;
215 wpa_key_mgmt key_mgmt;
217 /* The last AssocReq/Resp IEs */
218 u8 *assocreq_ies, *assocresp_ies;
219 size_t assocreq_ies_len, assocresp_ies_len;
221 int auth_tries, assoc_tries;
223 unsigned int ssid_set:1;
224 unsigned int bssid_set:1;
225 unsigned int prev_bssid_set:1;
226 unsigned int authenticated:1;
227 unsigned int associated:1;
228 unsigned int probereq_poll:1;
229 unsigned int use_protection:1;
230 unsigned int create_ibss:1;
231 unsigned int mixed_cell:1;
232 unsigned int wmm_enabled:1;
234 struct os_time last_probe;
236 #define IEEE80211_AUTH_ALG_OPEN BIT(0)
237 #define IEEE80211_AUTH_ALG_SHARED_KEY BIT(1)
238 #define IEEE80211_AUTH_ALG_LEAP BIT(2)
239 unsigned int auth_algs; /* bitfield of allowed auth algs */
240 int auth_alg; /* currently used IEEE 802.11 authentication algorithm */
241 int auth_transaction;
243 struct os_time ibss_join_req;
244 u8 *probe_resp; /* ProbeResp template for IBSS */
245 size_t probe_resp_len;
248 int wmm_last_param_set;
251 int scan_hw_mode_idx;
252 int scan_channel_idx;
253 enum { SCAN_SET_CHANNEL, SCAN_SEND_PROBE } scan_state;
254 struct os_time last_scan_completed;
255 int scan_oper_channel;
257 int scan_oper_phymode;
259 size_t scan_ssid_len;
262 struct ieee80211_sta_bss *sta_bss_list;
263 #define STA_HASH_SIZE 256
264 #define STA_HASH(sta) (sta[5])
265 struct ieee80211_sta_bss *sta_bss_hash[STA_HASH_SIZE];
267 int cts_protect_erp_frames;
269 hostapd_hw_mode phymode; /* current mode */
270 struct hostapd_hw_modes *modes;
272 unsigned int hw_modes; /* bitfield of allowed hardware modes;
273 * (1 << HOSTAPD_MODE_*) */
275 struct hostapd_rate_data *curr_rates;
276 int freq; /* The current frequency in MHz */
277 int channel; /* The current IEEE 802.11 channel number */
279 #ifdef CONFIG_IEEE80211R
283 #endif /* CONFIG_IEEE80211R */
285 #else /* CONFIG_CLIENT_MLME */
286 int dummy; /* to keep MSVC happy */
287 #endif /* CONFIG_CLIENT_MLME */
291 * struct wpa_supplicant - Internal data for wpa_supplicant interface
293 * This structure contains the internal data for core wpa_supplicant code. This
294 * should be only used directly from the core code. However, a pointer to this
295 * data is used from other files as an arbitrary context pointer in calls to
298 struct wpa_supplicant {
299 struct wpa_global *global;
300 struct wpa_supplicant *next;
301 struct l2_packet_data *l2;
302 struct l2_packet_data *l2_br;
303 unsigned char own_addr[ETH_ALEN];
305 #ifdef CONFIG_CTRL_IFACE_DBUS
307 #endif /* CONFIG_CTRL_IFACE_DBUS */
308 char bridge_ifname[16];
311 struct wpa_config *conf;
313 os_time_t last_michael_mic_error;
315 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
316 * field contains the targer BSSID. */
317 int reassociate; /* reassociation requested */
318 int disconnected; /* all connections disabled; i.e., do no reassociate
319 * before this has been cleared */
320 struct wpa_ssid *current_ssid;
321 int ap_ies_from_associnfo;
323 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
327 int mgmt_group_cipher;
329 void *drv_priv; /* private data used by driver_ops */
331 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
332 * NULL = not yet initialized (start
333 * with wildcard SSID)
334 * WILDCARD_SSID_SCAN = wildcard
335 * SSID was used in the previous scan
337 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
339 struct wpa_scan_results *scan_res;
341 struct wpa_driver_ops *driver;
342 int interface_removed; /* whether the network interface has been
345 struct eapol_sm *eapol;
347 struct ctrl_iface_priv *ctrl_iface;
349 wpa_states wpa_state;
352 int reassociated_connection;
354 int eapol_received; /* number of EAPOL packets received after the
355 * previous association event */
357 struct scard_data *scard;
359 unsigned char last_eapol_src[ETH_ALEN];
363 struct wpa_blacklist *blacklist;
365 int scan_req; /* manual scan request; this forces a scan even if there
366 * are no enabled networks in the configuration */
367 int scan_res_tried; /* whether ap_scan=1 mode has tried to fetch scan
368 * results without a new scan request; this is used
369 * to speed up the first association if the driver
370 * has already available scan results. */
371 int scan_runs; /* number of scan runs since WPS was started */
373 struct wpa_client_mlme mlme;
374 unsigned int drv_flags;
377 int pending_mic_error_report;
378 int pending_mic_error_pairwise;
379 int mic_errors_seen; /* Michael MIC errors with the current PTK */
381 struct wps_context *wps;
382 int wps_success; /* WPS success event received */
383 struct wps_er *wps_er;
384 int blacklist_cleared;
386 struct wpabuf *pending_eapol_rx;
387 struct os_time pending_eapol_rx_time;
388 u8 pending_eapol_rx_src[ETH_ALEN];
390 struct ibss_rsn *ibss_rsn;
398 size_t assoc_req_ie_len;
401 u8 mobility_domain[2];
405 #endif /* CONFIG_SME */
408 struct hostapd_iface *ap_iface;
409 #endif /* CONFIG_AP */
411 struct wpa_ssid *bgscan_ssid;
412 const struct bgscan_ops *bgscan;
417 /* wpa_supplicant.c */
418 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
420 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
422 const char * wpa_supplicant_state_txt(int state);
423 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
424 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
425 struct wpa_scan_res *bss,
426 struct wpa_ssid *ssid,
427 u8 *wpa_ie, size_t *wpa_ie_len);
428 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
429 struct wpa_scan_res *bss,
430 struct wpa_ssid *ssid);
431 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
432 struct wpa_ssid *ssid);
433 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
434 int wpa_supplicant_get_scan_results(struct wpa_supplicant *wpa_s);
435 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
436 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
438 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s, wpa_states state);
439 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
440 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
441 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
443 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
446 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
447 struct wpa_ssid *ssid);
448 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
449 struct wpa_ssid *ssid);
450 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
451 struct wpa_ssid *ssid);
452 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
454 int wpa_supplicant_set_debug_params(struct wpa_global *global,
455 int debug_level, int debug_timestamp,
456 int debug_show_keys);
458 void wpa_show_license(void);
460 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
461 struct wpa_interface *iface);
462 int wpa_supplicant_remove_iface(struct wpa_global *global,
463 struct wpa_supplicant *wpa_s);
464 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
466 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
467 int wpa_supplicant_run(struct wpa_global *global);
468 void wpa_supplicant_deinit(struct wpa_global *global);
470 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
471 struct wpa_ssid *ssid);
474 int wpa_supplicant_enabled_networks(struct wpa_config *conf);
475 void wpa_supplicant_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec);
476 void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s);
477 void wpa_supplicant_notify_scanning(struct wpa_supplicant *wpa_s,
479 struct wpa_driver_scan_params;
480 int wpa_supplicant_trigger_scan(struct wpa_supplicant *wpa_s,
481 struct wpa_driver_scan_params *params);
484 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
486 #endif /* WPA_SUPPLICANT_I_H */