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_driver_associate_params - Association parameters
130 * Data for struct wpa_driver_ops::associate().
132 struct wpa_driver_associate_params {
134 * bssid - BSSID of the selected AP
135 * This can be %NULL, if ap_scan=2 mode is used and the driver is
136 * responsible for selecting with which BSS to associate. */
140 * ssid - The selected SSID
146 * freq - Frequency of the channel the selected AP is using
147 * Frequency that the selected AP is using (in MHz as
148 * reported in the scan results)
153 * wpa_ie - WPA information element for (Re)Association Request
154 * WPA information element to be included in (Re)Association
155 * Request (including information element id and length). Use
156 * of this WPA IE is optional. If the driver generates the WPA
157 * IE, it can use pairwise_suite, group_suite, and
158 * key_mgmt_suite to select proper algorithms. In this case,
159 * the driver has to notify wpa_supplicant about the used WPA
160 * IE by generating an event that the interface code will
161 * convert into EVENT_ASSOCINFO data (see below).
163 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
164 * instead. The driver can determine which version is used by
165 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
168 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
172 * wpa_ie_len - length of the wpa_ie
176 /* The selected pairwise/group cipher and key management
177 * suites. These are usually ignored if @wpa_ie is used. */
178 wpa_cipher pairwise_suite;
179 wpa_cipher group_suite;
180 wpa_key_mgmt key_mgmt_suite;
183 * auth_alg - Allowed authentication algorithms
184 * Bit field of AUTH_ALG_*
189 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
194 * wep_key - WEP keys for static WEP configuration
196 const u8 *wep_key[4];
199 * wep_key_len - WEP key length for static WEP configuration
201 size_t wep_key_len[4];
204 * wep_tx_keyidx - WEP TX key index for static WEP configuration
209 * mgmt_frame_protection - IEEE 802.11w management frame protection
212 NO_MGMT_FRAME_PROTECTION,
213 MGMT_FRAME_PROTECTION_OPTIONAL,
214 MGMT_FRAME_PROTECTION_REQUIRED
215 } mgmt_frame_protection;
218 * ft_ies - IEEE 802.11r / FT information elements
219 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
220 * for fast transition, this parameter is set to include the IEs that
221 * are to be sent in the next FT Authentication Request message.
222 * update_ft_ies() handler is called to update the IEs for further
223 * FT messages in the sequence.
225 * The driver should use these IEs only if the target AP is advertising
226 * the same mobility domain as the one included in the MDIE here.
228 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
229 * AP after the initial association. These IEs can only be used if the
230 * target AP is advertising support for FT and is using the same MDIE
231 * and SSID as the current AP.
233 * The driver is responsible for reporting the FT IEs received from the
234 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
235 * type. update_ft_ies() handler will then be called with the FT IEs to
236 * include in the next frame in the authentication sequence.
241 * ft_ies_len - Length of ft_ies in bytes
246 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
248 * This value is provided to allow the driver interface easier access
249 * to the current mobility domain. This value is set to %NULL if no
250 * mobility domain is currently active.
255 * passphrase - RSN passphrase for PSK
257 * This value is made available only for WPA/WPA2-Personal (PSK) and
258 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
259 * the 8..63 character ASCII passphrase, if available. Please note that
260 * this can be %NULL if passphrase was not used to generate the PSK. In
261 * that case, the psk field must be used to fetch the PSK.
263 const char *passphrase;
266 * psk - RSN PSK (alternative for passphrase for PSK)
268 * This value is made available only for WPA/WPA2-Personal (PSK) and
269 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
270 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
271 * be prepared to handle %NULL value as an error.
277 * struct wpa_driver_capa - Driver capability information
279 struct wpa_driver_capa {
280 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
281 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
282 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
283 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
284 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
285 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
286 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
287 unsigned int key_mgmt;
289 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
290 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
291 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
292 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
295 #define WPA_DRIVER_AUTH_OPEN 0x00000001
296 #define WPA_DRIVER_AUTH_SHARED 0x00000002
297 #define WPA_DRIVER_AUTH_LEAP 0x00000004
300 /* Driver generated WPA/RSN IE */
301 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
302 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
303 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
304 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
305 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
306 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
311 #define WPA_CHAN_W_SCAN 0x00000001
312 #define WPA_CHAN_W_ACTIVE_SCAN 0x00000002
313 #define WPA_CHAN_W_IBSS 0x00000004
315 struct wpa_channel_data {
316 short chan; /* channel number (IEEE 802.11) */
317 short freq; /* frequency in MHz */
318 int flag; /* flag for user space use (WPA_CHAN_*) */
321 #define WPA_RATE_ERP 0x00000001
322 #define WPA_RATE_BASIC 0x00000002
323 #define WPA_RATE_PREAMBLE2 0x00000004
324 #define WPA_RATE_SUPPORTED 0x00000010
325 #define WPA_RATE_OFDM 0x00000020
326 #define WPA_RATE_CCK 0x00000040
327 #define WPA_RATE_MANDATORY 0x00000100
329 struct wpa_rate_data {
330 int rate; /* rate in 100 kbps */
331 int flags; /* WPA_RATE_ flags */
341 struct wpa_hw_modes {
344 struct wpa_channel_data *channels;
346 struct wpa_rate_data *rates;
350 struct ieee80211_rx_status {
357 * struct wpa_driver_ops - Driver interface API definition
359 * This structure defines the API that each driver interface needs to implement
360 * for core wpa_supplicant code. All driver specific functionality is captured
363 struct wpa_driver_ops {
364 /** Name of the driver interface */
366 /** One line description of the driver interface */
370 * get_bssid - Get the current BSSID
371 * @priv: private driver interface data
372 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
374 * Returns: 0 on success, -1 on failure
376 * Query kernel driver for the current BSSID and copy it to bssid.
377 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
380 int (*get_bssid)(void *priv, u8 *bssid);
383 * get_ssid - Get the current SSID
384 * @priv: private driver interface data
385 * @ssid: buffer for SSID (at least 32 bytes)
387 * Returns: Length of the SSID on success, -1 on failure
389 * Query kernel driver for the current SSID and copy it to ssid.
390 * Returning zero is recommended if the STA is not associated.
392 * Note: SSID is an array of octets, i.e., it is not nul terminated and
393 * can, at least in theory, contain control characters (including nul)
394 * and as such, should be processed as binary data, not a printable
397 int (*get_ssid)(void *priv, u8 *ssid);
400 * set_wpa - Enable/disable WPA support (OBSOLETE)
401 * @priv: private driver interface data
402 * @enabled: 1 = enable, 0 = disable
404 * Returns: 0 on success, -1 on failure
406 * Note: This function is included for backwards compatibility. This is
407 * called only just after init and just before deinit, so these
408 * functions can be used to implement same functionality and the driver
409 * interface need not define this function.
411 * Configure the kernel driver to enable/disable WPA support. This may
412 * be empty function, if WPA support is always enabled. Common
413 * configuration items are WPA IE (clearing it when WPA support is
414 * disabled), Privacy flag configuration for capability field (note:
415 * this the value need to set in associate handler to allow plaintext
416 * mode to be used) when trying to associate with, roaming mode (can
417 * allow wpa_supplicant to control roaming if ap_scan=1 is used;
418 * however, drivers can also implement roaming if desired, especially
419 * ap_scan=2 mode is used for this).
421 int (*set_wpa)(void *priv, int enabled);
424 * set_key - Configure encryption key
425 * @priv: private driver interface data
426 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
427 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
428 * %WPA_ALG_NONE clears the key.
429 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
430 * broadcast/default keys
431 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
433 * @set_tx: configure this key as the default Tx key (only used when
434 * driver does not support separate unicast/individual key
435 * @seq: sequence number/packet number, seq_len octets, the next
436 * packet number to be used for in replay protection; configured
437 * for Rx keys (in most cases, this is only used with broadcast
438 * keys and set to zero for unicast keys)
439 * @seq_len: length of the seq, depends on the algorithm:
440 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
441 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
443 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
444 * TKIP: 32, CCMP: 16, IGTK: 16)
446 * Returns: 0 on success, -1 on failure
448 * Configure the given key for the kernel driver. If the driver
449 * supports separate individual keys (4 default keys + 1 individual),
450 * addr can be used to determine whether the key is default or
451 * individual. If only 4 keys are supported, the default key with key
452 * index 0 is used as the individual key. STA must be configured to use
453 * it as the default Tx key (set_tx is set) and accept Rx for all the
454 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
455 * broadcast keys, so key index 0 is available for this kind of
458 * Please note that TKIP keys include separate TX and RX MIC keys and
459 * some drivers may expect them in different order than wpa_supplicant
460 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
461 * will tricker Michael MIC errors. This can be fixed by changing the
462 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
463 * in driver_*.c set_key() implementation, see driver_ndis.c for an
464 * example on how this can be done.
466 int (*set_key)(void *priv, wpa_alg alg, const u8 *addr,
467 int key_idx, int set_tx, const u8 *seq, size_t seq_len,
468 const u8 *key, size_t key_len);
471 * init - Initialize driver interface
472 * @ctx: context to be used when calling wpa_supplicant functions,
473 * e.g., wpa_supplicant_event()
474 * @ifname: interface name, e.g., wlan0
476 * Returns: Pointer to private data, %NULL on failure
478 * Initialize driver interface, including event processing for kernel
479 * driver events (e.g., associated, scan results, Michael MIC failure).
480 * This function can allocate a private configuration data area for
481 * @ctx, file descriptor, interface name, etc. information that may be
482 * needed in future driver operations. If this is not used, non-NULL
483 * value will need to be returned because %NULL is used to indicate
484 * failure. The returned value will be used as 'void *priv' data for
485 * all other driver_ops functions.
487 * The main event loop (eloop.c) of wpa_supplicant can be used to
488 * register callback for read sockets (eloop_register_read_sock()).
490 * See below for more information about events and
491 * wpa_supplicant_event() function.
493 void * (*init)(void *ctx, const char *ifname);
496 * deinit - Deinitialize driver interface
497 * @priv: private driver interface data from init()
499 * Shut down driver interface and processing of driver events. Free
500 * private data buffer if one was allocated in init() handler.
502 void (*deinit)(void *priv);
505 * set_param - Set driver configuration parameters
506 * @priv: private driver interface data from init()
507 * @param: driver specific configuration parameters
509 * Returns: 0 on success, -1 on failure
511 * Optional handler for notifying driver interface about configuration
512 * parameters (driver_param).
514 int (*set_param)(void *priv, const char *param);
517 * set_countermeasures - Enable/disable TKIP countermeasures
518 * @priv: private driver interface data
519 * @enabled: 1 = countermeasures enabled, 0 = disabled
521 * Returns: 0 on success, -1 on failure
523 * Configure TKIP countermeasures. When these are enabled, the driver
524 * should drop all received and queued frames that are using TKIP.
526 int (*set_countermeasures)(void *priv, int enabled);
529 * set_drop_unencrypted - Enable/disable unencrypted frame filtering
530 * @priv: private driver interface data
531 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
533 * Returns: 0 on success, -1 on failure
535 * Configure the driver to drop all non-EAPOL frames (both receive and
536 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
537 * still be allowed for key negotiation.
539 int (*set_drop_unencrypted)(void *priv, int enabled);
542 * scan - Request the driver to initiate scan
543 * @priv: private driver interface data
544 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
545 * all SSIDs (either active scan with broadcast SSID or passive
547 * @ssid_len: length of the SSID
549 * Returns: 0 on success, -1 on failure
551 * Once the scan results are ready, the driver should report scan
552 * results event for wpa_supplicant which will eventually request the
553 * results with wpa_driver_get_scan_results().
555 int (*scan)(void *priv, const u8 *ssid, size_t ssid_len);
558 * get_scan_results - Fetch the latest scan results (old version)
559 * @priv: private driver interface data
560 * @results: pointer to buffer for scan results
561 * @max_size: maximum number of entries (buffer size)
563 * Returns: Number of scan result entries used on success, -1 on
566 * If scan results include more than max_size BSSes, max_size will be
567 * returned and the remaining entries will not be included in the
570 * This function is depracated. New driver wrapper implementations
571 * should implement support for get_scan_results2().
573 int (*get_scan_results)(void *priv,
574 struct wpa_scan_result *results,
578 * deauthenticate - Request driver to deauthenticate
579 * @priv: private driver interface data
580 * @addr: peer address (BSSID of the AP)
581 * @reason_code: 16-bit reason code to be sent in the deauthentication
584 * Returns: 0 on success, -1 on failure
586 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
589 * disassociate - Request driver to disassociate
590 * @priv: private driver interface data
591 * @addr: peer address (BSSID of the AP)
592 * @reason_code: 16-bit reason code to be sent in the disassociation
595 * Returns: 0 on success, -1 on failure
597 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
600 * associate - Request driver to associate
601 * @priv: private driver interface data
602 * @params: association parameters
604 * Returns: 0 on success, -1 on failure
606 int (*associate)(void *priv,
607 struct wpa_driver_associate_params *params);
610 * set_auth_alg - Set IEEE 802.11 authentication algorithm
611 * @priv: private driver interface data
612 * @auth_alg: bit field of AUTH_ALG_*
614 * If the driver supports more than one authentication algorithm at the
615 * same time, it should configure all supported algorithms. If not, one
616 * algorithm needs to be selected arbitrarily. Open System
617 * authentication should be ok for most cases and it is recommended to
618 * be used if other options are not supported. Static WEP configuration
619 * may also use Shared Key authentication and LEAP requires its own
620 * algorithm number. For LEAP, user can make sure that only one
621 * algorithm is used at a time by configuring LEAP as the only
622 * supported EAP method. This information is also available in
623 * associate() params, so set_auth_alg may not be needed in case of
626 * Returns: 0 on success, -1 on failure
628 int (*set_auth_alg)(void *priv, int auth_alg);
631 * add_pmkid - Add PMKSA cache entry to the driver
632 * @priv: private driver interface data
633 * @bssid: BSSID for the PMKSA cache entry
634 * @pmkid: PMKID for the PMKSA cache entry
636 * Returns: 0 on success, -1 on failure
638 * This function is called when a new PMK is received, as a result of
639 * either normal authentication or RSN pre-authentication.
641 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
642 * associate(), add_pmkid() can be used to add new PMKSA cache entries
643 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
644 * driver_ops function does not need to be implemented. Likewise, if
645 * the driver does not support WPA, this function is not needed.
647 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
650 * remove_pmkid - Remove 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 the supplicant drops a PMKSA cache
658 * entry for any reason.
660 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
661 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
662 * between the driver and wpa_supplicant. If the driver uses wpa_ie
663 * from wpa_supplicant, this driver_ops function does not need to be
664 * implemented. Likewise, if the driver does not support WPA, this
665 * function is not needed.
667 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
670 * flush_pmkid - Flush PMKSA cache
671 * @priv: private driver interface data
673 * Returns: 0 on success, -1 on failure
675 * This function is called when the supplicant drops all PMKSA cache
676 * entries for any reason.
678 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
679 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
680 * between the driver and wpa_supplicant. If the driver uses wpa_ie
681 * from wpa_supplicant, this driver_ops function does not need to be
682 * implemented. Likewise, if the driver does not support WPA, this
683 * function is not needed.
685 int (*flush_pmkid)(void *priv);
688 * flush_pmkid - Flush PMKSA cache
689 * @priv: private driver interface data
691 * Returns: 0 on success, -1 on failure
693 * Get driver/firmware/hardware capabilities.
695 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
698 * poll - Poll driver for association information
699 * @priv: private driver interface data
701 * This is an option callback that can be used when the driver does not
702 * provide event mechanism for association events. This is called when
703 * receiving WPA EAPOL-Key messages that require association
704 * information. The driver interface is supposed to generate associnfo
705 * event before returning from this callback function. In addition, the
706 * driver interface should generate an association event after having
707 * sent out associnfo.
709 void (*poll)(void *priv);
712 * get_ifname - Get interface name
713 * @priv: private driver interface data
715 * Returns: Pointer to the interface name. This can differ from the
716 * interface name used in init() call. Init() is called first.
718 * This optional function can be used to allow the driver interface to
719 * replace the interface name with something else, e.g., based on an
720 * interface mapping from a more descriptive name.
722 const char * (*get_ifname)(void *priv);
725 * get_mac_addr - Get own MAC address
726 * @priv: private driver interface data
728 * Returns: Pointer to own MAC address or %NULL on failure
730 * This optional function can be used to get the own MAC address of the
731 * device from the driver interface code. This is only needed if the
732 * l2_packet implementation for the OS does not provide easy access to
734 const u8 * (*get_mac_addr)(void *priv);
737 * send_eapol - Optional function for sending EAPOL packets
738 * @priv: private driver interface data
739 * @dest: Destination MAC address
741 * @data: EAPOL packet starting with IEEE 802.1X header
742 * @data_len: Size of the EAPOL packet
744 * Returns: 0 on success, -1 on failure
746 * This optional function can be used to override l2_packet operations
747 * with driver specific functionality. If this function pointer is set,
748 * l2_packet module is not used at all and the driver interface code is
749 * responsible for receiving and sending all EAPOL packets. The
750 * received EAPOL packets are sent to core code by calling
751 * wpa_supplicant_rx_eapol(). The driver interface is required to
752 * implement get_mac_addr() handler if send_eapol() is used.
754 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
755 const u8 *data, size_t data_len);
758 * set_operstate - Sets device operating state to DORMANT or UP
759 * @priv: private driver interface data
760 * @state: 0 = dormant, 1 = up
761 * Returns: 0 on success, -1 on failure
763 * This is an optional function that can be used on operating systems
764 * that support a concept of controlling network device state from user
765 * space applications. This function, if set, gets called with
766 * state = 1 when authentication has been completed and with state = 0
767 * when connection is lost.
769 int (*set_operstate)(void *priv, int state);
772 * mlme_setprotection - MLME-SETPROTECTION.request primitive
773 * @priv: Private driver interface data
774 * @addr: Address of the station for which to set protection (may be
775 * %NULL for group keys)
776 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
777 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
778 * Returns: 0 on success, -1 on failure
780 * This is an optional function that can be used to set the driver to
781 * require protection for Tx and/or Rx frames. This uses the layer
782 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
783 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
784 * set protection operation; instead, they set protection implicitly
785 * based on configured keys.
787 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
791 * get_hw_feature_data - Get hardware support data (channels and rates)
792 * @priv: Private driver interface data
793 * @num_modes: Variable for returning the number of returned modes
794 * flags: Variable for returning hardware feature flags
795 * Returns: Pointer to allocated hardware data on success or %NULL on
796 * failure. Caller is responsible for freeing this.
798 * This function is only needed for drivers that export MLME
799 * (management frame processing) to wpa_supplicant.
801 struct wpa_hw_modes * (*get_hw_feature_data)(void *priv,
806 * set_channel - Set channel
807 * @priv: Private driver interface data
808 * @phymode: WPA_MODE_IEEE80211B, ..
809 * @chan: IEEE 802.11 channel number
810 * @freq: Frequency of the channel in MHz
811 * Returns: 0 on success, -1 on failure
813 * This function is only needed for drivers that export MLME
814 * (management frame processing) to wpa_supplicant.
816 int (*set_channel)(void *priv, wpa_hw_mode phymode, int chan,
820 * set_ssid - Set SSID
821 * @priv: Private driver interface data
823 * @ssid_len: SSID length
824 * Returns: 0 on success, -1 on failure
826 * This function is only needed for drivers that export MLME
827 * (management frame processing) to wpa_supplicant.
829 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
832 * set_bssid - Set BSSID
833 * @priv: Private driver interface data
835 * Returns: 0 on success, -1 on failure
837 * This function is only needed for drivers that export MLME
838 * (management frame processing) to wpa_supplicant.
840 int (*set_bssid)(void *priv, const u8 *bssid);
843 * send_mlme - Send management frame from MLME
844 * @priv: Private driver interface data
845 * @data: IEEE 802.11 management frame with IEEE 802.11 header
846 * @data_len: Size of the management frame
847 * Returns: 0 on success, -1 on failure
849 * This function is only needed for drivers that export MLME
850 * (management frame processing) to wpa_supplicant.
852 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
855 * mlme_add_sta - Add a STA entry into the driver/netstack
856 * @priv: Private driver interface data
857 * @addr: MAC address of the STA (e.g., BSSID of the AP)
858 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
859 * format (one octet per rate, 1 = 0.5 Mbps)
860 * @supp_rates_len: Number of entries in supp_rates
861 * Returns: 0 on success, -1 on failure
863 * This function is only needed for drivers that export MLME
864 * (management frame processing) to wpa_supplicant. When the MLME code
865 * completes association with an AP, this function is called to
866 * configure the driver/netstack with a STA entry for data frame
867 * processing (TX rate control, encryption/decryption).
869 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
870 size_t supp_rates_len);
873 * mlme_remove_sta - Remove a STA entry from the driver/netstack
874 * @priv: Private driver interface data
875 * @addr: MAC address of the STA (e.g., BSSID of the AP)
876 * Returns: 0 on success, -1 on failure
878 * This function is only needed for drivers that export MLME
879 * (management frame processing) to wpa_supplicant.
881 int (*mlme_remove_sta)(void *priv, const u8 *addr);
884 * update_ft_ies - Update FT (IEEE 802.11r) IEs
885 * @priv: Private driver interface data
886 * @md: Mobility domain (2 octets) (also included inside ies)
887 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
888 * @ies_len: Length of FT IEs in bytes
889 * Returns: 0 on success, -1 on failure
891 * The supplicant uses this callback to let the driver know that keying
892 * material for FT is available and that the driver can use the
893 * provided IEs in the next message in FT authentication sequence.
895 * This function is only needed for driver that support IEEE 802.11r
896 * (Fast BSS Transition).
898 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
902 * send_ft_action - Send FT Action frame (IEEE 802.11r)
903 * @priv: Private driver interface data
904 * @action: Action field value
905 * @target_ap: Target AP address
906 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
907 * @ies_len: Length of FT IEs in bytes
908 * Returns: 0 on success, -1 on failure
910 * The supplicant uses this callback to request the driver to transmit
911 * an FT Action frame (action category 6) for over-the-DS fast BSS
914 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
915 const u8 *ies, size_t ies_len);
918 * get_scan_results2 - Fetch the latest scan results
919 * @priv: private driver interface data
921 * Returns: Allocated buffer of scan results (caller is responsible for
922 * freeing the data structure) on success, NULL on failure
924 struct wpa_scan_results * (*get_scan_results2)(void *priv);
927 * * set_probe_req_ie - Set information element(s) for Probe Request
928 * @priv: private driver interface data
929 * @ies: Information elements to append or %NULL to remove extra IEs
930 * @ies_len: Length of the IE buffer in octets
931 * Returns: 0 on success, -1 on failure
933 int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len);
936 * set_mode - Request driver to set the operating mode
937 * @priv: private driver interface data
938 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
940 * This handler will be called before any key configuration and call to
941 * associate() handler in order to allow the operation mode to be
942 * configured as early as possible. This information is also available
943 * in associate() params and as such, some driver wrappers may not need
944 * to implement set_mode() handler.
945 * Returns: 0 on success, -1 on failure
947 int (*set_mode)(void *priv, int mode);
950 /* Function to check whether a driver is for wired connections */
951 static inline int IS_WIRED(const struct wpa_driver_ops *drv)
953 return os_strcmp(drv->name, "wired") == 0 ||
954 os_strcmp(drv->name, "roboswitch") == 0;
958 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
960 typedef enum wpa_event_type {
962 * EVENT_ASSOC - Association completed
964 * This event needs to be delivered when the driver completes IEEE
965 * 802.11 association or reassociation successfully.
966 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
967 * after this event has been generated. In addition, optional
968 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
969 * more information about the association. If the driver interface gets
970 * both of these events at the same time, it can also include the
971 * assoc_info data in EVENT_ASSOC call.
976 * EVENT_DISASSOC - Association lost
978 * This event should be called when association is lost either due to
979 * receiving deauthenticate or disassociate frame from the AP or when
980 * sending either of these frames to the current AP.
985 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
987 * This event must be delivered when a Michael MIC error is detected by
988 * the local driver. Additional data for event processing is
989 * provided with union wpa_event_data::michael_mic_failure. This
990 * information is used to request new encyption key and to initiate
991 * TKIP countermeasures if needed.
993 EVENT_MICHAEL_MIC_FAILURE,
996 * EVENT_SCAN_RESULTS - Scan results available
998 * This event must be called whenever scan results are available to be
999 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1000 * is expected to be used some time after struct wpa_driver_ops::scan()
1001 * is called. If the driver provides an unsolicited event when the scan
1002 * has been completed, this event can be used to trigger
1003 * EVENT_SCAN_RESULTS call. If such event is not available from the
1004 * driver, the driver wrapper code is expected to use a registered
1005 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1006 * scan is expected to be completed.
1011 * EVENT_ASSOCINFO - Report optional extra information for association
1013 * This event can be used to report extra association information for
1014 * EVENT_ASSOC processing. This extra information includes IEs from
1015 * association frames and Beacon/Probe Response frames in union
1016 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1017 * EVENT_ASSOC. Alternatively, the driver interface can include
1018 * assoc_info data in the EVENT_ASSOC call if it has all the
1019 * information available at the same point.
1024 * EVENT_INTERFACE_STATUS - Report interface status changes
1026 * This optional event can be used to report changes in interface
1027 * status (interface added/removed) using union
1028 * wpa_event_data::interface_status. This can be used to trigger
1029 * wpa_supplicant to stop and re-start processing for the interface,
1030 * e.g., when a cardbus card is ejected/inserted.
1032 EVENT_INTERFACE_STATUS,
1035 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1037 * This event can be used to inform wpa_supplicant about candidates for
1038 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1039 * for scan request (ap_scan=2 mode), this event is required for
1040 * pre-authentication. If wpa_supplicant is performing scan request
1041 * (ap_scan=1), this event is optional since scan results can be used
1042 * to add pre-authentication candidates. union
1043 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1044 * candidate and priority of the candidate, e.g., based on the signal
1045 * strength, in order to try to pre-authenticate first with candidates
1046 * that are most likely targets for re-association.
1048 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1049 * on the candidate list. In addition, it can be called for the current
1050 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1051 * will automatically skip pre-authentication in cases where a valid
1052 * PMKSA exists. When more than one candidate exists, this event should
1053 * be generated once for each candidate.
1055 * Driver will be notified about successful pre-authentication with
1056 * struct wpa_driver_ops::add_pmkid() calls.
1058 EVENT_PMKID_CANDIDATE,
1061 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1063 * This event can be used to inform wpa_supplicant about desire to set
1064 * up secure direct link connection between two stations as defined in
1065 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1066 * STAKey negotiation. The caller will need to set peer address for the
1072 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1074 * The driver is expected to report the received FT IEs from
1075 * FT authentication sequence from the AP. The FT IEs are included in
1076 * the extra information in union wpa_event_data::ft_ies.
1083 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1085 union wpa_event_data {
1087 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1089 * This structure is optional for EVENT_ASSOC calls and required for
1090 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1091 * driver interface does not need to generate separate EVENT_ASSOCINFO
1096 * req_ies - (Re)Association Request IEs
1098 * If the driver generates WPA/RSN IE, this event data must be
1099 * returned for WPA handshake to have needed information. If
1100 * wpa_supplicant-generated WPA/RSN IE is used, this
1101 * information event is optional.
1103 * This should start with the first IE (fixed fields before IEs
1104 * are not included).
1109 * req_ies_len - Length of req_ies in bytes
1114 * resp_ies - (Re)Association Response IEs
1116 * Optional association data from the driver. This data is not
1117 * required WPA, but may be useful for some protocols and as
1118 * such, should be reported if this is available to the driver
1121 * This should start with the first IE (fixed fields before IEs
1122 * are not included).
1127 * resp_ies_len - Length of resp_ies in bytes
1129 size_t resp_ies_len;
1132 * beacon_ies - Beacon or Probe Response IEs
1134 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1135 * Probe Response frames from the current AP (i.e., the one
1136 * that the client just associated with). This information is
1137 * used to update WPA/RSN IE for the AP. If this field is not
1138 * set, the results from previous scan will be used. If no
1139 * data for the new AP is found, scan results will be requested
1140 * again (without scan request). At this point, the driver is
1141 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1144 * This should start with the first IE (fixed fields before IEs
1145 * are not included).
1150 * beacon_ies_len - Length of beacon_ies */
1151 size_t beacon_ies_len;
1155 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1157 struct michael_mic_failure {
1159 } michael_mic_failure;
1162 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1164 struct interface_status {
1167 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1172 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1174 struct pmkid_candidate {
1175 /** BSSID of the PMKID candidate */
1177 /** Smaller the index, higher the priority */
1179 /** Whether RSN IE includes pre-authenticate flag */
1184 * struct stkstart - Data for EVENT_STKSTART
1191 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1193 * During FT (IEEE 802.11r) authentication sequence, the driver is
1194 * expected to use this event to report received FT IEs (MDIE, FTIE,
1195 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1196 * IEs for the next message will be delivered through the
1197 * struct wpa_driver_ops::update_ft_ies() callback.
1203 u8 target_ap[ETH_ALEN];
1208 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1209 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1210 * with struct wpa_driver_ops::init()
1211 * @event: event type (defined above)
1212 * @data: possible extra data for the event
1214 * Driver wrapper code should call this function whenever an event is received
1217 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1218 union wpa_event_data *data);
1221 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1222 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1223 * with struct wpa_driver_ops::init()
1224 * @src_addr: Source address of the EAPOL frame
1225 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1226 * @len: Length of the EAPOL data
1228 * This function is called for each received EAPOL frame. Most driver
1229 * interfaces rely on more generic OS mechanism for receiving frames through
1230 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1231 * take care of received EAPOL frames and deliver them to the core supplicant
1232 * code by calling this function.
1234 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1235 const u8 *buf, size_t len);
1237 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1238 struct ieee80211_rx_status *rx_status);
1239 void wpa_supplicant_sta_free_hw_features(struct wpa_hw_modes *hw_features,
1240 size_t num_hw_features);
1242 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1243 #define WPA_IE_VENDOR_TYPE 0x0050f201
1244 #define WPS_IE_VENDOR_TYPE 0x0050f204
1245 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1247 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1248 void wpa_scan_results_free(struct wpa_scan_results *res);
1249 void wpa_scan_sort_results(struct wpa_scan_results *res);
1251 #endif /* DRIVER_H */