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];
85 * struct wpa_scan_res - Scan result for an BSS/IBSS
87 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
88 * @beacon_int: beacon interval in TUs (host byte order)
89 * @caps: capability information field in host byte order
90 * @qual: signal quality
92 * @level: signal level
94 * @ie_len: length of the following IE field in octets
96 * This structure is used as a generic format for scan results from the
97 * driver. Each driver interface implementation is responsible for converting
98 * the driver or OS specific scan results into this format.
100 * If the driver does not support reporting all IEs, the IE data structure is
101 * constructed of the IEs that are available. This field will also need to
102 * include SSID in IE format. All drivers are encouraged to be extended to
103 * report all IEs to make it easier to support future additions.
105 struct wpa_scan_res {
115 /* followed by ie_len octets of IEs */
119 * struct wpa_scan_results - Scan results
120 * @res: Array of pointers to allocated variable length scan result entries
121 * @num: Number of entries in the scan result array
123 struct wpa_scan_results {
124 struct wpa_scan_res **res;
129 * struct wpa_interface_info - Network interface information
130 * @next: Pointer to the next interface or NULL if this is the last one
131 * @ifname: Interface name that can be used with init() or init2()
132 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
134 * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one
135 * is not an allocated copy, i.e., get_interfaces() caller will not free
138 struct wpa_interface_info {
139 struct wpa_interface_info *next;
142 const char *drv_name;
146 * struct wpa_driver_associate_params - Association parameters
147 * Data for struct wpa_driver_ops::associate().
149 struct wpa_driver_associate_params {
151 * bssid - BSSID of the selected AP
152 * This can be %NULL, if ap_scan=2 mode is used and the driver is
153 * responsible for selecting with which BSS to associate. */
157 * ssid - The selected SSID
163 * freq - Frequency of the channel the selected AP is using
164 * Frequency that the selected AP is using (in MHz as
165 * reported in the scan results)
170 * wpa_ie - WPA information element for (Re)Association Request
171 * WPA information element to be included in (Re)Association
172 * Request (including information element id and length). Use
173 * of this WPA IE is optional. If the driver generates the WPA
174 * IE, it can use pairwise_suite, group_suite, and
175 * key_mgmt_suite to select proper algorithms. In this case,
176 * the driver has to notify wpa_supplicant about the used WPA
177 * IE by generating an event that the interface code will
178 * convert into EVENT_ASSOCINFO data (see below).
180 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
181 * instead. The driver can determine which version is used by
182 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
185 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
189 * wpa_ie_len - length of the wpa_ie
193 /* The selected pairwise/group cipher and key management
194 * suites. These are usually ignored if @wpa_ie is used. */
195 wpa_cipher pairwise_suite;
196 wpa_cipher group_suite;
197 wpa_key_mgmt key_mgmt_suite;
200 * auth_alg - Allowed authentication algorithms
201 * Bit field of AUTH_ALG_*
206 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
211 * wep_key - WEP keys for static WEP configuration
213 const u8 *wep_key[4];
216 * wep_key_len - WEP key length for static WEP configuration
218 size_t wep_key_len[4];
221 * wep_tx_keyidx - WEP TX key index for static WEP configuration
226 * mgmt_frame_protection - IEEE 802.11w management frame protection
229 NO_MGMT_FRAME_PROTECTION,
230 MGMT_FRAME_PROTECTION_OPTIONAL,
231 MGMT_FRAME_PROTECTION_REQUIRED
232 } mgmt_frame_protection;
235 * ft_ies - IEEE 802.11r / FT information elements
236 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
237 * for fast transition, this parameter is set to include the IEs that
238 * are to be sent in the next FT Authentication Request message.
239 * update_ft_ies() handler is called to update the IEs for further
240 * FT messages in the sequence.
242 * The driver should use these IEs only if the target AP is advertising
243 * the same mobility domain as the one included in the MDIE here.
245 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
246 * AP after the initial association. These IEs can only be used if the
247 * target AP is advertising support for FT and is using the same MDIE
248 * and SSID as the current AP.
250 * The driver is responsible for reporting the FT IEs received from the
251 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
252 * type. update_ft_ies() handler will then be called with the FT IEs to
253 * include in the next frame in the authentication sequence.
258 * ft_ies_len - Length of ft_ies in bytes
263 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
265 * This value is provided to allow the driver interface easier access
266 * to the current mobility domain. This value is set to %NULL if no
267 * mobility domain is currently active.
272 * passphrase - RSN passphrase for PSK
274 * This value is made available only for WPA/WPA2-Personal (PSK) and
275 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
276 * the 8..63 character ASCII passphrase, if available. Please note that
277 * this can be %NULL if passphrase was not used to generate the PSK. In
278 * that case, the psk field must be used to fetch the PSK.
280 const char *passphrase;
283 * psk - RSN PSK (alternative for passphrase for PSK)
285 * This value is made available only for WPA/WPA2-Personal (PSK) and
286 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
287 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
288 * be prepared to handle %NULL value as an error.
294 * struct wpa_driver_capa - Driver capability information
296 struct wpa_driver_capa {
297 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
298 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
299 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
300 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
301 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
302 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
303 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
304 unsigned int key_mgmt;
306 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
307 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
308 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
309 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
312 #define WPA_DRIVER_AUTH_OPEN 0x00000001
313 #define WPA_DRIVER_AUTH_SHARED 0x00000002
314 #define WPA_DRIVER_AUTH_LEAP 0x00000004
317 /* Driver generated WPA/RSN IE */
318 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
319 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
320 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
321 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
322 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
323 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
330 #define WPA_CHAN_W_SCAN 0x00000001
331 #define WPA_CHAN_W_ACTIVE_SCAN 0x00000002
332 #define WPA_CHAN_W_IBSS 0x00000004
334 struct wpa_channel_data {
335 short chan; /* channel number (IEEE 802.11) */
336 short freq; /* frequency in MHz */
337 int flag; /* flag for user space use (WPA_CHAN_*) */
340 #define WPA_RATE_ERP 0x00000001
341 #define WPA_RATE_BASIC 0x00000002
342 #define WPA_RATE_PREAMBLE2 0x00000004
343 #define WPA_RATE_SUPPORTED 0x00000010
344 #define WPA_RATE_OFDM 0x00000020
345 #define WPA_RATE_CCK 0x00000040
346 #define WPA_RATE_MANDATORY 0x00000100
348 struct wpa_rate_data {
349 int rate; /* rate in 100 kbps */
350 int flags; /* WPA_RATE_ flags */
360 struct wpa_hw_modes {
363 struct wpa_channel_data *channels;
365 struct wpa_rate_data *rates;
369 struct ieee80211_rx_status {
376 * struct wpa_driver_ops - Driver interface API definition
378 * This structure defines the API that each driver interface needs to implement
379 * for core wpa_supplicant code. All driver specific functionality is captured
382 struct wpa_driver_ops {
383 /** Name of the driver interface */
385 /** One line description of the driver interface */
389 * get_bssid - Get the current BSSID
390 * @priv: private driver interface data
391 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
393 * Returns: 0 on success, -1 on failure
395 * Query kernel driver for the current BSSID and copy it to bssid.
396 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
399 int (*get_bssid)(void *priv, u8 *bssid);
402 * get_ssid - Get the current SSID
403 * @priv: private driver interface data
404 * @ssid: buffer for SSID (at least 32 bytes)
406 * Returns: Length of the SSID on success, -1 on failure
408 * Query kernel driver for the current SSID and copy it to ssid.
409 * Returning zero is recommended if the STA is not associated.
411 * Note: SSID is an array of octets, i.e., it is not nul terminated and
412 * can, at least in theory, contain control characters (including nul)
413 * and as such, should be processed as binary data, not a printable
416 int (*get_ssid)(void *priv, u8 *ssid);
419 * set_wpa - Enable/disable WPA support (OBSOLETE)
420 * @priv: private driver interface data
421 * @enabled: 1 = enable, 0 = disable
423 * Returns: 0 on success, -1 on failure
425 * Note: This function is included for backwards compatibility. This is
426 * called only just after init and just before deinit, so these
427 * functions can be used to implement same functionality and the driver
428 * interface need not define this function.
430 * Configure the kernel driver to enable/disable WPA support. This may
431 * be empty function, if WPA support is always enabled. Common
432 * configuration items are WPA IE (clearing it when WPA support is
433 * disabled), Privacy flag configuration for capability field (note:
434 * this the value need to set in associate handler to allow plaintext
435 * mode to be used) when trying to associate with, roaming mode (can
436 * allow wpa_supplicant to control roaming if ap_scan=1 is used;
437 * however, drivers can also implement roaming if desired, especially
438 * ap_scan=2 mode is used for this).
440 int (*set_wpa)(void *priv, int enabled);
443 * set_key - Configure encryption key
444 * @priv: private driver interface data
445 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
446 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
447 * %WPA_ALG_NONE clears the key.
448 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
449 * broadcast/default keys
450 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
452 * @set_tx: configure this key as the default Tx key (only used when
453 * driver does not support separate unicast/individual key
454 * @seq: sequence number/packet number, seq_len octets, the next
455 * packet number to be used for in replay protection; configured
456 * for Rx keys (in most cases, this is only used with broadcast
457 * keys and set to zero for unicast keys)
458 * @seq_len: length of the seq, depends on the algorithm:
459 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
460 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
462 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
463 * TKIP: 32, CCMP: 16, IGTK: 16)
465 * Returns: 0 on success, -1 on failure
467 * Configure the given key for the kernel driver. If the driver
468 * supports separate individual keys (4 default keys + 1 individual),
469 * addr can be used to determine whether the key is default or
470 * individual. If only 4 keys are supported, the default key with key
471 * index 0 is used as the individual key. STA must be configured to use
472 * it as the default Tx key (set_tx is set) and accept Rx for all the
473 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
474 * broadcast keys, so key index 0 is available for this kind of
477 * Please note that TKIP keys include separate TX and RX MIC keys and
478 * some drivers may expect them in different order than wpa_supplicant
479 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
480 * will tricker Michael MIC errors. This can be fixed by changing the
481 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
482 * in driver_*.c set_key() implementation, see driver_ndis.c for an
483 * example on how this can be done.
485 int (*set_key)(void *priv, wpa_alg alg, const u8 *addr,
486 int key_idx, int set_tx, const u8 *seq, size_t seq_len,
487 const u8 *key, size_t key_len);
490 * init - Initialize driver interface
491 * @ctx: context to be used when calling wpa_supplicant functions,
492 * e.g., wpa_supplicant_event()
493 * @ifname: interface name, e.g., wlan0
495 * Returns: Pointer to private data, %NULL on failure
497 * Initialize driver interface, including event processing for kernel
498 * driver events (e.g., associated, scan results, Michael MIC failure).
499 * This function can allocate a private configuration data area for
500 * @ctx, file descriptor, interface name, etc. information that may be
501 * needed in future driver operations. If this is not used, non-NULL
502 * value will need to be returned because %NULL is used to indicate
503 * failure. The returned value will be used as 'void *priv' data for
504 * all other driver_ops functions.
506 * The main event loop (eloop.c) of wpa_supplicant can be used to
507 * register callback for read sockets (eloop_register_read_sock()).
509 * See below for more information about events and
510 * wpa_supplicant_event() function.
512 void * (*init)(void *ctx, const char *ifname);
515 * deinit - Deinitialize driver interface
516 * @priv: private driver interface data from init()
518 * Shut down driver interface and processing of driver events. Free
519 * private data buffer if one was allocated in init() handler.
521 void (*deinit)(void *priv);
524 * set_param - Set driver configuration parameters
525 * @priv: private driver interface data from init()
526 * @param: driver specific configuration parameters
528 * Returns: 0 on success, -1 on failure
530 * Optional handler for notifying driver interface about configuration
531 * parameters (driver_param).
533 int (*set_param)(void *priv, const char *param);
536 * set_countermeasures - Enable/disable TKIP countermeasures
537 * @priv: private driver interface data
538 * @enabled: 1 = countermeasures enabled, 0 = disabled
540 * Returns: 0 on success, -1 on failure
542 * Configure TKIP countermeasures. When these are enabled, the driver
543 * should drop all received and queued frames that are using TKIP.
545 int (*set_countermeasures)(void *priv, int enabled);
548 * set_drop_unencrypted - Enable/disable unencrypted frame filtering
549 * @priv: private driver interface data
550 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
552 * Returns: 0 on success, -1 on failure
554 * Configure the driver to drop all non-EAPOL frames (both receive and
555 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
556 * still be allowed for key negotiation.
558 int (*set_drop_unencrypted)(void *priv, int enabled);
561 * scan - Request the driver to initiate scan
562 * @priv: private driver interface data
563 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
564 * all SSIDs (either active scan with broadcast SSID or passive
566 * @ssid_len: length of the SSID
568 * Returns: 0 on success, -1 on failure
570 * Once the scan results are ready, the driver should report scan
571 * results event for wpa_supplicant which will eventually request the
572 * results with wpa_driver_get_scan_results().
574 int (*scan)(void *priv, const u8 *ssid, size_t ssid_len);
577 * get_scan_results - Fetch the latest scan results (old version)
578 * @priv: private driver interface data
579 * @results: pointer to buffer for scan results
580 * @max_size: maximum number of entries (buffer size)
582 * Returns: Number of scan result entries used on success, -1 on
585 * If scan results include more than max_size BSSes, max_size will be
586 * returned and the remaining entries will not be included in the
589 * This function is depracated. New driver wrapper implementations
590 * should implement support for get_scan_results2().
592 int (*get_scan_results)(void *priv,
593 struct wpa_scan_result *results,
597 * deauthenticate - Request driver to deauthenticate
598 * @priv: private driver interface data
599 * @addr: peer address (BSSID of the AP)
600 * @reason_code: 16-bit reason code to be sent in the deauthentication
603 * Returns: 0 on success, -1 on failure
605 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
608 * disassociate - Request driver to disassociate
609 * @priv: private driver interface data
610 * @addr: peer address (BSSID of the AP)
611 * @reason_code: 16-bit reason code to be sent in the disassociation
614 * Returns: 0 on success, -1 on failure
616 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
619 * associate - Request driver to associate
620 * @priv: private driver interface data
621 * @params: association parameters
623 * Returns: 0 on success, -1 on failure
625 int (*associate)(void *priv,
626 struct wpa_driver_associate_params *params);
629 * set_auth_alg - Set IEEE 802.11 authentication algorithm
630 * @priv: private driver interface data
631 * @auth_alg: bit field of AUTH_ALG_*
633 * If the driver supports more than one authentication algorithm at the
634 * same time, it should configure all supported algorithms. If not, one
635 * algorithm needs to be selected arbitrarily. Open System
636 * authentication should be ok for most cases and it is recommended to
637 * be used if other options are not supported. Static WEP configuration
638 * may also use Shared Key authentication and LEAP requires its own
639 * algorithm number. For LEAP, user can make sure that only one
640 * algorithm is used at a time by configuring LEAP as the only
641 * supported EAP method. This information is also available in
642 * associate() params, so set_auth_alg may not be needed in case of
645 * Returns: 0 on success, -1 on failure
647 int (*set_auth_alg)(void *priv, int auth_alg);
650 * add_pmkid - Add PMKSA cache entry to the driver
651 * @priv: private driver interface data
652 * @bssid: BSSID for the PMKSA cache entry
653 * @pmkid: PMKID for the PMKSA cache entry
655 * Returns: 0 on success, -1 on failure
657 * This function is called when a new PMK is received, as a result of
658 * either normal authentication or RSN pre-authentication.
660 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
661 * associate(), add_pmkid() can be used to add new PMKSA cache entries
662 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
663 * driver_ops function does not need to be implemented. Likewise, if
664 * the driver does not support WPA, this function is not needed.
666 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
669 * remove_pmkid - Remove PMKSA cache entry to the driver
670 * @priv: private driver interface data
671 * @bssid: BSSID for the PMKSA cache entry
672 * @pmkid: PMKID for the PMKSA cache entry
674 * Returns: 0 on success, -1 on failure
676 * This function is called when the supplicant drops a PMKSA cache
677 * entry for any reason.
679 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
680 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
681 * between the driver and wpa_supplicant. If the driver uses wpa_ie
682 * from wpa_supplicant, this driver_ops function does not need to be
683 * implemented. Likewise, if the driver does not support WPA, this
684 * function is not needed.
686 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
689 * flush_pmkid - Flush PMKSA cache
690 * @priv: private driver interface data
692 * Returns: 0 on success, -1 on failure
694 * This function is called when the supplicant drops all PMKSA cache
695 * entries for any reason.
697 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
698 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
699 * between the driver and wpa_supplicant. If the driver uses wpa_ie
700 * from wpa_supplicant, this driver_ops function does not need to be
701 * implemented. Likewise, if the driver does not support WPA, this
702 * function is not needed.
704 int (*flush_pmkid)(void *priv);
707 * flush_pmkid - Flush PMKSA cache
708 * @priv: private driver interface data
710 * Returns: 0 on success, -1 on failure
712 * Get driver/firmware/hardware capabilities.
714 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
717 * poll - Poll driver for association information
718 * @priv: private driver interface data
720 * This is an option callback that can be used when the driver does not
721 * provide event mechanism for association events. This is called when
722 * receiving WPA EAPOL-Key messages that require association
723 * information. The driver interface is supposed to generate associnfo
724 * event before returning from this callback function. In addition, the
725 * driver interface should generate an association event after having
726 * sent out associnfo.
728 void (*poll)(void *priv);
731 * get_ifname - Get interface name
732 * @priv: private driver interface data
734 * Returns: Pointer to the interface name. This can differ from the
735 * interface name used in init() call. Init() is called first.
737 * This optional function can be used to allow the driver interface to
738 * replace the interface name with something else, e.g., based on an
739 * interface mapping from a more descriptive name.
741 const char * (*get_ifname)(void *priv);
744 * get_mac_addr - Get own MAC address
745 * @priv: private driver interface data
747 * Returns: Pointer to own MAC address or %NULL on failure
749 * This optional function can be used to get the own MAC address of the
750 * device from the driver interface code. This is only needed if the
751 * l2_packet implementation for the OS does not provide easy access to
753 const u8 * (*get_mac_addr)(void *priv);
756 * send_eapol - Optional function for sending EAPOL packets
757 * @priv: private driver interface data
758 * @dest: Destination MAC address
760 * @data: EAPOL packet starting with IEEE 802.1X header
761 * @data_len: Size of the EAPOL packet
763 * Returns: 0 on success, -1 on failure
765 * This optional function can be used to override l2_packet operations
766 * with driver specific functionality. If this function pointer is set,
767 * l2_packet module is not used at all and the driver interface code is
768 * responsible for receiving and sending all EAPOL packets. The
769 * received EAPOL packets are sent to core code by calling
770 * wpa_supplicant_rx_eapol(). The driver interface is required to
771 * implement get_mac_addr() handler if send_eapol() is used.
773 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
774 const u8 *data, size_t data_len);
777 * set_operstate - Sets device operating state to DORMANT or UP
778 * @priv: private driver interface data
779 * @state: 0 = dormant, 1 = up
780 * Returns: 0 on success, -1 on failure
782 * This is an optional function that can be used on operating systems
783 * that support a concept of controlling network device state from user
784 * space applications. This function, if set, gets called with
785 * state = 1 when authentication has been completed and with state = 0
786 * when connection is lost.
788 int (*set_operstate)(void *priv, int state);
791 * mlme_setprotection - MLME-SETPROTECTION.request primitive
792 * @priv: Private driver interface data
793 * @addr: Address of the station for which to set protection (may be
794 * %NULL for group keys)
795 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
796 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
797 * Returns: 0 on success, -1 on failure
799 * This is an optional function that can be used to set the driver to
800 * require protection for Tx and/or Rx frames. This uses the layer
801 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
802 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
803 * set protection operation; instead, they set protection implicitly
804 * based on configured keys.
806 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
810 * get_hw_feature_data - Get hardware support data (channels and rates)
811 * @priv: Private driver interface data
812 * @num_modes: Variable for returning the number of returned modes
813 * flags: Variable for returning hardware feature flags
814 * Returns: Pointer to allocated hardware data on success or %NULL on
815 * failure. Caller is responsible for freeing this.
817 * This function is only needed for drivers that export MLME
818 * (management frame processing) to wpa_supplicant.
820 struct wpa_hw_modes * (*get_hw_feature_data)(void *priv,
825 * set_channel - Set channel
826 * @priv: Private driver interface data
827 * @phymode: WPA_MODE_IEEE80211B, ..
828 * @chan: IEEE 802.11 channel number
829 * @freq: Frequency of the channel in MHz
830 * Returns: 0 on success, -1 on failure
832 * This function is only needed for drivers that export MLME
833 * (management frame processing) to wpa_supplicant.
835 int (*set_channel)(void *priv, wpa_hw_mode phymode, int chan,
839 * set_ssid - Set SSID
840 * @priv: Private driver interface data
842 * @ssid_len: SSID length
843 * Returns: 0 on success, -1 on failure
845 * This function is only needed for drivers that export MLME
846 * (management frame processing) to wpa_supplicant.
848 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
851 * set_bssid - Set BSSID
852 * @priv: Private driver interface data
854 * Returns: 0 on success, -1 on failure
856 * This function is only needed for drivers that export MLME
857 * (management frame processing) to wpa_supplicant.
859 int (*set_bssid)(void *priv, const u8 *bssid);
862 * send_mlme - Send management frame from MLME
863 * @priv: Private driver interface data
864 * @data: IEEE 802.11 management frame with IEEE 802.11 header
865 * @data_len: Size of the management frame
866 * Returns: 0 on success, -1 on failure
868 * This function is only needed for drivers that export MLME
869 * (management frame processing) to wpa_supplicant.
871 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
874 * mlme_add_sta - Add a STA entry into the driver/netstack
875 * @priv: Private driver interface data
876 * @addr: MAC address of the STA (e.g., BSSID of the AP)
877 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
878 * format (one octet per rate, 1 = 0.5 Mbps)
879 * @supp_rates_len: Number of entries in supp_rates
880 * Returns: 0 on success, -1 on failure
882 * This function is only needed for drivers that export MLME
883 * (management frame processing) to wpa_supplicant. When the MLME code
884 * completes association with an AP, this function is called to
885 * configure the driver/netstack with a STA entry for data frame
886 * processing (TX rate control, encryption/decryption).
888 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
889 size_t supp_rates_len);
892 * mlme_remove_sta - Remove a STA entry from the driver/netstack
893 * @priv: Private driver interface data
894 * @addr: MAC address of the STA (e.g., BSSID of the AP)
895 * Returns: 0 on success, -1 on failure
897 * This function is only needed for drivers that export MLME
898 * (management frame processing) to wpa_supplicant.
900 int (*mlme_remove_sta)(void *priv, const u8 *addr);
903 * update_ft_ies - Update FT (IEEE 802.11r) IEs
904 * @priv: Private driver interface data
905 * @md: Mobility domain (2 octets) (also included inside ies)
906 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
907 * @ies_len: Length of FT IEs in bytes
908 * Returns: 0 on success, -1 on failure
910 * The supplicant uses this callback to let the driver know that keying
911 * material for FT is available and that the driver can use the
912 * provided IEs in the next message in FT authentication sequence.
914 * This function is only needed for driver that support IEEE 802.11r
915 * (Fast BSS Transition).
917 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
921 * send_ft_action - Send FT Action frame (IEEE 802.11r)
922 * @priv: Private driver interface data
923 * @action: Action field value
924 * @target_ap: Target AP address
925 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
926 * @ies_len: Length of FT IEs in bytes
927 * Returns: 0 on success, -1 on failure
929 * The supplicant uses this callback to request the driver to transmit
930 * an FT Action frame (action category 6) for over-the-DS fast BSS
933 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
934 const u8 *ies, size_t ies_len);
937 * get_scan_results2 - Fetch the latest scan results
938 * @priv: private driver interface data
940 * Returns: Allocated buffer of scan results (caller is responsible for
941 * freeing the data structure) on success, NULL on failure
943 struct wpa_scan_results * (*get_scan_results2)(void *priv);
946 * set_probe_req_ie - Set information element(s) for Probe Request
947 * @priv: private driver interface data
948 * @ies: Information elements to append or %NULL to remove extra IEs
949 * @ies_len: Length of the IE buffer in octets
950 * Returns: 0 on success, -1 on failure
952 int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len);
955 * set_mode - Request driver to set the operating mode
956 * @priv: private driver interface data
957 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
959 * This handler will be called before any key configuration and call to
960 * associate() handler in order to allow the operation mode to be
961 * configured as early as possible. This information is also available
962 * in associate() params and as such, some driver wrappers may not need
963 * to implement set_mode() handler.
964 * Returns: 0 on success, -1 on failure
966 int (*set_mode)(void *priv, int mode);
969 * set_country - Set country
970 * @priv: Private driver interface data
971 * @alpha2: country to which to switch to
972 * Returns: 0 on success, -1 on failure
974 * This function is for drivers which support some form
975 * of setting a regulatory domain.
977 int (*set_country)(void *priv, const char *alpha2);
980 * global_init - Global driver initialization
981 * Returns: Pointer to private data (global), %NULL on failure
983 * This optional function is called to initialize the driver wrapper
984 * for global data, i.e., data that applies to all interfaces. If this
985 * function is implemented, global_deinit() will also need to be
986 * implemented to free the private data. The driver will also likely
987 * use init2() function instead of init() to get the pointer to global
988 * data available to per-interface initializer.
990 void * (*global_init)(void);
993 * global_deinit - Global driver deinitialization
994 * @priv: private driver global data from global_init()
996 * Terminate any global driver related functionality and free the
997 * global data structure.
999 void (*global_deinit)(void *priv);
1002 * init2 - Initialize driver interface (with global data)
1003 * @ctx: context to be used when calling wpa_supplicant functions,
1004 * e.g., wpa_supplicant_event()
1005 * @ifname: interface name, e.g., wlan0
1006 * @global_priv: private driver global data from global_init()
1007 * Returns: Pointer to private data, %NULL on failure
1009 * This function can be used instead of init() if the driver wrapper
1012 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1015 * get_interfaces - Get information about available interfaces
1016 * @global_priv: private driver global data from global_init()
1017 * Returns: Allocated buffer of interface information (caller is
1018 * responsible for freeing the data structure) on success, NULL on
1021 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1024 /* Function to check whether a driver is for wired connections */
1025 static inline int IS_WIRED(const struct wpa_driver_ops *drv)
1027 return os_strcmp(drv->name, "wired") == 0 ||
1028 os_strcmp(drv->name, "roboswitch") == 0;
1032 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1034 typedef enum wpa_event_type {
1036 * EVENT_ASSOC - Association completed
1038 * This event needs to be delivered when the driver completes IEEE
1039 * 802.11 association or reassociation successfully.
1040 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1041 * after this event has been generated. In addition, optional
1042 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1043 * more information about the association. If the driver interface gets
1044 * both of these events at the same time, it can also include the
1045 * assoc_info data in EVENT_ASSOC call.
1050 * EVENT_DISASSOC - Association lost
1052 * This event should be called when association is lost either due to
1053 * receiving deauthenticate or disassociate frame from the AP or when
1054 * sending either of these frames to the current AP.
1059 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1061 * This event must be delivered when a Michael MIC error is detected by
1062 * the local driver. Additional data for event processing is
1063 * provided with union wpa_event_data::michael_mic_failure. This
1064 * information is used to request new encyption key and to initiate
1065 * TKIP countermeasures if needed.
1067 EVENT_MICHAEL_MIC_FAILURE,
1070 * EVENT_SCAN_RESULTS - Scan results available
1072 * This event must be called whenever scan results are available to be
1073 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1074 * is expected to be used some time after struct wpa_driver_ops::scan()
1075 * is called. If the driver provides an unsolicited event when the scan
1076 * has been completed, this event can be used to trigger
1077 * EVENT_SCAN_RESULTS call. If such event is not available from the
1078 * driver, the driver wrapper code is expected to use a registered
1079 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1080 * scan is expected to be completed.
1085 * EVENT_ASSOCINFO - Report optional extra information for association
1087 * This event can be used to report extra association information for
1088 * EVENT_ASSOC processing. This extra information includes IEs from
1089 * association frames and Beacon/Probe Response frames in union
1090 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1091 * EVENT_ASSOC. Alternatively, the driver interface can include
1092 * assoc_info data in the EVENT_ASSOC call if it has all the
1093 * information available at the same point.
1098 * EVENT_INTERFACE_STATUS - Report interface status changes
1100 * This optional event can be used to report changes in interface
1101 * status (interface added/removed) using union
1102 * wpa_event_data::interface_status. This can be used to trigger
1103 * wpa_supplicant to stop and re-start processing for the interface,
1104 * e.g., when a cardbus card is ejected/inserted.
1106 EVENT_INTERFACE_STATUS,
1109 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1111 * This event can be used to inform wpa_supplicant about candidates for
1112 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1113 * for scan request (ap_scan=2 mode), this event is required for
1114 * pre-authentication. If wpa_supplicant is performing scan request
1115 * (ap_scan=1), this event is optional since scan results can be used
1116 * to add pre-authentication candidates. union
1117 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1118 * candidate and priority of the candidate, e.g., based on the signal
1119 * strength, in order to try to pre-authenticate first with candidates
1120 * that are most likely targets for re-association.
1122 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1123 * on the candidate list. In addition, it can be called for the current
1124 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1125 * will automatically skip pre-authentication in cases where a valid
1126 * PMKSA exists. When more than one candidate exists, this event should
1127 * be generated once for each candidate.
1129 * Driver will be notified about successful pre-authentication with
1130 * struct wpa_driver_ops::add_pmkid() calls.
1132 EVENT_PMKID_CANDIDATE,
1135 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1137 * This event can be used to inform wpa_supplicant about desire to set
1138 * up secure direct link connection between two stations as defined in
1139 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1140 * STAKey negotiation. The caller will need to set peer address for the
1146 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1148 * The driver is expected to report the received FT IEs from
1149 * FT authentication sequence from the AP. The FT IEs are included in
1150 * the extra information in union wpa_event_data::ft_ies.
1155 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1157 * The driver can use this event to inform wpa_supplicant about a STA
1158 * in an IBSS with which protected frames could be exchanged. This
1159 * event starts RSN authentication with the other STA to authenticate
1160 * the STA and set up encryption keys with it.
1162 EVENT_IBSS_RSN_START
1167 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1169 union wpa_event_data {
1171 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1173 * This structure is optional for EVENT_ASSOC calls and required for
1174 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1175 * driver interface does not need to generate separate EVENT_ASSOCINFO
1180 * req_ies - (Re)Association Request IEs
1182 * If the driver generates WPA/RSN IE, this event data must be
1183 * returned for WPA handshake to have needed information. If
1184 * wpa_supplicant-generated WPA/RSN IE is used, this
1185 * information event is optional.
1187 * This should start with the first IE (fixed fields before IEs
1188 * are not included).
1193 * req_ies_len - Length of req_ies in bytes
1198 * resp_ies - (Re)Association Response IEs
1200 * Optional association data from the driver. This data is not
1201 * required WPA, but may be useful for some protocols and as
1202 * such, should be reported if this is available to the driver
1205 * This should start with the first IE (fixed fields before IEs
1206 * are not included).
1211 * resp_ies_len - Length of resp_ies in bytes
1213 size_t resp_ies_len;
1216 * beacon_ies - Beacon or Probe Response IEs
1218 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1219 * Probe Response frames from the current AP (i.e., the one
1220 * that the client just associated with). This information is
1221 * used to update WPA/RSN IE for the AP. If this field is not
1222 * set, the results from previous scan will be used. If no
1223 * data for the new AP is found, scan results will be requested
1224 * again (without scan request). At this point, the driver is
1225 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1228 * This should start with the first IE (fixed fields before IEs
1229 * are not included).
1234 * beacon_ies_len - Length of beacon_ies */
1235 size_t beacon_ies_len;
1239 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1241 struct michael_mic_failure {
1243 } michael_mic_failure;
1246 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1248 struct interface_status {
1251 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1256 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1258 struct pmkid_candidate {
1259 /** BSSID of the PMKID candidate */
1261 /** Smaller the index, higher the priority */
1263 /** Whether RSN IE includes pre-authenticate flag */
1268 * struct stkstart - Data for EVENT_STKSTART
1275 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1277 * During FT (IEEE 802.11r) authentication sequence, the driver is
1278 * expected to use this event to report received FT IEs (MDIE, FTIE,
1279 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1280 * IEs for the next message will be delivered through the
1281 * struct wpa_driver_ops::update_ft_ies() callback.
1287 u8 target_ap[ETH_ALEN];
1291 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1293 struct ibss_rsn_start {
1299 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1300 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1301 * with struct wpa_driver_ops::init()
1302 * @event: event type (defined above)
1303 * @data: possible extra data for the event
1305 * Driver wrapper code should call this function whenever an event is received
1308 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1309 union wpa_event_data *data);
1312 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1313 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1314 * with struct wpa_driver_ops::init()
1315 * @src_addr: Source address of the EAPOL frame
1316 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1317 * @len: Length of the EAPOL data
1319 * This function is called for each received EAPOL frame. Most driver
1320 * interfaces rely on more generic OS mechanism for receiving frames through
1321 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1322 * take care of received EAPOL frames and deliver them to the core supplicant
1323 * code by calling this function.
1325 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1326 const u8 *buf, size_t len);
1328 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1329 struct ieee80211_rx_status *rx_status);
1330 void wpa_supplicant_sta_free_hw_features(struct wpa_hw_modes *hw_features,
1331 size_t num_hw_features);
1333 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1334 #define WPA_IE_VENDOR_TYPE 0x0050f201
1335 #define WPS_IE_VENDOR_TYPE 0x0050f204
1336 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1338 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1340 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1341 void wpa_scan_results_free(struct wpa_scan_results *res);
1342 void wpa_scan_sort_results(struct wpa_scan_results *res);
1344 #endif /* DRIVER_H */