]> git.ipfire.org Git - thirdparty/hostap.git/blame - wpa_supplicant/wpa_supplicant_i.h
Clear current_bss pointer on disassociation/deauthentication
[thirdparty/hostap.git] / wpa_supplicant / wpa_supplicant_i.h
CommitLineData
6fc6879b
JM
1/*
2 * wpa_supplicant - Internal definitions
83922c2d 3 * Copyright (c) 2003-2009, Jouni Malinen <j@w1.fi>
6fc6879b
JM
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
83922c2d 18#include "utils/list.h"
2d5b792d 19#include "common/defs.h"
6fc6879b 20
7e5ba1b9
JM
21extern const char *wpa_supplicant_version;
22extern const char *wpa_supplicant_license;
23#ifndef CONFIG_NO_STDOUT_DEBUG
24extern const char *wpa_supplicant_full_license1;
25extern const char *wpa_supplicant_full_license2;
26extern const char *wpa_supplicant_full_license3;
27extern const char *wpa_supplicant_full_license4;
28extern const char *wpa_supplicant_full_license5;
29#endif /* CONFIG_NO_STDOUT_DEBUG */
30
6fc6879b
JM
31struct wpa_sm;
32struct wpa_supplicant;
11ef8d35 33struct ibss_rsn;
8d923a4a 34struct scan_info;
6fa81a3b 35struct wpa_bss;
6fc6879b
JM
36
37/*
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
40 * these structures.
41 */
42struct ctrl_iface_priv;
43struct ctrl_iface_global_priv;
8ddef94b 44struct wpas_dbus_priv;
6fc6879b
JM
45
46/**
47 * struct wpa_interface - Parameters for wpa_supplicant_add_iface()
48 */
49struct wpa_interface {
50 /**
51 * confname - Configuration name (file or profile) name
52 *
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
55 * configured.
56 */
57 const char *confname;
58
59 /**
60 * ctrl_interface - Control interface parameter
61 *
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
66 * file.
67 */
68 const char *ctrl_interface;
69
70 /**
71 * driver - Driver interface name, or %NULL to use the default driver
72 */
73 const char *driver;
74
75 /**
76 * driver_param - Driver interface parameters
77 *
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
82 * file.
83 */
84 const char *driver_param;
85
86 /**
87 * ifname - Interface name
88 */
89 const char *ifname;
90
91 /**
92 * bridge_ifname - Optional bridge interface name
93 *
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.
98 */
99 const char *bridge_ifname;
100};
101
102/**
103 * struct wpa_params - Parameters for wpa_supplicant_init()
104 */
105struct wpa_params {
106 /**
107 * daemonize - Run %wpa_supplicant in the background
108 */
109 int daemonize;
110
111 /**
112 * wait_for_monitor - Wait for a monitor program before starting
113 */
114 int wait_for_monitor;
115
116 /**
117 * pid_file - Path to a PID (process ID) file
118 *
119 * If this and daemonize are set, process ID of the background process
120 * will be written to the specified file.
121 */
122 char *pid_file;
123
124 /**
125 * wpa_debug_level - Debugging verbosity level (e.g., MSG_INFO)
126 */
127 int wpa_debug_level;
128
129 /**
130 * wpa_debug_show_keys - Whether keying material is included in debug
131 *
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.
137 */
138 int wpa_debug_show_keys;
139
140 /**
141 * wpa_debug_timestamp - Whether to include timestamp in debug messages
142 */
143 int wpa_debug_timestamp;
144
145 /**
146 * ctrl_interface - Global ctrl_iface path/parameter
147 */
148 char *ctrl_interface;
149
150 /**
151 * dbus_ctrl_interface - Enable the DBus control interface
152 */
153 int dbus_ctrl_interface;
154
155 /**
156 * wpa_debug_file_path - Path of debug file or %NULL to use stdout
157 */
158 const char *wpa_debug_file_path;
daa70d49
SL
159
160 /**
161 * wpa_debug_syslog - Enable log output through syslog
162 */
163 int wpa_debug_syslog;
d27df100
JM
164
165 /**
166 * override_driver - Optional driver parameter override
167 *
168 * This parameter can be used to override the driver parameter in
169 * dynamic interface addition to force a specific driver wrapper to be
170 * used instead.
171 */
172 char *override_driver;
173
174 /**
175 * override_ctrl_interface - Optional ctrl_interface override
176 *
177 * This parameter can be used to override the ctrl_interface parameter
178 * in dynamic interface addition to force a control interface to be
179 * created.
180 */
181 char *override_ctrl_interface;
6fc6879b
JM
182};
183
184/**
185 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
186 *
187 * This structure is initialized by calling wpa_supplicant_init() when starting
188 * %wpa_supplicant.
189 */
190struct wpa_global {
191 struct wpa_supplicant *ifaces;
192 struct wpa_params params;
193 struct ctrl_iface_global_priv *ctrl_iface;
8ddef94b 194 struct wpas_dbus_priv *dbus;
ac305589
JM
195 void **drv_priv;
196 size_t drv_count;
6fc6879b
JM
197};
198
199
200struct wpa_client_mlme {
201#ifdef CONFIG_CLIENT_MLME
202 enum {
203 IEEE80211_DISABLED, IEEE80211_AUTHENTICATE,
204 IEEE80211_ASSOCIATE, IEEE80211_ASSOCIATED,
205 IEEE80211_IBSS_SEARCH, IEEE80211_IBSS_JOINED
206 } state;
207 u8 prev_bssid[ETH_ALEN];
208 u8 ssid[32];
209 size_t ssid_len;
210 u16 aid;
211 u16 ap_capab, capab;
212 u8 *extra_ie; /* to be added to the end of AssocReq */
213 size_t extra_ie_len;
214 u8 *extra_probe_ie; /* to be added to the end of ProbeReq */
215 size_t extra_probe_ie_len;
71934751 216 enum wpa_key_mgmt key_mgmt;
6fc6879b
JM
217
218 /* The last AssocReq/Resp IEs */
219 u8 *assocreq_ies, *assocresp_ies;
220 size_t assocreq_ies_len, assocresp_ies_len;
221
222 int auth_tries, assoc_tries;
223
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;
234
235 struct os_time last_probe;
236
abd9fafa
JM
237 unsigned int auth_algs; /* bitfield of allowed auth algs
238 * (WPA_AUTH_ALG_*) */
6fc6879b
JM
239 int auth_alg; /* currently used IEEE 802.11 authentication algorithm */
240 int auth_transaction;
241
242 struct os_time ibss_join_req;
243 u8 *probe_resp; /* ProbeResp template for IBSS */
244 size_t probe_resp_len;
245 u32 supp_rates_bits;
246
247 int wmm_last_param_set;
248
249 int sta_scanning;
250 int scan_hw_mode_idx;
251 int scan_channel_idx;
252 enum { SCAN_SET_CHANNEL, SCAN_SEND_PROBE } scan_state;
253 struct os_time last_scan_completed;
254 int scan_oper_channel;
255 int scan_oper_freq;
256 int scan_oper_phymode;
257 u8 scan_ssid[32];
258 size_t scan_ssid_len;
259 int scan_skip_11b;
d009a9da 260 int *scan_freqs;
6fc6879b
JM
261
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];
266
267 int cts_protect_erp_frames;
268
71934751 269 enum hostapd_hw_mode phymode; /* current mode */
6caf9ca6 270 struct hostapd_hw_modes *modes;
6fc6879b
JM
271 size_t num_modes;
272 unsigned int hw_modes; /* bitfield of allowed hardware modes;
6caf9ca6 273 * (1 << HOSTAPD_MODE_*) */
6fc6879b 274 int num_curr_rates;
fb7842aa 275 int *curr_rates;
6fc6879b
JM
276 int freq; /* The current frequency in MHz */
277 int channel; /* The current IEEE 802.11 channel number */
278
279#ifdef CONFIG_IEEE80211R
280 u8 current_md[6];
281 u8 *ft_ies;
282 size_t ft_ies_len;
283#endif /* CONFIG_IEEE80211R */
284
285#else /* CONFIG_CLIENT_MLME */
286 int dummy; /* to keep MSVC happy */
287#endif /* CONFIG_CLIENT_MLME */
288};
289
290/**
291 * struct wpa_supplicant - Internal data for wpa_supplicant interface
292 *
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
296 * core functions.
297 */
298struct 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];
304 char ifname[100];
305#ifdef CONFIG_CTRL_IFACE_DBUS
306 char *dbus_path;
307#endif /* CONFIG_CTRL_IFACE_DBUS */
8fc2fb56
WS
308#ifdef CONFIG_CTRL_IFACE_DBUS_NEW
309 char *dbus_new_path;
310#endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
6fc6879b
JM
311 char bridge_ifname[16];
312
313 char *confname;
314 struct wpa_config *conf;
315 int countermeasures;
316 os_time_t last_michael_mic_error;
317 u8 bssid[ETH_ALEN];
318 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
319 * field contains the targer BSSID. */
320 int reassociate; /* reassociation requested */
321 int disconnected; /* all connections disabled; i.e., do no reassociate
322 * before this has been cleared */
323 struct wpa_ssid *current_ssid;
8f770587 324 struct wpa_bss *current_bss;
6fc6879b 325 int ap_ies_from_associnfo;
4832ecd7 326 unsigned int assoc_freq;
6fc6879b
JM
327
328 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
329 int pairwise_cipher;
330 int group_cipher;
331 int key_mgmt;
332 int mgmt_group_cipher;
333
334 void *drv_priv; /* private data used by driver_ops */
8a5ab9f5 335 void *global_drv_priv;
6fc6879b
JM
336
337 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
338 * NULL = not yet initialized (start
ba2a573c
JM
339 * with wildcard SSID)
340 * WILDCARD_SSID_SCAN = wildcard
6fc6879b
JM
341 * SSID was used in the previous scan
342 */
ba2a573c 343#define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
6fc6879b 344
83922c2d 345 struct dl_list bss; /* struct wpa_bss::list */
d4bf8f13 346 struct dl_list bss_id; /* struct wpa_bss::list_id */
83922c2d
JM
347 size_t num_bss;
348 unsigned int bss_update_idx;
349 unsigned int bss_next_id;
6fc6879b
JM
350
351 struct wpa_driver_ops *driver;
352 int interface_removed; /* whether the network interface has been
353 * removed */
354 struct wpa_sm *wpa;
355 struct eapol_sm *eapol;
356
357 struct ctrl_iface_priv *ctrl_iface;
358
71934751 359 enum wpa_states wpa_state;
cb8564b1 360 int scanning;
6fc6879b
JM
361 int new_connection;
362 int reassociated_connection;
363
364 int eapol_received; /* number of EAPOL packets received after the
365 * previous association event */
366
367 struct scard_data *scard;
368
369 unsigned char last_eapol_src[ETH_ALEN];
370
371 int keys_cleared;
372
373 struct wpa_blacklist *blacklist;
374
375 int scan_req; /* manual scan request; this forces a scan even if there
376 * are no enabled networks in the configuration */
377 int scan_res_tried; /* whether ap_scan=1 mode has tried to fetch scan
378 * results without a new scan request; this is used
379 * to speed up the first association if the driver
380 * has already available scan results. */
a6099152 381 int scan_runs; /* number of scan runs since WPS was started */
6fc6879b
JM
382
383 struct wpa_client_mlme mlme;
c2a04078 384 unsigned int drv_flags;
80bc75f1 385 int max_scan_ssids;
46690a3b
JM
386
387 int pending_mic_error_report;
388 int pending_mic_error_pairwise;
389 int mic_errors_seen; /* Michael MIC errors with the current PTK */
116654ce
JM
390
391 struct wps_context *wps;
a6099152 392 int wps_success; /* WPS success event received */
e9bcfebf 393 struct wps_er *wps_er;
a6099152 394 int blacklist_cleared;
11ef8d35 395
1ff73338
JM
396 struct wpabuf *pending_eapol_rx;
397 struct os_time pending_eapol_rx_time;
398 u8 pending_eapol_rx_src[ETH_ALEN];
399
11ef8d35 400 struct ibss_rsn *ibss_rsn;
c2a04078
JM
401
402#ifdef CONFIG_SME
403 struct {
404 u8 ssid[32];
405 size_t ssid_len;
406 int freq;
407 u8 assoc_req_ie[80];
408 size_t assoc_req_ie_len;
409 int mfp;
410 int ft_used;
411 u8 mobility_domain[2];
412 u8 *ft_ies;
413 size_t ft_ies_len;
62fa124c
JM
414 u8 prev_bssid[ETH_ALEN];
415 int prev_bssid_set;
c2a04078
JM
416 } sme;
417#endif /* CONFIG_SME */
2d5b792d
JM
418
419#ifdef CONFIG_AP
420 struct hostapd_iface *ap_iface;
421#endif /* CONFIG_AP */
60b94c98
JM
422
423 struct wpa_ssid *bgscan_ssid;
424 const struct bgscan_ops *bgscan;
425 void *bgscan_priv;
6fc6879b
JM
426};
427
428
429/* wpa_supplicant.c */
0194fedb
JB
430int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
431
6fc6879b
JM
432int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
433
71934751 434const char * wpa_supplicant_state_txt(enum wpa_states state);
6fc6879b
JM
435int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
436int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
6fa81a3b 437 struct wpa_bss *bss, struct wpa_ssid *ssid,
6fc6879b
JM
438 u8 *wpa_ie, size_t *wpa_ie_len);
439void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
6fa81a3b 440 struct wpa_bss *bss,
6fc6879b
JM
441 struct wpa_ssid *ssid);
442void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
443 struct wpa_ssid *ssid);
444void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
6fc6879b
JM
445void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
446void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
447 int sec, int usec);
71934751
JM
448void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
449 enum wpa_states state);
6fc6879b
JM
450struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
451void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
452void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
453 int reason_code);
454void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
455 int reason_code);
456
86b89452
WS
457void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
458 struct wpa_ssid *ssid);
459void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
460 struct wpa_ssid *ssid);
461void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
462 struct wpa_ssid *ssid);
463int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
464 int ap_scan);
465int wpa_supplicant_set_debug_params(struct wpa_global *global,
466 int debug_level, int debug_timestamp,
467 int debug_show_keys);
468
6fc6879b
JM
469void wpa_show_license(void);
470
471struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
472 struct wpa_interface *iface);
473int wpa_supplicant_remove_iface(struct wpa_global *global,
474 struct wpa_supplicant *wpa_s);
475struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
476 const char *ifname);
477struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
478int wpa_supplicant_run(struct wpa_global *global);
479void wpa_supplicant_deinit(struct wpa_global *global);
480
481int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
482 struct wpa_ssid *ssid);
1a1bf008 483void wpa_supplicant_terminate_proc(struct wpa_global *global);
a8e0505b
JM
484void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
485 const u8 *buf, size_t len);
6fc6879b 486
6fc6879b
JM
487/* events.c */
488void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
489
12760815
JM
490/* eap_register.c */
491int eap_register_methods(void);
492
6fc6879b 493#endif /* WPA_SUPPLICANT_I_H */