2 * RSN pre-authentication (supplicant)
3 * Copyright (c) 2003-2015, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
14 #include "l2_packet/l2_packet.h"
15 #include "eapol_supp/eapol_supp_sm.h"
17 #include "pmksa_cache.h"
21 #ifdef IEEE8021X_EAPOL
23 #define PMKID_CANDIDATE_PRIO_SCAN 1000
26 struct rsn_pmksa_candidate {
34 * pmksa_candidate_free - Free all entries in PMKSA candidate list
35 * @sm: Pointer to WPA state machine data from wpa_sm_init()
37 void pmksa_candidate_free(struct wpa_sm *sm)
39 struct rsn_pmksa_candidate *entry, *n;
44 dl_list_for_each_safe(entry, n, &sm->pmksa_candidates,
45 struct rsn_pmksa_candidate, list) {
46 dl_list_del(&entry->list);
52 static void rsn_preauth_receive(void *ctx, const u8 *src_addr,
53 const u8 *buf, size_t len)
55 struct wpa_sm *sm = ctx;
57 wpa_printf(MSG_DEBUG, "RX pre-auth from " MACSTR, MAC2STR(src_addr));
58 wpa_hexdump(MSG_MSGDUMP, "RX pre-auth", buf, len);
60 if (sm->preauth_eapol == NULL ||
61 is_zero_ether_addr(sm->preauth_bssid) ||
62 os_memcmp(sm->preauth_bssid, src_addr, ETH_ALEN) != 0) {
63 wpa_printf(MSG_WARNING, "RSN pre-auth frame received from "
64 "unexpected source " MACSTR " - dropped",
69 eapol_sm_rx_eapol(sm->preauth_eapol, src_addr, buf, len);
73 static void rsn_preauth_eapol_cb(struct eapol_sm *eapol,
74 enum eapol_supp_result result,
77 struct wpa_sm *sm = ctx;
80 if (result == EAPOL_SUPP_RESULT_SUCCESS) {
83 res = eapol_sm_get_key(eapol, pmk, PMK_LEN);
86 * EAP-LEAP is an exception from other EAP methods: it
87 * uses only 16-byte PMK.
89 res = eapol_sm_get_key(eapol, pmk, 16);
93 wpa_hexdump_key(MSG_DEBUG, "RSN: PMK from pre-auth",
95 sm->pmk_len = pmk_len;
96 pmksa_cache_add(sm->pmksa, pmk, pmk_len,
98 sm->preauth_bssid, sm->own_addr,
100 WPA_KEY_MGMT_IEEE8021X);
102 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
103 "RSN: failed to get master session key from "
104 "pre-auth EAPOL state machines");
105 result = EAPOL_SUPP_RESULT_FAILURE;
109 wpa_msg(sm->ctx->msg_ctx, MSG_INFO, "RSN: pre-authentication with "
110 MACSTR " %s", MAC2STR(sm->preauth_bssid),
111 result == EAPOL_SUPP_RESULT_SUCCESS ? "completed successfully" :
114 rsn_preauth_deinit(sm);
115 rsn_preauth_candidate_process(sm);
119 static void rsn_preauth_timeout(void *eloop_ctx, void *timeout_ctx)
121 struct wpa_sm *sm = eloop_ctx;
123 wpa_msg(sm->ctx->msg_ctx, MSG_INFO, "RSN: pre-authentication with "
124 MACSTR " timed out", MAC2STR(sm->preauth_bssid));
125 rsn_preauth_deinit(sm);
126 rsn_preauth_candidate_process(sm);
130 static int rsn_preauth_eapol_send(void *ctx, int type, const u8 *buf,
133 struct wpa_sm *sm = ctx;
138 /* TODO: could add l2_packet_sendmsg that allows fragments to avoid
141 if (sm->l2_preauth == NULL)
144 msg = wpa_sm_alloc_eapol(sm, type, buf, len, &msglen, NULL);
148 wpa_hexdump(MSG_MSGDUMP, "TX EAPOL (preauth)", msg, msglen);
149 res = l2_packet_send(sm->l2_preauth, sm->preauth_bssid,
150 ETH_P_RSN_PREAUTH, msg, msglen);
157 * rsn_preauth_init - Start new RSN pre-authentication
158 * @sm: Pointer to WPA state machine data from wpa_sm_init()
159 * @dst: Authenticator address (BSSID) with which to preauthenticate
160 * @eap_conf: Current EAP configuration
161 * Returns: 0 on success, -1 on another pre-authentication is in progress,
162 * -2 on layer 2 packet initialization failure, -3 on EAPOL state machine
163 * initialization failure, -4 on memory allocation failure
165 * This function request an RSN pre-authentication with a given destination
166 * address. This is usually called for PMKSA candidates found from scan results
167 * or from driver reports. In addition, ctrl_iface PREAUTH command can trigger
168 * pre-authentication.
170 int rsn_preauth_init(struct wpa_sm *sm, const u8 *dst,
171 struct eap_peer_config *eap_conf)
173 struct eapol_config eapol_conf;
174 struct eapol_ctx *ctx;
177 if (sm->preauth_eapol)
180 wpa_msg(sm->ctx->msg_ctx, MSG_DEBUG,
181 "RSN: starting pre-authentication with " MACSTR, MAC2STR(dst));
183 sm->l2_preauth = l2_packet_init(sm->ifname, sm->own_addr,
185 rsn_preauth_receive, sm, 0);
186 if (sm->l2_preauth == NULL) {
187 wpa_printf(MSG_WARNING, "RSN: Failed to initialize L2 packet "
188 "processing for pre-authentication");
192 if (sm->bridge_ifname) {
193 sm->l2_preauth_br = l2_packet_init(sm->bridge_ifname,
196 rsn_preauth_receive, sm, 0);
197 if (sm->l2_preauth_br == NULL) {
198 wpa_printf(MSG_WARNING, "RSN: Failed to initialize L2 "
199 "packet processing (bridge) for "
200 "pre-authentication");
206 ctx = os_zalloc(sizeof(*ctx));
208 wpa_printf(MSG_WARNING, "Failed to allocate EAPOL context.");
212 ctx->ctx = sm->ctx->ctx;
213 ctx->msg_ctx = sm->ctx->ctx;
215 ctx->cb = rsn_preauth_eapol_cb;
217 ctx->scard_ctx = sm->scard_ctx;
218 ctx->eapol_send = rsn_preauth_eapol_send;
219 ctx->eapol_send_ctx = sm;
220 ctx->set_config_blob = sm->ctx->set_config_blob;
221 ctx->get_config_blob = sm->ctx->get_config_blob;
223 sm->preauth_eapol = eapol_sm_init(ctx);
224 if (sm->preauth_eapol == NULL) {
226 wpa_printf(MSG_WARNING, "RSN: Failed to initialize EAPOL "
227 "state machines for pre-authentication");
231 os_memset(&eapol_conf, 0, sizeof(eapol_conf));
232 eapol_conf.accept_802_1x_keys = 0;
233 eapol_conf.required_keys = 0;
234 eapol_conf.fast_reauth = sm->fast_reauth;
235 eapol_conf.workaround = sm->eap_workaround;
236 eapol_sm_notify_config(sm->preauth_eapol, eap_conf, &eapol_conf);
238 * Use a shorter startPeriod with preauthentication since the first
239 * preauth EAPOL-Start frame may end up being dropped due to race
240 * condition in the AP between the data receive and key configuration
241 * after the 4-Way Handshake.
243 eapol_sm_configure(sm->preauth_eapol, -1, -1, 5, 6);
244 os_memcpy(sm->preauth_bssid, dst, ETH_ALEN);
246 eapol_sm_notify_portValid(sm->preauth_eapol, TRUE);
247 /* 802.1X::portControl = Auto */
248 eapol_sm_notify_portEnabled(sm->preauth_eapol, TRUE);
250 eloop_register_timeout(sm->dot11RSNAConfigSATimeout, 0,
251 rsn_preauth_timeout, sm, NULL);
256 if (sm->l2_preauth_br) {
257 l2_packet_deinit(sm->l2_preauth_br);
258 sm->l2_preauth_br = NULL;
260 l2_packet_deinit(sm->l2_preauth);
261 sm->l2_preauth = NULL;
267 * rsn_preauth_deinit - Abort RSN pre-authentication
268 * @sm: Pointer to WPA state machine data from wpa_sm_init()
270 * This function aborts the current RSN pre-authentication (if one is started)
271 * and frees resources allocated for it.
273 void rsn_preauth_deinit(struct wpa_sm *sm)
275 if (sm == NULL || !sm->preauth_eapol)
278 eloop_cancel_timeout(rsn_preauth_timeout, sm, NULL);
279 eapol_sm_deinit(sm->preauth_eapol);
280 sm->preauth_eapol = NULL;
281 os_memset(sm->preauth_bssid, 0, ETH_ALEN);
283 l2_packet_deinit(sm->l2_preauth);
284 sm->l2_preauth = NULL;
285 if (sm->l2_preauth_br) {
286 l2_packet_deinit(sm->l2_preauth_br);
287 sm->l2_preauth_br = NULL;
293 * rsn_preauth_candidate_process - Process PMKSA candidates
294 * @sm: Pointer to WPA state machine data from wpa_sm_init()
296 * Go through the PMKSA candidates and start pre-authentication if a candidate
297 * without an existing PMKSA cache entry is found. Processed candidates will be
298 * removed from the list.
300 void rsn_preauth_candidate_process(struct wpa_sm *sm)
302 struct rsn_pmksa_candidate *candidate, *n;
304 if (dl_list_empty(&sm->pmksa_candidates))
307 /* TODO: drop priority for old candidate entries */
309 wpa_msg(sm->ctx->msg_ctx, MSG_DEBUG, "RSN: processing PMKSA candidate "
311 if (sm->preauth_eapol ||
312 sm->proto != WPA_PROTO_RSN ||
313 wpa_sm_get_state(sm) != WPA_COMPLETED ||
314 (sm->key_mgmt != WPA_KEY_MGMT_IEEE8021X &&
315 sm->key_mgmt != WPA_KEY_MGMT_IEEE8021X_SHA256 &&
316 sm->key_mgmt != WPA_KEY_MGMT_IEEE8021X_SUITE_B &&
317 sm->key_mgmt != WPA_KEY_MGMT_IEEE8021X_SUITE_B_192)) {
318 wpa_msg(sm->ctx->msg_ctx, MSG_DEBUG, "RSN: not in suitable "
319 "state for new pre-authentication");
320 return; /* invalid state for new pre-auth */
323 dl_list_for_each_safe(candidate, n, &sm->pmksa_candidates,
324 struct rsn_pmksa_candidate, list) {
325 struct rsn_pmksa_cache_entry *p = NULL;
326 p = pmksa_cache_get(sm->pmksa, candidate->bssid, NULL, NULL);
327 if (os_memcmp(sm->bssid, candidate->bssid, ETH_ALEN) != 0 &&
328 (p == NULL || p->opportunistic)) {
329 wpa_msg(sm->ctx->msg_ctx, MSG_DEBUG, "RSN: PMKSA "
331 " selected for pre-authentication",
332 MAC2STR(candidate->bssid));
333 dl_list_del(&candidate->list);
334 rsn_preauth_init(sm, candidate->bssid,
339 wpa_msg(sm->ctx->msg_ctx, MSG_DEBUG, "RSN: PMKSA candidate "
340 MACSTR " does not need pre-authentication anymore",
341 MAC2STR(candidate->bssid));
342 /* Some drivers (e.g., NDIS) expect to get notified about the
343 * PMKIDs again, so report the existing data now. */
345 wpa_sm_add_pmkid(sm, candidate->bssid, p->pmkid);
348 dl_list_del(&candidate->list);
351 wpa_msg(sm->ctx->msg_ctx, MSG_DEBUG, "RSN: no more pending PMKSA "
357 * pmksa_candidate_add - Add a new PMKSA candidate
358 * @sm: Pointer to WPA state machine data from wpa_sm_init()
359 * @bssid: BSSID (authenticator address) of the candidate
360 * @prio: Priority (the smaller number, the higher priority)
361 * @preauth: Whether the candidate AP advertises support for pre-authentication
363 * This function is used to add PMKSA candidates for RSN pre-authentication. It
364 * is called from scan result processing and from driver events for PMKSA
365 * candidates, i.e., EVENT_PMKID_CANDIDATE events to wpa_supplicant_event().
367 void pmksa_candidate_add(struct wpa_sm *sm, const u8 *bssid,
368 int prio, int preauth)
370 struct rsn_pmksa_candidate *cand, *pos;
372 if (sm->network_ctx && sm->proactive_key_caching)
373 pmksa_cache_get_opportunistic(sm->pmksa, sm->network_ctx,
377 wpa_printf(MSG_DEBUG, "RSN: Ignored PMKID candidate without "
382 /* If BSSID already on candidate list, update the priority of the old
383 * entry. Do not override priority based on normal scan results. */
385 dl_list_for_each(pos, &sm->pmksa_candidates,
386 struct rsn_pmksa_candidate, list) {
387 if (os_memcmp(pos->bssid, bssid, ETH_ALEN) == 0) {
394 dl_list_del(&cand->list);
395 if (prio < PMKID_CANDIDATE_PRIO_SCAN)
396 cand->priority = prio;
398 cand = os_zalloc(sizeof(*cand));
401 os_memcpy(cand->bssid, bssid, ETH_ALEN);
402 cand->priority = prio;
405 /* Add candidate to the list; order by increasing priority value. i.e.,
406 * highest priority (smallest value) first. */
407 dl_list_for_each(pos, &sm->pmksa_candidates,
408 struct rsn_pmksa_candidate, list) {
409 if (cand->priority <= pos->priority) {
410 if (!pos->list.prev) {
412 * This cannot really happen in pracrice since
413 * pos was fetched from the list and the prev
414 * pointer must be set. It looks like clang
415 * static analyzer gets confused with the
416 * dl_list_del(&cand->list) call above and ends
417 * up assuming pos->list.prev could be NULL.
422 dl_list_add(pos->list.prev, &cand->list);
428 dl_list_add_tail(&sm->pmksa_candidates, &cand->list);
430 wpa_msg(sm->ctx->msg_ctx, MSG_DEBUG, "RSN: added PMKSA cache "
431 "candidate " MACSTR " prio %d", MAC2STR(bssid), prio);
432 rsn_preauth_candidate_process(sm);
436 /* TODO: schedule periodic scans if current AP supports preauth */
439 * rsn_preauth_scan_results - Start processing scan results for canditates
440 * @sm: Pointer to WPA state machine data from wpa_sm_init()
441 * Returns: 0 if ready to process results or -1 to skip processing
443 * This functions is used to notify RSN code about start of new scan results
444 * processing. The actual scan results will be provided by calling
445 * rsn_preauth_scan_result() for each BSS if this function returned 0.
447 int rsn_preauth_scan_results(struct wpa_sm *sm)
449 if (sm->ssid_len == 0)
453 * TODO: is it ok to free all candidates? What about the entries
454 * received from EVENT_PMKID_CANDIDATE?
456 pmksa_candidate_free(sm);
463 * rsn_preauth_scan_result - Processing scan result for PMKSA canditates
464 * @sm: Pointer to WPA state machine data from wpa_sm_init()
466 * Add all suitable APs (Authenticators) from scan results into PMKSA
469 void rsn_preauth_scan_result(struct wpa_sm *sm, const u8 *bssid,
470 const u8 *ssid, const u8 *rsn)
472 struct wpa_ie_data ie;
473 struct rsn_pmksa_cache_entry *pmksa;
475 if (ssid[1] != sm->ssid_len ||
476 os_memcmp(ssid + 2, sm->ssid, sm->ssid_len) != 0)
477 return; /* Not for the current SSID */
479 if (os_memcmp(bssid, sm->bssid, ETH_ALEN) == 0)
480 return; /* Ignore current AP */
482 if (wpa_parse_wpa_ie(rsn, 2 + rsn[1], &ie))
485 pmksa = pmksa_cache_get(sm->pmksa, bssid, NULL, NULL);
486 if (pmksa && (!pmksa->opportunistic ||
487 !(ie.capabilities & WPA_CAPABILITY_PREAUTH)))
490 /* Give less priority to candidates found from normal scan results. */
491 pmksa_candidate_add(sm, bssid, PMKID_CANDIDATE_PRIO_SCAN,
492 ie.capabilities & WPA_CAPABILITY_PREAUTH);
496 #ifdef CONFIG_CTRL_IFACE
498 * rsn_preauth_get_status - Get pre-authentication status
499 * @sm: Pointer to WPA state machine data from wpa_sm_init()
500 * @buf: Buffer for status information
501 * @buflen: Maximum buffer length
502 * @verbose: Whether to include verbose status information
503 * Returns: Number of bytes written to buf.
505 * Query WPA2 pre-authentication for status information. This function fills in
506 * a text area with current status information. If the buffer (buf) is not
507 * large enough, status information will be truncated to fit the buffer.
509 int rsn_preauth_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
512 char *pos = buf, *end = buf + buflen;
515 if (sm->preauth_eapol) {
516 ret = os_snprintf(pos, end - pos, "Pre-authentication "
517 "EAPOL state machines:\n");
518 if (os_snprintf_error(end - pos, ret))
521 res = eapol_sm_get_status(sm->preauth_eapol,
522 pos, end - pos, verbose);
529 #endif /* CONFIG_CTRL_IFACE */
533 * rsn_preauth_in_progress - Verify whether pre-authentication is in progress
534 * @sm: Pointer to WPA state machine data from wpa_sm_init()
536 int rsn_preauth_in_progress(struct wpa_sm *sm)
538 return sm->preauth_eapol != NULL;
541 #endif /* IEEE8021X_EAPOL */