]> git.ipfire.org Git - thirdparty/hostap.git/blame - wpa_supplicant/wpa_supplicant_i.h
Allow Probe Request callbacks to terminate iteration
[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 31struct wpa_scan_result;
2d5b792d 32struct wpa_scan_res;
6fc6879b
JM
33struct wpa_sm;
34struct wpa_supplicant;
11ef8d35 35struct ibss_rsn;
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;
44struct ctrl_iface_dbus_priv;
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;
8fc2fb56 194 /* old DBus API data */
6fc6879b 195 struct ctrl_iface_dbus_priv *dbus_ctrl_iface;
8fc2fb56
WS
196 /* new DBus API data */
197 struct ctrl_iface_dbus_new_priv *dbus_new_ctrl_iface;
ac305589
JM
198 void **drv_priv;
199 size_t drv_count;
6fc6879b
JM
200};
201
202
203struct wpa_client_mlme {
204#ifdef CONFIG_CLIENT_MLME
205 enum {
206 IEEE80211_DISABLED, IEEE80211_AUTHENTICATE,
207 IEEE80211_ASSOCIATE, IEEE80211_ASSOCIATED,
208 IEEE80211_IBSS_SEARCH, IEEE80211_IBSS_JOINED
209 } state;
210 u8 prev_bssid[ETH_ALEN];
211 u8 ssid[32];
212 size_t ssid_len;
213 u16 aid;
214 u16 ap_capab, capab;
215 u8 *extra_ie; /* to be added to the end of AssocReq */
216 size_t extra_ie_len;
217 u8 *extra_probe_ie; /* to be added to the end of ProbeReq */
218 size_t extra_probe_ie_len;
71934751 219 enum wpa_key_mgmt key_mgmt;
6fc6879b
JM
220
221 /* The last AssocReq/Resp IEs */
222 u8 *assocreq_ies, *assocresp_ies;
223 size_t assocreq_ies_len, assocresp_ies_len;
224
225 int auth_tries, assoc_tries;
226
227 unsigned int ssid_set:1;
228 unsigned int bssid_set:1;
229 unsigned int prev_bssid_set:1;
230 unsigned int authenticated:1;
231 unsigned int associated:1;
232 unsigned int probereq_poll:1;
233 unsigned int use_protection:1;
234 unsigned int create_ibss:1;
235 unsigned int mixed_cell:1;
236 unsigned int wmm_enabled:1;
237
238 struct os_time last_probe;
239
240#define IEEE80211_AUTH_ALG_OPEN BIT(0)
241#define IEEE80211_AUTH_ALG_SHARED_KEY BIT(1)
242#define IEEE80211_AUTH_ALG_LEAP BIT(2)
243 unsigned int auth_algs; /* bitfield of allowed auth algs */
244 int auth_alg; /* currently used IEEE 802.11 authentication algorithm */
245 int auth_transaction;
246
247 struct os_time ibss_join_req;
248 u8 *probe_resp; /* ProbeResp template for IBSS */
249 size_t probe_resp_len;
250 u32 supp_rates_bits;
251
252 int wmm_last_param_set;
253
254 int sta_scanning;
255 int scan_hw_mode_idx;
256 int scan_channel_idx;
257 enum { SCAN_SET_CHANNEL, SCAN_SEND_PROBE } scan_state;
258 struct os_time last_scan_completed;
259 int scan_oper_channel;
260 int scan_oper_freq;
261 int scan_oper_phymode;
262 u8 scan_ssid[32];
263 size_t scan_ssid_len;
264 int scan_skip_11b;
265
266 struct ieee80211_sta_bss *sta_bss_list;
267#define STA_HASH_SIZE 256
268#define STA_HASH(sta) (sta[5])
269 struct ieee80211_sta_bss *sta_bss_hash[STA_HASH_SIZE];
270
271 int cts_protect_erp_frames;
272
71934751 273 enum hostapd_hw_mode phymode; /* current mode */
6caf9ca6 274 struct hostapd_hw_modes *modes;
6fc6879b
JM
275 size_t num_modes;
276 unsigned int hw_modes; /* bitfield of allowed hardware modes;
6caf9ca6 277 * (1 << HOSTAPD_MODE_*) */
6fc6879b 278 int num_curr_rates;
fb7842aa 279 int *curr_rates;
6fc6879b
JM
280 int freq; /* The current frequency in MHz */
281 int channel; /* The current IEEE 802.11 channel number */
282
283#ifdef CONFIG_IEEE80211R
284 u8 current_md[6];
285 u8 *ft_ies;
286 size_t ft_ies_len;
287#endif /* CONFIG_IEEE80211R */
288
289#else /* CONFIG_CLIENT_MLME */
290 int dummy; /* to keep MSVC happy */
291#endif /* CONFIG_CLIENT_MLME */
292};
293
294/**
295 * struct wpa_supplicant - Internal data for wpa_supplicant interface
296 *
297 * This structure contains the internal data for core wpa_supplicant code. This
298 * should be only used directly from the core code. However, a pointer to this
299 * data is used from other files as an arbitrary context pointer in calls to
300 * core functions.
301 */
302struct wpa_supplicant {
303 struct wpa_global *global;
304 struct wpa_supplicant *next;
305 struct l2_packet_data *l2;
306 struct l2_packet_data *l2_br;
307 unsigned char own_addr[ETH_ALEN];
308 char ifname[100];
309#ifdef CONFIG_CTRL_IFACE_DBUS
310 char *dbus_path;
311#endif /* CONFIG_CTRL_IFACE_DBUS */
8fc2fb56
WS
312#ifdef CONFIG_CTRL_IFACE_DBUS_NEW
313 char *dbus_new_path;
314#endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
6fc6879b
JM
315 char bridge_ifname[16];
316
317 char *confname;
318 struct wpa_config *conf;
319 int countermeasures;
320 os_time_t last_michael_mic_error;
321 u8 bssid[ETH_ALEN];
322 u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
323 * field contains the targer BSSID. */
324 int reassociate; /* reassociation requested */
325 int disconnected; /* all connections disabled; i.e., do no reassociate
326 * before this has been cleared */
327 struct wpa_ssid *current_ssid;
328 int ap_ies_from_associnfo;
329
330 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
331 int pairwise_cipher;
332 int group_cipher;
333 int key_mgmt;
334 int mgmt_group_cipher;
335
336 void *drv_priv; /* private data used by driver_ops */
8a5ab9f5 337 void *global_drv_priv;
6fc6879b
JM
338
339 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
340 * NULL = not yet initialized (start
ba2a573c
JM
341 * with wildcard SSID)
342 * WILDCARD_SSID_SCAN = wildcard
6fc6879b
JM
343 * SSID was used in the previous scan
344 */
ba2a573c 345#define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
6fc6879b
JM
346
347 struct wpa_scan_results *scan_res;
83922c2d 348 struct dl_list bss; /* struct wpa_bss::list */
d4bf8f13 349 struct dl_list bss_id; /* struct wpa_bss::list_id */
83922c2d
JM
350 size_t num_bss;
351 unsigned int bss_update_idx;
352 unsigned int bss_next_id;
6fc6879b
JM
353
354 struct wpa_driver_ops *driver;
355 int interface_removed; /* whether the network interface has been
356 * removed */
357 struct wpa_sm *wpa;
358 struct eapol_sm *eapol;
359
360 struct ctrl_iface_priv *ctrl_iface;
361
71934751 362 enum wpa_states wpa_state;
cb8564b1 363 int scanning;
6fc6879b
JM
364 int new_connection;
365 int reassociated_connection;
366
367 int eapol_received; /* number of EAPOL packets received after the
368 * previous association event */
369
370 struct scard_data *scard;
371
372 unsigned char last_eapol_src[ETH_ALEN];
373
374 int keys_cleared;
375
376 struct wpa_blacklist *blacklist;
377
378 int scan_req; /* manual scan request; this forces a scan even if there
379 * are no enabled networks in the configuration */
380 int scan_res_tried; /* whether ap_scan=1 mode has tried to fetch scan
381 * results without a new scan request; this is used
382 * to speed up the first association if the driver
383 * has already available scan results. */
a6099152 384 int scan_runs; /* number of scan runs since WPS was started */
6fc6879b
JM
385
386 struct wpa_client_mlme mlme;
c2a04078 387 unsigned int drv_flags;
80bc75f1 388 int max_scan_ssids;
46690a3b
JM
389
390 int pending_mic_error_report;
391 int pending_mic_error_pairwise;
392 int mic_errors_seen; /* Michael MIC errors with the current PTK */
116654ce
JM
393
394 struct wps_context *wps;
a6099152 395 int wps_success; /* WPS success event received */
e9bcfebf 396 struct wps_er *wps_er;
a6099152 397 int blacklist_cleared;
11ef8d35 398
1ff73338
JM
399 struct wpabuf *pending_eapol_rx;
400 struct os_time pending_eapol_rx_time;
401 u8 pending_eapol_rx_src[ETH_ALEN];
402
11ef8d35 403 struct ibss_rsn *ibss_rsn;
c2a04078
JM
404
405#ifdef CONFIG_SME
406 struct {
407 u8 ssid[32];
408 size_t ssid_len;
409 int freq;
410 u8 assoc_req_ie[80];
411 size_t assoc_req_ie_len;
412 int mfp;
413 int ft_used;
414 u8 mobility_domain[2];
415 u8 *ft_ies;
416 size_t ft_ies_len;
62fa124c
JM
417 u8 prev_bssid[ETH_ALEN];
418 int prev_bssid_set;
c2a04078
JM
419 } sme;
420#endif /* CONFIG_SME */
2d5b792d
JM
421
422#ifdef CONFIG_AP
423 struct hostapd_iface *ap_iface;
424#endif /* CONFIG_AP */
60b94c98
JM
425
426 struct wpa_ssid *bgscan_ssid;
427 const struct bgscan_ops *bgscan;
428 void *bgscan_priv;
6fc6879b
JM
429};
430
431
432/* wpa_supplicant.c */
0194fedb
JB
433int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
434
6fc6879b
JM
435int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
436
71934751 437const char * wpa_supplicant_state_txt(enum wpa_states state);
6fc6879b
JM
438int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
439int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
440 struct wpa_scan_res *bss,
441 struct wpa_ssid *ssid,
442 u8 *wpa_ie, size_t *wpa_ie_len);
443void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
444 struct wpa_scan_res *bss,
445 struct wpa_ssid *ssid);
446void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
447 struct wpa_ssid *ssid);
448void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
449int wpa_supplicant_get_scan_results(struct wpa_supplicant *wpa_s);
450void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
451void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
452 int sec, int usec);
71934751
JM
453void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s,
454 enum wpa_states state);
6fc6879b
JM
455struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
456void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
457void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
458 int reason_code);
459void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
460 int reason_code);
461
86b89452
WS
462void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
463 struct wpa_ssid *ssid);
464void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
465 struct wpa_ssid *ssid);
466void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
467 struct wpa_ssid *ssid);
468int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
469 int ap_scan);
470int wpa_supplicant_set_debug_params(struct wpa_global *global,
471 int debug_level, int debug_timestamp,
472 int debug_show_keys);
473
6fc6879b
JM
474void wpa_show_license(void);
475
476struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
477 struct wpa_interface *iface);
478int wpa_supplicant_remove_iface(struct wpa_global *global,
479 struct wpa_supplicant *wpa_s);
480struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
481 const char *ifname);
482struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
483int wpa_supplicant_run(struct wpa_global *global);
484void wpa_supplicant_deinit(struct wpa_global *global);
485
486int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
487 struct wpa_ssid *ssid);
1a1bf008 488void wpa_supplicant_terminate_proc(struct wpa_global *global);
6fc6879b
JM
489
490/* scan.c */
4f34d51a 491int wpa_supplicant_enabled_networks(struct wpa_config *conf);
6fc6879b
JM
492void wpa_supplicant_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec);
493void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s);
cb8564b1
DW
494void wpa_supplicant_notify_scanning(struct wpa_supplicant *wpa_s,
495 int scanning);
60b94c98
JM
496struct wpa_driver_scan_params;
497int wpa_supplicant_trigger_scan(struct wpa_supplicant *wpa_s,
498 struct wpa_driver_scan_params *params);
6fc6879b
JM
499
500/* events.c */
501void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
502
12760815
JM
503/* eap_register.c */
504int eap_register_methods(void);
505
6fc6879b 506#endif /* WPA_SUPPLICANT_I_H */