2 * WPA Supplicant - driver interface definition
3 * Copyright (c) 2003-2008, Jouni Malinen <j@w1.fi>
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.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
18 #define WPA_SUPPLICANT_DRIVER_VERSION 3
22 #define AUTH_ALG_OPEN_SYSTEM 0x01
23 #define AUTH_ALG_SHARED_KEY 0x02
24 #define AUTH_ALG_LEAP 0x04
26 #define IEEE80211_MODE_INFRA 0
27 #define IEEE80211_MODE_IBSS 1
29 #define IEEE80211_CAP_ESS 0x0001
30 #define IEEE80211_CAP_IBSS 0x0002
31 #define IEEE80211_CAP_PRIVACY 0x0010
33 #define SSID_MAX_WPA_IE_LEN 40
35 * struct wpa_scan_result - Scan results (old structure)
38 * @ssid_len: length of the ssid
40 * @wpa_ie_len: length of the wpa_ie
42 * @rsn_ie_len: length of the RSN IE
43 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
44 * @caps: capability information field in host byte order
45 * @qual: signal quality
47 * @level: signal level
48 * @maxrate: maximum supported rate
49 * @mdie_present: Whether MDIE was included in Beacon/ProbeRsp frame
50 * @mdie: Mobility domain identifier IE (IEEE 802.11r MDIE) (starting from
54 * This structure is used as a generic format for scan results from the
55 * driver. Each driver interface implementation is responsible for converting
56 * the driver or OS specific scan results into this format.
58 * This structure is the old data structure used for scan results. It is
59 * obsoleted by the new struct wpa_scan_res structure and the old version is
60 * only included for backwards compatibility with existing driver wrapper
61 * implementations. New implementations are encouraged to implement for struct
62 * wpa_scan_res. The old structure will be removed at some point.
64 struct wpa_scan_result {
68 u8 wpa_ie[SSID_MAX_WPA_IE_LEN];
70 u8 rsn_ie[SSID_MAX_WPA_IE_LEN];
84 #define WPA_SCAN_QUAL_INVALID BIT(0)
85 #define WPA_SCAN_NOISE_INVALID BIT(1)
86 #define WPA_SCAN_LEVEL_INVALID BIT(2)
87 #define WPA_SCAN_LEVEL_DBM BIT(3)
90 * struct wpa_scan_res - Scan result for an BSS/IBSS
91 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
93 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
94 * @beacon_int: beacon interval in TUs (host byte order)
95 * @caps: capability information field in host byte order
96 * @qual: signal quality
98 * @level: signal level
100 * @ie_len: length of the following IE field in octets
102 * This structure is used as a generic format for scan results from the
103 * driver. Each driver interface implementation is responsible for converting
104 * the driver or OS specific scan results into this format.
106 * If the driver does not support reporting all IEs, the IE data structure is
107 * constructed of the IEs that are available. This field will also need to
108 * include SSID in IE format. All drivers are encouraged to be extended to
109 * report all IEs to make it easier to support future additions.
111 struct wpa_scan_res {
122 /* followed by ie_len octets of IEs */
126 * struct wpa_scan_results - Scan results
127 * @res: Array of pointers to allocated variable length scan result entries
128 * @num: Number of entries in the scan result array
130 struct wpa_scan_results {
131 struct wpa_scan_res **res;
136 * struct wpa_interface_info - Network interface information
137 * @next: Pointer to the next interface or NULL if this is the last one
138 * @ifname: Interface name that can be used with init() or init2()
139 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
141 * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one
142 * is not an allocated copy, i.e., get_interfaces() caller will not free
145 struct wpa_interface_info {
146 struct wpa_interface_info *next;
149 const char *drv_name;
152 #define WPAS_MAX_SCAN_SSIDS 4
155 * struct wpa_driver_scan_params - Scan parameters
156 * Data for struct wpa_driver_ops::scan2().
158 struct wpa_driver_scan_params {
160 * ssids - SSIDs to scan for
162 struct wpa_driver_scan_ssid {
164 * ssid - specific SSID to scan for (ProbeReq)
165 * %NULL or zero-length SSID is used to indicate active scan
166 * with wildcard SSID.
170 * ssid_len: Length of the SSID in octets
173 } ssids[WPAS_MAX_SCAN_SSIDS];
176 * num_ssids - Number of entries in ssids array
177 * Zero indicates a request for a passive scan.
182 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
187 * extra_ies_len - Length of extra_ies in octets
189 size_t extra_ies_len;
193 * struct wpa_driver_associate_params - Association parameters
194 * Data for struct wpa_driver_ops::associate().
196 struct wpa_driver_associate_params {
198 * bssid - BSSID of the selected AP
199 * This can be %NULL, if ap_scan=2 mode is used and the driver is
200 * responsible for selecting with which BSS to associate. */
204 * ssid - The selected SSID
210 * freq - Frequency of the channel the selected AP is using
211 * Frequency that the selected AP is using (in MHz as
212 * reported in the scan results)
217 * wpa_ie - WPA information element for (Re)Association Request
218 * WPA information element to be included in (Re)Association
219 * Request (including information element id and length). Use
220 * of this WPA IE is optional. If the driver generates the WPA
221 * IE, it can use pairwise_suite, group_suite, and
222 * key_mgmt_suite to select proper algorithms. In this case,
223 * the driver has to notify wpa_supplicant about the used WPA
224 * IE by generating an event that the interface code will
225 * convert into EVENT_ASSOCINFO data (see below).
227 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
228 * instead. The driver can determine which version is used by
229 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
232 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
236 * wpa_ie_len - length of the wpa_ie
240 /* The selected pairwise/group cipher and key management
241 * suites. These are usually ignored if @wpa_ie is used. */
242 wpa_cipher pairwise_suite;
243 wpa_cipher group_suite;
244 wpa_key_mgmt key_mgmt_suite;
247 * auth_alg - Allowed authentication algorithms
248 * Bit field of AUTH_ALG_*
253 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
258 * wep_key - WEP keys for static WEP configuration
260 const u8 *wep_key[4];
263 * wep_key_len - WEP key length for static WEP configuration
265 size_t wep_key_len[4];
268 * wep_tx_keyidx - WEP TX key index for static WEP configuration
273 * mgmt_frame_protection - IEEE 802.11w management frame protection
276 NO_MGMT_FRAME_PROTECTION,
277 MGMT_FRAME_PROTECTION_OPTIONAL,
278 MGMT_FRAME_PROTECTION_REQUIRED
279 } mgmt_frame_protection;
282 * ft_ies - IEEE 802.11r / FT information elements
283 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
284 * for fast transition, this parameter is set to include the IEs that
285 * are to be sent in the next FT Authentication Request message.
286 * update_ft_ies() handler is called to update the IEs for further
287 * FT messages in the sequence.
289 * The driver should use these IEs only if the target AP is advertising
290 * the same mobility domain as the one included in the MDIE here.
292 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
293 * AP after the initial association. These IEs can only be used if the
294 * target AP is advertising support for FT and is using the same MDIE
295 * and SSID as the current AP.
297 * The driver is responsible for reporting the FT IEs received from the
298 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
299 * type. update_ft_ies() handler will then be called with the FT IEs to
300 * include in the next frame in the authentication sequence.
305 * ft_ies_len - Length of ft_ies in bytes
310 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
312 * This value is provided to allow the driver interface easier access
313 * to the current mobility domain. This value is set to %NULL if no
314 * mobility domain is currently active.
319 * passphrase - RSN passphrase for PSK
321 * This value is made available only for WPA/WPA2-Personal (PSK) and
322 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
323 * the 8..63 character ASCII passphrase, if available. Please note that
324 * this can be %NULL if passphrase was not used to generate the PSK. In
325 * that case, the psk field must be used to fetch the PSK.
327 const char *passphrase;
330 * psk - RSN PSK (alternative for passphrase for PSK)
332 * This value is made available only for WPA/WPA2-Personal (PSK) and
333 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
334 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
335 * be prepared to handle %NULL value as an error.
341 * struct wpa_driver_capa - Driver capability information
343 struct wpa_driver_capa {
344 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
345 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
346 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
347 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
348 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
349 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
350 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
351 unsigned int key_mgmt;
353 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
354 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
355 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
356 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
359 #define WPA_DRIVER_AUTH_OPEN 0x00000001
360 #define WPA_DRIVER_AUTH_SHARED 0x00000002
361 #define WPA_DRIVER_AUTH_LEAP 0x00000004
364 /* Driver generated WPA/RSN IE */
365 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
366 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
367 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
368 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
369 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
370 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
371 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
378 #define WPA_CHAN_W_SCAN 0x00000001
379 #define WPA_CHAN_W_ACTIVE_SCAN 0x00000002
380 #define WPA_CHAN_W_IBSS 0x00000004
382 struct wpa_channel_data {
383 short chan; /* channel number (IEEE 802.11) */
384 short freq; /* frequency in MHz */
385 int flag; /* flag for user space use (WPA_CHAN_*) */
388 #define WPA_RATE_ERP 0x00000001
389 #define WPA_RATE_BASIC 0x00000002
390 #define WPA_RATE_PREAMBLE2 0x00000004
391 #define WPA_RATE_SUPPORTED 0x00000010
392 #define WPA_RATE_OFDM 0x00000020
393 #define WPA_RATE_CCK 0x00000040
394 #define WPA_RATE_MANDATORY 0x00000100
396 struct wpa_rate_data {
397 int rate; /* rate in 100 kbps */
398 int flags; /* WPA_RATE_ flags */
408 struct wpa_hw_modes {
411 struct wpa_channel_data *channels;
413 struct wpa_rate_data *rates;
417 struct ieee80211_rx_status {
424 * struct wpa_driver_ops - Driver interface API definition
426 * This structure defines the API that each driver interface needs to implement
427 * for core wpa_supplicant code. All driver specific functionality is captured
430 struct wpa_driver_ops {
431 /** Name of the driver interface */
433 /** One line description of the driver interface */
437 * get_bssid - Get the current BSSID
438 * @priv: private driver interface data
439 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
441 * Returns: 0 on success, -1 on failure
443 * Query kernel driver for the current BSSID and copy it to bssid.
444 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
447 int (*get_bssid)(void *priv, u8 *bssid);
450 * get_ssid - Get the current SSID
451 * @priv: private driver interface data
452 * @ssid: buffer for SSID (at least 32 bytes)
454 * Returns: Length of the SSID on success, -1 on failure
456 * Query kernel driver for the current SSID and copy it to ssid.
457 * Returning zero is recommended if the STA is not associated.
459 * Note: SSID is an array of octets, i.e., it is not nul terminated and
460 * can, at least in theory, contain control characters (including nul)
461 * and as such, should be processed as binary data, not a printable
464 int (*get_ssid)(void *priv, u8 *ssid);
467 * set_wpa - Enable/disable WPA support (OBSOLETE)
468 * @priv: private driver interface data
469 * @enabled: 1 = enable, 0 = disable
471 * Returns: 0 on success, -1 on failure
473 * Note: This function is included for backwards compatibility. This is
474 * called only just after init and just before deinit, so these
475 * functions can be used to implement same functionality and the driver
476 * interface need not define this function.
478 * Configure the kernel driver to enable/disable WPA support. This may
479 * be empty function, if WPA support is always enabled. Common
480 * configuration items are WPA IE (clearing it when WPA support is
481 * disabled), Privacy flag configuration for capability field (note:
482 * this the value need to set in associate handler to allow plaintext
483 * mode to be used) when trying to associate with, roaming mode (can
484 * allow wpa_supplicant to control roaming if ap_scan=1 is used;
485 * however, drivers can also implement roaming if desired, especially
486 * ap_scan=2 mode is used for this).
488 int (*set_wpa)(void *priv, int enabled);
491 * set_key - Configure encryption key
492 * @priv: private driver interface data
493 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
494 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
495 * %WPA_ALG_NONE clears the key.
496 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
497 * broadcast/default keys
498 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
500 * @set_tx: configure this key as the default Tx key (only used when
501 * driver does not support separate unicast/individual key
502 * @seq: sequence number/packet number, seq_len octets, the next
503 * packet number to be used for in replay protection; configured
504 * for Rx keys (in most cases, this is only used with broadcast
505 * keys and set to zero for unicast keys)
506 * @seq_len: length of the seq, depends on the algorithm:
507 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
508 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
510 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
511 * TKIP: 32, CCMP: 16, IGTK: 16)
513 * Returns: 0 on success, -1 on failure
515 * Configure the given key for the kernel driver. If the driver
516 * supports separate individual keys (4 default keys + 1 individual),
517 * addr can be used to determine whether the key is default or
518 * individual. If only 4 keys are supported, the default key with key
519 * index 0 is used as the individual key. STA must be configured to use
520 * it as the default Tx key (set_tx is set) and accept Rx for all the
521 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
522 * broadcast keys, so key index 0 is available for this kind of
525 * Please note that TKIP keys include separate TX and RX MIC keys and
526 * some drivers may expect them in different order than wpa_supplicant
527 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
528 * will tricker Michael MIC errors. This can be fixed by changing the
529 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
530 * in driver_*.c set_key() implementation, see driver_ndis.c for an
531 * example on how this can be done.
533 int (*set_key)(void *priv, wpa_alg alg, const u8 *addr,
534 int key_idx, int set_tx, const u8 *seq, size_t seq_len,
535 const u8 *key, size_t key_len);
538 * init - Initialize driver interface
539 * @ctx: context to be used when calling wpa_supplicant functions,
540 * e.g., wpa_supplicant_event()
541 * @ifname: interface name, e.g., wlan0
543 * Returns: Pointer to private data, %NULL on failure
545 * Initialize driver interface, including event processing for kernel
546 * driver events (e.g., associated, scan results, Michael MIC failure).
547 * This function can allocate a private configuration data area for
548 * @ctx, file descriptor, interface name, etc. information that may be
549 * needed in future driver operations. If this is not used, non-NULL
550 * value will need to be returned because %NULL is used to indicate
551 * failure. The returned value will be used as 'void *priv' data for
552 * all other driver_ops functions.
554 * The main event loop (eloop.c) of wpa_supplicant can be used to
555 * register callback for read sockets (eloop_register_read_sock()).
557 * See below for more information about events and
558 * wpa_supplicant_event() function.
560 void * (*init)(void *ctx, const char *ifname);
563 * deinit - Deinitialize driver interface
564 * @priv: private driver interface data from init()
566 * Shut down driver interface and processing of driver events. Free
567 * private data buffer if one was allocated in init() handler.
569 void (*deinit)(void *priv);
572 * set_param - Set driver configuration parameters
573 * @priv: private driver interface data from init()
574 * @param: driver specific configuration parameters
576 * Returns: 0 on success, -1 on failure
578 * Optional handler for notifying driver interface about configuration
579 * parameters (driver_param).
581 int (*set_param)(void *priv, const char *param);
584 * set_countermeasures - Enable/disable TKIP countermeasures
585 * @priv: private driver interface data
586 * @enabled: 1 = countermeasures enabled, 0 = disabled
588 * Returns: 0 on success, -1 on failure
590 * Configure TKIP countermeasures. When these are enabled, the driver
591 * should drop all received and queued frames that are using TKIP.
593 int (*set_countermeasures)(void *priv, int enabled);
596 * set_drop_unencrypted - Enable/disable unencrypted frame filtering
597 * @priv: private driver interface data
598 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
600 * Returns: 0 on success, -1 on failure
602 * Configure the driver to drop all non-EAPOL frames (both receive and
603 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
604 * still be allowed for key negotiation.
606 int (*set_drop_unencrypted)(void *priv, int enabled);
609 * scan - Request the driver to initiate scan (old version)
610 * @priv: private driver interface data
611 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
612 * all SSIDs (either active scan with wildcard SSID or passive
614 * @ssid_len: length of the SSID
616 * Returns: 0 on success, -1 on failure
618 * Once the scan results are ready, the driver should report scan
619 * results event for wpa_supplicant which will eventually request the
620 * results with wpa_driver_get_scan_results().
622 * This function is depracated. New driver wrapper implementations
623 * should implement support for scan2().
625 int (*scan)(void *priv, const u8 *ssid, size_t ssid_len);
628 * get_scan_results - Fetch the latest scan results (old version)
629 * @priv: private driver interface data
630 * @results: pointer to buffer for scan results
631 * @max_size: maximum number of entries (buffer size)
633 * Returns: Number of scan result entries used on success, -1 on
636 * If scan results include more than max_size BSSes, max_size will be
637 * returned and the remaining entries will not be included in the
640 * This function is depracated. New driver wrapper implementations
641 * should implement support for get_scan_results2().
643 int (*get_scan_results)(void *priv,
644 struct wpa_scan_result *results,
648 * deauthenticate - Request driver to deauthenticate
649 * @priv: private driver interface data
650 * @addr: peer address (BSSID of the AP)
651 * @reason_code: 16-bit reason code to be sent in the deauthentication
654 * Returns: 0 on success, -1 on failure
656 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
659 * disassociate - Request driver to disassociate
660 * @priv: private driver interface data
661 * @addr: peer address (BSSID of the AP)
662 * @reason_code: 16-bit reason code to be sent in the disassociation
665 * Returns: 0 on success, -1 on failure
667 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
670 * associate - Request driver to associate
671 * @priv: private driver interface data
672 * @params: association parameters
674 * Returns: 0 on success, -1 on failure
676 int (*associate)(void *priv,
677 struct wpa_driver_associate_params *params);
680 * set_auth_alg - Set IEEE 802.11 authentication algorithm
681 * @priv: private driver interface data
682 * @auth_alg: bit field of AUTH_ALG_*
684 * If the driver supports more than one authentication algorithm at the
685 * same time, it should configure all supported algorithms. If not, one
686 * algorithm needs to be selected arbitrarily. Open System
687 * authentication should be ok for most cases and it is recommended to
688 * be used if other options are not supported. Static WEP configuration
689 * may also use Shared Key authentication and LEAP requires its own
690 * algorithm number. For LEAP, user can make sure that only one
691 * algorithm is used at a time by configuring LEAP as the only
692 * supported EAP method. This information is also available in
693 * associate() params, so set_auth_alg may not be needed in case of
696 * Returns: 0 on success, -1 on failure
698 int (*set_auth_alg)(void *priv, int auth_alg);
701 * add_pmkid - Add PMKSA cache entry to the driver
702 * @priv: private driver interface data
703 * @bssid: BSSID for the PMKSA cache entry
704 * @pmkid: PMKID for the PMKSA cache entry
706 * Returns: 0 on success, -1 on failure
708 * This function is called when a new PMK is received, as a result of
709 * either normal authentication or RSN pre-authentication.
711 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
712 * associate(), add_pmkid() can be used to add new PMKSA cache entries
713 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
714 * driver_ops function does not need to be implemented. Likewise, if
715 * the driver does not support WPA, this function is not needed.
717 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
720 * remove_pmkid - Remove PMKSA cache entry to the driver
721 * @priv: private driver interface data
722 * @bssid: BSSID for the PMKSA cache entry
723 * @pmkid: PMKID for the PMKSA cache entry
725 * Returns: 0 on success, -1 on failure
727 * This function is called when the supplicant drops a PMKSA cache
728 * entry for any reason.
730 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
731 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
732 * between the driver and wpa_supplicant. If the driver uses wpa_ie
733 * from wpa_supplicant, this driver_ops function does not need to be
734 * implemented. Likewise, if the driver does not support WPA, this
735 * function is not needed.
737 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
740 * flush_pmkid - Flush PMKSA cache
741 * @priv: private driver interface data
743 * Returns: 0 on success, -1 on failure
745 * This function is called when the supplicant drops all PMKSA cache
746 * entries for any reason.
748 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
749 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
750 * between the driver and wpa_supplicant. If the driver uses wpa_ie
751 * from wpa_supplicant, this driver_ops function does not need to be
752 * implemented. Likewise, if the driver does not support WPA, this
753 * function is not needed.
755 int (*flush_pmkid)(void *priv);
758 * flush_pmkid - Flush PMKSA cache
759 * @priv: private driver interface data
761 * Returns: 0 on success, -1 on failure
763 * Get driver/firmware/hardware capabilities.
765 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
768 * poll - Poll driver for association information
769 * @priv: private driver interface data
771 * This is an option callback that can be used when the driver does not
772 * provide event mechanism for association events. This is called when
773 * receiving WPA EAPOL-Key messages that require association
774 * information. The driver interface is supposed to generate associnfo
775 * event before returning from this callback function. In addition, the
776 * driver interface should generate an association event after having
777 * sent out associnfo.
779 void (*poll)(void *priv);
782 * get_ifname - Get interface name
783 * @priv: private driver interface data
785 * Returns: Pointer to the interface name. This can differ from the
786 * interface name used in init() call. Init() is called first.
788 * This optional function can be used to allow the driver interface to
789 * replace the interface name with something else, e.g., based on an
790 * interface mapping from a more descriptive name.
792 const char * (*get_ifname)(void *priv);
795 * get_mac_addr - Get own MAC address
796 * @priv: private driver interface data
798 * Returns: Pointer to own MAC address or %NULL on failure
800 * This optional function can be used to get the own MAC address of the
801 * device from the driver interface code. This is only needed if the
802 * l2_packet implementation for the OS does not provide easy access to
804 const u8 * (*get_mac_addr)(void *priv);
807 * send_eapol - Optional function for sending EAPOL packets
808 * @priv: private driver interface data
809 * @dest: Destination MAC address
811 * @data: EAPOL packet starting with IEEE 802.1X header
812 * @data_len: Size of the EAPOL packet
814 * Returns: 0 on success, -1 on failure
816 * This optional function can be used to override l2_packet operations
817 * with driver specific functionality. If this function pointer is set,
818 * l2_packet module is not used at all and the driver interface code is
819 * responsible for receiving and sending all EAPOL packets. The
820 * received EAPOL packets are sent to core code by calling
821 * wpa_supplicant_rx_eapol(). The driver interface is required to
822 * implement get_mac_addr() handler if send_eapol() is used.
824 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
825 const u8 *data, size_t data_len);
828 * set_operstate - Sets device operating state to DORMANT or UP
829 * @priv: private driver interface data
830 * @state: 0 = dormant, 1 = up
831 * Returns: 0 on success, -1 on failure
833 * This is an optional function that can be used on operating systems
834 * that support a concept of controlling network device state from user
835 * space applications. This function, if set, gets called with
836 * state = 1 when authentication has been completed and with state = 0
837 * when connection is lost.
839 int (*set_operstate)(void *priv, int state);
842 * mlme_setprotection - MLME-SETPROTECTION.request primitive
843 * @priv: Private driver interface data
844 * @addr: Address of the station for which to set protection (may be
845 * %NULL for group keys)
846 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
847 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
848 * Returns: 0 on success, -1 on failure
850 * This is an optional function that can be used to set the driver to
851 * require protection for Tx and/or Rx frames. This uses the layer
852 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
853 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
854 * set protection operation; instead, they set protection implicitly
855 * based on configured keys.
857 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
861 * get_hw_feature_data - Get hardware support data (channels and rates)
862 * @priv: Private driver interface data
863 * @num_modes: Variable for returning the number of returned modes
864 * flags: Variable for returning hardware feature flags
865 * Returns: Pointer to allocated hardware data on success or %NULL on
866 * failure. Caller is responsible for freeing this.
868 * This function is only needed for drivers that export MLME
869 * (management frame processing) to wpa_supplicant.
871 struct wpa_hw_modes * (*get_hw_feature_data)(void *priv,
876 * set_channel - Set channel
877 * @priv: Private driver interface data
878 * @phymode: WPA_MODE_IEEE80211B, ..
879 * @chan: IEEE 802.11 channel number
880 * @freq: Frequency of the channel in MHz
881 * Returns: 0 on success, -1 on failure
883 * This function is only needed for drivers that export MLME
884 * (management frame processing) to wpa_supplicant.
886 int (*set_channel)(void *priv, wpa_hw_mode phymode, int chan,
890 * set_ssid - Set SSID
891 * @priv: Private driver interface data
893 * @ssid_len: SSID length
894 * Returns: 0 on success, -1 on failure
896 * This function is only needed for drivers that export MLME
897 * (management frame processing) to wpa_supplicant.
899 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
902 * set_bssid - Set BSSID
903 * @priv: Private driver interface data
905 * Returns: 0 on success, -1 on failure
907 * This function is only needed for drivers that export MLME
908 * (management frame processing) to wpa_supplicant.
910 int (*set_bssid)(void *priv, const u8 *bssid);
913 * send_mlme - Send management frame from MLME
914 * @priv: Private driver interface data
915 * @data: IEEE 802.11 management frame with IEEE 802.11 header
916 * @data_len: Size of the management frame
917 * Returns: 0 on success, -1 on failure
919 * This function is only needed for drivers that export MLME
920 * (management frame processing) to wpa_supplicant.
922 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
925 * mlme_add_sta - Add a STA entry into the driver/netstack
926 * @priv: Private driver interface data
927 * @addr: MAC address of the STA (e.g., BSSID of the AP)
928 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
929 * format (one octet per rate, 1 = 0.5 Mbps)
930 * @supp_rates_len: Number of entries in supp_rates
931 * Returns: 0 on success, -1 on failure
933 * This function is only needed for drivers that export MLME
934 * (management frame processing) to wpa_supplicant. When the MLME code
935 * completes association with an AP, this function is called to
936 * configure the driver/netstack with a STA entry for data frame
937 * processing (TX rate control, encryption/decryption).
939 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
940 size_t supp_rates_len);
943 * mlme_remove_sta - Remove a STA entry from the driver/netstack
944 * @priv: Private driver interface data
945 * @addr: MAC address of the STA (e.g., BSSID of the AP)
946 * Returns: 0 on success, -1 on failure
948 * This function is only needed for drivers that export MLME
949 * (management frame processing) to wpa_supplicant.
951 int (*mlme_remove_sta)(void *priv, const u8 *addr);
954 * update_ft_ies - Update FT (IEEE 802.11r) IEs
955 * @priv: Private driver interface data
956 * @md: Mobility domain (2 octets) (also included inside ies)
957 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
958 * @ies_len: Length of FT IEs in bytes
959 * Returns: 0 on success, -1 on failure
961 * The supplicant uses this callback to let the driver know that keying
962 * material for FT is available and that the driver can use the
963 * provided IEs in the next message in FT authentication sequence.
965 * This function is only needed for driver that support IEEE 802.11r
966 * (Fast BSS Transition).
968 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
972 * send_ft_action - Send FT Action frame (IEEE 802.11r)
973 * @priv: Private driver interface data
974 * @action: Action field value
975 * @target_ap: Target AP address
976 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
977 * @ies_len: Length of FT IEs in bytes
978 * Returns: 0 on success, -1 on failure
980 * The supplicant uses this callback to request the driver to transmit
981 * an FT Action frame (action category 6) for over-the-DS fast BSS
984 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
985 const u8 *ies, size_t ies_len);
988 * get_scan_results2 - Fetch the latest scan results
989 * @priv: private driver interface data
991 * Returns: Allocated buffer of scan results (caller is responsible for
992 * freeing the data structure) on success, NULL on failure
994 struct wpa_scan_results * (*get_scan_results2)(void *priv);
997 * set_probe_req_ie - Set information element(s) for Probe Request
998 * @priv: private driver interface data
999 * @ies: Information elements to append or %NULL to remove extra IEs
1000 * @ies_len: Length of the IE buffer in octets
1001 * Returns: 0 on success, -1 on failure
1003 int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len);
1006 * set_mode - Request driver to set the operating mode
1007 * @priv: private driver interface data
1008 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
1010 * This handler will be called before any key configuration and call to
1011 * associate() handler in order to allow the operation mode to be
1012 * configured as early as possible. This information is also available
1013 * in associate() params and as such, some driver wrappers may not need
1014 * to implement set_mode() handler.
1015 * Returns: 0 on success, -1 on failure
1017 int (*set_mode)(void *priv, int mode);
1020 * set_country - Set country
1021 * @priv: Private driver interface data
1022 * @alpha2: country to which to switch to
1023 * Returns: 0 on success, -1 on failure
1025 * This function is for drivers which support some form
1026 * of setting a regulatory domain.
1028 int (*set_country)(void *priv, const char *alpha2);
1031 * global_init - Global driver initialization
1032 * Returns: Pointer to private data (global), %NULL on failure
1034 * This optional function is called to initialize the driver wrapper
1035 * for global data, i.e., data that applies to all interfaces. If this
1036 * function is implemented, global_deinit() will also need to be
1037 * implemented to free the private data. The driver will also likely
1038 * use init2() function instead of init() to get the pointer to global
1039 * data available to per-interface initializer.
1041 void * (*global_init)(void);
1044 * global_deinit - Global driver deinitialization
1045 * @priv: private driver global data from global_init()
1047 * Terminate any global driver related functionality and free the
1048 * global data structure.
1050 void (*global_deinit)(void *priv);
1053 * init2 - Initialize driver interface (with global data)
1054 * @ctx: context to be used when calling wpa_supplicant functions,
1055 * e.g., wpa_supplicant_event()
1056 * @ifname: interface name, e.g., wlan0
1057 * @global_priv: private driver global data from global_init()
1058 * Returns: Pointer to private data, %NULL on failure
1060 * This function can be used instead of init() if the driver wrapper
1063 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1066 * get_interfaces - Get information about available interfaces
1067 * @global_priv: private driver global data from global_init()
1068 * Returns: Allocated buffer of interface information (caller is
1069 * responsible for freeing the data structure) on success, NULL on
1072 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1075 * scan2 - Request the driver to initiate scan
1076 * @priv: private driver interface data
1077 * @params: Scan parameters
1079 * Returns: 0 on success, -1 on failure
1081 * Once the scan results are ready, the driver should report scan
1082 * results event for wpa_supplicant which will eventually request the
1083 * results with wpa_driver_get_scan_results2().
1085 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1089 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1091 typedef enum wpa_event_type {
1093 * EVENT_ASSOC - Association completed
1095 * This event needs to be delivered when the driver completes IEEE
1096 * 802.11 association or reassociation successfully.
1097 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1098 * after this event has been generated. In addition, optional
1099 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1100 * more information about the association. If the driver interface gets
1101 * both of these events at the same time, it can also include the
1102 * assoc_info data in EVENT_ASSOC call.
1107 * EVENT_DISASSOC - Association lost
1109 * This event should be called when association is lost either due to
1110 * receiving deauthenticate or disassociate frame from the AP or when
1111 * sending either of these frames to the current AP.
1116 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1118 * This event must be delivered when a Michael MIC error is detected by
1119 * the local driver. Additional data for event processing is
1120 * provided with union wpa_event_data::michael_mic_failure. This
1121 * information is used to request new encyption key and to initiate
1122 * TKIP countermeasures if needed.
1124 EVENT_MICHAEL_MIC_FAILURE,
1127 * EVENT_SCAN_RESULTS - Scan results available
1129 * This event must be called whenever scan results are available to be
1130 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1131 * is expected to be used some time after struct wpa_driver_ops::scan()
1132 * is called. If the driver provides an unsolicited event when the scan
1133 * has been completed, this event can be used to trigger
1134 * EVENT_SCAN_RESULTS call. If such event is not available from the
1135 * driver, the driver wrapper code is expected to use a registered
1136 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1137 * scan is expected to be completed.
1142 * EVENT_ASSOCINFO - Report optional extra information for association
1144 * This event can be used to report extra association information for
1145 * EVENT_ASSOC processing. This extra information includes IEs from
1146 * association frames and Beacon/Probe Response frames in union
1147 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1148 * EVENT_ASSOC. Alternatively, the driver interface can include
1149 * assoc_info data in the EVENT_ASSOC call if it has all the
1150 * information available at the same point.
1155 * EVENT_INTERFACE_STATUS - Report interface status changes
1157 * This optional event can be used to report changes in interface
1158 * status (interface added/removed) using union
1159 * wpa_event_data::interface_status. This can be used to trigger
1160 * wpa_supplicant to stop and re-start processing for the interface,
1161 * e.g., when a cardbus card is ejected/inserted.
1163 EVENT_INTERFACE_STATUS,
1166 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1168 * This event can be used to inform wpa_supplicant about candidates for
1169 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1170 * for scan request (ap_scan=2 mode), this event is required for
1171 * pre-authentication. If wpa_supplicant is performing scan request
1172 * (ap_scan=1), this event is optional since scan results can be used
1173 * to add pre-authentication candidates. union
1174 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1175 * candidate and priority of the candidate, e.g., based on the signal
1176 * strength, in order to try to pre-authenticate first with candidates
1177 * that are most likely targets for re-association.
1179 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1180 * on the candidate list. In addition, it can be called for the current
1181 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1182 * will automatically skip pre-authentication in cases where a valid
1183 * PMKSA exists. When more than one candidate exists, this event should
1184 * be generated once for each candidate.
1186 * Driver will be notified about successful pre-authentication with
1187 * struct wpa_driver_ops::add_pmkid() calls.
1189 EVENT_PMKID_CANDIDATE,
1192 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1194 * This event can be used to inform wpa_supplicant about desire to set
1195 * up secure direct link connection between two stations as defined in
1196 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1197 * STAKey negotiation. The caller will need to set peer address for the
1203 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1205 * The driver is expected to report the received FT IEs from
1206 * FT authentication sequence from the AP. The FT IEs are included in
1207 * the extra information in union wpa_event_data::ft_ies.
1212 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1214 * The driver can use this event to inform wpa_supplicant about a STA
1215 * in an IBSS with which protected frames could be exchanged. This
1216 * event starts RSN authentication with the other STA to authenticate
1217 * the STA and set up encryption keys with it.
1219 EVENT_IBSS_RSN_START
1224 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1226 union wpa_event_data {
1228 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1230 * This structure is optional for EVENT_ASSOC calls and required for
1231 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1232 * driver interface does not need to generate separate EVENT_ASSOCINFO
1237 * req_ies - (Re)Association Request IEs
1239 * If the driver generates WPA/RSN IE, this event data must be
1240 * returned for WPA handshake to have needed information. If
1241 * wpa_supplicant-generated WPA/RSN IE is used, this
1242 * information event is optional.
1244 * This should start with the first IE (fixed fields before IEs
1245 * are not included).
1250 * req_ies_len - Length of req_ies in bytes
1255 * resp_ies - (Re)Association Response IEs
1257 * Optional association data from the driver. This data is not
1258 * required WPA, but may be useful for some protocols and as
1259 * such, should be reported if this is available to the driver
1262 * This should start with the first IE (fixed fields before IEs
1263 * are not included).
1268 * resp_ies_len - Length of resp_ies in bytes
1270 size_t resp_ies_len;
1273 * beacon_ies - Beacon or Probe Response IEs
1275 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1276 * Probe Response frames from the current AP (i.e., the one
1277 * that the client just associated with). This information is
1278 * used to update WPA/RSN IE for the AP. If this field is not
1279 * set, the results from previous scan will be used. If no
1280 * data for the new AP is found, scan results will be requested
1281 * again (without scan request). At this point, the driver is
1282 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1285 * This should start with the first IE (fixed fields before IEs
1286 * are not included).
1291 * beacon_ies_len - Length of beacon_ies */
1292 size_t beacon_ies_len;
1296 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1298 struct michael_mic_failure {
1300 } michael_mic_failure;
1303 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1305 struct interface_status {
1308 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1313 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1315 struct pmkid_candidate {
1316 /** BSSID of the PMKID candidate */
1318 /** Smaller the index, higher the priority */
1320 /** Whether RSN IE includes pre-authenticate flag */
1325 * struct stkstart - Data for EVENT_STKSTART
1332 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1334 * During FT (IEEE 802.11r) authentication sequence, the driver is
1335 * expected to use this event to report received FT IEs (MDIE, FTIE,
1336 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1337 * IEs for the next message will be delivered through the
1338 * struct wpa_driver_ops::update_ft_ies() callback.
1344 u8 target_ap[ETH_ALEN];
1348 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1350 struct ibss_rsn_start {
1356 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1357 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1358 * with struct wpa_driver_ops::init()
1359 * @event: event type (defined above)
1360 * @data: possible extra data for the event
1362 * Driver wrapper code should call this function whenever an event is received
1365 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1366 union wpa_event_data *data);
1369 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1370 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1371 * with struct wpa_driver_ops::init()
1372 * @src_addr: Source address of the EAPOL frame
1373 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1374 * @len: Length of the EAPOL data
1376 * This function is called for each received EAPOL frame. Most driver
1377 * interfaces rely on more generic OS mechanism for receiving frames through
1378 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1379 * take care of received EAPOL frames and deliver them to the core supplicant
1380 * code by calling this function.
1382 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1383 const u8 *buf, size_t len);
1385 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1386 struct ieee80211_rx_status *rx_status);
1387 void wpa_supplicant_sta_free_hw_features(struct wpa_hw_modes *hw_features,
1388 size_t num_hw_features);
1390 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1391 #define WPA_IE_VENDOR_TYPE 0x0050f201
1392 #define WPS_IE_VENDOR_TYPE 0x0050f204
1393 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1395 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1397 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1398 void wpa_scan_results_free(struct wpa_scan_results *res);
1399 void wpa_scan_sort_results(struct wpa_scan_results *res);
1401 #endif /* DRIVER_H */