2 * WPA Supplicant - Glue code to setup EAPOL and RSN modules
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 #include "eapol_supp/eapol_supp_sm.h"
19 #include "rsn_supp/wpa.h"
22 #include "l2_packet/l2_packet.h"
23 #include "common/wpa_common.h"
24 #include "wpa_supplicant_i.h"
26 #include "rsn_supp/pmksa_cache.h"
29 #include "common/ieee802_11_defs.h"
30 #include "common/wpa_ctrl.h"
31 #include "wpas_glue.h"
32 #include "wps_supplicant.h"
37 #ifndef CONFIG_NO_CONFIG_BLOBS
38 #if defined(IEEE8021X_EAPOL) || !defined(CONFIG_NO_WPA)
39 static void wpa_supplicant_set_config_blob(void *ctx
,
40 struct wpa_config_blob
*blob
)
42 struct wpa_supplicant
*wpa_s
= ctx
;
43 wpa_config_set_blob(wpa_s
->conf
, blob
);
44 if (wpa_s
->conf
->update_config
) {
45 int ret
= wpa_config_write(wpa_s
->confname
, wpa_s
->conf
);
47 wpa_printf(MSG_DEBUG
, "Failed to update config after "
54 static const struct wpa_config_blob
*
55 wpa_supplicant_get_config_blob(void *ctx
, const char *name
)
57 struct wpa_supplicant
*wpa_s
= ctx
;
58 return wpa_config_get_blob(wpa_s
->conf
, name
);
60 #endif /* defined(IEEE8021X_EAPOL) || !defined(CONFIG_NO_WPA) */
61 #endif /* CONFIG_NO_CONFIG_BLOBS */
64 #if defined(IEEE8021X_EAPOL) || !defined(CONFIG_NO_WPA)
65 static u8
* wpa_alloc_eapol(const struct wpa_supplicant
*wpa_s
, u8 type
,
66 const void *data
, u16 data_len
,
67 size_t *msg_len
, void **data_pos
)
69 struct ieee802_1x_hdr
*hdr
;
71 *msg_len
= sizeof(*hdr
) + data_len
;
72 hdr
= os_malloc(*msg_len
);
76 hdr
->version
= wpa_s
->conf
->eapol_version
;
78 hdr
->length
= host_to_be16(data_len
);
81 os_memcpy(hdr
+ 1, data
, data_len
);
83 os_memset(hdr
+ 1, 0, data_len
);
93 * wpa_ether_send - Send Ethernet frame
94 * @wpa_s: Pointer to wpa_supplicant data
95 * @dest: Destination MAC address
96 * @proto: Ethertype in host byte order
97 * @buf: Frame payload starting from IEEE 802.1X header
98 * @len: Frame payload length
99 * Returns: >=0 on success, <0 on failure
101 static int wpa_ether_send(struct wpa_supplicant
*wpa_s
, const u8
*dest
,
102 u16 proto
, const u8
*buf
, size_t len
)
105 return l2_packet_send(wpa_s
->l2
, dest
, proto
, buf
, len
);
108 return wpa_drv_send_eapol(wpa_s
, dest
, proto
, buf
, len
);
110 #endif /* IEEE8021X_EAPOL || !CONFIG_NO_WPA */
113 #ifdef IEEE8021X_EAPOL
116 * wpa_supplicant_eapol_send - Send IEEE 802.1X EAPOL packet to Authenticator
117 * @ctx: Pointer to wpa_supplicant data (wpa_s)
118 * @type: IEEE 802.1X packet type (IEEE802_1X_TYPE_*)
119 * @buf: EAPOL payload (after IEEE 802.1X header)
120 * @len: EAPOL payload length
121 * Returns: >=0 on success, <0 on failure
123 * This function adds Ethernet and IEEE 802.1X header and sends the EAPOL frame
124 * to the current Authenticator.
126 static int wpa_supplicant_eapol_send(void *ctx
, int type
, const u8
*buf
,
129 struct wpa_supplicant
*wpa_s
= ctx
;
130 u8
*msg
, *dst
, bssid
[ETH_ALEN
];
134 /* TODO: could add l2_packet_sendmsg that allows fragments to avoid
137 if (wpa_key_mgmt_wpa_psk(wpa_s
->key_mgmt
) ||
138 wpa_s
->key_mgmt
== WPA_KEY_MGMT_NONE
) {
139 /* Current SSID is not using IEEE 802.1X/EAP, so drop possible
140 * EAPOL frames (mainly, EAPOL-Start) from EAPOL state
142 wpa_printf(MSG_DEBUG
, "WPA: drop TX EAPOL in non-IEEE 802.1X "
143 "mode (type=%d len=%lu)", type
,
144 (unsigned long) len
);
148 if (pmksa_cache_get_current(wpa_s
->wpa
) &&
149 type
== IEEE802_1X_TYPE_EAPOL_START
) {
150 /* Trying to use PMKSA caching - do not send EAPOL-Start frames
151 * since they will trigger full EAPOL authentication. */
152 wpa_printf(MSG_DEBUG
, "RSN: PMKSA caching - do not send "
157 if (is_zero_ether_addr(wpa_s
->bssid
)) {
158 wpa_printf(MSG_DEBUG
, "BSSID not set when trying to send an "
160 if (wpa_drv_get_bssid(wpa_s
, bssid
) == 0 &&
161 !is_zero_ether_addr(bssid
)) {
163 wpa_printf(MSG_DEBUG
, "Using current BSSID " MACSTR
164 " from the driver as the EAPOL destination",
167 dst
= wpa_s
->last_eapol_src
;
168 wpa_printf(MSG_DEBUG
, "Using the source address of the"
169 " last received EAPOL frame " MACSTR
" as "
170 "the EAPOL destination",
174 /* BSSID was already set (from (Re)Assoc event, so use it as
175 * the EAPOL destination. */
179 msg
= wpa_alloc_eapol(wpa_s
, type
, buf
, len
, &msglen
, NULL
);
183 wpa_printf(MSG_DEBUG
, "TX EAPOL: dst=" MACSTR
, MAC2STR(dst
));
184 wpa_hexdump(MSG_MSGDUMP
, "TX EAPOL", msg
, msglen
);
185 res
= wpa_ether_send(wpa_s
, dst
, ETH_P_EAPOL
, msg
, msglen
);
192 * wpa_eapol_set_wep_key - set WEP key for the driver
193 * @ctx: Pointer to wpa_supplicant data (wpa_s)
194 * @unicast: 1 = individual unicast key, 0 = broadcast key
195 * @keyidx: WEP key index (0..3)
196 * @key: Pointer to key data
197 * @keylen: Key length in bytes
198 * Returns: 0 on success or < 0 on error.
200 static int wpa_eapol_set_wep_key(void *ctx
, int unicast
, int keyidx
,
201 const u8
*key
, size_t keylen
)
203 struct wpa_supplicant
*wpa_s
= ctx
;
204 if (wpa_s
->key_mgmt
== WPA_KEY_MGMT_IEEE8021X_NO_WPA
) {
205 int cipher
= (keylen
== 5) ? WPA_CIPHER_WEP40
:
208 wpa_s
->pairwise_cipher
= cipher
;
210 wpa_s
->group_cipher
= cipher
;
212 return wpa_drv_set_key(wpa_s
, WPA_ALG_WEP
,
213 unicast
? wpa_s
->bssid
:
214 (u8
*) "\xff\xff\xff\xff\xff\xff",
215 keyidx
, unicast
, (u8
*) "", 0, key
, keylen
);
219 static void wpa_supplicant_aborted_cached(void *ctx
)
221 struct wpa_supplicant
*wpa_s
= ctx
;
222 wpa_sm_aborted_cached(wpa_s
->wpa
);
226 static void wpa_supplicant_eapol_cb(struct eapol_sm
*eapol
, int success
,
229 struct wpa_supplicant
*wpa_s
= ctx
;
233 wpa_printf(MSG_DEBUG
, "EAPOL authentication completed %ssuccessfully",
234 success
? "" : "un");
236 if (wpas_wps_eapol_cb(wpa_s
) > 0)
241 * Make sure we do not get stuck here waiting for long EAPOL
242 * timeout if the AP does not disconnect in case of
243 * authentication failure.
245 wpa_supplicant_req_auth_timeout(wpa_s
, 2, 0);
248 if (!success
|| !(wpa_s
->drv_flags
& WPA_DRIVER_FLAGS_4WAY_HANDSHAKE
))
251 if (!wpa_key_mgmt_wpa_ieee8021x(wpa_s
->key_mgmt
))
254 wpa_printf(MSG_DEBUG
, "Configure PMK for driver-based RSN 4-way "
258 res
= eapol_sm_get_key(eapol
, pmk
, PMK_LEN
);
261 * EAP-LEAP is an exception from other EAP methods: it
262 * uses only 16-byte PMK.
264 res
= eapol_sm_get_key(eapol
, pmk
, 16);
269 wpa_printf(MSG_DEBUG
, "Failed to get PMK from EAPOL state "
274 if (wpa_drv_set_key(wpa_s
, WPA_ALG_PMK
, NULL
, 0, 0, NULL
, 0, pmk
,
276 wpa_printf(MSG_DEBUG
, "Failed to set PMK to the driver");
279 wpa_supplicant_cancel_scan(wpa_s
);
280 wpa_supplicant_cancel_auth_timeout(wpa_s
);
281 wpa_supplicant_set_state(wpa_s
, WPA_COMPLETED
);
286 static void wpa_supplicant_notify_eapol_done(void *ctx
)
288 struct wpa_supplicant
*wpa_s
= ctx
;
289 wpa_msg(wpa_s
, MSG_DEBUG
, "WPA: EAPOL processing complete");
290 if (wpa_key_mgmt_wpa_ieee8021x(wpa_s
->key_mgmt
)) {
291 wpa_supplicant_set_state(wpa_s
, WPA_4WAY_HANDSHAKE
);
293 wpa_supplicant_cancel_auth_timeout(wpa_s
);
294 wpa_supplicant_set_state(wpa_s
, WPA_COMPLETED
);
298 #endif /* IEEE8021X_EAPOL */
301 #ifndef CONFIG_NO_WPA
303 static int wpa_get_beacon_ie(struct wpa_supplicant
*wpa_s
)
306 struct wpa_bss
*curr
= NULL
, *bss
;
307 struct wpa_ssid
*ssid
= wpa_s
->current_ssid
;
310 dl_list_for_each(bss
, &wpa_s
->bss
, struct wpa_bss
, list
) {
311 if (os_memcmp(bss
->bssid
, wpa_s
->bssid
, ETH_ALEN
) != 0)
314 ((bss
->ssid_len
== ssid
->ssid_len
&&
315 os_memcmp(bss
->ssid
, ssid
->ssid
, ssid
->ssid_len
) == 0) ||
316 ssid
->ssid_len
== 0)) {
323 ie
= wpa_bss_get_vendor_ie(curr
, WPA_IE_VENDOR_TYPE
);
324 if (wpa_sm_set_ap_wpa_ie(wpa_s
->wpa
, ie
, ie
? 2 + ie
[1] : 0))
327 ie
= wpa_bss_get_ie(curr
, WLAN_EID_RSN
);
328 if (wpa_sm_set_ap_rsn_ie(wpa_s
->wpa
, ie
, ie
? 2 + ie
[1] : 0))
338 static int wpa_supplicant_get_beacon_ie(void *ctx
)
340 struct wpa_supplicant
*wpa_s
= ctx
;
341 if (wpa_get_beacon_ie(wpa_s
) == 0) {
345 /* No WPA/RSN IE found in the cached scan results. Try to get updated
346 * scan results from the driver. */
347 if (wpa_supplicant_update_scan_results(wpa_s
) < 0)
350 return wpa_get_beacon_ie(wpa_s
);
354 static u8
* _wpa_alloc_eapol(void *wpa_s
, u8 type
,
355 const void *data
, u16 data_len
,
356 size_t *msg_len
, void **data_pos
)
358 return wpa_alloc_eapol(wpa_s
, type
, data
, data_len
, msg_len
, data_pos
);
362 static int _wpa_ether_send(void *wpa_s
, const u8
*dest
, u16 proto
,
363 const u8
*buf
, size_t len
)
365 return wpa_ether_send(wpa_s
, dest
, proto
, buf
, len
);
369 static void _wpa_supplicant_cancel_auth_timeout(void *wpa_s
)
371 wpa_supplicant_cancel_auth_timeout(wpa_s
);
375 static void _wpa_supplicant_set_state(void *wpa_s
, enum wpa_states state
)
377 wpa_supplicant_set_state(wpa_s
, state
);
382 * wpa_supplicant_get_state - Get the connection state
383 * @wpa_s: Pointer to wpa_supplicant data
384 * Returns: The current connection state (WPA_*)
386 static enum wpa_states
wpa_supplicant_get_state(struct wpa_supplicant
*wpa_s
)
388 return wpa_s
->wpa_state
;
392 static enum wpa_states
_wpa_supplicant_get_state(void *wpa_s
)
394 return wpa_supplicant_get_state(wpa_s
);
398 static void _wpa_supplicant_disassociate(void *wpa_s
, int reason_code
)
400 wpa_supplicant_disassociate(wpa_s
, reason_code
);
401 /* Schedule a scan to make sure we continue looking for networks */
402 wpa_supplicant_req_scan(wpa_s
, 5, 0);
406 static void _wpa_supplicant_deauthenticate(void *wpa_s
, int reason_code
)
408 wpa_supplicant_deauthenticate(wpa_s
, reason_code
);
409 /* Schedule a scan to make sure we continue looking for networks */
410 wpa_supplicant_req_scan(wpa_s
, 5, 0);
414 static void * wpa_supplicant_get_network_ctx(void *wpa_s
)
416 return wpa_supplicant_get_ssid(wpa_s
);
420 static int wpa_supplicant_get_bssid(void *ctx
, u8
*bssid
)
422 struct wpa_supplicant
*wpa_s
= ctx
;
423 if (wpa_s
->drv_flags
& WPA_DRIVER_FLAGS_USER_SPACE_MLME
) {
424 os_memcpy(bssid
, wpa_s
->bssid
, ETH_ALEN
);
427 return wpa_drv_get_bssid(wpa_s
, bssid
);
431 static int wpa_supplicant_set_key(void *_wpa_s
, enum wpa_alg alg
,
432 const u8
*addr
, int key_idx
, int set_tx
,
433 const u8
*seq
, size_t seq_len
,
434 const u8
*key
, size_t key_len
)
436 struct wpa_supplicant
*wpa_s
= _wpa_s
;
437 if (alg
== WPA_ALG_TKIP
&& key_idx
== 0 && key_len
== 32) {
438 /* Clear the MIC error counter when setting a new PTK. */
439 wpa_s
->mic_errors_seen
= 0;
441 return wpa_drv_set_key(wpa_s
, alg
, addr
, key_idx
, set_tx
, seq
, seq_len
,
446 static int wpa_supplicant_mlme_setprotection(void *wpa_s
, const u8
*addr
,
450 return wpa_drv_mlme_setprotection(wpa_s
, addr
, protection_type
,
455 static int wpa_supplicant_add_pmkid(void *wpa_s
,
456 const u8
*bssid
, const u8
*pmkid
)
458 return wpa_drv_add_pmkid(wpa_s
, bssid
, pmkid
);
462 static int wpa_supplicant_remove_pmkid(void *wpa_s
,
463 const u8
*bssid
, const u8
*pmkid
)
465 return wpa_drv_remove_pmkid(wpa_s
, bssid
, pmkid
);
469 #ifdef CONFIG_IEEE80211R
470 static int wpa_supplicant_update_ft_ies(void *ctx
, const u8
*md
,
471 const u8
*ies
, size_t ies_len
)
473 struct wpa_supplicant
*wpa_s
= ctx
;
474 if (wpa_s
->drv_flags
& WPA_DRIVER_FLAGS_USER_SPACE_MLME
)
475 return ieee80211_sta_update_ft_ies(wpa_s
, md
, ies
, ies_len
);
476 if (wpa_s
->drv_flags
& WPA_DRIVER_FLAGS_SME
)
477 return sme_update_ft_ies(wpa_s
, md
, ies
, ies_len
);
478 return wpa_drv_update_ft_ies(wpa_s
, md
, ies
, ies_len
);
482 static int wpa_supplicant_send_ft_action(void *ctx
, u8 action
,
484 const u8
*ies
, size_t ies_len
)
486 struct wpa_supplicant
*wpa_s
= ctx
;
487 if (wpa_s
->drv_flags
& WPA_DRIVER_FLAGS_USER_SPACE_MLME
)
488 return ieee80211_sta_send_ft_action(wpa_s
, action
, target_ap
,
490 return wpa_drv_send_ft_action(wpa_s
, action
, target_ap
, ies
, ies_len
);
492 #endif /* CONFIG_IEEE80211R */
494 #endif /* CONFIG_NO_WPA */
497 #ifdef IEEE8021X_EAPOL
498 #if defined(CONFIG_CTRL_IFACE) || !defined(CONFIG_NO_STDOUT_DEBUG)
499 static void wpa_supplicant_eap_param_needed(void *ctx
, const char *field
,
502 struct wpa_supplicant
*wpa_s
= ctx
;
503 struct wpa_ssid
*ssid
= wpa_s
->current_ssid
;
511 buflen
= 100 + os_strlen(txt
) + ssid
->ssid_len
;
512 buf
= os_malloc(buflen
);
515 len
= os_snprintf(buf
, buflen
,
516 WPA_CTRL_REQ
"%s-%d:%s needed for SSID ",
517 field
, ssid
->id
, txt
);
518 if (len
< 0 || (size_t) len
>= buflen
) {
522 if (ssid
->ssid
&& buflen
> len
+ ssid
->ssid_len
) {
523 os_memcpy(buf
+ len
, ssid
->ssid
, ssid
->ssid_len
);
524 len
+= ssid
->ssid_len
;
527 buf
[buflen
- 1] = '\0';
528 wpa_msg(wpa_s
, MSG_INFO
, "%s", buf
);
531 #else /* CONFIG_CTRL_IFACE || !CONFIG_NO_STDOUT_DEBUG */
532 #define wpa_supplicant_eap_param_needed NULL
533 #endif /* CONFIG_CTRL_IFACE || !CONFIG_NO_STDOUT_DEBUG */
536 static void wpa_supplicant_port_cb(void *ctx
, int authorized
)
538 struct wpa_supplicant
*wpa_s
= ctx
;
539 wpa_printf(MSG_DEBUG
, "EAPOL: Supplicant port status: %s",
540 authorized
? "Authorized" : "Unauthorized");
541 wpa_drv_set_supp_port(wpa_s
, authorized
);
543 #endif /* IEEE8021X_EAPOL */
546 int wpa_supplicant_init_eapol(struct wpa_supplicant
*wpa_s
)
548 #ifdef IEEE8021X_EAPOL
549 struct eapol_ctx
*ctx
;
550 ctx
= os_zalloc(sizeof(*ctx
));
552 wpa_printf(MSG_ERROR
, "Failed to allocate EAPOL context.");
557 ctx
->msg_ctx
= wpa_s
;
558 ctx
->eapol_send_ctx
= wpa_s
;
560 ctx
->eapol_done_cb
= wpa_supplicant_notify_eapol_done
;
561 ctx
->eapol_send
= wpa_supplicant_eapol_send
;
562 ctx
->set_wep_key
= wpa_eapol_set_wep_key
;
563 ctx
->set_config_blob
= wpa_supplicant_set_config_blob
;
564 ctx
->get_config_blob
= wpa_supplicant_get_config_blob
;
565 ctx
->aborted_cached
= wpa_supplicant_aborted_cached
;
566 ctx
->opensc_engine_path
= wpa_s
->conf
->opensc_engine_path
;
567 ctx
->pkcs11_engine_path
= wpa_s
->conf
->pkcs11_engine_path
;
568 ctx
->pkcs11_module_path
= wpa_s
->conf
->pkcs11_module_path
;
569 ctx
->wps
= wpa_s
->wps
;
570 ctx
->eap_param_needed
= wpa_supplicant_eap_param_needed
;
571 ctx
->port_cb
= wpa_supplicant_port_cb
;
572 ctx
->cb
= wpa_supplicant_eapol_cb
;
574 wpa_s
->eapol
= eapol_sm_init(ctx
);
575 if (wpa_s
->eapol
== NULL
) {
577 wpa_printf(MSG_ERROR
, "Failed to initialize EAPOL state "
581 #endif /* IEEE8021X_EAPOL */
587 int wpa_supplicant_init_wpa(struct wpa_supplicant
*wpa_s
)
589 #ifndef CONFIG_NO_WPA
590 struct wpa_sm_ctx
*ctx
;
591 ctx
= os_zalloc(sizeof(*ctx
));
593 wpa_printf(MSG_ERROR
, "Failed to allocate WPA context.");
598 ctx
->msg_ctx
= wpa_s
;
599 ctx
->set_state
= _wpa_supplicant_set_state
;
600 ctx
->get_state
= _wpa_supplicant_get_state
;
601 ctx
->deauthenticate
= _wpa_supplicant_deauthenticate
;
602 ctx
->disassociate
= _wpa_supplicant_disassociate
;
603 ctx
->set_key
= wpa_supplicant_set_key
;
604 ctx
->get_network_ctx
= wpa_supplicant_get_network_ctx
;
605 ctx
->get_bssid
= wpa_supplicant_get_bssid
;
606 ctx
->ether_send
= _wpa_ether_send
;
607 ctx
->get_beacon_ie
= wpa_supplicant_get_beacon_ie
;
608 ctx
->alloc_eapol
= _wpa_alloc_eapol
;
609 ctx
->cancel_auth_timeout
= _wpa_supplicant_cancel_auth_timeout
;
610 ctx
->add_pmkid
= wpa_supplicant_add_pmkid
;
611 ctx
->remove_pmkid
= wpa_supplicant_remove_pmkid
;
612 #ifndef CONFIG_NO_CONFIG_BLOBS
613 ctx
->set_config_blob
= wpa_supplicant_set_config_blob
;
614 ctx
->get_config_blob
= wpa_supplicant_get_config_blob
;
615 #endif /* CONFIG_NO_CONFIG_BLOBS */
616 ctx
->mlme_setprotection
= wpa_supplicant_mlme_setprotection
;
617 #ifdef CONFIG_IEEE80211R
618 ctx
->update_ft_ies
= wpa_supplicant_update_ft_ies
;
619 ctx
->send_ft_action
= wpa_supplicant_send_ft_action
;
620 #endif /* CONFIG_IEEE80211R */
622 wpa_s
->wpa
= wpa_sm_init(ctx
);
623 if (wpa_s
->wpa
== NULL
) {
624 wpa_printf(MSG_ERROR
, "Failed to initialize WPA state "
628 #endif /* CONFIG_NO_WPA */
634 void wpa_supplicant_rsn_supp_set_config(struct wpa_supplicant
*wpa_s
,
635 struct wpa_ssid
*ssid
)
637 struct rsn_supp_config conf
;
639 os_memset(&conf
, 0, sizeof(conf
));
640 conf
.network_ctx
= ssid
;
641 conf
.peerkey_enabled
= ssid
->peerkey
;
642 conf
.allowed_pairwise_cipher
= ssid
->pairwise_cipher
;
643 #ifdef IEEE8021X_EAPOL
644 conf
.eap_workaround
= ssid
->eap_workaround
;
645 conf
.eap_conf_ctx
= &ssid
->eap
;
646 #endif /* IEEE8021X_EAPOL */
647 conf
.ssid
= ssid
->ssid
;
648 conf
.ssid_len
= ssid
->ssid_len
;
649 conf
.wpa_ptk_rekey
= ssid
->wpa_ptk_rekey
;
651 wpa_sm_set_config(wpa_s
->wpa
, ssid
? &conf
: NULL
);