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