]>
Commit | Line | Data |
---|---|---|
6fc6879b JM |
1 | /* |
2 | * WPA Supplicant - driver interface definition | |
d3a98225 | 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 DRIVER_H | |
16 | #define DRIVER_H | |
17 | ||
18 | #define WPA_SUPPLICANT_DRIVER_VERSION 3 | |
19 | ||
20 | #include "defs.h" | |
21 | ||
c5121837 JM |
22 | #define HOSTAPD_CHAN_DISABLED 0x00000001 |
23 | #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002 | |
24 | #define HOSTAPD_CHAN_NO_IBSS 0x00000004 | |
25 | #define HOSTAPD_CHAN_RADAR 0x00000008 | |
26 | ||
27 | struct hostapd_channel_data { | |
28 | short chan; /* channel number (IEEE 802.11) */ | |
29 | short freq; /* frequency in MHz */ | |
30 | int flag; /* flag for hostapd use (HOSTAPD_CHAN_*) */ | |
31 | u8 max_tx_power; /* maximum transmit power in dBm */ | |
32 | }; | |
33 | ||
34 | #define HOSTAPD_RATE_ERP 0x00000001 | |
35 | #define HOSTAPD_RATE_BASIC 0x00000002 | |
36 | #define HOSTAPD_RATE_PREAMBLE2 0x00000004 | |
37 | #define HOSTAPD_RATE_SUPPORTED 0x00000010 | |
38 | #define HOSTAPD_RATE_OFDM 0x00000020 | |
39 | #define HOSTAPD_RATE_CCK 0x00000040 | |
40 | #define HOSTAPD_RATE_MANDATORY 0x00000100 | |
41 | ||
42 | struct hostapd_rate_data { | |
43 | int rate; /* rate in 100 kbps */ | |
44 | int flags; /* HOSTAPD_RATE_ flags */ | |
45 | }; | |
46 | ||
47 | struct hostapd_hw_modes { | |
48 | hostapd_hw_mode mode; | |
49 | int num_channels; | |
50 | struct hostapd_channel_data *channels; | |
51 | int num_rates; | |
52 | struct hostapd_rate_data *rates; | |
53 | u16 ht_capab; | |
54 | }; | |
55 | ||
56 | ||
6fc6879b JM |
57 | #define AUTH_ALG_OPEN_SYSTEM 0x01 |
58 | #define AUTH_ALG_SHARED_KEY 0x02 | |
59 | #define AUTH_ALG_LEAP 0x04 | |
c2a04078 | 60 | #define AUTH_ALG_FT 0x08 |
6fc6879b JM |
61 | |
62 | #define IEEE80211_MODE_INFRA 0 | |
63 | #define IEEE80211_MODE_IBSS 1 | |
ad1e68e6 | 64 | #define IEEE80211_MODE_AP 2 |
6fc6879b JM |
65 | |
66 | #define IEEE80211_CAP_ESS 0x0001 | |
67 | #define IEEE80211_CAP_IBSS 0x0002 | |
68 | #define IEEE80211_CAP_PRIVACY 0x0010 | |
69 | ||
70 | #define SSID_MAX_WPA_IE_LEN 40 | |
71 | /** | |
72 | * struct wpa_scan_result - Scan results (old structure) | |
73 | * @bssid: BSSID | |
74 | * @ssid: SSID | |
75 | * @ssid_len: length of the ssid | |
76 | * @wpa_ie: WPA IE | |
77 | * @wpa_ie_len: length of the wpa_ie | |
78 | * @rsn_ie: RSN IE | |
79 | * @rsn_ie_len: length of the RSN IE | |
80 | * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1) | |
81 | * @caps: capability information field in host byte order | |
82 | * @qual: signal quality | |
83 | * @noise: noise level | |
84 | * @level: signal level | |
85 | * @maxrate: maximum supported rate | |
86 | * @mdie_present: Whether MDIE was included in Beacon/ProbeRsp frame | |
87 | * @mdie: Mobility domain identifier IE (IEEE 802.11r MDIE) (starting from | |
88 | * IE type field) | |
89 | * @tsf: Timestamp | |
90 | * | |
91 | * This structure is used as a generic format for scan results from the | |
92 | * driver. Each driver interface implementation is responsible for converting | |
93 | * the driver or OS specific scan results into this format. | |
94 | * | |
95 | * This structure is the old data structure used for scan results. It is | |
96 | * obsoleted by the new struct wpa_scan_res structure and the old version is | |
97 | * only included for backwards compatibility with existing driver wrapper | |
98 | * implementations. New implementations are encouraged to implement for struct | |
99 | * wpa_scan_res. The old structure will be removed at some point. | |
100 | */ | |
101 | struct wpa_scan_result { | |
102 | u8 bssid[ETH_ALEN]; | |
103 | u8 ssid[32]; | |
104 | size_t ssid_len; | |
105 | u8 wpa_ie[SSID_MAX_WPA_IE_LEN]; | |
106 | size_t wpa_ie_len; | |
107 | u8 rsn_ie[SSID_MAX_WPA_IE_LEN]; | |
108 | size_t rsn_ie_len; | |
109 | int freq; | |
110 | u16 caps; | |
111 | int qual; | |
112 | int noise; | |
113 | int level; | |
114 | int maxrate; | |
115 | int mdie_present; | |
116 | u8 mdie[5]; | |
117 | u64 tsf; | |
118 | }; | |
119 | ||
120 | ||
7c2849d2 JM |
121 | #define WPA_SCAN_QUAL_INVALID BIT(0) |
122 | #define WPA_SCAN_NOISE_INVALID BIT(1) | |
123 | #define WPA_SCAN_LEVEL_INVALID BIT(2) | |
124 | #define WPA_SCAN_LEVEL_DBM BIT(3) | |
125 | ||
6fc6879b JM |
126 | /** |
127 | * struct wpa_scan_res - Scan result for an BSS/IBSS | |
7c2849d2 | 128 | * @flags: information flags about the BSS/IBSS (WPA_SCAN_*) |
6fc6879b JM |
129 | * @bssid: BSSID |
130 | * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1) | |
131 | * @beacon_int: beacon interval in TUs (host byte order) | |
132 | * @caps: capability information field in host byte order | |
133 | * @qual: signal quality | |
134 | * @noise: noise level | |
135 | * @level: signal level | |
136 | * @tsf: Timestamp | |
137 | * @ie_len: length of the following IE field in octets | |
138 | * | |
139 | * This structure is used as a generic format for scan results from the | |
140 | * driver. Each driver interface implementation is responsible for converting | |
141 | * the driver or OS specific scan results into this format. | |
142 | * | |
143 | * If the driver does not support reporting all IEs, the IE data structure is | |
144 | * constructed of the IEs that are available. This field will also need to | |
145 | * include SSID in IE format. All drivers are encouraged to be extended to | |
146 | * report all IEs to make it easier to support future additions. | |
147 | */ | |
148 | struct wpa_scan_res { | |
7c2849d2 | 149 | unsigned int flags; |
6fc6879b JM |
150 | u8 bssid[ETH_ALEN]; |
151 | int freq; | |
152 | u16 beacon_int; | |
153 | u16 caps; | |
154 | int qual; | |
155 | int noise; | |
156 | int level; | |
157 | u64 tsf; | |
158 | size_t ie_len; | |
159 | /* followed by ie_len octets of IEs */ | |
160 | }; | |
161 | ||
162 | /** | |
163 | * struct wpa_scan_results - Scan results | |
164 | * @res: Array of pointers to allocated variable length scan result entries | |
165 | * @num: Number of entries in the scan result array | |
166 | */ | |
167 | struct wpa_scan_results { | |
168 | struct wpa_scan_res **res; | |
169 | size_t num; | |
170 | }; | |
171 | ||
4b4a8ae5 JM |
172 | /** |
173 | * struct wpa_interface_info - Network interface information | |
174 | * @next: Pointer to the next interface or NULL if this is the last one | |
175 | * @ifname: Interface name that can be used with init() or init2() | |
176 | * @desc: Human readable adapter description (e.g., vendor/model) or NULL if | |
177 | * not available | |
178 | * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one | |
179 | * is not an allocated copy, i.e., get_interfaces() caller will not free | |
180 | * this) | |
181 | */ | |
182 | struct wpa_interface_info { | |
183 | struct wpa_interface_info *next; | |
184 | char *ifname; | |
185 | char *desc; | |
186 | const char *drv_name; | |
187 | }; | |
188 | ||
fc2b7ed5 JM |
189 | #define WPAS_MAX_SCAN_SSIDS 4 |
190 | ||
191 | /** | |
192 | * struct wpa_driver_scan_params - Scan parameters | |
193 | * Data for struct wpa_driver_ops::scan2(). | |
194 | */ | |
195 | struct wpa_driver_scan_params { | |
196 | /** | |
197 | * ssids - SSIDs to scan for | |
198 | */ | |
199 | struct wpa_driver_scan_ssid { | |
200 | /** | |
201 | * ssid - specific SSID to scan for (ProbeReq) | |
202 | * %NULL or zero-length SSID is used to indicate active scan | |
ba2a573c | 203 | * with wildcard SSID. |
fc2b7ed5 JM |
204 | */ |
205 | const u8 *ssid; | |
206 | /** | |
207 | * ssid_len: Length of the SSID in octets | |
208 | */ | |
209 | size_t ssid_len; | |
210 | } ssids[WPAS_MAX_SCAN_SSIDS]; | |
211 | ||
212 | /** | |
213 | * num_ssids - Number of entries in ssids array | |
214 | * Zero indicates a request for a passive scan. | |
215 | */ | |
216 | size_t num_ssids; | |
217 | ||
218 | /** | |
219 | * extra_ies - Extra IE(s) to add into Probe Request or %NULL | |
220 | */ | |
221 | const u8 *extra_ies; | |
222 | ||
223 | /** | |
224 | * extra_ies_len - Length of extra_ies in octets | |
225 | */ | |
226 | size_t extra_ies_len; | |
d3a98225 JM |
227 | |
228 | /** | |
229 | * freqs - Array of frequencies to scan or %NULL for all frequencies | |
230 | * | |
231 | * The frequency is set in MHz. The array is zero-terminated. | |
232 | */ | |
233 | int *freqs; | |
fc2b7ed5 JM |
234 | }; |
235 | ||
c2a04078 JM |
236 | /** |
237 | * struct wpa_driver_auth_params - Authentication parameters | |
238 | * Data for struct wpa_driver_ops::authenticate(). | |
239 | */ | |
240 | struct wpa_driver_auth_params { | |
241 | int freq; | |
242 | const u8 *bssid; | |
243 | const u8 *ssid; | |
244 | size_t ssid_len; | |
245 | int auth_alg; | |
246 | const u8 *ie; | |
247 | size_t ie_len; | |
a0b2f99b JM |
248 | const u8 *wep_key[4]; |
249 | size_t wep_key_len[4]; | |
250 | int wep_tx_keyidx; | |
c2a04078 JM |
251 | }; |
252 | ||
6fc6879b JM |
253 | /** |
254 | * struct wpa_driver_associate_params - Association parameters | |
255 | * Data for struct wpa_driver_ops::associate(). | |
256 | */ | |
257 | struct wpa_driver_associate_params { | |
258 | /** | |
259 | * bssid - BSSID of the selected AP | |
260 | * This can be %NULL, if ap_scan=2 mode is used and the driver is | |
261 | * responsible for selecting with which BSS to associate. */ | |
262 | const u8 *bssid; | |
263 | ||
264 | /** | |
265 | * ssid - The selected SSID | |
266 | */ | |
267 | const u8 *ssid; | |
268 | size_t ssid_len; | |
269 | ||
270 | /** | |
271 | * freq - Frequency of the channel the selected AP is using | |
272 | * Frequency that the selected AP is using (in MHz as | |
273 | * reported in the scan results) | |
274 | */ | |
275 | int freq; | |
276 | ||
277 | /** | |
278 | * wpa_ie - WPA information element for (Re)Association Request | |
279 | * WPA information element to be included in (Re)Association | |
280 | * Request (including information element id and length). Use | |
281 | * of this WPA IE is optional. If the driver generates the WPA | |
282 | * IE, it can use pairwise_suite, group_suite, and | |
283 | * key_mgmt_suite to select proper algorithms. In this case, | |
284 | * the driver has to notify wpa_supplicant about the used WPA | |
285 | * IE by generating an event that the interface code will | |
286 | * convert into EVENT_ASSOCINFO data (see below). | |
287 | * | |
288 | * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE | |
289 | * instead. The driver can determine which version is used by | |
290 | * looking at the first byte of the IE (0xdd for WPA, 0x30 for | |
291 | * WPA2/RSN). | |
ad08c363 JM |
292 | * |
293 | * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE. | |
6fc6879b JM |
294 | */ |
295 | const u8 *wpa_ie; | |
296 | /** | |
297 | * wpa_ie_len - length of the wpa_ie | |
298 | */ | |
299 | size_t wpa_ie_len; | |
300 | ||
301 | /* The selected pairwise/group cipher and key management | |
302 | * suites. These are usually ignored if @wpa_ie is used. */ | |
303 | wpa_cipher pairwise_suite; | |
304 | wpa_cipher group_suite; | |
305 | wpa_key_mgmt key_mgmt_suite; | |
306 | ||
307 | /** | |
308 | * auth_alg - Allowed authentication algorithms | |
309 | * Bit field of AUTH_ALG_* | |
310 | */ | |
311 | int auth_alg; | |
312 | ||
313 | /** | |
314 | * mode - Operation mode (infra/ibss) IEEE80211_MODE_* | |
315 | */ | |
316 | int mode; | |
317 | ||
318 | /** | |
319 | * wep_key - WEP keys for static WEP configuration | |
320 | */ | |
321 | const u8 *wep_key[4]; | |
322 | ||
323 | /** | |
324 | * wep_key_len - WEP key length for static WEP configuration | |
325 | */ | |
326 | size_t wep_key_len[4]; | |
327 | ||
328 | /** | |
329 | * wep_tx_keyidx - WEP TX key index for static WEP configuration | |
330 | */ | |
331 | int wep_tx_keyidx; | |
332 | ||
333 | /** | |
334 | * mgmt_frame_protection - IEEE 802.11w management frame protection | |
335 | */ | |
336 | enum { | |
337 | NO_MGMT_FRAME_PROTECTION, | |
338 | MGMT_FRAME_PROTECTION_OPTIONAL, | |
339 | MGMT_FRAME_PROTECTION_REQUIRED | |
340 | } mgmt_frame_protection; | |
341 | ||
342 | /** | |
343 | * ft_ies - IEEE 802.11r / FT information elements | |
344 | * If the supplicant is using IEEE 802.11r (FT) and has the needed keys | |
345 | * for fast transition, this parameter is set to include the IEs that | |
346 | * are to be sent in the next FT Authentication Request message. | |
347 | * update_ft_ies() handler is called to update the IEs for further | |
348 | * FT messages in the sequence. | |
349 | * | |
350 | * The driver should use these IEs only if the target AP is advertising | |
351 | * the same mobility domain as the one included in the MDIE here. | |
352 | * | |
353 | * In ap_scan=2 mode, the driver can use these IEs when moving to a new | |
354 | * AP after the initial association. These IEs can only be used if the | |
355 | * target AP is advertising support for FT and is using the same MDIE | |
356 | * and SSID as the current AP. | |
357 | * | |
358 | * The driver is responsible for reporting the FT IEs received from the | |
359 | * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE | |
360 | * type. update_ft_ies() handler will then be called with the FT IEs to | |
361 | * include in the next frame in the authentication sequence. | |
362 | */ | |
363 | const u8 *ft_ies; | |
364 | ||
365 | /** | |
366 | * ft_ies_len - Length of ft_ies in bytes | |
367 | */ | |
368 | size_t ft_ies_len; | |
369 | ||
370 | /** | |
371 | * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies) | |
372 | * | |
373 | * This value is provided to allow the driver interface easier access | |
374 | * to the current mobility domain. This value is set to %NULL if no | |
375 | * mobility domain is currently active. | |
376 | */ | |
377 | const u8 *ft_md; | |
378 | ||
379 | /** | |
380 | * passphrase - RSN passphrase for PSK | |
381 | * | |
382 | * This value is made available only for WPA/WPA2-Personal (PSK) and | |
383 | * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is | |
384 | * the 8..63 character ASCII passphrase, if available. Please note that | |
385 | * this can be %NULL if passphrase was not used to generate the PSK. In | |
386 | * that case, the psk field must be used to fetch the PSK. | |
387 | */ | |
388 | const char *passphrase; | |
389 | ||
390 | /** | |
391 | * psk - RSN PSK (alternative for passphrase for PSK) | |
392 | * | |
393 | * This value is made available only for WPA/WPA2-Personal (PSK) and | |
394 | * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is | |
395 | * the 32-octet (256-bit) PSK, if available. The driver wrapper should | |
396 | * be prepared to handle %NULL value as an error. | |
397 | */ | |
398 | const u8 *psk; | |
36b15723 JM |
399 | |
400 | /** | |
401 | * drop_unencrypted - Enable/disable unencrypted frame filtering | |
402 | * | |
403 | * Configure the driver to drop all non-EAPOL frames (both receive and | |
404 | * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must | |
405 | * still be allowed for key negotiation. | |
406 | */ | |
407 | int drop_unencrypted; | |
6fc6879b JM |
408 | }; |
409 | ||
410 | /** | |
411 | * struct wpa_driver_capa - Driver capability information | |
412 | */ | |
413 | struct wpa_driver_capa { | |
414 | #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001 | |
415 | #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002 | |
416 | #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004 | |
417 | #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008 | |
418 | #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010 | |
419 | #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020 | |
420 | #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040 | |
421 | unsigned int key_mgmt; | |
422 | ||
423 | #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001 | |
424 | #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002 | |
425 | #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004 | |
426 | #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008 | |
427 | unsigned int enc; | |
428 | ||
429 | #define WPA_DRIVER_AUTH_OPEN 0x00000001 | |
430 | #define WPA_DRIVER_AUTH_SHARED 0x00000002 | |
431 | #define WPA_DRIVER_AUTH_LEAP 0x00000004 | |
432 | unsigned int auth; | |
433 | ||
434 | /* Driver generated WPA/RSN IE */ | |
435 | #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001 | |
436 | #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002 | |
437 | #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004 | |
438 | /* Driver takes care of RSN 4-way handshake internally; PMK is configured with | |
439 | * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */ | |
440 | #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008 | |
4ef1e644 | 441 | #define WPA_DRIVER_FLAGS_WIRED 0x00000010 |
c2a04078 JM |
442 | /* Driver provides separate commands for authentication and association (SME in |
443 | * wpa_supplicant). */ | |
444 | #define WPA_DRIVER_FLAGS_SME 0x00000020 | |
1581b38b JM |
445 | /* Driver supports AP mode */ |
446 | #define WPA_DRIVER_FLAGS_AP 0x00000040 | |
6fc6879b | 447 | unsigned int flags; |
80bc75f1 JM |
448 | |
449 | int max_scan_ssids; | |
6fc6879b JM |
450 | }; |
451 | ||
452 | ||
6fc6879b JM |
453 | struct ieee80211_rx_status { |
454 | int channel; | |
455 | int ssi; | |
456 | }; | |
457 | ||
458 | ||
c5121837 JM |
459 | struct hostapd_data; |
460 | ||
461 | struct hostap_sta_driver_data { | |
462 | unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes; | |
463 | unsigned long current_tx_rate; | |
464 | unsigned long inactive_msec; | |
465 | unsigned long flags; | |
466 | unsigned long num_ps_buf_frames; | |
467 | unsigned long tx_retry_failed; | |
468 | unsigned long tx_retry_count; | |
469 | int last_rssi; | |
470 | int last_ack_rssi; | |
471 | }; | |
472 | ||
473 | struct hostapd_sta_add_params { | |
474 | const u8 *addr; | |
475 | u16 aid; | |
476 | u16 capability; | |
477 | const u8 *supp_rates; | |
478 | size_t supp_rates_len; | |
479 | int flags; | |
480 | u16 listen_interval; | |
481 | const struct ht_cap_ie *ht_capabilities; | |
482 | }; | |
483 | ||
484 | struct hostapd_freq_params { | |
485 | int mode; | |
486 | int freq; | |
487 | int channel; | |
488 | int ht_enabled; | |
489 | int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled, | |
490 | * secondary channel below primary, 1 = HT40 | |
491 | * enabled, secondary channel above primary */ | |
492 | }; | |
493 | ||
494 | enum hostapd_driver_if_type { | |
b8c4d6df | 495 | HOSTAPD_IF_VLAN |
c5121837 JM |
496 | }; |
497 | ||
92f475b4 JM |
498 | struct wpa_init_params { |
499 | const u8 *bssid; | |
500 | const char *ifname; | |
501 | const u8 *ssid; | |
502 | size_t ssid_len; | |
503 | const char *test_socket; | |
504 | int use_pae_group_addr; | |
92f475b4 JM |
505 | char **bridge; |
506 | size_t num_bridge; | |
412036f5 JM |
507 | |
508 | u8 *own_addr; /* buffer for writing own MAC address */ | |
92f475b4 JM |
509 | }; |
510 | ||
c5121837 | 511 | |
6fc6879b JM |
512 | /** |
513 | * struct wpa_driver_ops - Driver interface API definition | |
514 | * | |
515 | * This structure defines the API that each driver interface needs to implement | |
516 | * for core wpa_supplicant code. All driver specific functionality is captured | |
517 | * in this wrapper. | |
518 | */ | |
519 | struct wpa_driver_ops { | |
520 | /** Name of the driver interface */ | |
521 | const char *name; | |
522 | /** One line description of the driver interface */ | |
523 | const char *desc; | |
524 | ||
525 | /** | |
526 | * get_bssid - Get the current BSSID | |
527 | * @priv: private driver interface data | |
528 | * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes) | |
529 | * | |
530 | * Returns: 0 on success, -1 on failure | |
531 | * | |
532 | * Query kernel driver for the current BSSID and copy it to bssid. | |
533 | * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not | |
534 | * associated. | |
535 | */ | |
536 | int (*get_bssid)(void *priv, u8 *bssid); | |
537 | ||
538 | /** | |
539 | * get_ssid - Get the current SSID | |
540 | * @priv: private driver interface data | |
541 | * @ssid: buffer for SSID (at least 32 bytes) | |
542 | * | |
543 | * Returns: Length of the SSID on success, -1 on failure | |
544 | * | |
545 | * Query kernel driver for the current SSID and copy it to ssid. | |
546 | * Returning zero is recommended if the STA is not associated. | |
547 | * | |
548 | * Note: SSID is an array of octets, i.e., it is not nul terminated and | |
549 | * can, at least in theory, contain control characters (including nul) | |
550 | * and as such, should be processed as binary data, not a printable | |
551 | * string. | |
552 | */ | |
553 | int (*get_ssid)(void *priv, u8 *ssid); | |
554 | ||
555 | /** | |
556 | * set_wpa - Enable/disable WPA support (OBSOLETE) | |
557 | * @priv: private driver interface data | |
558 | * @enabled: 1 = enable, 0 = disable | |
559 | * | |
560 | * Returns: 0 on success, -1 on failure | |
561 | * | |
562 | * Note: This function is included for backwards compatibility. This is | |
563 | * called only just after init and just before deinit, so these | |
564 | * functions can be used to implement same functionality and the driver | |
565 | * interface need not define this function. | |
566 | * | |
567 | * Configure the kernel driver to enable/disable WPA support. This may | |
568 | * be empty function, if WPA support is always enabled. Common | |
569 | * configuration items are WPA IE (clearing it when WPA support is | |
570 | * disabled), Privacy flag configuration for capability field (note: | |
571 | * this the value need to set in associate handler to allow plaintext | |
572 | * mode to be used) when trying to associate with, roaming mode (can | |
573 | * allow wpa_supplicant to control roaming if ap_scan=1 is used; | |
574 | * however, drivers can also implement roaming if desired, especially | |
575 | * ap_scan=2 mode is used for this). | |
576 | */ | |
577 | int (*set_wpa)(void *priv, int enabled); | |
578 | ||
579 | /** | |
580 | * set_key - Configure encryption key | |
581 | * @priv: private driver interface data | |
582 | * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP, | |
583 | * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK); | |
584 | * %WPA_ALG_NONE clears the key. | |
585 | * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for | |
586 | * broadcast/default keys | |
587 | * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for | |
588 | * IGTK | |
589 | * @set_tx: configure this key as the default Tx key (only used when | |
590 | * driver does not support separate unicast/individual key | |
591 | * @seq: sequence number/packet number, seq_len octets, the next | |
592 | * packet number to be used for in replay protection; configured | |
593 | * for Rx keys (in most cases, this is only used with broadcast | |
594 | * keys and set to zero for unicast keys) | |
595 | * @seq_len: length of the seq, depends on the algorithm: | |
596 | * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets | |
597 | * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key, | |
598 | * 8-byte Rx Mic Key | |
599 | * @key_len: length of the key buffer in octets (WEP: 5 or 13, | |
600 | * TKIP: 32, CCMP: 16, IGTK: 16) | |
601 | * | |
602 | * Returns: 0 on success, -1 on failure | |
603 | * | |
604 | * Configure the given key for the kernel driver. If the driver | |
605 | * supports separate individual keys (4 default keys + 1 individual), | |
606 | * addr can be used to determine whether the key is default or | |
607 | * individual. If only 4 keys are supported, the default key with key | |
608 | * index 0 is used as the individual key. STA must be configured to use | |
609 | * it as the default Tx key (set_tx is set) and accept Rx for all the | |
610 | * key indexes. In most cases, WPA uses only key indexes 1 and 2 for | |
611 | * broadcast keys, so key index 0 is available for this kind of | |
612 | * configuration. | |
613 | * | |
614 | * Please note that TKIP keys include separate TX and RX MIC keys and | |
615 | * some drivers may expect them in different order than wpa_supplicant | |
616 | * is using. If the TX/RX keys are swapped, all TKIP encrypted packets | |
617 | * will tricker Michael MIC errors. This can be fixed by changing the | |
618 | * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key | |
619 | * in driver_*.c set_key() implementation, see driver_ndis.c for an | |
620 | * example on how this can be done. | |
621 | */ | |
622 | int (*set_key)(void *priv, wpa_alg alg, const u8 *addr, | |
623 | int key_idx, int set_tx, const u8 *seq, size_t seq_len, | |
624 | const u8 *key, size_t key_len); | |
625 | ||
626 | /** | |
627 | * init - Initialize driver interface | |
628 | * @ctx: context to be used when calling wpa_supplicant functions, | |
629 | * e.g., wpa_supplicant_event() | |
630 | * @ifname: interface name, e.g., wlan0 | |
631 | * | |
632 | * Returns: Pointer to private data, %NULL on failure | |
633 | * | |
634 | * Initialize driver interface, including event processing for kernel | |
635 | * driver events (e.g., associated, scan results, Michael MIC failure). | |
636 | * This function can allocate a private configuration data area for | |
637 | * @ctx, file descriptor, interface name, etc. information that may be | |
638 | * needed in future driver operations. If this is not used, non-NULL | |
639 | * value will need to be returned because %NULL is used to indicate | |
640 | * failure. The returned value will be used as 'void *priv' data for | |
641 | * all other driver_ops functions. | |
642 | * | |
643 | * The main event loop (eloop.c) of wpa_supplicant can be used to | |
644 | * register callback for read sockets (eloop_register_read_sock()). | |
645 | * | |
646 | * See below for more information about events and | |
647 | * wpa_supplicant_event() function. | |
648 | */ | |
649 | void * (*init)(void *ctx, const char *ifname); | |
650 | ||
651 | /** | |
652 | * deinit - Deinitialize driver interface | |
653 | * @priv: private driver interface data from init() | |
654 | * | |
655 | * Shut down driver interface and processing of driver events. Free | |
656 | * private data buffer if one was allocated in init() handler. | |
657 | */ | |
658 | void (*deinit)(void *priv); | |
659 | ||
660 | /** | |
661 | * set_param - Set driver configuration parameters | |
662 | * @priv: private driver interface data from init() | |
663 | * @param: driver specific configuration parameters | |
664 | * | |
665 | * Returns: 0 on success, -1 on failure | |
666 | * | |
667 | * Optional handler for notifying driver interface about configuration | |
668 | * parameters (driver_param). | |
669 | */ | |
670 | int (*set_param)(void *priv, const char *param); | |
671 | ||
672 | /** | |
673 | * set_countermeasures - Enable/disable TKIP countermeasures | |
674 | * @priv: private driver interface data | |
675 | * @enabled: 1 = countermeasures enabled, 0 = disabled | |
676 | * | |
677 | * Returns: 0 on success, -1 on failure | |
678 | * | |
679 | * Configure TKIP countermeasures. When these are enabled, the driver | |
680 | * should drop all received and queued frames that are using TKIP. | |
681 | */ | |
682 | int (*set_countermeasures)(void *priv, int enabled); | |
683 | ||
684 | /** | |
685 | * set_drop_unencrypted - Enable/disable unencrypted frame filtering | |
686 | * @priv: private driver interface data | |
687 | * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled | |
688 | * | |
689 | * Returns: 0 on success, -1 on failure | |
690 | * | |
691 | * Configure the driver to drop all non-EAPOL frames (both receive and | |
692 | * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must | |
693 | * still be allowed for key negotiation. | |
36b15723 JM |
694 | * |
695 | * This function is deprecated. New driver wrapper implementations | |
696 | * should use associate() parameter drop_unencrypted instead. | |
6fc6879b JM |
697 | */ |
698 | int (*set_drop_unencrypted)(void *priv, int enabled); | |
699 | ||
700 | /** | |
fc2b7ed5 | 701 | * scan - Request the driver to initiate scan (old version) |
6fc6879b JM |
702 | * @priv: private driver interface data |
703 | * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for | |
ba2a573c JM |
704 | * all SSIDs (either active scan with wildcard SSID or passive |
705 | * scan) | |
6fc6879b JM |
706 | * @ssid_len: length of the SSID |
707 | * | |
708 | * Returns: 0 on success, -1 on failure | |
709 | * | |
710 | * Once the scan results are ready, the driver should report scan | |
711 | * results event for wpa_supplicant which will eventually request the | |
712 | * results with wpa_driver_get_scan_results(). | |
fc2b7ed5 | 713 | * |
36b15723 | 714 | * This function is deprecated. New driver wrapper implementations |
fc2b7ed5 | 715 | * should implement support for scan2(). |
6fc6879b JM |
716 | */ |
717 | int (*scan)(void *priv, const u8 *ssid, size_t ssid_len); | |
718 | ||
719 | /** | |
720 | * get_scan_results - Fetch the latest scan results (old version) | |
721 | * @priv: private driver interface data | |
722 | * @results: pointer to buffer for scan results | |
723 | * @max_size: maximum number of entries (buffer size) | |
724 | * | |
725 | * Returns: Number of scan result entries used on success, -1 on | |
726 | * failure | |
727 | * | |
728 | * If scan results include more than max_size BSSes, max_size will be | |
729 | * returned and the remaining entries will not be included in the | |
730 | * buffer. | |
731 | * | |
36b15723 | 732 | * This function is deprecated. New driver wrapper implementations |
6fc6879b JM |
733 | * should implement support for get_scan_results2(). |
734 | */ | |
735 | int (*get_scan_results)(void *priv, | |
736 | struct wpa_scan_result *results, | |
737 | size_t max_size); | |
738 | ||
739 | /** | |
740 | * deauthenticate - Request driver to deauthenticate | |
741 | * @priv: private driver interface data | |
742 | * @addr: peer address (BSSID of the AP) | |
743 | * @reason_code: 16-bit reason code to be sent in the deauthentication | |
744 | * frame | |
745 | * | |
746 | * Returns: 0 on success, -1 on failure | |
747 | */ | |
748 | int (*deauthenticate)(void *priv, const u8 *addr, int reason_code); | |
749 | ||
750 | /** | |
751 | * disassociate - Request driver to disassociate | |
752 | * @priv: private driver interface data | |
753 | * @addr: peer address (BSSID of the AP) | |
754 | * @reason_code: 16-bit reason code to be sent in the disassociation | |
755 | * frame | |
756 | * | |
757 | * Returns: 0 on success, -1 on failure | |
758 | */ | |
759 | int (*disassociate)(void *priv, const u8 *addr, int reason_code); | |
760 | ||
761 | /** | |
762 | * associate - Request driver to associate | |
763 | * @priv: private driver interface data | |
764 | * @params: association parameters | |
765 | * | |
766 | * Returns: 0 on success, -1 on failure | |
767 | */ | |
768 | int (*associate)(void *priv, | |
769 | struct wpa_driver_associate_params *params); | |
770 | ||
771 | /** | |
772 | * set_auth_alg - Set IEEE 802.11 authentication algorithm | |
773 | * @priv: private driver interface data | |
774 | * @auth_alg: bit field of AUTH_ALG_* | |
775 | * | |
776 | * If the driver supports more than one authentication algorithm at the | |
777 | * same time, it should configure all supported algorithms. If not, one | |
778 | * algorithm needs to be selected arbitrarily. Open System | |
779 | * authentication should be ok for most cases and it is recommended to | |
780 | * be used if other options are not supported. Static WEP configuration | |
781 | * may also use Shared Key authentication and LEAP requires its own | |
782 | * algorithm number. For LEAP, user can make sure that only one | |
783 | * algorithm is used at a time by configuring LEAP as the only | |
784 | * supported EAP method. This information is also available in | |
785 | * associate() params, so set_auth_alg may not be needed in case of | |
786 | * most drivers. | |
787 | * | |
36b15723 JM |
788 | * This function is deprecated. New driver wrapper implementations |
789 | * should use associate() parameter auth_alg instead. | |
790 | * | |
6fc6879b JM |
791 | * Returns: 0 on success, -1 on failure |
792 | */ | |
793 | int (*set_auth_alg)(void *priv, int auth_alg); | |
794 | ||
795 | /** | |
796 | * add_pmkid - Add PMKSA cache entry to the driver | |
797 | * @priv: private driver interface data | |
798 | * @bssid: BSSID for the PMKSA cache entry | |
799 | * @pmkid: PMKID for the PMKSA cache entry | |
800 | * | |
801 | * Returns: 0 on success, -1 on failure | |
802 | * | |
803 | * This function is called when a new PMK is received, as a result of | |
804 | * either normal authentication or RSN pre-authentication. | |
805 | * | |
806 | * If the driver generates RSN IE, i.e., it does not use wpa_ie in | |
807 | * associate(), add_pmkid() can be used to add new PMKSA cache entries | |
808 | * in the driver. If the driver uses wpa_ie from wpa_supplicant, this | |
809 | * driver_ops function does not need to be implemented. Likewise, if | |
810 | * the driver does not support WPA, this function is not needed. | |
811 | */ | |
812 | int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); | |
813 | ||
814 | /** | |
815 | * remove_pmkid - Remove PMKSA cache entry to the driver | |
816 | * @priv: private driver interface data | |
817 | * @bssid: BSSID for the PMKSA cache entry | |
818 | * @pmkid: PMKID for the PMKSA cache entry | |
819 | * | |
820 | * Returns: 0 on success, -1 on failure | |
821 | * | |
822 | * This function is called when the supplicant drops a PMKSA cache | |
823 | * entry for any reason. | |
824 | * | |
825 | * If the driver generates RSN IE, i.e., it does not use wpa_ie in | |
826 | * associate(), remove_pmkid() can be used to synchronize PMKSA caches | |
827 | * between the driver and wpa_supplicant. If the driver uses wpa_ie | |
828 | * from wpa_supplicant, this driver_ops function does not need to be | |
829 | * implemented. Likewise, if the driver does not support WPA, this | |
830 | * function is not needed. | |
831 | */ | |
832 | int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); | |
833 | ||
834 | /** | |
835 | * flush_pmkid - Flush PMKSA cache | |
836 | * @priv: private driver interface data | |
837 | * | |
838 | * Returns: 0 on success, -1 on failure | |
839 | * | |
840 | * This function is called when the supplicant drops all PMKSA cache | |
841 | * entries for any reason. | |
842 | * | |
843 | * If the driver generates RSN IE, i.e., it does not use wpa_ie in | |
844 | * associate(), remove_pmkid() can be used to synchronize PMKSA caches | |
845 | * between the driver and wpa_supplicant. If the driver uses wpa_ie | |
846 | * from wpa_supplicant, this driver_ops function does not need to be | |
847 | * implemented. Likewise, if the driver does not support WPA, this | |
848 | * function is not needed. | |
849 | */ | |
850 | int (*flush_pmkid)(void *priv); | |
851 | ||
852 | /** | |
6179d2fd | 853 | * get_capa - Get driver capabilities |
6fc6879b JM |
854 | * @priv: private driver interface data |
855 | * | |
856 | * Returns: 0 on success, -1 on failure | |
857 | * | |
858 | * Get driver/firmware/hardware capabilities. | |
859 | */ | |
860 | int (*get_capa)(void *priv, struct wpa_driver_capa *capa); | |
861 | ||
862 | /** | |
863 | * poll - Poll driver for association information | |
864 | * @priv: private driver interface data | |
865 | * | |
866 | * This is an option callback that can be used when the driver does not | |
867 | * provide event mechanism for association events. This is called when | |
868 | * receiving WPA EAPOL-Key messages that require association | |
869 | * information. The driver interface is supposed to generate associnfo | |
870 | * event before returning from this callback function. In addition, the | |
871 | * driver interface should generate an association event after having | |
872 | * sent out associnfo. | |
873 | */ | |
874 | void (*poll)(void *priv); | |
875 | ||
876 | /** | |
877 | * get_ifname - Get interface name | |
878 | * @priv: private driver interface data | |
879 | * | |
880 | * Returns: Pointer to the interface name. This can differ from the | |
e519314e | 881 | * interface name used in init() call. Init() is called first. |
6fc6879b JM |
882 | * |
883 | * This optional function can be used to allow the driver interface to | |
884 | * replace the interface name with something else, e.g., based on an | |
885 | * interface mapping from a more descriptive name. | |
886 | */ | |
887 | const char * (*get_ifname)(void *priv); | |
888 | ||
889 | /** | |
890 | * get_mac_addr - Get own MAC address | |
891 | * @priv: private driver interface data | |
892 | * | |
893 | * Returns: Pointer to own MAC address or %NULL on failure | |
894 | * | |
895 | * This optional function can be used to get the own MAC address of the | |
896 | * device from the driver interface code. This is only needed if the | |
897 | * l2_packet implementation for the OS does not provide easy access to | |
898 | * a MAC address. */ | |
899 | const u8 * (*get_mac_addr)(void *priv); | |
900 | ||
901 | /** | |
902 | * send_eapol - Optional function for sending EAPOL packets | |
903 | * @priv: private driver interface data | |
904 | * @dest: Destination MAC address | |
905 | * @proto: Ethertype | |
906 | * @data: EAPOL packet starting with IEEE 802.1X header | |
907 | * @data_len: Size of the EAPOL packet | |
908 | * | |
909 | * Returns: 0 on success, -1 on failure | |
910 | * | |
911 | * This optional function can be used to override l2_packet operations | |
912 | * with driver specific functionality. If this function pointer is set, | |
913 | * l2_packet module is not used at all and the driver interface code is | |
914 | * responsible for receiving and sending all EAPOL packets. The | |
915 | * received EAPOL packets are sent to core code by calling | |
916 | * wpa_supplicant_rx_eapol(). The driver interface is required to | |
917 | * implement get_mac_addr() handler if send_eapol() is used. | |
918 | */ | |
919 | int (*send_eapol)(void *priv, const u8 *dest, u16 proto, | |
920 | const u8 *data, size_t data_len); | |
921 | ||
922 | /** | |
923 | * set_operstate - Sets device operating state to DORMANT or UP | |
924 | * @priv: private driver interface data | |
925 | * @state: 0 = dormant, 1 = up | |
926 | * Returns: 0 on success, -1 on failure | |
927 | * | |
928 | * This is an optional function that can be used on operating systems | |
929 | * that support a concept of controlling network device state from user | |
930 | * space applications. This function, if set, gets called with | |
931 | * state = 1 when authentication has been completed and with state = 0 | |
932 | * when connection is lost. | |
933 | */ | |
934 | int (*set_operstate)(void *priv, int state); | |
935 | ||
936 | /** | |
937 | * mlme_setprotection - MLME-SETPROTECTION.request primitive | |
938 | * @priv: Private driver interface data | |
939 | * @addr: Address of the station for which to set protection (may be | |
940 | * %NULL for group keys) | |
941 | * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_* | |
942 | * @key_type: MLME_SETPROTECTION_KEY_TYPE_* | |
943 | * Returns: 0 on success, -1 on failure | |
944 | * | |
945 | * This is an optional function that can be used to set the driver to | |
946 | * require protection for Tx and/or Rx frames. This uses the layer | |
947 | * interface defined in IEEE 802.11i-2004 clause 10.3.22.1 | |
948 | * (MLME-SETPROTECTION.request). Many drivers do not use explicit | |
949 | * set protection operation; instead, they set protection implicitly | |
950 | * based on configured keys. | |
951 | */ | |
952 | int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type, | |
953 | int key_type); | |
954 | ||
955 | /** | |
956 | * get_hw_feature_data - Get hardware support data (channels and rates) | |
957 | * @priv: Private driver interface data | |
958 | * @num_modes: Variable for returning the number of returned modes | |
959 | * flags: Variable for returning hardware feature flags | |
960 | * Returns: Pointer to allocated hardware data on success or %NULL on | |
961 | * failure. Caller is responsible for freeing this. | |
962 | * | |
963 | * This function is only needed for drivers that export MLME | |
964 | * (management frame processing) to wpa_supplicant. | |
965 | */ | |
6caf9ca6 JM |
966 | struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv, |
967 | u16 *num_modes, | |
968 | u16 *flags); | |
6fc6879b JM |
969 | |
970 | /** | |
971 | * set_channel - Set channel | |
972 | * @priv: Private driver interface data | |
6caf9ca6 | 973 | * @phymode: HOSTAPD_MODE_IEEE80211B, .. |
6fc6879b JM |
974 | * @chan: IEEE 802.11 channel number |
975 | * @freq: Frequency of the channel in MHz | |
976 | * Returns: 0 on success, -1 on failure | |
977 | * | |
978 | * This function is only needed for drivers that export MLME | |
979 | * (management frame processing) to wpa_supplicant. | |
980 | */ | |
6caf9ca6 | 981 | int (*set_channel)(void *priv, hostapd_hw_mode phymode, int chan, |
6fc6879b JM |
982 | int freq); |
983 | ||
984 | /** | |
985 | * set_ssid - Set SSID | |
986 | * @priv: Private driver interface data | |
987 | * @ssid: SSID | |
988 | * @ssid_len: SSID length | |
989 | * Returns: 0 on success, -1 on failure | |
990 | * | |
991 | * This function is only needed for drivers that export MLME | |
992 | * (management frame processing) to wpa_supplicant. | |
993 | */ | |
994 | int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len); | |
995 | ||
996 | /** | |
997 | * set_bssid - Set BSSID | |
998 | * @priv: Private driver interface data | |
999 | * @bssid: BSSID | |
1000 | * Returns: 0 on success, -1 on failure | |
1001 | * | |
1002 | * This function is only needed for drivers that export MLME | |
1003 | * (management frame processing) to wpa_supplicant. | |
1004 | */ | |
1005 | int (*set_bssid)(void *priv, const u8 *bssid); | |
1006 | ||
1007 | /** | |
1008 | * send_mlme - Send management frame from MLME | |
1009 | * @priv: Private driver interface data | |
1010 | * @data: IEEE 802.11 management frame with IEEE 802.11 header | |
1011 | * @data_len: Size of the management frame | |
1012 | * Returns: 0 on success, -1 on failure | |
1013 | * | |
1014 | * This function is only needed for drivers that export MLME | |
1015 | * (management frame processing) to wpa_supplicant. | |
1016 | */ | |
1017 | int (*send_mlme)(void *priv, const u8 *data, size_t data_len); | |
1018 | ||
1019 | /** | |
1020 | * mlme_add_sta - Add a STA entry into the driver/netstack | |
1021 | * @priv: Private driver interface data | |
1022 | * @addr: MAC address of the STA (e.g., BSSID of the AP) | |
1023 | * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11 | |
1024 | * format (one octet per rate, 1 = 0.5 Mbps) | |
1025 | * @supp_rates_len: Number of entries in supp_rates | |
1026 | * Returns: 0 on success, -1 on failure | |
1027 | * | |
1028 | * This function is only needed for drivers that export MLME | |
1029 | * (management frame processing) to wpa_supplicant. When the MLME code | |
1030 | * completes association with an AP, this function is called to | |
1031 | * configure the driver/netstack with a STA entry for data frame | |
1032 | * processing (TX rate control, encryption/decryption). | |
1033 | */ | |
1034 | int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates, | |
1035 | size_t supp_rates_len); | |
1036 | ||
1037 | /** | |
1038 | * mlme_remove_sta - Remove a STA entry from the driver/netstack | |
1039 | * @priv: Private driver interface data | |
1040 | * @addr: MAC address of the STA (e.g., BSSID of the AP) | |
1041 | * Returns: 0 on success, -1 on failure | |
1042 | * | |
1043 | * This function is only needed for drivers that export MLME | |
1044 | * (management frame processing) to wpa_supplicant. | |
1045 | */ | |
1046 | int (*mlme_remove_sta)(void *priv, const u8 *addr); | |
1047 | ||
1048 | /** | |
1049 | * update_ft_ies - Update FT (IEEE 802.11r) IEs | |
1050 | * @priv: Private driver interface data | |
1051 | * @md: Mobility domain (2 octets) (also included inside ies) | |
1052 | * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs | |
1053 | * @ies_len: Length of FT IEs in bytes | |
1054 | * Returns: 0 on success, -1 on failure | |
1055 | * | |
1056 | * The supplicant uses this callback to let the driver know that keying | |
1057 | * material for FT is available and that the driver can use the | |
1058 | * provided IEs in the next message in FT authentication sequence. | |
1059 | * | |
1060 | * This function is only needed for driver that support IEEE 802.11r | |
1061 | * (Fast BSS Transition). | |
1062 | */ | |
1063 | int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies, | |
1064 | size_t ies_len); | |
1065 | ||
1066 | /** | |
1067 | * send_ft_action - Send FT Action frame (IEEE 802.11r) | |
1068 | * @priv: Private driver interface data | |
1069 | * @action: Action field value | |
1070 | * @target_ap: Target AP address | |
1071 | * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body) | |
1072 | * @ies_len: Length of FT IEs in bytes | |
1073 | * Returns: 0 on success, -1 on failure | |
1074 | * | |
1075 | * The supplicant uses this callback to request the driver to transmit | |
1076 | * an FT Action frame (action category 6) for over-the-DS fast BSS | |
1077 | * transition. | |
1078 | */ | |
1079 | int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap, | |
1080 | const u8 *ies, size_t ies_len); | |
1081 | ||
1082 | /** | |
1083 | * get_scan_results2 - Fetch the latest scan results | |
1084 | * @priv: private driver interface data | |
1085 | * | |
1086 | * Returns: Allocated buffer of scan results (caller is responsible for | |
1087 | * freeing the data structure) on success, NULL on failure | |
1088 | */ | |
1089 | struct wpa_scan_results * (*get_scan_results2)(void *priv); | |
1090 | ||
1091 | /** | |
b39d1280 | 1092 | * set_probe_req_ie - Set information element(s) for Probe Request |
6fc6879b JM |
1093 | * @priv: private driver interface data |
1094 | * @ies: Information elements to append or %NULL to remove extra IEs | |
1095 | * @ies_len: Length of the IE buffer in octets | |
1096 | * Returns: 0 on success, -1 on failure | |
1097 | */ | |
ad08c363 | 1098 | int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len); |
ec5f180a DW |
1099 | |
1100 | /** | |
1101 | * set_mode - Request driver to set the operating mode | |
1102 | * @priv: private driver interface data | |
1103 | * @mode: Operation mode (infra/ibss) IEEE80211_MODE_* | |
1104 | * | |
1105 | * This handler will be called before any key configuration and call to | |
1106 | * associate() handler in order to allow the operation mode to be | |
1107 | * configured as early as possible. This information is also available | |
36b15723 | 1108 | * in associate() params and as such, driver wrappers may not need |
ec5f180a | 1109 | * to implement set_mode() handler. |
36b15723 JM |
1110 | * |
1111 | * This function is deprecated. New driver wrapper implementations | |
1112 | * should use associate() parameter mode instead. | |
1113 | * | |
ec5f180a DW |
1114 | * Returns: 0 on success, -1 on failure |
1115 | */ | |
1116 | int (*set_mode)(void *priv, int mode); | |
6d158490 LR |
1117 | |
1118 | /** | |
1119 | * set_country - Set country | |
1120 | * @priv: Private driver interface data | |
1121 | * @alpha2: country to which to switch to | |
1122 | * Returns: 0 on success, -1 on failure | |
1123 | * | |
1124 | * This function is for drivers which support some form | |
1125 | * of setting a regulatory domain. | |
1126 | */ | |
1127 | int (*set_country)(void *priv, const char *alpha2); | |
ac305589 JM |
1128 | |
1129 | /** | |
1130 | * global_init - Global driver initialization | |
1131 | * Returns: Pointer to private data (global), %NULL on failure | |
1132 | * | |
1133 | * This optional function is called to initialize the driver wrapper | |
1134 | * for global data, i.e., data that applies to all interfaces. If this | |
1135 | * function is implemented, global_deinit() will also need to be | |
1136 | * implemented to free the private data. The driver will also likely | |
1137 | * use init2() function instead of init() to get the pointer to global | |
1138 | * data available to per-interface initializer. | |
1139 | */ | |
1140 | void * (*global_init)(void); | |
1141 | ||
1142 | /** | |
1143 | * global_deinit - Global driver deinitialization | |
1144 | * @priv: private driver global data from global_init() | |
1145 | * | |
1146 | * Terminate any global driver related functionality and free the | |
1147 | * global data structure. | |
1148 | */ | |
1149 | void (*global_deinit)(void *priv); | |
1150 | ||
1151 | /** | |
1152 | * init2 - Initialize driver interface (with global data) | |
1153 | * @ctx: context to be used when calling wpa_supplicant functions, | |
1154 | * e.g., wpa_supplicant_event() | |
1155 | * @ifname: interface name, e.g., wlan0 | |
1156 | * @global_priv: private driver global data from global_init() | |
1157 | * Returns: Pointer to private data, %NULL on failure | |
1158 | * | |
1159 | * This function can be used instead of init() if the driver wrapper | |
1160 | * uses global data. | |
1161 | */ | |
1162 | void * (*init2)(void *ctx, const char *ifname, void *global_priv); | |
4b4a8ae5 JM |
1163 | |
1164 | /** | |
1165 | * get_interfaces - Get information about available interfaces | |
1166 | * @global_priv: private driver global data from global_init() | |
1167 | * Returns: Allocated buffer of interface information (caller is | |
1168 | * responsible for freeing the data structure) on success, NULL on | |
1169 | * failure | |
1170 | */ | |
1171 | struct wpa_interface_info * (*get_interfaces)(void *global_priv); | |
fc2b7ed5 JM |
1172 | |
1173 | /** | |
1174 | * scan2 - Request the driver to initiate scan | |
1175 | * @priv: private driver interface data | |
1176 | * @params: Scan parameters | |
1177 | * | |
1178 | * Returns: 0 on success, -1 on failure | |
1179 | * | |
1180 | * Once the scan results are ready, the driver should report scan | |
1181 | * results event for wpa_supplicant which will eventually request the | |
1182 | * results with wpa_driver_get_scan_results2(). | |
1183 | */ | |
1184 | int (*scan2)(void *priv, struct wpa_driver_scan_params *params); | |
c2a04078 JM |
1185 | |
1186 | /** | |
1187 | * authenticate - Request driver to authenticate | |
1188 | * @priv: private driver interface data | |
1189 | * @params: authentication parameters | |
1190 | * Returns: 0 on success, -1 on failure | |
1191 | * | |
1192 | * This is an optional function that can be used with drivers that | |
1193 | * support separate authentication and association steps, i.e., when | |
1194 | * wpa_supplicant can act as the SME. If not implemented, associate() | |
1195 | * function is expected to take care of IEEE 802.11 authentication, | |
1196 | * too. | |
1197 | */ | |
d2440ba0 JM |
1198 | int (*authenticate)(void *priv, |
1199 | struct wpa_driver_auth_params *params); | |
1200 | ||
1201 | int (*set_beacon)(void *priv, const u8 *head, size_t head_len, | |
1202 | const u8 *tail, size_t tail_len, int dtim_period); | |
1203 | ||
1204 | int (*set_beacon_int)(void *priv, int value); | |
c5121837 | 1205 | |
92f475b4 JM |
1206 | void * (*hapd_init)(struct hostapd_data *hapd, |
1207 | struct wpa_init_params *params); | |
c5121837 JM |
1208 | void (*hapd_deinit)(void *priv); |
1209 | ||
1210 | /** | |
1211 | * set_8021x - enable/disable IEEE 802.1X support | |
1212 | * @ifname: Interface name (for multi-SSID/VLAN support) | |
1213 | * @priv: driver private data | |
1214 | * @enabled: 1 = enable, 0 = disable | |
1215 | * | |
1216 | * Returns: 0 on success, -1 on failure | |
1217 | * | |
1218 | * Configure the kernel driver to enable/disable 802.1X support. | |
1219 | * This may be an empty function if 802.1X support is always enabled. | |
1220 | */ | |
1221 | int (*set_ieee8021x)(const char *ifname, void *priv, int enabled); | |
1222 | ||
1223 | /** | |
1224 | * set_privacy - enable/disable privacy | |
1225 | * @priv: driver private data | |
1226 | * @enabled: 1 = privacy enabled, 0 = disabled | |
1227 | * | |
1228 | * Return: 0 on success, -1 on failure | |
1229 | * | |
1230 | * Configure privacy. | |
1231 | */ | |
1232 | int (*set_privacy)(const char *ifname, void *priv, int enabled); | |
1233 | ||
1234 | int (*hapd_set_key)(const char *ifname, void *priv, wpa_alg alg, | |
1235 | const u8 *addr, int key_idx, int set_tx, | |
1236 | const u8 *seq, size_t seq_len, | |
1237 | const u8 *key, size_t key_len); | |
1238 | int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr, | |
1239 | int idx, u8 *seq); | |
1240 | int (*get_seqnum_igtk)(const char *ifname, void *priv, const u8 *addr, | |
1241 | int idx, u8 *seq); | |
1242 | int (*flush)(void *priv); | |
1243 | int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem, | |
1244 | size_t elem_len); | |
1245 | ||
1246 | int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data, | |
1247 | const u8 *addr); | |
1248 | int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data, | |
1249 | size_t data_len, int encrypt, | |
1250 | const u8 *own_addr); | |
731723a5 JM |
1251 | int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr, |
1252 | int reason); | |
1253 | int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr, | |
1254 | int reason); | |
c5121837 JM |
1255 | int (*sta_remove)(void *priv, const u8 *addr); |
1256 | int (*hapd_get_ssid)(const char *ifname, void *priv, u8 *buf, int len); | |
1257 | int (*hapd_set_ssid)(const char *ifname, void *priv, const u8 *buf, | |
1258 | int len); | |
1259 | int (*hapd_set_countermeasures)(void *priv, int enabled); | |
c5121837 JM |
1260 | int (*sta_add)(const char *ifname, void *priv, |
1261 | struct hostapd_sta_add_params *params); | |
1262 | int (*get_inact_sec)(void *priv, const u8 *addr); | |
1263 | int (*sta_clear_stats)(void *priv, const u8 *addr); | |
1264 | ||
1265 | int (*set_freq)(void *priv, struct hostapd_freq_params *freq); | |
1266 | int (*set_rts)(void *priv, int rts); | |
1267 | int (*set_frag)(void *priv, int frag); | |
c5121837 JM |
1268 | |
1269 | int (*sta_set_flags)(void *priv, const u8 *addr, | |
1270 | int total_flags, int flags_or, int flags_and); | |
1271 | int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates, | |
1272 | int mode); | |
c5121837 JM |
1273 | int (*hapd_set_beacon)(const char *ifname, void *priv, |
1274 | const u8 *head, size_t head_len, | |
1275 | const u8 *tail, size_t tail_len, | |
1276 | int dtim_period); | |
1277 | ||
1278 | /* Configure internal bridge: | |
1279 | * 0 = disabled, i.e., client separation is enabled (no bridging of | |
1280 | * packets between associated STAs | |
1281 | * 1 = enabled, i.e., bridge packets between associated STAs (default) | |
1282 | */ | |
1283 | int (*set_internal_bridge)(void *priv, int value); | |
c5121837 JM |
1284 | int (*set_cts_protect)(void *priv, int value); |
1285 | int (*set_preamble)(void *priv, int value); | |
1286 | int (*set_short_slot_time)(void *priv, int value); | |
1287 | int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min, | |
1288 | int cw_max, int burst_time); | |
1289 | int (*bss_add)(void *priv, const char *ifname, const u8 *bssid); | |
1290 | int (*bss_remove)(void *priv, const char *ifname); | |
1291 | int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask); | |
c5121837 JM |
1292 | int (*if_add)(const char *iface, void *priv, |
1293 | enum hostapd_driver_if_type type, char *ifname, | |
1294 | const u8 *addr); | |
1295 | int (*if_update)(void *priv, enum hostapd_driver_if_type type, | |
1296 | char *ifname, const u8 *addr); | |
1297 | int (*if_remove)(void *priv, enum hostapd_driver_if_type type, | |
1298 | const char *ifname, const u8 *addr); | |
1299 | int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname, | |
1300 | int vlan_id); | |
1301 | /** | |
1302 | * commit - Optional commit changes handler | |
1303 | * @priv: driver private data | |
1304 | * Returns: 0 on success, -1 on failure | |
1305 | * | |
1306 | * This optional handler function can be registered if the driver | |
1307 | * interface implementation needs to commit changes (e.g., by setting | |
1308 | * network interface up) at the end of initial configuration. If set, | |
1309 | * this handler will be called after initial setup has been completed. | |
1310 | */ | |
1311 | int (*commit)(void *priv); | |
1312 | ||
1313 | int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto, | |
1314 | const u8 *data, size_t data_len); | |
1315 | ||
1316 | int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted, | |
1317 | u32 session_timeout); | |
1318 | int (*set_radius_acl_expire)(void *priv, const u8 *mac); | |
1319 | ||
1320 | int (*set_ht_params)(const char *ifname, void *priv, | |
1321 | const u8 *ht_capab, size_t ht_capab_len, | |
1322 | const u8 *ht_oper, size_t ht_oper_len); | |
1323 | ||
1324 | int (*set_wps_beacon_ie)(const char *ifname, void *priv, | |
1325 | const u8 *ie, size_t len); | |
1326 | int (*set_wps_probe_resp_ie)(const char *ifname, void *priv, | |
1327 | const u8 *ie, size_t len); | |
4bc181ec JM |
1328 | |
1329 | /** | |
1330 | * set_supp_port - Set IEEE 802.1X Supplicant Port status | |
1331 | * @priv: Private driver interface data | |
1332 | * @authorized: Whether the port is authorized | |
1333 | * Returns: 0 on success, -1 on failure | |
1334 | */ | |
1335 | int (*set_supp_port)(void *priv, int authorized); | |
6fc6879b JM |
1336 | }; |
1337 | ||
1338 | /** | |
1339 | * enum wpa_event_type - Event type for wpa_supplicant_event() calls | |
1340 | */ | |
1341 | typedef enum wpa_event_type { | |
1342 | /** | |
1343 | * EVENT_ASSOC - Association completed | |
1344 | * | |
1345 | * This event needs to be delivered when the driver completes IEEE | |
1346 | * 802.11 association or reassociation successfully. | |
1347 | * wpa_driver_ops::get_bssid() is expected to provide the current BSSID | |
1348 | * after this event has been generated. In addition, optional | |
1349 | * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide | |
1350 | * more information about the association. If the driver interface gets | |
1351 | * both of these events at the same time, it can also include the | |
1352 | * assoc_info data in EVENT_ASSOC call. | |
1353 | */ | |
1354 | EVENT_ASSOC, | |
1355 | ||
1356 | /** | |
1357 | * EVENT_DISASSOC - Association lost | |
1358 | * | |
1359 | * This event should be called when association is lost either due to | |
1360 | * receiving deauthenticate or disassociate frame from the AP or when | |
c2a04078 JM |
1361 | * sending either of these frames to the current AP. If the driver |
1362 | * supports separate deauthentication event, EVENT_DISASSOC should only | |
1363 | * be used for disassociation and EVENT_DEAUTH for deauthentication. | |
6fc6879b JM |
1364 | */ |
1365 | EVENT_DISASSOC, | |
1366 | ||
1367 | /** | |
1368 | * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected | |
1369 | * | |
1370 | * This event must be delivered when a Michael MIC error is detected by | |
1371 | * the local driver. Additional data for event processing is | |
1372 | * provided with union wpa_event_data::michael_mic_failure. This | |
1373 | * information is used to request new encyption key and to initiate | |
1374 | * TKIP countermeasures if needed. | |
1375 | */ | |
1376 | EVENT_MICHAEL_MIC_FAILURE, | |
1377 | ||
1378 | /** | |
1379 | * EVENT_SCAN_RESULTS - Scan results available | |
1380 | * | |
1381 | * This event must be called whenever scan results are available to be | |
1382 | * fetched with struct wpa_driver_ops::get_scan_results(). This event | |
1383 | * is expected to be used some time after struct wpa_driver_ops::scan() | |
1384 | * is called. If the driver provides an unsolicited event when the scan | |
1385 | * has been completed, this event can be used to trigger | |
1386 | * EVENT_SCAN_RESULTS call. If such event is not available from the | |
1387 | * driver, the driver wrapper code is expected to use a registered | |
1388 | * timeout to generate EVENT_SCAN_RESULTS call after the time that the | |
1389 | * scan is expected to be completed. | |
1390 | */ | |
1391 | EVENT_SCAN_RESULTS, | |
1392 | ||
1393 | /** | |
1394 | * EVENT_ASSOCINFO - Report optional extra information for association | |
1395 | * | |
1396 | * This event can be used to report extra association information for | |
1397 | * EVENT_ASSOC processing. This extra information includes IEs from | |
1398 | * association frames and Beacon/Probe Response frames in union | |
1399 | * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before | |
1400 | * EVENT_ASSOC. Alternatively, the driver interface can include | |
1401 | * assoc_info data in the EVENT_ASSOC call if it has all the | |
1402 | * information available at the same point. | |
1403 | */ | |
1404 | EVENT_ASSOCINFO, | |
1405 | ||
1406 | /** | |
1407 | * EVENT_INTERFACE_STATUS - Report interface status changes | |
1408 | * | |
1409 | * This optional event can be used to report changes in interface | |
1410 | * status (interface added/removed) using union | |
1411 | * wpa_event_data::interface_status. This can be used to trigger | |
1412 | * wpa_supplicant to stop and re-start processing for the interface, | |
1413 | * e.g., when a cardbus card is ejected/inserted. | |
1414 | */ | |
1415 | EVENT_INTERFACE_STATUS, | |
1416 | ||
1417 | /** | |
1418 | * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication | |
1419 | * | |
1420 | * This event can be used to inform wpa_supplicant about candidates for | |
1421 | * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible | |
1422 | * for scan request (ap_scan=2 mode), this event is required for | |
1423 | * pre-authentication. If wpa_supplicant is performing scan request | |
1424 | * (ap_scan=1), this event is optional since scan results can be used | |
1425 | * to add pre-authentication candidates. union | |
1426 | * wpa_event_data::pmkid_candidate is used to report the BSSID of the | |
1427 | * candidate and priority of the candidate, e.g., based on the signal | |
1428 | * strength, in order to try to pre-authenticate first with candidates | |
1429 | * that are most likely targets for re-association. | |
1430 | * | |
1431 | * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates | |
1432 | * on the candidate list. In addition, it can be called for the current | |
1433 | * AP and APs that have existing PMKSA cache entries. wpa_supplicant | |
1434 | * will automatically skip pre-authentication in cases where a valid | |
1435 | * PMKSA exists. When more than one candidate exists, this event should | |
1436 | * be generated once for each candidate. | |
1437 | * | |
1438 | * Driver will be notified about successful pre-authentication with | |
1439 | * struct wpa_driver_ops::add_pmkid() calls. | |
1440 | */ | |
1441 | EVENT_PMKID_CANDIDATE, | |
1442 | ||
1443 | /** | |
1444 | * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request) | |
1445 | * | |
1446 | * This event can be used to inform wpa_supplicant about desire to set | |
1447 | * up secure direct link connection between two stations as defined in | |
1448 | * IEEE 802.11e with a new PeerKey mechanism that replaced the original | |
1449 | * STAKey negotiation. The caller will need to set peer address for the | |
1450 | * event. | |
1451 | */ | |
1452 | EVENT_STKSTART, | |
1453 | ||
1454 | /** | |
1455 | * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs | |
1456 | * | |
1457 | * The driver is expected to report the received FT IEs from | |
1458 | * FT authentication sequence from the AP. The FT IEs are included in | |
1459 | * the extra information in union wpa_event_data::ft_ies. | |
1460 | */ | |
11ef8d35 JM |
1461 | EVENT_FT_RESPONSE, |
1462 | ||
1463 | /** | |
1464 | * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS | |
1465 | * | |
1466 | * The driver can use this event to inform wpa_supplicant about a STA | |
1467 | * in an IBSS with which protected frames could be exchanged. This | |
1468 | * event starts RSN authentication with the other STA to authenticate | |
1469 | * the STA and set up encryption keys with it. | |
1470 | */ | |
c2a04078 JM |
1471 | EVENT_IBSS_RSN_START, |
1472 | ||
1473 | /** | |
1474 | * EVENT_AUTH - Authentication result | |
1475 | * | |
1476 | * This event should be called when authentication attempt has been | |
1477 | * completed. This is only used if the driver supports separate | |
1478 | * authentication step (struct wpa_driver_ops::authenticate). | |
1479 | * Information about authentication result is included in | |
1480 | * union wpa_event_data::auth. | |
1481 | */ | |
1482 | EVENT_AUTH, | |
1483 | ||
1484 | /** | |
1485 | * EVENT_DEAUTH - Authentication lost | |
1486 | * | |
1487 | * This event should be called when authentication is lost either due | |
1488 | * to receiving deauthenticate frame from the AP or when sending that | |
1489 | * frame to the current AP. | |
1490 | */ | |
efa46078 JM |
1491 | EVENT_DEAUTH, |
1492 | ||
1493 | /** | |
1494 | * EVENT_ASSOC_REJECT - Association rejected | |
1495 | * | |
1496 | * This event should be called when (re)association attempt has been | |
1497 | * rejected by the AP. Information about authentication result is | |
1498 | * included in union wpa_event_data::assoc_reject. | |
1499 | */ | |
da1fb17c JM |
1500 | EVENT_ASSOC_REJECT, |
1501 | ||
1502 | /** | |
1503 | * EVENT_AUTH_TIMED_OUT - Authentication timed out | |
1504 | */ | |
1505 | EVENT_AUTH_TIMED_OUT, | |
1506 | ||
1507 | /** | |
1508 | * EVENT_ASSOC_TIMED_OUT - Association timed out | |
1509 | */ | |
1510 | EVENT_ASSOC_TIMED_OUT | |
6fc6879b JM |
1511 | } wpa_event_type; |
1512 | ||
1513 | ||
1514 | /** | |
1515 | * union wpa_event_data - Additional data for wpa_supplicant_event() calls | |
1516 | */ | |
1517 | union wpa_event_data { | |
1518 | /** | |
1519 | * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events | |
1520 | * | |
1521 | * This structure is optional for EVENT_ASSOC calls and required for | |
1522 | * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the | |
1523 | * driver interface does not need to generate separate EVENT_ASSOCINFO | |
1524 | * calls. | |
1525 | */ | |
1526 | struct assoc_info { | |
1527 | /** | |
1528 | * req_ies - (Re)Association Request IEs | |
1529 | * | |
1530 | * If the driver generates WPA/RSN IE, this event data must be | |
1531 | * returned for WPA handshake to have needed information. If | |
1532 | * wpa_supplicant-generated WPA/RSN IE is used, this | |
1533 | * information event is optional. | |
1534 | * | |
1535 | * This should start with the first IE (fixed fields before IEs | |
1536 | * are not included). | |
1537 | */ | |
1538 | u8 *req_ies; | |
1539 | ||
1540 | /** | |
1541 | * req_ies_len - Length of req_ies in bytes | |
1542 | */ | |
1543 | size_t req_ies_len; | |
1544 | ||
1545 | /** | |
1546 | * resp_ies - (Re)Association Response IEs | |
1547 | * | |
1548 | * Optional association data from the driver. This data is not | |
1549 | * required WPA, but may be useful for some protocols and as | |
1550 | * such, should be reported if this is available to the driver | |
1551 | * interface. | |
1552 | * | |
1553 | * This should start with the first IE (fixed fields before IEs | |
1554 | * are not included). | |
1555 | */ | |
1556 | u8 *resp_ies; | |
1557 | ||
1558 | /** | |
1559 | * resp_ies_len - Length of resp_ies in bytes | |
1560 | */ | |
1561 | size_t resp_ies_len; | |
1562 | ||
1563 | /** | |
1564 | * beacon_ies - Beacon or Probe Response IEs | |
1565 | * | |
1566 | * Optional Beacon/ProbeResp data: IEs included in Beacon or | |
1567 | * Probe Response frames from the current AP (i.e., the one | |
1568 | * that the client just associated with). This information is | |
1569 | * used to update WPA/RSN IE for the AP. If this field is not | |
1570 | * set, the results from previous scan will be used. If no | |
1571 | * data for the new AP is found, scan results will be requested | |
1572 | * again (without scan request). At this point, the driver is | |
1573 | * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is | |
1574 | * used). | |
1575 | * | |
1576 | * This should start with the first IE (fixed fields before IEs | |
1577 | * are not included). | |
1578 | */ | |
1579 | u8 *beacon_ies; | |
1580 | ||
1581 | /** | |
1582 | * beacon_ies_len - Length of beacon_ies */ | |
1583 | size_t beacon_ies_len; | |
1584 | } assoc_info; | |
1585 | ||
1586 | /** | |
1587 | * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE | |
1588 | */ | |
1589 | struct michael_mic_failure { | |
1590 | int unicast; | |
ad1e68e6 | 1591 | const u8 *src; |
6fc6879b JM |
1592 | } michael_mic_failure; |
1593 | ||
1594 | /** | |
1595 | * struct interface_status - Data for EVENT_INTERFACE_STATUS | |
1596 | */ | |
1597 | struct interface_status { | |
1598 | char ifname[100]; | |
1599 | enum { | |
1600 | EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED | |
1601 | } ievent; | |
1602 | } interface_status; | |
1603 | ||
1604 | /** | |
1605 | * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE | |
1606 | */ | |
1607 | struct pmkid_candidate { | |
1608 | /** BSSID of the PMKID candidate */ | |
1609 | u8 bssid[ETH_ALEN]; | |
1610 | /** Smaller the index, higher the priority */ | |
1611 | int index; | |
1612 | /** Whether RSN IE includes pre-authenticate flag */ | |
1613 | int preauth; | |
1614 | } pmkid_candidate; | |
1615 | ||
1616 | /** | |
1617 | * struct stkstart - Data for EVENT_STKSTART | |
1618 | */ | |
1619 | struct stkstart { | |
1620 | u8 peer[ETH_ALEN]; | |
1621 | } stkstart; | |
1622 | ||
1623 | /** | |
1624 | * struct ft_ies - FT information elements (EVENT_FT_RESPONSE) | |
1625 | * | |
1626 | * During FT (IEEE 802.11r) authentication sequence, the driver is | |
1627 | * expected to use this event to report received FT IEs (MDIE, FTIE, | |
1628 | * RSN IE, TIE, possible resource request) to the supplicant. The FT | |
1629 | * IEs for the next message will be delivered through the | |
1630 | * struct wpa_driver_ops::update_ft_ies() callback. | |
1631 | */ | |
1632 | struct ft_ies { | |
1633 | const u8 *ies; | |
1634 | size_t ies_len; | |
1635 | int ft_action; | |
1636 | u8 target_ap[ETH_ALEN]; | |
babfbf15 JM |
1637 | /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */ |
1638 | const u8 *ric_ies; | |
1639 | /** Length of ric_ies buffer in octets */ | |
1640 | size_t ric_ies_len; | |
6fc6879b | 1641 | } ft_ies; |
11ef8d35 JM |
1642 | |
1643 | /** | |
1644 | * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START | |
1645 | */ | |
1646 | struct ibss_rsn_start { | |
1647 | u8 peer[ETH_ALEN]; | |
1648 | } ibss_rsn_start; | |
c2a04078 JM |
1649 | |
1650 | /** | |
1651 | * struct auth_info - Data for EVENT_AUTH events | |
1652 | */ | |
1653 | struct auth_info { | |
1654 | u8 peer[ETH_ALEN]; | |
1655 | u16 auth_type; | |
1656 | u16 status_code; | |
1657 | const u8 *ies; | |
1658 | size_t ies_len; | |
1659 | } auth; | |
efa46078 JM |
1660 | |
1661 | /** | |
1662 | * struct assoc_reject - Data for EVENT_ASSOC_REJECT events | |
1663 | */ | |
1664 | struct assoc_reject { | |
1665 | /** | |
1666 | * resp_ies - (Re)Association Response IEs | |
1667 | * | |
1668 | * Optional association data from the driver. This data is not | |
1669 | * required WPA, but may be useful for some protocols and as | |
1670 | * such, should be reported if this is available to the driver | |
1671 | * interface. | |
1672 | * | |
1673 | * This should start with the first IE (fixed fields before IEs | |
1674 | * are not included). | |
1675 | */ | |
1676 | u8 *resp_ies; | |
1677 | ||
1678 | /** | |
1679 | * resp_ies_len - Length of resp_ies in bytes | |
1680 | */ | |
1681 | size_t resp_ies_len; | |
1682 | ||
1683 | /** | |
1684 | * status_code - Status Code from (Re)association Response | |
1685 | */ | |
1686 | u16 status_code; | |
1687 | } assoc_reject; | |
da1fb17c JM |
1688 | |
1689 | struct timeout_event { | |
1690 | u8 addr[ETH_ALEN]; | |
1691 | } timeout_event; | |
6fc6879b JM |
1692 | }; |
1693 | ||
1694 | /** | |
1695 | * wpa_supplicant_event - Report a driver event for wpa_supplicant | |
1696 | * @ctx: Context pointer (wpa_s); this is the ctx variable registered | |
1697 | * with struct wpa_driver_ops::init() | |
1698 | * @event: event type (defined above) | |
1699 | * @data: possible extra data for the event | |
1700 | * | |
1701 | * Driver wrapper code should call this function whenever an event is received | |
1702 | * from the driver. | |
1703 | */ | |
1704 | void wpa_supplicant_event(void *ctx, wpa_event_type event, | |
1705 | union wpa_event_data *data); | |
1706 | ||
1707 | /** | |
1708 | * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant | |
1709 | * @ctx: Context pointer (wpa_s); this is the ctx variable registered | |
1710 | * with struct wpa_driver_ops::init() | |
1711 | * @src_addr: Source address of the EAPOL frame | |
1712 | * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header) | |
1713 | * @len: Length of the EAPOL data | |
1714 | * | |
1715 | * This function is called for each received EAPOL frame. Most driver | |
1716 | * interfaces rely on more generic OS mechanism for receiving frames through | |
1717 | * l2_packet, but if such a mechanism is not available, the driver wrapper may | |
1718 | * take care of received EAPOL frames and deliver them to the core supplicant | |
1719 | * code by calling this function. | |
1720 | */ | |
1721 | void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr, | |
1722 | const u8 *buf, size_t len); | |
1723 | ||
1724 | void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len, | |
1725 | struct ieee80211_rx_status *rx_status); | |
6fc6879b JM |
1726 | |
1727 | const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie); | |
1728 | #define WPA_IE_VENDOR_TYPE 0x0050f201 | |
ad08c363 | 1729 | #define WPS_IE_VENDOR_TYPE 0x0050f204 |
6fc6879b JM |
1730 | const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res, |
1731 | u32 vendor_type); | |
351f09a2 JM |
1732 | struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res, |
1733 | u32 vendor_type); | |
6fc6879b JM |
1734 | int wpa_scan_get_max_rate(const struct wpa_scan_res *res); |
1735 | void wpa_scan_results_free(struct wpa_scan_results *res); | |
1736 | void wpa_scan_sort_results(struct wpa_scan_results *res); | |
1737 | ||
c5121837 JM |
1738 | /* hostapd functions for driver wrappers */ |
1739 | ||
1740 | struct sta_info; | |
4b9841d3 | 1741 | struct ieee80211_hdr; |
c5121837 JM |
1742 | |
1743 | void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta, | |
1744 | int reassoc); | |
1745 | void hostapd_tx_status(struct hostapd_data *hapd, const u8 *addr, | |
1746 | const u8 *buf, size_t len, int ack); | |
4b9841d3 JM |
1747 | void hostapd_rx_from_unknown_sta(struct hostapd_data *hapd, |
1748 | const struct ieee80211_hdr *hdr, size_t len); | |
c5121837 JM |
1749 | int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr, |
1750 | const u8 *ie, size_t ielen); | |
1751 | void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr); | |
1752 | void hostapd_eapol_receive(struct hostapd_data *hapd, const u8 *sa, | |
1753 | const u8 *buf, size_t len); | |
1754 | ||
1755 | struct hostapd_frame_info { | |
1756 | u32 phytype; | |
1757 | u32 channel; | |
1758 | u32 datarate; | |
1759 | u32 ssi_signal; | |
c5121837 JM |
1760 | }; |
1761 | ||
1762 | void hostapd_mgmt_rx(struct hostapd_data *hapd, u8 *buf, size_t len, | |
1763 | u16 stype, struct hostapd_frame_info *fi); | |
1764 | void hostapd_mgmt_tx_cb(struct hostapd_data *hapd, u8 *buf, size_t len, | |
1765 | u16 stype, int ok); | |
1766 | void hostapd_michael_mic_failure(struct hostapd_data *hapd, const u8 *addr); | |
1767 | struct hostapd_data * hostapd_sta_get_bss(struct hostapd_data *hapd, | |
1768 | const u8 *addr); | |
1769 | ||
6fc6879b | 1770 | #endif /* DRIVER_H */ |