2 * WPA Supplicant - Glue code to setup EAPOL and RSN modules
3 * Copyright (c) 2003-2007, 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"
22 #include "l2_packet/l2_packet.h"
23 #include "wpa_common.h"
24 #include "wpa_supplicant_i.h"
25 #include "pmksa_cache.h"
27 #include "ieee802_11_defs.h"
29 #include "wpas_glue.h"
32 #ifndef CONFIG_NO_CONFIG_BLOBS
33 #if defined(IEEE8021X_EAPOL) || !defined(CONFIG_NO_WPA)
34 static void wpa_supplicant_set_config_blob(void *ctx,
35 struct wpa_config_blob *blob)
37 struct wpa_supplicant *wpa_s = ctx;
38 wpa_config_set_blob(wpa_s->conf, blob);
42 static const struct wpa_config_blob *
43 wpa_supplicant_get_config_blob(void *ctx, const char *name)
45 struct wpa_supplicant *wpa_s = ctx;
46 return wpa_config_get_blob(wpa_s->conf, name);
48 #endif /* defined(IEEE8021X_EAPOL) || !defined(CONFIG_NO_WPA) */
49 #endif /* CONFIG_NO_CONFIG_BLOBS */
52 #if defined(IEEE8021X_EAPOL) || !defined(CONFIG_NO_WPA)
53 static u8 * wpa_alloc_eapol(const struct wpa_supplicant *wpa_s, u8 type,
54 const void *data, u16 data_len,
55 size_t *msg_len, void **data_pos)
57 struct ieee802_1x_hdr *hdr;
59 *msg_len = sizeof(*hdr) + data_len;
60 hdr = os_malloc(*msg_len);
64 hdr->version = wpa_s->conf->eapol_version;
66 hdr->length = host_to_be16(data_len);
69 os_memcpy(hdr + 1, data, data_len);
71 os_memset(hdr + 1, 0, data_len);
81 * wpa_ether_send - Send Ethernet frame
82 * @wpa_s: Pointer to wpa_supplicant data
83 * @dest: Destination MAC address
84 * @proto: Ethertype in host byte order
85 * @buf: Frame payload starting from IEEE 802.1X header
86 * @len: Frame payload length
87 * Returns: >=0 on success, <0 on failure
89 static int wpa_ether_send(struct wpa_supplicant *wpa_s, const u8 *dest,
90 u16 proto, const u8 *buf, size_t len)
93 return l2_packet_send(wpa_s->l2, dest, proto, buf, len);
96 return wpa_drv_send_eapol(wpa_s, dest, proto, buf, len);
98 #endif /* IEEE8021X_EAPOL || !CONFIG_NO_WPA */
101 #ifdef IEEE8021X_EAPOL
104 * wpa_supplicant_eapol_send - Send IEEE 802.1X EAPOL packet to Authenticator
105 * @ctx: Pointer to wpa_supplicant data (wpa_s)
106 * @type: IEEE 802.1X packet type (IEEE802_1X_TYPE_*)
107 * @buf: EAPOL payload (after IEEE 802.1X header)
108 * @len: EAPOL payload length
109 * Returns: >=0 on success, <0 on failure
111 * This function adds Ethernet and IEEE 802.1X header and sends the EAPOL frame
112 * to the current Authenticator.
114 static int wpa_supplicant_eapol_send(void *ctx, int type, const u8 *buf,
117 struct wpa_supplicant *wpa_s = ctx;
118 u8 *msg, *dst, bssid[ETH_ALEN];
122 /* TODO: could add l2_packet_sendmsg that allows fragments to avoid
125 if (wpa_s->key_mgmt == WPA_KEY_MGMT_PSK ||
126 wpa_s->key_mgmt == WPA_KEY_MGMT_FT_PSK ||
127 wpa_s->key_mgmt == WPA_KEY_MGMT_NONE) {
128 /* Current SSID is not using IEEE 802.1X/EAP, so drop possible
129 * EAPOL frames (mainly, EAPOL-Start) from EAPOL state
131 wpa_printf(MSG_DEBUG, "WPA: drop TX EAPOL in non-IEEE 802.1X "
132 "mode (type=%d len=%lu)", type,
133 (unsigned long) len);
137 if (pmksa_cache_get_current(wpa_s->wpa) &&
138 type == IEEE802_1X_TYPE_EAPOL_START) {
139 /* Trying to use PMKSA caching - do not send EAPOL-Start frames
140 * since they will trigger full EAPOL authentication. */
141 wpa_printf(MSG_DEBUG, "RSN: PMKSA caching - do not send "
146 if (os_memcmp(wpa_s->bssid, "\x00\x00\x00\x00\x00\x00", ETH_ALEN) == 0)
148 wpa_printf(MSG_DEBUG, "BSSID not set when trying to send an "
150 if (wpa_drv_get_bssid(wpa_s, bssid) == 0 &&
151 os_memcmp(bssid, "\x00\x00\x00\x00\x00\x00", ETH_ALEN) !=
154 wpa_printf(MSG_DEBUG, "Using current BSSID " MACSTR
155 " from the driver as the EAPOL destination",
158 dst = wpa_s->last_eapol_src;
159 wpa_printf(MSG_DEBUG, "Using the source address of the"
160 " last received EAPOL frame " MACSTR " as "
161 "the EAPOL destination",
165 /* BSSID was already set (from (Re)Assoc event, so use it as
166 * the EAPOL destination. */
170 msg = wpa_alloc_eapol(wpa_s, type, buf, len, &msglen, NULL);
174 wpa_printf(MSG_DEBUG, "TX EAPOL: dst=" MACSTR, MAC2STR(dst));
175 wpa_hexdump(MSG_MSGDUMP, "TX EAPOL", msg, msglen);
176 res = wpa_ether_send(wpa_s, dst, ETH_P_EAPOL, msg, msglen);
183 * wpa_eapol_set_wep_key - set WEP key for the driver
184 * @ctx: Pointer to wpa_supplicant data (wpa_s)
185 * @unicast: 1 = individual unicast key, 0 = broadcast key
186 * @keyidx: WEP key index (0..3)
187 * @key: Pointer to key data
188 * @keylen: Key length in bytes
189 * Returns: 0 on success or < 0 on error.
191 static int wpa_eapol_set_wep_key(void *ctx, int unicast, int keyidx,
192 const u8 *key, size_t keylen)
194 struct wpa_supplicant *wpa_s = ctx;
195 if (wpa_s->key_mgmt == WPA_KEY_MGMT_IEEE8021X_NO_WPA) {
196 int cipher = (keylen == 5) ? WPA_CIPHER_WEP40 :
199 wpa_s->pairwise_cipher = cipher;
201 wpa_s->group_cipher = cipher;
203 return wpa_drv_set_key(wpa_s, WPA_ALG_WEP,
204 unicast ? wpa_s->bssid :
205 (u8 *) "\xff\xff\xff\xff\xff\xff",
206 keyidx, unicast, (u8 *) "", 0, key, keylen);
210 static void wpa_supplicant_aborted_cached(void *ctx)
212 struct wpa_supplicant *wpa_s = ctx;
213 wpa_sm_aborted_cached(wpa_s->wpa);
217 static void wpa_supplicant_eapol_cb(struct eapol_sm *eapol, int success,
220 struct wpa_supplicant *wpa_s = ctx;
224 wpa_printf(MSG_DEBUG, "EAPOL authentication completed %ssuccessfully",
225 success ? "" : "un");
227 if (!success || !wpa_s->driver_4way_handshake)
230 if (wpa_s->key_mgmt != WPA_KEY_MGMT_IEEE8021X &&
231 wpa_s->key_mgmt != WPA_KEY_MGMT_FT_IEEE8021X)
234 wpa_printf(MSG_DEBUG, "Configure PMK for driver-based RSN 4-way "
238 res = eapol_sm_get_key(eapol, pmk, PMK_LEN);
241 * EAP-LEAP is an exception from other EAP methods: it
242 * uses only 16-byte PMK.
244 res = eapol_sm_get_key(eapol, pmk, 16);
249 wpa_printf(MSG_DEBUG, "Failed to get PMK from EAPOL state "
254 if (wpa_drv_set_key(wpa_s, WPA_ALG_PMK, NULL, 0, 0, NULL, 0, pmk,
256 wpa_printf(MSG_DEBUG, "Failed to set PMK to the driver");
259 wpa_supplicant_cancel_scan(wpa_s);
260 wpa_supplicant_cancel_auth_timeout(wpa_s);
261 wpa_supplicant_set_state(wpa_s, WPA_COMPLETED);
266 static void wpa_supplicant_notify_eapol_done(void *ctx)
268 struct wpa_supplicant *wpa_s = ctx;
269 wpa_msg(wpa_s, MSG_DEBUG, "WPA: EAPOL processing complete");
270 if (wpa_s->key_mgmt == WPA_KEY_MGMT_IEEE8021X ||
271 wpa_s->key_mgmt == WPA_KEY_MGMT_FT_IEEE8021X) {
272 wpa_supplicant_set_state(wpa_s, WPA_4WAY_HANDSHAKE);
274 wpa_supplicant_cancel_scan(wpa_s);
275 wpa_supplicant_cancel_auth_timeout(wpa_s);
276 wpa_supplicant_set_state(wpa_s, WPA_COMPLETED);
280 #endif /* IEEE8021X_EAPOL */
283 #ifndef CONFIG_NO_WPA
285 static int wpa_get_beacon_ie(struct wpa_supplicant *wpa_s)
289 struct wpa_scan_res *curr = NULL;
290 struct wpa_ssid *ssid = wpa_s->current_ssid;
293 if (wpa_s->scan_res == NULL)
296 for (i = 0; i < wpa_s->scan_res->num; i++) {
297 struct wpa_scan_res *r = wpa_s->scan_res->res[i];
298 if (os_memcmp(r->bssid, wpa_s->bssid, ETH_ALEN) != 0)
300 ie = wpa_scan_get_ie(r, WLAN_EID_SSID);
302 ((ie && ie[1] == ssid->ssid_len &&
303 os_memcmp(ie + 2, ssid->ssid, ssid->ssid_len) == 0) ||
304 ssid->ssid_len == 0)) {
311 ie = wpa_scan_get_vendor_ie(curr, WPA_IE_VENDOR_TYPE);
312 if (wpa_sm_set_ap_wpa_ie(wpa_s->wpa, ie, ie ? 2 + ie[1] : 0))
315 ie = wpa_scan_get_ie(curr, WLAN_EID_RSN);
316 if (wpa_sm_set_ap_rsn_ie(wpa_s->wpa, ie, ie ? 2 + ie[1] : 0))
326 static int wpa_supplicant_get_beacon_ie(void *ctx)
328 struct wpa_supplicant *wpa_s = ctx;
329 if (wpa_get_beacon_ie(wpa_s) == 0) {
333 /* No WPA/RSN IE found in the cached scan results. Try to get updated
334 * scan results from the driver. */
335 if (wpa_supplicant_get_scan_results(wpa_s) < 0) {
339 return wpa_get_beacon_ie(wpa_s);
343 static u8 * _wpa_alloc_eapol(void *wpa_s, u8 type,
344 const void *data, u16 data_len,
345 size_t *msg_len, void **data_pos)
347 return wpa_alloc_eapol(wpa_s, type, data, data_len, msg_len, data_pos);
351 static int _wpa_ether_send(void *wpa_s, const u8 *dest, u16 proto,
352 const u8 *buf, size_t len)
354 return wpa_ether_send(wpa_s, dest, proto, buf, len);
358 static void _wpa_supplicant_req_scan(void *wpa_s, int sec, int usec)
360 wpa_supplicant_req_scan(wpa_s, sec, usec);
364 static void _wpa_supplicant_cancel_scan(void *wpa_s)
366 wpa_supplicant_cancel_scan(wpa_s);
370 static void _wpa_supplicant_cancel_auth_timeout(void *wpa_s)
372 wpa_supplicant_cancel_auth_timeout(wpa_s);
376 static void _wpa_supplicant_set_state(void *wpa_s, wpa_states state)
378 wpa_supplicant_set_state(wpa_s, state);
383 * wpa_supplicant_get_state - Get the connection state
384 * @wpa_s: Pointer to wpa_supplicant data
385 * Returns: The current connection state (WPA_*)
387 static wpa_states wpa_supplicant_get_state(struct wpa_supplicant *wpa_s)
389 return wpa_s->wpa_state;
393 static wpa_states _wpa_supplicant_get_state(void *wpa_s)
395 return wpa_supplicant_get_state(wpa_s);
399 static void _wpa_supplicant_disassociate(void *wpa_s, int reason_code)
401 wpa_supplicant_disassociate(wpa_s, reason_code);
405 static void _wpa_supplicant_deauthenticate(void *wpa_s, int reason_code)
407 wpa_supplicant_deauthenticate(wpa_s, reason_code);
411 static void * wpa_supplicant_get_network_ctx(void *wpa_s)
413 return wpa_supplicant_get_ssid(wpa_s);
417 static int wpa_supplicant_get_bssid(void *ctx, u8 *bssid)
419 struct wpa_supplicant *wpa_s = ctx;
420 if (wpa_s->use_client_mlme) {
421 os_memcpy(bssid, wpa_s->bssid, ETH_ALEN);
424 return wpa_drv_get_bssid(wpa_s, bssid);
428 static int wpa_supplicant_set_key(void *wpa_s, wpa_alg alg,
429 const u8 *addr, int key_idx, int set_tx,
430 const u8 *seq, size_t seq_len,
431 const u8 *key, size_t key_len)
433 return wpa_drv_set_key(wpa_s, alg, addr, key_idx, set_tx, seq, seq_len,
438 static int wpa_supplicant_mlme_setprotection(void *wpa_s, const u8 *addr,
442 return wpa_drv_mlme_setprotection(wpa_s, addr, protection_type,
447 static int wpa_supplicant_add_pmkid(void *wpa_s,
448 const u8 *bssid, const u8 *pmkid)
450 return wpa_drv_add_pmkid(wpa_s, bssid, pmkid);
454 static int wpa_supplicant_remove_pmkid(void *wpa_s,
455 const u8 *bssid, const u8 *pmkid)
457 return wpa_drv_remove_pmkid(wpa_s, bssid, pmkid);
461 #ifdef CONFIG_IEEE80211R
462 static int wpa_supplicant_update_ft_ies(void *ctx, const u8 *md,
463 const u8 *ies, size_t ies_len)
465 struct wpa_supplicant *wpa_s = ctx;
466 if (wpa_s->use_client_mlme)
467 return ieee80211_sta_update_ft_ies(wpa_s, md, ies, ies_len);
468 return wpa_drv_update_ft_ies(wpa_s, md, ies, ies_len);
472 static int wpa_supplicant_send_ft_action(void *ctx, u8 action,
474 const u8 *ies, size_t ies_len)
476 struct wpa_supplicant *wpa_s = ctx;
477 if (wpa_s->use_client_mlme)
478 return ieee80211_sta_send_ft_action(wpa_s, action, target_ap,
480 return wpa_drv_send_ft_action(wpa_s, action, target_ap, ies, ies_len);
482 #endif /* CONFIG_IEEE80211R */
484 #endif /* CONFIG_NO_WPA */
487 #if defined(CONFIG_CTRL_IFACE) || !defined(CONFIG_NO_STDOUT_DEBUG)
488 static void wpa_supplicant_eap_param_needed(void *ctx, const char *field,
491 struct wpa_supplicant *wpa_s = ctx;
492 struct wpa_ssid *ssid = wpa_s->current_ssid;
500 buflen = 100 + os_strlen(txt) + ssid->ssid_len;
501 buf = os_malloc(buflen);
504 len = os_snprintf(buf, buflen,
505 WPA_CTRL_REQ "%s-%d:%s needed for SSID ",
506 field, ssid->id, txt);
507 if (len < 0 || (size_t) len >= buflen) {
511 if (ssid->ssid && buflen > len + ssid->ssid_len) {
512 os_memcpy(buf + len, ssid->ssid, ssid->ssid_len);
513 len += ssid->ssid_len;
516 buf[buflen - 1] = '\0';
517 wpa_msg(wpa_s, MSG_INFO, "%s", buf);
520 #else /* CONFIG_CTRL_IFACE || !CONFIG_NO_STDOUT_DEBUG */
521 #define wpa_supplicant_eap_param_needed NULL
522 #endif /* CONFIG_CTRL_IFACE || !CONFIG_NO_STDOUT_DEBUG */
525 int wpa_supplicant_init_eapol(struct wpa_supplicant *wpa_s)
527 #ifdef IEEE8021X_EAPOL
528 struct eapol_ctx *ctx;
529 ctx = os_zalloc(sizeof(*ctx));
531 wpa_printf(MSG_ERROR, "Failed to allocate EAPOL context.");
536 ctx->msg_ctx = wpa_s;
537 ctx->eapol_send_ctx = wpa_s;
539 ctx->eapol_done_cb = wpa_supplicant_notify_eapol_done;
540 ctx->eapol_send = wpa_supplicant_eapol_send;
541 ctx->set_wep_key = wpa_eapol_set_wep_key;
542 ctx->set_config_blob = wpa_supplicant_set_config_blob;
543 ctx->get_config_blob = wpa_supplicant_get_config_blob;
544 ctx->aborted_cached = wpa_supplicant_aborted_cached;
545 #ifdef EAP_TLS_OPENSSL
546 ctx->opensc_engine_path = wpa_s->conf->opensc_engine_path;
547 ctx->pkcs11_engine_path = wpa_s->conf->pkcs11_engine_path;
548 ctx->pkcs11_module_path = wpa_s->conf->pkcs11_module_path;
549 #endif /* EAP_TLS_OPENSSL */
550 ctx->eap_param_needed = wpa_supplicant_eap_param_needed;
551 ctx->cb = wpa_supplicant_eapol_cb;
553 wpa_s->eapol = eapol_sm_init(ctx);
554 if (wpa_s->eapol == NULL) {
556 wpa_printf(MSG_ERROR, "Failed to initialize EAPOL state "
560 #endif /* IEEE8021X_EAPOL */
566 int wpa_supplicant_init_wpa(struct wpa_supplicant *wpa_s)
568 #ifndef CONFIG_NO_WPA
569 struct wpa_sm_ctx *ctx;
570 ctx = os_zalloc(sizeof(*ctx));
572 wpa_printf(MSG_ERROR, "Failed to allocate WPA context.");
577 ctx->set_state = _wpa_supplicant_set_state;
578 ctx->get_state = _wpa_supplicant_get_state;
579 ctx->req_scan = _wpa_supplicant_req_scan;
580 ctx->cancel_scan = _wpa_supplicant_cancel_scan;
581 ctx->deauthenticate = _wpa_supplicant_deauthenticate;
582 ctx->disassociate = _wpa_supplicant_disassociate;
583 ctx->set_key = wpa_supplicant_set_key;
584 ctx->get_network_ctx = wpa_supplicant_get_network_ctx;
585 ctx->get_bssid = wpa_supplicant_get_bssid;
586 ctx->ether_send = _wpa_ether_send;
587 ctx->get_beacon_ie = wpa_supplicant_get_beacon_ie;
588 ctx->alloc_eapol = _wpa_alloc_eapol;
589 ctx->cancel_auth_timeout = _wpa_supplicant_cancel_auth_timeout;
590 ctx->add_pmkid = wpa_supplicant_add_pmkid;
591 ctx->remove_pmkid = wpa_supplicant_remove_pmkid;
592 #ifndef CONFIG_NO_CONFIG_BLOBS
593 ctx->set_config_blob = wpa_supplicant_set_config_blob;
594 ctx->get_config_blob = wpa_supplicant_get_config_blob;
595 #endif /* CONFIG_NO_CONFIG_BLOBS */
596 ctx->mlme_setprotection = wpa_supplicant_mlme_setprotection;
597 #ifdef CONFIG_IEEE80211R
598 ctx->update_ft_ies = wpa_supplicant_update_ft_ies;
599 ctx->send_ft_action = wpa_supplicant_send_ft_action;
600 #endif /* CONFIG_IEEE80211R */
602 wpa_s->wpa = wpa_sm_init(ctx);
603 if (wpa_s->wpa == NULL) {
604 wpa_printf(MSG_ERROR, "Failed to initialize WPA state "
608 #endif /* CONFIG_NO_WPA */
614 void wpa_supplicant_rsn_supp_set_config(struct wpa_supplicant *wpa_s,
615 struct wpa_ssid *ssid)
617 struct rsn_supp_config conf;
619 os_memset(&conf, 0, sizeof(conf));
620 conf.peerkey_enabled = ssid->peerkey;
621 conf.allowed_pairwise_cipher = ssid->pairwise_cipher;
622 conf.eap_workaround = ssid->eap_workaround;
623 conf.eap_conf_ctx = &ssid->eap;
624 conf.ssid = ssid->ssid;
625 conf.ssid_len = ssid->ssid_len;
627 wpa_sm_set_config(wpa_s->wpa, ssid ? &conf : NULL);