2 * wpa_supplicant - Internal definitions
3 * Copyright (c) 2003-2009, 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 "utils/list.h"
19 #include "common/defs.h"
21 extern const char *wpa_supplicant_version;
22 extern const char *wpa_supplicant_license;
23 #ifndef CONFIG_NO_STDOUT_DEBUG
24 extern const char *wpa_supplicant_full_license1;
25 extern const char *wpa_supplicant_full_license2;
26 extern const char *wpa_supplicant_full_license3;
27 extern const char *wpa_supplicant_full_license4;
28 extern const char *wpa_supplicant_full_license5;
29 #endif /* CONFIG_NO_STDOUT_DEBUG */
32 struct wpa_supplicant;
38 * Forward declarations of private structures used within the ctrl_iface
39 * backends. Other parts of wpa_supplicant do not have access to data stored in
42 struct ctrl_iface_priv;
43 struct ctrl_iface_global_priv;
44 struct wpas_dbus_priv;
47 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
49 struct wpa_interface {
51 * confname - Configuration name (file or profile) name
53 * This can also be %NULL when a configuration file is not used. In
54 * that case, ctrl_interface must be set to allow the interface to be
60 * ctrl_interface - Control interface parameter
62 * If a configuration file is not used, this variable can be used to
63 * set the ctrl_interface parameter that would have otherwise been read
64 * from the configuration file. If both confname and ctrl_interface are
65 * set, ctrl_interface is used to override the value from configuration
68 const char *ctrl_interface;
71 * driver - Driver interface name, or %NULL to use the default driver
76 * driver_param - Driver interface parameters
78 * If a configuration file is not used, this variable can be used to
79 * set the driver_param parameters that would have otherwise been read
80 * from the configuration file. If both confname and driver_param are
81 * set, driver_param is used to override the value from configuration
84 const char *driver_param;
87 * ifname - Interface name
92 * bridge_ifname - Optional bridge interface name
94 * If the driver interface (ifname) is included in a Linux bridge
95 * device, the bridge interface may need to be used for receiving EAPOL
96 * frames. This can be enabled by setting this variable to enable
97 * receiving of EAPOL frames from an additional interface.
99 const char *bridge_ifname;
103 * struct wpa_params - Parameters for wpa_supplicant_init()
107 * daemonize - Run %wpa_supplicant in the background
112 * wait_for_monitor - Wait for a monitor program before starting
114 int wait_for_monitor;
117 * pid_file - Path to a PID (process ID) file
119 * If this and daemonize are set, process ID of the background process
120 * will be written to the specified file.
125 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
130 * wpa_debug_show_keys - Whether keying material is included in debug
132 * This parameter can be used to allow keying material to be included
133 * in debug messages. This is a security risk and this option should
134 * not be enabled in normal configuration. If needed during
135 * development or while troubleshooting, this option can provide more
136 * details for figuring out what is happening.
138 int wpa_debug_show_keys;
141 * wpa_debug_timestamp - Whether to include timestamp in debug messages
143 int wpa_debug_timestamp;
146 * ctrl_interface - Global ctrl_iface path/parameter
148 char *ctrl_interface;
151 * dbus_ctrl_interface - Enable the DBus control interface
153 int dbus_ctrl_interface;
156 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
158 const char *wpa_debug_file_path;
161 * wpa_debug_syslog - Enable log output through syslog
163 int wpa_debug_syslog;
166 * override_driver - Optional driver parameter override
168 * This parameter can be used to override the driver parameter in
169 * dynamic interface addition to force a specific driver wrapper to be
172 char *override_driver;
175 * override_ctrl_interface - Optional ctrl_interface override
177 * This parameter can be used to override the ctrl_interface parameter
178 * in dynamic interface addition to force a control interface to be
181 char *override_ctrl_interface;
185 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
187 * This structure is initialized by calling wpa_supplicant_init() when starting
191 struct wpa_supplicant *ifaces;
192 struct wpa_params params;
193 struct ctrl_iface_global_priv *ctrl_iface;
194 struct wpas_dbus_priv *dbus;
200 struct wpa_client_mlme {
201 #ifdef CONFIG_CLIENT_MLME
203 IEEE80211_DISABLED, IEEE80211_AUTHENTICATE,
204 IEEE80211_ASSOCIATE, IEEE80211_ASSOCIATED,
205 IEEE80211_IBSS_SEARCH, IEEE80211_IBSS_JOINED
207 u8 prev_bssid[ETH_ALEN];
212 u8 *extra_ie; /* to be added to the end of AssocReq */
214 u8 *extra_probe_ie; /* to be added to the end of ProbeReq */
215 size_t extra_probe_ie_len;
216 enum wpa_key_mgmt key_mgmt;
218 /* The last AssocReq/Resp IEs */
219 u8 *assocreq_ies, *assocresp_ies;
220 size_t assocreq_ies_len, assocresp_ies_len;
222 int auth_tries, assoc_tries;
224 unsigned int ssid_set:1;
225 unsigned int bssid_set:1;
226 unsigned int prev_bssid_set:1;
227 unsigned int authenticated:1;
228 unsigned int associated:1;
229 unsigned int probereq_poll:1;
230 unsigned int use_protection:1;
231 unsigned int create_ibss:1;
232 unsigned int mixed_cell:1;
233 unsigned int wmm_enabled:1;
235 struct os_time last_probe;
237 #define IEEE80211_AUTH_ALG_OPEN BIT(0)
238 #define IEEE80211_AUTH_ALG_SHARED_KEY BIT(1)
239 #define IEEE80211_AUTH_ALG_LEAP BIT(2)
240 unsigned int auth_algs; /* bitfield of allowed auth algs */
241 int auth_alg; /* currently used IEEE 802.11 authentication algorithm */
242 int auth_transaction;
244 struct os_time ibss_join_req;
245 u8 *probe_resp; /* ProbeResp template for IBSS */
246 size_t probe_resp_len;
249 int wmm_last_param_set;
252 int scan_hw_mode_idx;
253 int scan_channel_idx;
254 enum { SCAN_SET_CHANNEL, SCAN_SEND_PROBE } scan_state;
255 struct os_time last_scan_completed;
256 int scan_oper_channel;
258 int scan_oper_phymode;
260 size_t scan_ssid_len;
264 struct ieee80211_sta_bss *sta_bss_list;
265 #define STA_HASH_SIZE 256
266 #define STA_HASH(sta) (sta[5])
267 struct ieee80211_sta_bss *sta_bss_hash[STA_HASH_SIZE];
269 int cts_protect_erp_frames;
271 enum hostapd_hw_mode phymode; /* current mode */
272 struct hostapd_hw_modes *modes;
274 unsigned int hw_modes; /* bitfield of allowed hardware modes;
275 * (1 << HOSTAPD_MODE_*) */
278 int freq; /* The current frequency in MHz */
279 int channel; /* The current IEEE 802.11 channel number */
281 #ifdef CONFIG_IEEE80211R
285 #endif /* CONFIG_IEEE80211R */
287 #else /* CONFIG_CLIENT_MLME */
288 int dummy; /* to keep MSVC happy */
289 #endif /* CONFIG_CLIENT_MLME */
293 * struct wpa_supplicant - Internal data for wpa_supplicant interface
295 * This structure contains the internal data for core wpa_supplicant code. This
296 * should be only used directly from the core code. However, a pointer to this
297 * data is used from other files as an arbitrary context pointer in calls to
300 struct wpa_supplicant {
301 struct wpa_global *global;
302 struct wpa_supplicant *next;
303 struct l2_packet_data *l2;
304 struct l2_packet_data *l2_br;
305 unsigned char own_addr[ETH_ALEN];
307 #ifdef CONFIG_CTRL_IFACE_DBUS
309 #endif /* CONFIG_CTRL_IFACE_DBUS */
310 #ifdef CONFIG_CTRL_IFACE_DBUS_NEW
312 #endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
313 char bridge_ifname[16];
316 struct wpa_config *conf;
318 os_time_t last_michael_mic_error;
320 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
321 * field contains the targer BSSID. */
322 int reassociate; /* reassociation requested */
323 int disconnected; /* all connections disabled; i.e., do no reassociate
324 * before this has been cleared */
325 struct wpa_ssid *current_ssid;
326 int ap_ies_from_associnfo;
327 unsigned int assoc_freq;
329 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
333 int mgmt_group_cipher;
335 void *drv_priv; /* private data used by driver_ops */
336 void *global_drv_priv;
338 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
339 * NULL = not yet initialized (start
340 * with wildcard SSID)
341 * WILDCARD_SSID_SCAN = wildcard
342 * SSID was used in the previous scan
344 #define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
346 struct dl_list bss; /* struct wpa_bss::list */
347 struct dl_list bss_id; /* struct wpa_bss::list_id */
349 unsigned int bss_update_idx;
350 unsigned int bss_next_id;
352 struct wpa_driver_ops *driver;
353 int interface_removed; /* whether the network interface has been
356 struct eapol_sm *eapol;
358 struct ctrl_iface_priv *ctrl_iface;
360 enum wpa_states wpa_state;
363 int reassociated_connection;
365 int eapol_received; /* number of EAPOL packets received after the
366 * previous association event */
368 struct scard_data *scard;
370 unsigned char last_eapol_src[ETH_ALEN];
374 struct wpa_blacklist *blacklist;
376 int scan_req; /* manual scan request; this forces a scan even if there
377 * are no enabled networks in the configuration */
378 int scan_res_tried; /* whether ap_scan=1 mode has tried to fetch scan
379 * results without a new scan request; this is used
380 * to speed up the first association if the driver
381 * has already available scan results. */
382 int scan_runs; /* number of scan runs since WPS was started */
384 struct wpa_client_mlme mlme;
385 unsigned int drv_flags;
388 int pending_mic_error_report;
389 int pending_mic_error_pairwise;
390 int mic_errors_seen; /* Michael MIC errors with the current PTK */
392 struct wps_context *wps;
393 int wps_success; /* WPS success event received */
394 struct wps_er *wps_er;
395 int blacklist_cleared;
397 struct wpabuf *pending_eapol_rx;
398 struct os_time pending_eapol_rx_time;
399 u8 pending_eapol_rx_src[ETH_ALEN];
401 struct ibss_rsn *ibss_rsn;
409 size_t assoc_req_ie_len;
412 u8 mobility_domain[2];
415 u8 prev_bssid[ETH_ALEN];
418 #endif /* CONFIG_SME */
421 struct hostapd_iface *ap_iface;
422 #endif /* CONFIG_AP */
424 struct wpa_ssid *bgscan_ssid;
425 const struct bgscan_ops *bgscan;
430 /* wpa_supplicant.c */
431 int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
433 int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
435 const char * wpa_supplicant_state_txt(enum wpa_states state);
436 int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
437 int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
438 struct wpa_bss *bss, struct wpa_ssid *ssid,
439 u8 *wpa_ie, size_t *wpa_ie_len);
440 void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
442 struct wpa_ssid *ssid);
443 void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
444 struct wpa_ssid *ssid);
445 void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
446 struct wpa_scan_results *
447 wpa_supplicant_get_scan_results(struct wpa_supplicant *wpa_s,
448 struct scan_info *info, int new_scan);
449 int wpa_supplicant_update_scan_results(struct wpa_supplicant *wpa_s);
450 void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
451 void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
453 void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
454 enum wpa_states state);
455 struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
456 void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
457 void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
459 void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
462 void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
463 struct wpa_ssid *ssid);
464 void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
465 struct wpa_ssid *ssid);
466 void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
467 struct wpa_ssid *ssid);
468 int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
470 int wpa_supplicant_set_debug_params(struct wpa_global *global,
471 int debug_level, int debug_timestamp,
472 int debug_show_keys);
474 void wpa_show_license(void);
476 struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
477 struct wpa_interface *iface);
478 int wpa_supplicant_remove_iface(struct wpa_global *global,
479 struct wpa_supplicant *wpa_s);
480 struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
482 struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
483 int wpa_supplicant_run(struct wpa_global *global);
484 void wpa_supplicant_deinit(struct wpa_global *global);
486 int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
487 struct wpa_ssid *ssid);
488 void wpa_supplicant_terminate_proc(struct wpa_global *global);
491 int wpa_supplicant_enabled_networks(struct wpa_config *conf);
492 void wpa_supplicant_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec);
493 void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s);
494 void wpa_supplicant_notify_scanning(struct wpa_supplicant *wpa_s,
496 struct wpa_driver_scan_params;
497 int wpa_supplicant_trigger_scan(struct wpa_supplicant *wpa_s,
498 struct wpa_driver_scan_params *params);
501 void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
504 int eap_register_methods(void);
506 #endif /* WPA_SUPPLICANT_I_H */