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