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
25 #define AUTH_ALG_FT 0x08
27 #define IEEE80211_MODE_INFRA 0
28 #define IEEE80211_MODE_IBSS 1
30 #define IEEE80211_CAP_ESS 0x0001
31 #define IEEE80211_CAP_IBSS 0x0002
32 #define IEEE80211_CAP_PRIVACY 0x0010
34 #define SSID_MAX_WPA_IE_LEN 40
36 * struct wpa_scan_result - Scan results (old structure)
39 * @ssid_len: length of the ssid
41 * @wpa_ie_len: length of the wpa_ie
43 * @rsn_ie_len: length of the RSN IE
44 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
45 * @caps: capability information field in host byte order
46 * @qual: signal quality
48 * @level: signal level
49 * @maxrate: maximum supported rate
50 * @mdie_present: Whether MDIE was included in Beacon/ProbeRsp frame
51 * @mdie: Mobility domain identifier IE (IEEE 802.11r MDIE) (starting from
55 * This structure is used as a generic format for scan results from the
56 * driver. Each driver interface implementation is responsible for converting
57 * the driver or OS specific scan results into this format.
59 * This structure is the old data structure used for scan results. It is
60 * obsoleted by the new struct wpa_scan_res structure and the old version is
61 * only included for backwards compatibility with existing driver wrapper
62 * implementations. New implementations are encouraged to implement for struct
63 * wpa_scan_res. The old structure will be removed at some point.
65 struct wpa_scan_result {
69 u8 wpa_ie[SSID_MAX_WPA_IE_LEN];
71 u8 rsn_ie[SSID_MAX_WPA_IE_LEN];
85 #define WPA_SCAN_QUAL_INVALID BIT(0)
86 #define WPA_SCAN_NOISE_INVALID BIT(1)
87 #define WPA_SCAN_LEVEL_INVALID BIT(2)
88 #define WPA_SCAN_LEVEL_DBM BIT(3)
91 * struct wpa_scan_res - Scan result for an BSS/IBSS
92 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
94 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
95 * @beacon_int: beacon interval in TUs (host byte order)
96 * @caps: capability information field in host byte order
97 * @qual: signal quality
99 * @level: signal level
101 * @ie_len: length of the following IE field in octets
103 * This structure is used as a generic format for scan results from the
104 * driver. Each driver interface implementation is responsible for converting
105 * the driver or OS specific scan results into this format.
107 * If the driver does not support reporting all IEs, the IE data structure is
108 * constructed of the IEs that are available. This field will also need to
109 * include SSID in IE format. All drivers are encouraged to be extended to
110 * report all IEs to make it easier to support future additions.
112 struct wpa_scan_res {
123 /* followed by ie_len octets of IEs */
127 * struct wpa_scan_results - Scan results
128 * @res: Array of pointers to allocated variable length scan result entries
129 * @num: Number of entries in the scan result array
131 struct wpa_scan_results {
132 struct wpa_scan_res **res;
137 * struct wpa_interface_info - Network interface information
138 * @next: Pointer to the next interface or NULL if this is the last one
139 * @ifname: Interface name that can be used with init() or init2()
140 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
142 * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one
143 * is not an allocated copy, i.e., get_interfaces() caller will not free
146 struct wpa_interface_info {
147 struct wpa_interface_info *next;
150 const char *drv_name;
153 #define WPAS_MAX_SCAN_SSIDS 4
156 * struct wpa_driver_scan_params - Scan parameters
157 * Data for struct wpa_driver_ops::scan2().
159 struct wpa_driver_scan_params {
161 * ssids - SSIDs to scan for
163 struct wpa_driver_scan_ssid {
165 * ssid - specific SSID to scan for (ProbeReq)
166 * %NULL or zero-length SSID is used to indicate active scan
167 * with wildcard SSID.
171 * ssid_len: Length of the SSID in octets
174 } ssids[WPAS_MAX_SCAN_SSIDS];
177 * num_ssids - Number of entries in ssids array
178 * Zero indicates a request for a passive scan.
183 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
188 * extra_ies_len - Length of extra_ies in octets
190 size_t extra_ies_len;
194 * struct wpa_driver_auth_params - Authentication parameters
195 * Data for struct wpa_driver_ops::authenticate().
197 struct wpa_driver_auth_params {
208 * struct wpa_driver_associate_params - Association parameters
209 * Data for struct wpa_driver_ops::associate().
211 struct wpa_driver_associate_params {
213 * bssid - BSSID of the selected AP
214 * This can be %NULL, if ap_scan=2 mode is used and the driver is
215 * responsible for selecting with which BSS to associate. */
219 * ssid - The selected SSID
225 * freq - Frequency of the channel the selected AP is using
226 * Frequency that the selected AP is using (in MHz as
227 * reported in the scan results)
232 * wpa_ie - WPA information element for (Re)Association Request
233 * WPA information element to be included in (Re)Association
234 * Request (including information element id and length). Use
235 * of this WPA IE is optional. If the driver generates the WPA
236 * IE, it can use pairwise_suite, group_suite, and
237 * key_mgmt_suite to select proper algorithms. In this case,
238 * the driver has to notify wpa_supplicant about the used WPA
239 * IE by generating an event that the interface code will
240 * convert into EVENT_ASSOCINFO data (see below).
242 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
243 * instead. The driver can determine which version is used by
244 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
247 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
251 * wpa_ie_len - length of the wpa_ie
255 /* The selected pairwise/group cipher and key management
256 * suites. These are usually ignored if @wpa_ie is used. */
257 wpa_cipher pairwise_suite;
258 wpa_cipher group_suite;
259 wpa_key_mgmt key_mgmt_suite;
262 * auth_alg - Allowed authentication algorithms
263 * Bit field of AUTH_ALG_*
268 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
273 * wep_key - WEP keys for static WEP configuration
275 const u8 *wep_key[4];
278 * wep_key_len - WEP key length for static WEP configuration
280 size_t wep_key_len[4];
283 * wep_tx_keyidx - WEP TX key index for static WEP configuration
288 * mgmt_frame_protection - IEEE 802.11w management frame protection
291 NO_MGMT_FRAME_PROTECTION,
292 MGMT_FRAME_PROTECTION_OPTIONAL,
293 MGMT_FRAME_PROTECTION_REQUIRED
294 } mgmt_frame_protection;
297 * ft_ies - IEEE 802.11r / FT information elements
298 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
299 * for fast transition, this parameter is set to include the IEs that
300 * are to be sent in the next FT Authentication Request message.
301 * update_ft_ies() handler is called to update the IEs for further
302 * FT messages in the sequence.
304 * The driver should use these IEs only if the target AP is advertising
305 * the same mobility domain as the one included in the MDIE here.
307 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
308 * AP after the initial association. These IEs can only be used if the
309 * target AP is advertising support for FT and is using the same MDIE
310 * and SSID as the current AP.
312 * The driver is responsible for reporting the FT IEs received from the
313 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
314 * type. update_ft_ies() handler will then be called with the FT IEs to
315 * include in the next frame in the authentication sequence.
320 * ft_ies_len - Length of ft_ies in bytes
325 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
327 * This value is provided to allow the driver interface easier access
328 * to the current mobility domain. This value is set to %NULL if no
329 * mobility domain is currently active.
334 * passphrase - RSN passphrase for PSK
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 8..63 character ASCII passphrase, if available. Please note that
339 * this can be %NULL if passphrase was not used to generate the PSK. In
340 * that case, the psk field must be used to fetch the PSK.
342 const char *passphrase;
345 * psk - RSN PSK (alternative for passphrase for PSK)
347 * This value is made available only for WPA/WPA2-Personal (PSK) and
348 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
349 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
350 * be prepared to handle %NULL value as an error.
355 * drop_unencrypted - Enable/disable unencrypted frame filtering
357 * Configure the driver to drop all non-EAPOL frames (both receive and
358 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
359 * still be allowed for key negotiation.
361 int drop_unencrypted;
365 * struct wpa_driver_capa - Driver capability information
367 struct wpa_driver_capa {
368 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
369 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
370 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
371 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
372 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
373 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
374 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
375 unsigned int key_mgmt;
377 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
378 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
379 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
380 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
383 #define WPA_DRIVER_AUTH_OPEN 0x00000001
384 #define WPA_DRIVER_AUTH_SHARED 0x00000002
385 #define WPA_DRIVER_AUTH_LEAP 0x00000004
388 /* Driver generated WPA/RSN IE */
389 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
390 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
391 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
392 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
393 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
394 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
395 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
396 /* Driver provides separate commands for authentication and association (SME in
397 * wpa_supplicant). */
398 #define WPA_DRIVER_FLAGS_SME 0x00000020
405 #define WPA_CHAN_W_SCAN 0x00000001
406 #define WPA_CHAN_W_ACTIVE_SCAN 0x00000002
407 #define WPA_CHAN_W_IBSS 0x00000004
409 struct wpa_channel_data {
410 short chan; /* channel number (IEEE 802.11) */
411 short freq; /* frequency in MHz */
412 int flag; /* flag for user space use (WPA_CHAN_*) */
415 #define WPA_RATE_ERP 0x00000001
416 #define WPA_RATE_BASIC 0x00000002
417 #define WPA_RATE_PREAMBLE2 0x00000004
418 #define WPA_RATE_SUPPORTED 0x00000010
419 #define WPA_RATE_OFDM 0x00000020
420 #define WPA_RATE_CCK 0x00000040
421 #define WPA_RATE_MANDATORY 0x00000100
423 struct wpa_rate_data {
424 int rate; /* rate in 100 kbps */
425 int flags; /* WPA_RATE_ flags */
435 struct wpa_hw_modes {
438 struct wpa_channel_data *channels;
440 struct wpa_rate_data *rates;
444 struct ieee80211_rx_status {
451 * struct wpa_driver_ops - Driver interface API definition
453 * This structure defines the API that each driver interface needs to implement
454 * for core wpa_supplicant code. All driver specific functionality is captured
457 struct wpa_driver_ops {
458 /** Name of the driver interface */
460 /** One line description of the driver interface */
464 * get_bssid - Get the current BSSID
465 * @priv: private driver interface data
466 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
468 * Returns: 0 on success, -1 on failure
470 * Query kernel driver for the current BSSID and copy it to bssid.
471 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
474 int (*get_bssid)(void *priv, u8 *bssid);
477 * get_ssid - Get the current SSID
478 * @priv: private driver interface data
479 * @ssid: buffer for SSID (at least 32 bytes)
481 * Returns: Length of the SSID on success, -1 on failure
483 * Query kernel driver for the current SSID and copy it to ssid.
484 * Returning zero is recommended if the STA is not associated.
486 * Note: SSID is an array of octets, i.e., it is not nul terminated and
487 * can, at least in theory, contain control characters (including nul)
488 * and as such, should be processed as binary data, not a printable
491 int (*get_ssid)(void *priv, u8 *ssid);
494 * set_wpa - Enable/disable WPA support (OBSOLETE)
495 * @priv: private driver interface data
496 * @enabled: 1 = enable, 0 = disable
498 * Returns: 0 on success, -1 on failure
500 * Note: This function is included for backwards compatibility. This is
501 * called only just after init and just before deinit, so these
502 * functions can be used to implement same functionality and the driver
503 * interface need not define this function.
505 * Configure the kernel driver to enable/disable WPA support. This may
506 * be empty function, if WPA support is always enabled. Common
507 * configuration items are WPA IE (clearing it when WPA support is
508 * disabled), Privacy flag configuration for capability field (note:
509 * this the value need to set in associate handler to allow plaintext
510 * mode to be used) when trying to associate with, roaming mode (can
511 * allow wpa_supplicant to control roaming if ap_scan=1 is used;
512 * however, drivers can also implement roaming if desired, especially
513 * ap_scan=2 mode is used for this).
515 int (*set_wpa)(void *priv, int enabled);
518 * set_key - Configure encryption key
519 * @priv: private driver interface data
520 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
521 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
522 * %WPA_ALG_NONE clears the key.
523 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
524 * broadcast/default keys
525 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
527 * @set_tx: configure this key as the default Tx key (only used when
528 * driver does not support separate unicast/individual key
529 * @seq: sequence number/packet number, seq_len octets, the next
530 * packet number to be used for in replay protection; configured
531 * for Rx keys (in most cases, this is only used with broadcast
532 * keys and set to zero for unicast keys)
533 * @seq_len: length of the seq, depends on the algorithm:
534 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
535 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
537 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
538 * TKIP: 32, CCMP: 16, IGTK: 16)
540 * Returns: 0 on success, -1 on failure
542 * Configure the given key for the kernel driver. If the driver
543 * supports separate individual keys (4 default keys + 1 individual),
544 * addr can be used to determine whether the key is default or
545 * individual. If only 4 keys are supported, the default key with key
546 * index 0 is used as the individual key. STA must be configured to use
547 * it as the default Tx key (set_tx is set) and accept Rx for all the
548 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
549 * broadcast keys, so key index 0 is available for this kind of
552 * Please note that TKIP keys include separate TX and RX MIC keys and
553 * some drivers may expect them in different order than wpa_supplicant
554 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
555 * will tricker Michael MIC errors. This can be fixed by changing the
556 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
557 * in driver_*.c set_key() implementation, see driver_ndis.c for an
558 * example on how this can be done.
560 int (*set_key)(void *priv, wpa_alg alg, const u8 *addr,
561 int key_idx, int set_tx, const u8 *seq, size_t seq_len,
562 const u8 *key, size_t key_len);
565 * init - Initialize driver interface
566 * @ctx: context to be used when calling wpa_supplicant functions,
567 * e.g., wpa_supplicant_event()
568 * @ifname: interface name, e.g., wlan0
570 * Returns: Pointer to private data, %NULL on failure
572 * Initialize driver interface, including event processing for kernel
573 * driver events (e.g., associated, scan results, Michael MIC failure).
574 * This function can allocate a private configuration data area for
575 * @ctx, file descriptor, interface name, etc. information that may be
576 * needed in future driver operations. If this is not used, non-NULL
577 * value will need to be returned because %NULL is used to indicate
578 * failure. The returned value will be used as 'void *priv' data for
579 * all other driver_ops functions.
581 * The main event loop (eloop.c) of wpa_supplicant can be used to
582 * register callback for read sockets (eloop_register_read_sock()).
584 * See below for more information about events and
585 * wpa_supplicant_event() function.
587 void * (*init)(void *ctx, const char *ifname);
590 * deinit - Deinitialize driver interface
591 * @priv: private driver interface data from init()
593 * Shut down driver interface and processing of driver events. Free
594 * private data buffer if one was allocated in init() handler.
596 void (*deinit)(void *priv);
599 * set_param - Set driver configuration parameters
600 * @priv: private driver interface data from init()
601 * @param: driver specific configuration parameters
603 * Returns: 0 on success, -1 on failure
605 * Optional handler for notifying driver interface about configuration
606 * parameters (driver_param).
608 int (*set_param)(void *priv, const char *param);
611 * set_countermeasures - Enable/disable TKIP countermeasures
612 * @priv: private driver interface data
613 * @enabled: 1 = countermeasures enabled, 0 = disabled
615 * Returns: 0 on success, -1 on failure
617 * Configure TKIP countermeasures. When these are enabled, the driver
618 * should drop all received and queued frames that are using TKIP.
620 int (*set_countermeasures)(void *priv, int enabled);
623 * set_drop_unencrypted - Enable/disable unencrypted frame filtering
624 * @priv: private driver interface data
625 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
627 * Returns: 0 on success, -1 on failure
629 * Configure the driver to drop all non-EAPOL frames (both receive and
630 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
631 * still be allowed for key negotiation.
633 * This function is deprecated. New driver wrapper implementations
634 * should use associate() parameter drop_unencrypted instead.
636 int (*set_drop_unencrypted)(void *priv, int enabled);
639 * scan - Request the driver to initiate scan (old version)
640 * @priv: private driver interface data
641 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
642 * all SSIDs (either active scan with wildcard SSID or passive
644 * @ssid_len: length of the SSID
646 * Returns: 0 on success, -1 on failure
648 * Once the scan results are ready, the driver should report scan
649 * results event for wpa_supplicant which will eventually request the
650 * results with wpa_driver_get_scan_results().
652 * This function is deprecated. New driver wrapper implementations
653 * should implement support for scan2().
655 int (*scan)(void *priv, const u8 *ssid, size_t ssid_len);
658 * get_scan_results - Fetch the latest scan results (old version)
659 * @priv: private driver interface data
660 * @results: pointer to buffer for scan results
661 * @max_size: maximum number of entries (buffer size)
663 * Returns: Number of scan result entries used on success, -1 on
666 * If scan results include more than max_size BSSes, max_size will be
667 * returned and the remaining entries will not be included in the
670 * This function is deprecated. New driver wrapper implementations
671 * should implement support for get_scan_results2().
673 int (*get_scan_results)(void *priv,
674 struct wpa_scan_result *results,
678 * deauthenticate - Request driver to deauthenticate
679 * @priv: private driver interface data
680 * @addr: peer address (BSSID of the AP)
681 * @reason_code: 16-bit reason code to be sent in the deauthentication
684 * Returns: 0 on success, -1 on failure
686 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
689 * disassociate - Request driver to disassociate
690 * @priv: private driver interface data
691 * @addr: peer address (BSSID of the AP)
692 * @reason_code: 16-bit reason code to be sent in the disassociation
695 * Returns: 0 on success, -1 on failure
697 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
700 * associate - Request driver to associate
701 * @priv: private driver interface data
702 * @params: association parameters
704 * Returns: 0 on success, -1 on failure
706 int (*associate)(void *priv,
707 struct wpa_driver_associate_params *params);
710 * set_auth_alg - Set IEEE 802.11 authentication algorithm
711 * @priv: private driver interface data
712 * @auth_alg: bit field of AUTH_ALG_*
714 * If the driver supports more than one authentication algorithm at the
715 * same time, it should configure all supported algorithms. If not, one
716 * algorithm needs to be selected arbitrarily. Open System
717 * authentication should be ok for most cases and it is recommended to
718 * be used if other options are not supported. Static WEP configuration
719 * may also use Shared Key authentication and LEAP requires its own
720 * algorithm number. For LEAP, user can make sure that only one
721 * algorithm is used at a time by configuring LEAP as the only
722 * supported EAP method. This information is also available in
723 * associate() params, so set_auth_alg may not be needed in case of
726 * This function is deprecated. New driver wrapper implementations
727 * should use associate() parameter auth_alg instead.
729 * Returns: 0 on success, -1 on failure
731 int (*set_auth_alg)(void *priv, int auth_alg);
734 * add_pmkid - Add PMKSA cache entry to the driver
735 * @priv: private driver interface data
736 * @bssid: BSSID for the PMKSA cache entry
737 * @pmkid: PMKID for the PMKSA cache entry
739 * Returns: 0 on success, -1 on failure
741 * This function is called when a new PMK is received, as a result of
742 * either normal authentication or RSN pre-authentication.
744 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
745 * associate(), add_pmkid() can be used to add new PMKSA cache entries
746 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
747 * driver_ops function does not need to be implemented. Likewise, if
748 * the driver does not support WPA, this function is not needed.
750 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
753 * remove_pmkid - Remove PMKSA cache entry to the driver
754 * @priv: private driver interface data
755 * @bssid: BSSID for the PMKSA cache entry
756 * @pmkid: PMKID for the PMKSA cache entry
758 * Returns: 0 on success, -1 on failure
760 * This function is called when the supplicant drops a PMKSA cache
761 * entry for any reason.
763 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
764 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
765 * between the driver and wpa_supplicant. If the driver uses wpa_ie
766 * from wpa_supplicant, this driver_ops function does not need to be
767 * implemented. Likewise, if the driver does not support WPA, this
768 * function is not needed.
770 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
773 * flush_pmkid - Flush PMKSA cache
774 * @priv: private driver interface data
776 * Returns: 0 on success, -1 on failure
778 * This function is called when the supplicant drops all PMKSA cache
779 * entries for any reason.
781 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
782 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
783 * between the driver and wpa_supplicant. If the driver uses wpa_ie
784 * from wpa_supplicant, this driver_ops function does not need to be
785 * implemented. Likewise, if the driver does not support WPA, this
786 * function is not needed.
788 int (*flush_pmkid)(void *priv);
791 * flush_pmkid - Flush PMKSA cache
792 * @priv: private driver interface data
794 * Returns: 0 on success, -1 on failure
796 * Get driver/firmware/hardware capabilities.
798 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
801 * poll - Poll driver for association information
802 * @priv: private driver interface data
804 * This is an option callback that can be used when the driver does not
805 * provide event mechanism for association events. This is called when
806 * receiving WPA EAPOL-Key messages that require association
807 * information. The driver interface is supposed to generate associnfo
808 * event before returning from this callback function. In addition, the
809 * driver interface should generate an association event after having
810 * sent out associnfo.
812 void (*poll)(void *priv);
815 * get_ifname - Get interface name
816 * @priv: private driver interface data
818 * Returns: Pointer to the interface name. This can differ from the
819 * interface name used in init() call. Init() is called first.
821 * This optional function can be used to allow the driver interface to
822 * replace the interface name with something else, e.g., based on an
823 * interface mapping from a more descriptive name.
825 const char * (*get_ifname)(void *priv);
828 * get_mac_addr - Get own MAC address
829 * @priv: private driver interface data
831 * Returns: Pointer to own MAC address or %NULL on failure
833 * This optional function can be used to get the own MAC address of the
834 * device from the driver interface code. This is only needed if the
835 * l2_packet implementation for the OS does not provide easy access to
837 const u8 * (*get_mac_addr)(void *priv);
840 * send_eapol - Optional function for sending EAPOL packets
841 * @priv: private driver interface data
842 * @dest: Destination MAC address
844 * @data: EAPOL packet starting with IEEE 802.1X header
845 * @data_len: Size of the EAPOL packet
847 * Returns: 0 on success, -1 on failure
849 * This optional function can be used to override l2_packet operations
850 * with driver specific functionality. If this function pointer is set,
851 * l2_packet module is not used at all and the driver interface code is
852 * responsible for receiving and sending all EAPOL packets. The
853 * received EAPOL packets are sent to core code by calling
854 * wpa_supplicant_rx_eapol(). The driver interface is required to
855 * implement get_mac_addr() handler if send_eapol() is used.
857 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
858 const u8 *data, size_t data_len);
861 * set_operstate - Sets device operating state to DORMANT or UP
862 * @priv: private driver interface data
863 * @state: 0 = dormant, 1 = up
864 * Returns: 0 on success, -1 on failure
866 * This is an optional function that can be used on operating systems
867 * that support a concept of controlling network device state from user
868 * space applications. This function, if set, gets called with
869 * state = 1 when authentication has been completed and with state = 0
870 * when connection is lost.
872 int (*set_operstate)(void *priv, int state);
875 * mlme_setprotection - MLME-SETPROTECTION.request primitive
876 * @priv: Private driver interface data
877 * @addr: Address of the station for which to set protection (may be
878 * %NULL for group keys)
879 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
880 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
881 * Returns: 0 on success, -1 on failure
883 * This is an optional function that can be used to set the driver to
884 * require protection for Tx and/or Rx frames. This uses the layer
885 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
886 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
887 * set protection operation; instead, they set protection implicitly
888 * based on configured keys.
890 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
894 * get_hw_feature_data - Get hardware support data (channels and rates)
895 * @priv: Private driver interface data
896 * @num_modes: Variable for returning the number of returned modes
897 * flags: Variable for returning hardware feature flags
898 * Returns: Pointer to allocated hardware data on success or %NULL on
899 * failure. Caller is responsible for freeing this.
901 * This function is only needed for drivers that export MLME
902 * (management frame processing) to wpa_supplicant.
904 struct wpa_hw_modes * (*get_hw_feature_data)(void *priv,
909 * set_channel - Set channel
910 * @priv: Private driver interface data
911 * @phymode: WPA_MODE_IEEE80211B, ..
912 * @chan: IEEE 802.11 channel number
913 * @freq: Frequency of the channel in MHz
914 * Returns: 0 on success, -1 on failure
916 * This function is only needed for drivers that export MLME
917 * (management frame processing) to wpa_supplicant.
919 int (*set_channel)(void *priv, wpa_hw_mode phymode, int chan,
923 * set_ssid - Set SSID
924 * @priv: Private driver interface data
926 * @ssid_len: SSID length
927 * Returns: 0 on success, -1 on failure
929 * This function is only needed for drivers that export MLME
930 * (management frame processing) to wpa_supplicant.
932 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
935 * set_bssid - Set BSSID
936 * @priv: Private driver interface data
938 * Returns: 0 on success, -1 on failure
940 * This function is only needed for drivers that export MLME
941 * (management frame processing) to wpa_supplicant.
943 int (*set_bssid)(void *priv, const u8 *bssid);
946 * send_mlme - Send management frame from MLME
947 * @priv: Private driver interface data
948 * @data: IEEE 802.11 management frame with IEEE 802.11 header
949 * @data_len: Size of the management frame
950 * Returns: 0 on success, -1 on failure
952 * This function is only needed for drivers that export MLME
953 * (management frame processing) to wpa_supplicant.
955 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
958 * mlme_add_sta - Add a STA entry into the driver/netstack
959 * @priv: Private driver interface data
960 * @addr: MAC address of the STA (e.g., BSSID of the AP)
961 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
962 * format (one octet per rate, 1 = 0.5 Mbps)
963 * @supp_rates_len: Number of entries in supp_rates
964 * Returns: 0 on success, -1 on failure
966 * This function is only needed for drivers that export MLME
967 * (management frame processing) to wpa_supplicant. When the MLME code
968 * completes association with an AP, this function is called to
969 * configure the driver/netstack with a STA entry for data frame
970 * processing (TX rate control, encryption/decryption).
972 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
973 size_t supp_rates_len);
976 * mlme_remove_sta - Remove a STA entry from the driver/netstack
977 * @priv: Private driver interface data
978 * @addr: MAC address of the STA (e.g., BSSID of the AP)
979 * Returns: 0 on success, -1 on failure
981 * This function is only needed for drivers that export MLME
982 * (management frame processing) to wpa_supplicant.
984 int (*mlme_remove_sta)(void *priv, const u8 *addr);
987 * update_ft_ies - Update FT (IEEE 802.11r) IEs
988 * @priv: Private driver interface data
989 * @md: Mobility domain (2 octets) (also included inside ies)
990 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
991 * @ies_len: Length of FT IEs in bytes
992 * Returns: 0 on success, -1 on failure
994 * The supplicant uses this callback to let the driver know that keying
995 * material for FT is available and that the driver can use the
996 * provided IEs in the next message in FT authentication sequence.
998 * This function is only needed for driver that support IEEE 802.11r
999 * (Fast BSS Transition).
1001 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1005 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1006 * @priv: Private driver interface data
1007 * @action: Action field value
1008 * @target_ap: Target AP address
1009 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1010 * @ies_len: Length of FT IEs in bytes
1011 * Returns: 0 on success, -1 on failure
1013 * The supplicant uses this callback to request the driver to transmit
1014 * an FT Action frame (action category 6) for over-the-DS fast BSS
1017 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1018 const u8 *ies, size_t ies_len);
1021 * get_scan_results2 - Fetch the latest scan results
1022 * @priv: private driver interface data
1024 * Returns: Allocated buffer of scan results (caller is responsible for
1025 * freeing the data structure) on success, NULL on failure
1027 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1030 * set_probe_req_ie - Set information element(s) for Probe Request
1031 * @priv: private driver interface data
1032 * @ies: Information elements to append or %NULL to remove extra IEs
1033 * @ies_len: Length of the IE buffer in octets
1034 * Returns: 0 on success, -1 on failure
1036 int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len);
1039 * set_mode - Request driver to set the operating mode
1040 * @priv: private driver interface data
1041 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
1043 * This handler will be called before any key configuration and call to
1044 * associate() handler in order to allow the operation mode to be
1045 * configured as early as possible. This information is also available
1046 * in associate() params and as such, driver wrappers may not need
1047 * to implement set_mode() handler.
1049 * This function is deprecated. New driver wrapper implementations
1050 * should use associate() parameter mode instead.
1052 * Returns: 0 on success, -1 on failure
1054 int (*set_mode)(void *priv, int mode);
1057 * set_country - Set country
1058 * @priv: Private driver interface data
1059 * @alpha2: country to which to switch to
1060 * Returns: 0 on success, -1 on failure
1062 * This function is for drivers which support some form
1063 * of setting a regulatory domain.
1065 int (*set_country)(void *priv, const char *alpha2);
1068 * global_init - Global driver initialization
1069 * Returns: Pointer to private data (global), %NULL on failure
1071 * This optional function is called to initialize the driver wrapper
1072 * for global data, i.e., data that applies to all interfaces. If this
1073 * function is implemented, global_deinit() will also need to be
1074 * implemented to free the private data. The driver will also likely
1075 * use init2() function instead of init() to get the pointer to global
1076 * data available to per-interface initializer.
1078 void * (*global_init)(void);
1081 * global_deinit - Global driver deinitialization
1082 * @priv: private driver global data from global_init()
1084 * Terminate any global driver related functionality and free the
1085 * global data structure.
1087 void (*global_deinit)(void *priv);
1090 * init2 - Initialize driver interface (with global data)
1091 * @ctx: context to be used when calling wpa_supplicant functions,
1092 * e.g., wpa_supplicant_event()
1093 * @ifname: interface name, e.g., wlan0
1094 * @global_priv: private driver global data from global_init()
1095 * Returns: Pointer to private data, %NULL on failure
1097 * This function can be used instead of init() if the driver wrapper
1100 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1103 * get_interfaces - Get information about available interfaces
1104 * @global_priv: private driver global data from global_init()
1105 * Returns: Allocated buffer of interface information (caller is
1106 * responsible for freeing the data structure) on success, NULL on
1109 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1112 * scan2 - Request the driver to initiate scan
1113 * @priv: private driver interface data
1114 * @params: Scan parameters
1116 * Returns: 0 on success, -1 on failure
1118 * Once the scan results are ready, the driver should report scan
1119 * results event for wpa_supplicant which will eventually request the
1120 * results with wpa_driver_get_scan_results2().
1122 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1125 * authenticate - Request driver to authenticate
1126 * @priv: private driver interface data
1127 * @params: authentication parameters
1128 * Returns: 0 on success, -1 on failure
1130 * This is an optional function that can be used with drivers that
1131 * support separate authentication and association steps, i.e., when
1132 * wpa_supplicant can act as the SME. If not implemented, associate()
1133 * function is expected to take care of IEEE 802.11 authentication,
1136 int (*authenticate)(void *priv,
1137 struct wpa_driver_auth_params *params);
1141 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1143 typedef enum wpa_event_type {
1145 * EVENT_ASSOC - Association completed
1147 * This event needs to be delivered when the driver completes IEEE
1148 * 802.11 association or reassociation successfully.
1149 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1150 * after this event has been generated. In addition, optional
1151 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1152 * more information about the association. If the driver interface gets
1153 * both of these events at the same time, it can also include the
1154 * assoc_info data in EVENT_ASSOC call.
1159 * EVENT_DISASSOC - Association lost
1161 * This event should be called when association is lost either due to
1162 * receiving deauthenticate or disassociate frame from the AP or when
1163 * sending either of these frames to the current AP. If the driver
1164 * supports separate deauthentication event, EVENT_DISASSOC should only
1165 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1170 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1172 * This event must be delivered when a Michael MIC error is detected by
1173 * the local driver. Additional data for event processing is
1174 * provided with union wpa_event_data::michael_mic_failure. This
1175 * information is used to request new encyption key and to initiate
1176 * TKIP countermeasures if needed.
1178 EVENT_MICHAEL_MIC_FAILURE,
1181 * EVENT_SCAN_RESULTS - Scan results available
1183 * This event must be called whenever scan results are available to be
1184 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1185 * is expected to be used some time after struct wpa_driver_ops::scan()
1186 * is called. If the driver provides an unsolicited event when the scan
1187 * has been completed, this event can be used to trigger
1188 * EVENT_SCAN_RESULTS call. If such event is not available from the
1189 * driver, the driver wrapper code is expected to use a registered
1190 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1191 * scan is expected to be completed.
1196 * EVENT_ASSOCINFO - Report optional extra information for association
1198 * This event can be used to report extra association information for
1199 * EVENT_ASSOC processing. This extra information includes IEs from
1200 * association frames and Beacon/Probe Response frames in union
1201 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1202 * EVENT_ASSOC. Alternatively, the driver interface can include
1203 * assoc_info data in the EVENT_ASSOC call if it has all the
1204 * information available at the same point.
1209 * EVENT_INTERFACE_STATUS - Report interface status changes
1211 * This optional event can be used to report changes in interface
1212 * status (interface added/removed) using union
1213 * wpa_event_data::interface_status. This can be used to trigger
1214 * wpa_supplicant to stop and re-start processing for the interface,
1215 * e.g., when a cardbus card is ejected/inserted.
1217 EVENT_INTERFACE_STATUS,
1220 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1222 * This event can be used to inform wpa_supplicant about candidates for
1223 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1224 * for scan request (ap_scan=2 mode), this event is required for
1225 * pre-authentication. If wpa_supplicant is performing scan request
1226 * (ap_scan=1), this event is optional since scan results can be used
1227 * to add pre-authentication candidates. union
1228 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1229 * candidate and priority of the candidate, e.g., based on the signal
1230 * strength, in order to try to pre-authenticate first with candidates
1231 * that are most likely targets for re-association.
1233 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1234 * on the candidate list. In addition, it can be called for the current
1235 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1236 * will automatically skip pre-authentication in cases where a valid
1237 * PMKSA exists. When more than one candidate exists, this event should
1238 * be generated once for each candidate.
1240 * Driver will be notified about successful pre-authentication with
1241 * struct wpa_driver_ops::add_pmkid() calls.
1243 EVENT_PMKID_CANDIDATE,
1246 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1248 * This event can be used to inform wpa_supplicant about desire to set
1249 * up secure direct link connection between two stations as defined in
1250 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1251 * STAKey negotiation. The caller will need to set peer address for the
1257 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1259 * The driver is expected to report the received FT IEs from
1260 * FT authentication sequence from the AP. The FT IEs are included in
1261 * the extra information in union wpa_event_data::ft_ies.
1266 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1268 * The driver can use this event to inform wpa_supplicant about a STA
1269 * in an IBSS with which protected frames could be exchanged. This
1270 * event starts RSN authentication with the other STA to authenticate
1271 * the STA and set up encryption keys with it.
1273 EVENT_IBSS_RSN_START,
1276 * EVENT_AUTH - Authentication result
1278 * This event should be called when authentication attempt has been
1279 * completed. This is only used if the driver supports separate
1280 * authentication step (struct wpa_driver_ops::authenticate).
1281 * Information about authentication result is included in
1282 * union wpa_event_data::auth.
1287 * EVENT_DEAUTH - Authentication lost
1289 * This event should be called when authentication is lost either due
1290 * to receiving deauthenticate frame from the AP or when sending that
1291 * frame to the current AP.
1298 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1300 union wpa_event_data {
1302 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1304 * This structure is optional for EVENT_ASSOC calls and required for
1305 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1306 * driver interface does not need to generate separate EVENT_ASSOCINFO
1311 * req_ies - (Re)Association Request IEs
1313 * If the driver generates WPA/RSN IE, this event data must be
1314 * returned for WPA handshake to have needed information. If
1315 * wpa_supplicant-generated WPA/RSN IE is used, this
1316 * information event is optional.
1318 * This should start with the first IE (fixed fields before IEs
1319 * are not included).
1324 * req_ies_len - Length of req_ies in bytes
1329 * resp_ies - (Re)Association Response IEs
1331 * Optional association data from the driver. This data is not
1332 * required WPA, but may be useful for some protocols and as
1333 * such, should be reported if this is available to the driver
1336 * This should start with the first IE (fixed fields before IEs
1337 * are not included).
1342 * resp_ies_len - Length of resp_ies in bytes
1344 size_t resp_ies_len;
1347 * beacon_ies - Beacon or Probe Response IEs
1349 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1350 * Probe Response frames from the current AP (i.e., the one
1351 * that the client just associated with). This information is
1352 * used to update WPA/RSN IE for the AP. If this field is not
1353 * set, the results from previous scan will be used. If no
1354 * data for the new AP is found, scan results will be requested
1355 * again (without scan request). At this point, the driver is
1356 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1359 * This should start with the first IE (fixed fields before IEs
1360 * are not included).
1365 * beacon_ies_len - Length of beacon_ies */
1366 size_t beacon_ies_len;
1370 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1372 struct michael_mic_failure {
1374 } michael_mic_failure;
1377 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1379 struct interface_status {
1382 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1387 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1389 struct pmkid_candidate {
1390 /** BSSID of the PMKID candidate */
1392 /** Smaller the index, higher the priority */
1394 /** Whether RSN IE includes pre-authenticate flag */
1399 * struct stkstart - Data for EVENT_STKSTART
1406 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1408 * During FT (IEEE 802.11r) authentication sequence, the driver is
1409 * expected to use this event to report received FT IEs (MDIE, FTIE,
1410 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1411 * IEs for the next message will be delivered through the
1412 * struct wpa_driver_ops::update_ft_ies() callback.
1418 u8 target_ap[ETH_ALEN];
1419 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
1421 /** Length of ric_ies buffer in octets */
1426 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1428 struct ibss_rsn_start {
1433 * struct auth_info - Data for EVENT_AUTH events
1445 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1446 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1447 * with struct wpa_driver_ops::init()
1448 * @event: event type (defined above)
1449 * @data: possible extra data for the event
1451 * Driver wrapper code should call this function whenever an event is received
1454 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1455 union wpa_event_data *data);
1458 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1459 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1460 * with struct wpa_driver_ops::init()
1461 * @src_addr: Source address of the EAPOL frame
1462 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1463 * @len: Length of the EAPOL data
1465 * This function is called for each received EAPOL frame. Most driver
1466 * interfaces rely on more generic OS mechanism for receiving frames through
1467 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1468 * take care of received EAPOL frames and deliver them to the core supplicant
1469 * code by calling this function.
1471 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1472 const u8 *buf, size_t len);
1474 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1475 struct ieee80211_rx_status *rx_status);
1476 void wpa_supplicant_sta_free_hw_features(struct wpa_hw_modes *hw_features,
1477 size_t num_hw_features);
1479 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1480 #define WPA_IE_VENDOR_TYPE 0x0050f201
1481 #define WPS_IE_VENDOR_TYPE 0x0050f204
1482 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1484 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1486 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1487 void wpa_scan_results_free(struct wpa_scan_results *res);
1488 void wpa_scan_sort_results(struct wpa_scan_results *res);
1490 #endif /* DRIVER_H */