]> git.ipfire.org Git - thirdparty/hostap.git/blame - wpa_supplicant/wpa_supplicant_i.h
Fix MCS set field to be based on driver info
[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;
d27df100
JM
163
164 /**
165 * override_driver - Optional driver parameter override
166 *
167 * This parameter can be used to override the driver parameter in
168 * dynamic interface addition to force a specific driver wrapper to be
169 * used instead.
170 */
171 char *override_driver;
172
173 /**
174 * override_ctrl_interface - Optional ctrl_interface override
175 *
176 * This parameter can be used to override the ctrl_interface parameter
177 * in dynamic interface addition to force a control interface to be
178 * created.
179 */
180 char *override_ctrl_interface;
6fc6879b
JM
181};
182
183/**
184 * struct wpa_global - Internal, global data for all %wpa_supplicant interfaces
185 *
186 * This structure is initialized by calling wpa_supplicant_init() when starting
187 * %wpa_supplicant.
188 */
189struct wpa_global {
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;
ac305589
JM
194 void **drv_priv;
195 size_t drv_count;
6fc6879b
JM
196};
197
198
199struct wpa_client_mlme {
200#ifdef CONFIG_CLIENT_MLME
201 enum {
202 IEEE80211_DISABLED, IEEE80211_AUTHENTICATE,
203 IEEE80211_ASSOCIATE, IEEE80211_ASSOCIATED,
204 IEEE80211_IBSS_SEARCH, IEEE80211_IBSS_JOINED
205 } state;
206 u8 prev_bssid[ETH_ALEN];
207 u8 ssid[32];
208 size_t ssid_len;
209 u16 aid;
210 u16 ap_capab, capab;
211 u8 *extra_ie; /* to be added to the end of AssocReq */
212 size_t extra_ie_len;
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;
216
217 /* The last AssocReq/Resp IEs */
218 u8 *assocreq_ies, *assocresp_ies;
219 size_t assocreq_ies_len, assocresp_ies_len;
220
221 int auth_tries, assoc_tries;
222
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;
233
234 struct os_time last_probe;
235
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;
242
243 struct os_time ibss_join_req;
244 u8 *probe_resp; /* ProbeResp template for IBSS */
245 size_t probe_resp_len;
246 u32 supp_rates_bits;
247
248 int wmm_last_param_set;
249
250 int sta_scanning;
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;
256 int scan_oper_freq;
257 int scan_oper_phymode;
258 u8 scan_ssid[32];
259 size_t scan_ssid_len;
260 int scan_skip_11b;
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
6caf9ca6
JM
269 hostapd_hw_mode phymode; /* current mode */
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;
6caf9ca6 275 struct hostapd_rate_data *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 */
308 char bridge_ifname[16];
309
310 char *confname;
311 struct wpa_config *conf;
312 int countermeasures;
313 os_time_t last_michael_mic_error;
314 u8 bssid[ETH_ALEN];
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;
322
323 /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
324 int pairwise_cipher;
325 int group_cipher;
326 int key_mgmt;
327 int mgmt_group_cipher;
328
329 void *drv_priv; /* private data used by driver_ops */
330
331 struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
332 * NULL = not yet initialized (start
ba2a573c
JM
333 * with wildcard SSID)
334 * WILDCARD_SSID_SCAN = wildcard
6fc6879b
JM
335 * SSID was used in the previous scan
336 */
ba2a573c 337#define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)
6fc6879b
JM
338
339 struct wpa_scan_results *scan_res;
340
341 struct wpa_driver_ops *driver;
342 int interface_removed; /* whether the network interface has been
343 * removed */
344 struct wpa_sm *wpa;
345 struct eapol_sm *eapol;
346
347 struct ctrl_iface_priv *ctrl_iface;
348
349 wpa_states wpa_state;
cb8564b1 350 int scanning;
6fc6879b
JM
351 int new_connection;
352 int reassociated_connection;
353
354 int eapol_received; /* number of EAPOL packets received after the
355 * previous association event */
356
357 struct scard_data *scard;
358
359 unsigned char last_eapol_src[ETH_ALEN];
360
361 int keys_cleared;
362
363 struct wpa_blacklist *blacklist;
364
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. */
a6099152 371 int scan_runs; /* number of scan runs since WPS was started */
6fc6879b
JM
372
373 struct wpa_client_mlme mlme;
c2a04078 374 unsigned int drv_flags;
80bc75f1 375 int max_scan_ssids;
46690a3b
JM
376
377 int pending_mic_error_report;
378 int pending_mic_error_pairwise;
379 int mic_errors_seen; /* Michael MIC errors with the current PTK */
116654ce
JM
380
381 struct wps_context *wps;
a6099152
JM
382 int wps_success; /* WPS success event received */
383 int blacklist_cleared;
11ef8d35 384
1ff73338
JM
385 struct wpabuf *pending_eapol_rx;
386 struct os_time pending_eapol_rx_time;
387 u8 pending_eapol_rx_src[ETH_ALEN];
388
11ef8d35 389 struct ibss_rsn *ibss_rsn;
c2a04078
JM
390
391#ifdef CONFIG_SME
392 struct {
393 u8 ssid[32];
394 size_t ssid_len;
395 int freq;
396 u8 assoc_req_ie[80];
397 size_t assoc_req_ie_len;
398 int mfp;
399 int ft_used;
400 u8 mobility_domain[2];
401 u8 *ft_ies;
402 size_t ft_ies_len;
403 } sme;
404#endif /* CONFIG_SME */
2d5b792d
JM
405
406#ifdef CONFIG_AP
407 struct hostapd_iface *ap_iface;
408#endif /* CONFIG_AP */
60b94c98
JM
409
410 struct wpa_ssid *bgscan_ssid;
411 const struct bgscan_ops *bgscan;
412 void *bgscan_priv;
6fc6879b
JM
413};
414
415
416/* wpa_supplicant.c */
0194fedb
JB
417int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);
418
6fc6879b
JM
419int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);
420
421const char * wpa_supplicant_state_txt(int state);
422int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
423int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
424 struct wpa_scan_res *bss,
425 struct wpa_ssid *ssid,
426 u8 *wpa_ie, size_t *wpa_ie_len);
427void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
428 struct wpa_scan_res *bss,
429 struct wpa_ssid *ssid);
430void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
431 struct wpa_ssid *ssid);
432void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
433int wpa_supplicant_get_scan_results(struct wpa_supplicant *wpa_s);
434void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
435void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
436 int sec, int usec);
437void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s, wpa_states state);
438struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
439void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
440void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
441 int reason_code);
442void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
443 int reason_code);
444
86b89452
WS
445void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
446 struct wpa_ssid *ssid);
447void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
448 struct wpa_ssid *ssid);
449void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
450 struct wpa_ssid *ssid);
451int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
452 int ap_scan);
453int wpa_supplicant_set_debug_params(struct wpa_global *global,
454 int debug_level, int debug_timestamp,
455 int debug_show_keys);
456
6fc6879b
JM
457void wpa_show_license(void);
458
459struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
460 struct wpa_interface *iface);
461int wpa_supplicant_remove_iface(struct wpa_global *global,
462 struct wpa_supplicant *wpa_s);
463struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
464 const char *ifname);
465struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
466int wpa_supplicant_run(struct wpa_global *global);
467void wpa_supplicant_deinit(struct wpa_global *global);
468
469int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
470 struct wpa_ssid *ssid);
471
472/* scan.c */
4f34d51a 473int wpa_supplicant_enabled_networks(struct wpa_config *conf);
6fc6879b
JM
474void wpa_supplicant_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec);
475void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s);
cb8564b1
DW
476void wpa_supplicant_notify_scanning(struct wpa_supplicant *wpa_s,
477 int scanning);
60b94c98
JM
478struct wpa_driver_scan_params;
479int wpa_supplicant_trigger_scan(struct wpa_supplicant *wpa_s,
480 struct wpa_driver_scan_params *params);
6fc6879b
JM
481
482/* events.c */
483void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);
484
6fc6879b 485#endif /* WPA_SUPPLICANT_I_H */