2 * EAP peer method: EAP-AKA (RFC 4187) and EAP-AKA' (draft-arkko-eap-aka-kdf)
3 * Copyright (c) 2004-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 "eap_peer/eap_i.h"
19 #include "pcsc_funcs.h"
20 #include "eap_common/eap_sim_common.h"
24 #include "eap_peer/eap_config.h"
25 #ifdef CONFIG_USIM_SIMULATOR
26 #include "hlr_auc_gw/milenage.h"
27 #endif /* CONFIG_USIM_SIMULATOR */
31 u8 ik[EAP_AKA_IK_LEN], ck[EAP_AKA_CK_LEN], res[EAP_AKA_RES_MAX_LEN];
33 u8 nonce_s[EAP_SIM_NONCE_S_LEN];
34 u8 mk[EAP_SIM_MK_LEN];
35 u8 k_aut[EAP_AKA_PRIME_K_AUT_LEN];
36 u8 k_encr[EAP_SIM_K_ENCR_LEN];
37 u8 k_re[EAP_AKA_PRIME_K_RE_LEN]; /* EAP-AKA' only */
38 u8 msk[EAP_SIM_KEYING_DATA_LEN];
39 u8 emsk[EAP_EMSK_LEN];
40 u8 rand[EAP_AKA_RAND_LEN], autn[EAP_AKA_AUTN_LEN];
41 u8 auts[EAP_AKA_AUTS_LEN];
43 int num_id_req, num_notification;
49 unsigned int counter, counter_too_small;
50 u8 *last_eap_identity;
51 size_t last_eap_identity_len;
53 CONTINUE, RESULT_SUCCESS, RESULT_FAILURE, SUCCESS, FAILURE
56 struct wpabuf *id_msgs;
58 int result_ind, use_result_ind;
61 size_t network_name_len;
67 #ifndef CONFIG_NO_STDOUT_DEBUG
68 static const char * eap_aka_state_txt(int state)
74 return "RESULT_SUCCESS";
76 return "RESULT_FAILURE";
85 #endif /* CONFIG_NO_STDOUT_DEBUG */
88 static void eap_aka_state(struct eap_aka_data *data, int state)
90 wpa_printf(MSG_DEBUG, "EAP-AKA: %s -> %s",
91 eap_aka_state_txt(data->state),
92 eap_aka_state_txt(state));
97 static void * eap_aka_init(struct eap_sm *sm)
99 struct eap_aka_data *data;
100 const char *phase1 = eap_get_config_phase1(sm);
102 data = os_zalloc(sizeof(*data));
106 data->eap_method = EAP_TYPE_AKA;
108 eap_aka_state(data, CONTINUE);
111 data->result_ind = phase1 && os_strstr(phase1, "result_ind=1") != NULL;
118 static void * eap_aka_prime_init(struct eap_sm *sm)
120 struct eap_aka_data *data = eap_aka_init(sm);
123 data->eap_method = EAP_TYPE_AKA_PRIME;
126 #endif /* EAP_AKA_PRIME */
129 static void eap_aka_deinit(struct eap_sm *sm, void *priv)
131 struct eap_aka_data *data = priv;
133 os_free(data->pseudonym);
134 os_free(data->reauth_id);
135 os_free(data->last_eap_identity);
136 wpabuf_free(data->id_msgs);
137 os_free(data->network_name);
143 static int eap_aka_umts_auth(struct eap_sm *sm, struct eap_aka_data *data)
145 struct eap_peer_config *conf;
147 wpa_printf(MSG_DEBUG, "EAP-AKA: UMTS authentication algorithm");
149 conf = eap_get_config(sm);
153 return scard_umts_auth(sm->scard_ctx, data->rand,
154 data->autn, data->res, &data->res_len,
155 data->ik, data->ck, data->auts);
158 #ifdef CONFIG_USIM_SIMULATOR
159 if (conf->password) {
160 u8 opc[16], k[16], sqn[6];
162 wpa_printf(MSG_DEBUG, "EAP-AKA: Use internal Milenage "
163 "implementation for UMTS authentication");
164 if (conf->password_len < 78) {
165 wpa_printf(MSG_DEBUG, "EAP-AKA: invalid Milenage "
169 pos = (const char *) conf->password;
170 if (hexstr2bin(pos, k, 16))
177 if (hexstr2bin(pos, opc, 16))
184 if (hexstr2bin(pos, sqn, 6))
187 return milenage_check(opc, k, sqn, data->rand, data->autn,
189 data->res, &data->res_len, data->auts);
191 #endif /* CONFIG_USIM_SIMULATOR */
193 #ifdef CONFIG_USIM_HARDCODED
194 wpa_printf(MSG_DEBUG, "EAP-AKA: Use hardcoded Kc and SRES values for "
197 /* These hardcoded Kc and SRES values are used for testing.
198 * Could consider making them configurable. */
199 os_memset(data->res, '2', EAP_AKA_RES_MAX_LEN);
200 data->res_len = EAP_AKA_RES_MAX_LEN;
201 os_memset(data->ik, '3', EAP_AKA_IK_LEN);
202 os_memset(data->ck, '4', EAP_AKA_CK_LEN);
204 u8 autn[EAP_AKA_AUTN_LEN];
205 os_memset(autn, '1', EAP_AKA_AUTN_LEN);
206 if (os_memcmp(autn, data->autn, EAP_AKA_AUTN_LEN) != 0) {
207 wpa_printf(MSG_WARNING, "EAP-AKA: AUTN did not match "
208 "with expected value");
214 static int test_resync = 1;
216 /* Test Resynchronization */
224 #else /* CONFIG_USIM_HARDCODED */
226 wpa_printf(MSG_DEBUG, "EAP-AKA: No UMTS authentication algorith "
230 #endif /* CONFIG_USIM_HARDCODED */
234 #define CLEAR_PSEUDONYM 0x01
235 #define CLEAR_REAUTH_ID 0x02
236 #define CLEAR_EAP_ID 0x04
238 static void eap_aka_clear_identities(struct eap_aka_data *data, int id)
240 wpa_printf(MSG_DEBUG, "EAP-AKA: forgetting old%s%s%s",
241 id & CLEAR_PSEUDONYM ? " pseudonym" : "",
242 id & CLEAR_REAUTH_ID ? " reauth_id" : "",
243 id & CLEAR_EAP_ID ? " eap_id" : "");
244 if (id & CLEAR_PSEUDONYM) {
245 os_free(data->pseudonym);
246 data->pseudonym = NULL;
247 data->pseudonym_len = 0;
249 if (id & CLEAR_REAUTH_ID) {
250 os_free(data->reauth_id);
251 data->reauth_id = NULL;
252 data->reauth_id_len = 0;
254 if (id & CLEAR_EAP_ID) {
255 os_free(data->last_eap_identity);
256 data->last_eap_identity = NULL;
257 data->last_eap_identity_len = 0;
262 static int eap_aka_learn_ids(struct eap_aka_data *data,
263 struct eap_sim_attrs *attr)
265 if (attr->next_pseudonym) {
266 os_free(data->pseudonym);
267 data->pseudonym = os_malloc(attr->next_pseudonym_len);
268 if (data->pseudonym == NULL) {
269 wpa_printf(MSG_INFO, "EAP-AKA: (encr) No memory for "
273 os_memcpy(data->pseudonym, attr->next_pseudonym,
274 attr->next_pseudonym_len);
275 data->pseudonym_len = attr->next_pseudonym_len;
276 wpa_hexdump_ascii(MSG_DEBUG,
277 "EAP-AKA: (encr) AT_NEXT_PSEUDONYM",
279 data->pseudonym_len);
282 if (attr->next_reauth_id) {
283 os_free(data->reauth_id);
284 data->reauth_id = os_malloc(attr->next_reauth_id_len);
285 if (data->reauth_id == NULL) {
286 wpa_printf(MSG_INFO, "EAP-AKA: (encr) No memory for "
290 os_memcpy(data->reauth_id, attr->next_reauth_id,
291 attr->next_reauth_id_len);
292 data->reauth_id_len = attr->next_reauth_id_len;
293 wpa_hexdump_ascii(MSG_DEBUG,
294 "EAP-AKA: (encr) AT_NEXT_REAUTH_ID",
296 data->reauth_id_len);
303 static int eap_aka_add_id_msg(struct eap_aka_data *data,
304 const struct wpabuf *msg)
309 if (data->id_msgs == NULL) {
310 data->id_msgs = wpabuf_dup(msg);
311 return data->id_msgs == NULL ? -1 : 0;
314 if (wpabuf_resize(&data->id_msgs, wpabuf_len(msg)) < 0)
316 wpabuf_put_buf(data->id_msgs, msg);
322 static void eap_aka_add_checkcode(struct eap_aka_data *data,
323 struct eap_sim_msg *msg)
327 u8 hash[SHA256_MAC_LEN];
329 wpa_printf(MSG_DEBUG, " AT_CHECKCODE");
331 if (data->id_msgs == NULL) {
333 * No EAP-AKA/Identity packets were exchanged - send empty
336 eap_sim_msg_add(msg, EAP_SIM_AT_CHECKCODE, 0, NULL, 0);
340 /* Checkcode is SHA1/SHA256 hash over all EAP-AKA/Identity packets. */
341 addr = wpabuf_head(data->id_msgs);
342 len = wpabuf_len(data->id_msgs);
343 wpa_hexdump(MSG_MSGDUMP, "EAP-AKA: AT_CHECKCODE data", addr, len);
345 if (data->eap_method == EAP_TYPE_AKA_PRIME)
346 sha256_vector(1, &addr, &len, hash);
348 #endif /* EAP_AKA_PRIME */
349 sha1_vector(1, &addr, &len, hash);
351 eap_sim_msg_add(msg, EAP_SIM_AT_CHECKCODE, 0, hash,
352 data->eap_method == EAP_TYPE_AKA_PRIME ?
353 EAP_AKA_PRIME_CHECKCODE_LEN : EAP_AKA_CHECKCODE_LEN);
357 static int eap_aka_verify_checkcode(struct eap_aka_data *data,
358 const u8 *checkcode, size_t checkcode_len)
362 u8 hash[SHA256_MAC_LEN];
365 if (checkcode == NULL)
368 if (data->id_msgs == NULL) {
369 if (checkcode_len != 0) {
370 wpa_printf(MSG_DEBUG, "EAP-AKA: Checkcode from server "
371 "indicates that AKA/Identity messages were "
372 "used, but they were not");
378 hash_len = data->eap_method == EAP_TYPE_AKA_PRIME ?
379 EAP_AKA_PRIME_CHECKCODE_LEN : EAP_AKA_CHECKCODE_LEN;
381 if (checkcode_len != hash_len) {
382 wpa_printf(MSG_DEBUG, "EAP-AKA: Checkcode from server "
383 "indicates that AKA/Identity message were not "
384 "used, but they were");
388 /* Checkcode is SHA1/SHA256 hash over all EAP-AKA/Identity packets. */
389 addr = wpabuf_head(data->id_msgs);
390 len = wpabuf_len(data->id_msgs);
392 if (data->eap_method == EAP_TYPE_AKA_PRIME)
393 sha256_vector(1, &addr, &len, hash);
395 #endif /* EAP_AKA_PRIME */
396 sha1_vector(1, &addr, &len, hash);
398 if (os_memcmp(hash, checkcode, hash_len) != 0) {
399 wpa_printf(MSG_DEBUG, "EAP-AKA: Mismatch in AT_CHECKCODE");
407 static struct wpabuf * eap_aka_client_error(struct eap_aka_data *data, u8 id,
410 struct eap_sim_msg *msg;
412 eap_aka_state(data, FAILURE);
413 data->num_id_req = 0;
414 data->num_notification = 0;
416 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
417 EAP_AKA_SUBTYPE_CLIENT_ERROR);
418 eap_sim_msg_add(msg, EAP_SIM_AT_CLIENT_ERROR_CODE, err, NULL, 0);
419 return eap_sim_msg_finish(msg, NULL, NULL, 0);
423 static struct wpabuf * eap_aka_authentication_reject(struct eap_aka_data *data,
426 struct eap_sim_msg *msg;
428 eap_aka_state(data, FAILURE);
429 data->num_id_req = 0;
430 data->num_notification = 0;
432 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Authentication-Reject "
434 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
435 EAP_AKA_SUBTYPE_AUTHENTICATION_REJECT);
436 return eap_sim_msg_finish(msg, NULL, NULL, 0);
440 static struct wpabuf * eap_aka_synchronization_failure(
441 struct eap_aka_data *data, u8 id)
443 struct eap_sim_msg *msg;
445 data->num_id_req = 0;
446 data->num_notification = 0;
448 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Synchronization-Failure "
450 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
451 EAP_AKA_SUBTYPE_SYNCHRONIZATION_FAILURE);
452 wpa_printf(MSG_DEBUG, " AT_AUTS");
453 eap_sim_msg_add_full(msg, EAP_SIM_AT_AUTS, data->auts,
455 return eap_sim_msg_finish(msg, NULL, NULL, 0);
459 static struct wpabuf * eap_aka_response_identity(struct eap_sm *sm,
460 struct eap_aka_data *data,
462 enum eap_sim_id_req id_req)
464 const u8 *identity = NULL;
465 size_t identity_len = 0;
466 struct eap_sim_msg *msg;
469 if (id_req == ANY_ID && data->reauth_id) {
470 identity = data->reauth_id;
471 identity_len = data->reauth_id_len;
473 } else if ((id_req == ANY_ID || id_req == FULLAUTH_ID) &&
475 identity = data->pseudonym;
476 identity_len = data->pseudonym_len;
477 eap_aka_clear_identities(data, CLEAR_REAUTH_ID);
478 } else if (id_req != NO_ID_REQ) {
479 identity = eap_get_config_identity(sm, &identity_len);
481 eap_aka_clear_identities(data, CLEAR_PSEUDONYM |
485 if (id_req != NO_ID_REQ)
486 eap_aka_clear_identities(data, CLEAR_EAP_ID);
488 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Identity (id=%d)", id);
489 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
490 EAP_AKA_SUBTYPE_IDENTITY);
493 wpa_hexdump_ascii(MSG_DEBUG, " AT_IDENTITY",
494 identity, identity_len);
495 eap_sim_msg_add(msg, EAP_SIM_AT_IDENTITY, identity_len,
496 identity, identity_len);
499 return eap_sim_msg_finish(msg, NULL, NULL, 0);
503 static struct wpabuf * eap_aka_response_challenge(struct eap_aka_data *data,
506 struct eap_sim_msg *msg;
508 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Challenge (id=%d)", id);
509 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
510 EAP_AKA_SUBTYPE_CHALLENGE);
511 wpa_printf(MSG_DEBUG, " AT_RES");
512 eap_sim_msg_add(msg, EAP_SIM_AT_RES, data->res_len * 8,
513 data->res, data->res_len);
514 eap_aka_add_checkcode(data, msg);
515 if (data->use_result_ind) {
516 wpa_printf(MSG_DEBUG, " AT_RESULT_IND");
517 eap_sim_msg_add(msg, EAP_SIM_AT_RESULT_IND, 0, NULL, 0);
519 wpa_printf(MSG_DEBUG, " AT_MAC");
520 eap_sim_msg_add_mac(msg, EAP_SIM_AT_MAC);
521 return eap_sim_msg_finish(msg, data->k_aut, (u8 *) "", 0);
525 static struct wpabuf * eap_aka_response_reauth(struct eap_aka_data *data,
526 u8 id, int counter_too_small,
529 struct eap_sim_msg *msg;
530 unsigned int counter;
532 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Reauthentication (id=%d)",
534 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
535 EAP_AKA_SUBTYPE_REAUTHENTICATION);
536 wpa_printf(MSG_DEBUG, " AT_IV");
537 wpa_printf(MSG_DEBUG, " AT_ENCR_DATA");
538 eap_sim_msg_add_encr_start(msg, EAP_SIM_AT_IV, EAP_SIM_AT_ENCR_DATA);
540 if (counter_too_small) {
541 wpa_printf(MSG_DEBUG, " *AT_COUNTER_TOO_SMALL");
542 eap_sim_msg_add(msg, EAP_SIM_AT_COUNTER_TOO_SMALL, 0, NULL, 0);
543 counter = data->counter_too_small;
545 counter = data->counter;
547 wpa_printf(MSG_DEBUG, " *AT_COUNTER %d", counter);
548 eap_sim_msg_add(msg, EAP_SIM_AT_COUNTER, counter, NULL, 0);
550 if (eap_sim_msg_add_encr_end(msg, data->k_encr, EAP_SIM_AT_PADDING)) {
551 wpa_printf(MSG_WARNING, "EAP-AKA: Failed to encrypt "
553 eap_sim_msg_free(msg);
556 eap_aka_add_checkcode(data, msg);
557 if (data->use_result_ind) {
558 wpa_printf(MSG_DEBUG, " AT_RESULT_IND");
559 eap_sim_msg_add(msg, EAP_SIM_AT_RESULT_IND, 0, NULL, 0);
561 wpa_printf(MSG_DEBUG, " AT_MAC");
562 eap_sim_msg_add_mac(msg, EAP_SIM_AT_MAC);
563 return eap_sim_msg_finish(msg, data->k_aut, nonce_s,
564 EAP_SIM_NONCE_S_LEN);
568 static struct wpabuf * eap_aka_response_notification(struct eap_aka_data *data,
569 u8 id, u16 notification)
571 struct eap_sim_msg *msg;
572 u8 *k_aut = (notification & 0x4000) == 0 ? data->k_aut : NULL;
574 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Notification (id=%d)", id);
575 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
576 EAP_AKA_SUBTYPE_NOTIFICATION);
577 if (k_aut && data->reauth) {
578 wpa_printf(MSG_DEBUG, " AT_IV");
579 wpa_printf(MSG_DEBUG, " AT_ENCR_DATA");
580 eap_sim_msg_add_encr_start(msg, EAP_SIM_AT_IV,
581 EAP_SIM_AT_ENCR_DATA);
582 wpa_printf(MSG_DEBUG, " *AT_COUNTER %d", data->counter);
583 eap_sim_msg_add(msg, EAP_SIM_AT_COUNTER, data->counter,
585 if (eap_sim_msg_add_encr_end(msg, data->k_encr,
586 EAP_SIM_AT_PADDING)) {
587 wpa_printf(MSG_WARNING, "EAP-AKA: Failed to encrypt "
589 eap_sim_msg_free(msg);
594 wpa_printf(MSG_DEBUG, " AT_MAC");
595 eap_sim_msg_add_mac(msg, EAP_SIM_AT_MAC);
597 return eap_sim_msg_finish(msg, k_aut, (u8 *) "", 0);
601 static struct wpabuf * eap_aka_process_identity(struct eap_sm *sm,
602 struct eap_aka_data *data,
604 const struct wpabuf *reqData,
605 struct eap_sim_attrs *attr)
610 wpa_printf(MSG_DEBUG, "EAP-AKA: subtype Identity");
613 switch (attr->id_req) {
617 if (data->num_id_req > 0)
622 if (data->num_id_req > 1)
627 if (data->num_id_req > 2)
633 wpa_printf(MSG_INFO, "EAP-AKA: Too many ID requests "
634 "used within one authentication");
635 return eap_aka_client_error(data, id,
636 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
639 buf = eap_aka_response_identity(sm, data, id, attr->id_req);
641 if (data->prev_id != id) {
642 eap_aka_add_id_msg(data, reqData);
643 eap_aka_add_id_msg(data, buf);
651 static int eap_aka_verify_mac(struct eap_aka_data *data,
652 const struct wpabuf *req,
653 const u8 *mac, const u8 *extra,
656 if (data->eap_method == EAP_TYPE_AKA_PRIME)
657 return eap_sim_verify_mac_sha256(data->k_aut, req, mac, extra,
659 return eap_sim_verify_mac(data->k_aut, req, mac, extra, extra_len);
664 static struct wpabuf * eap_aka_prime_kdf_select(struct eap_aka_data *data,
667 struct eap_sim_msg *msg;
669 data->kdf_negotiation = 1;
671 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Challenge (id=%d) (KDF "
673 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
674 EAP_AKA_SUBTYPE_CHALLENGE);
675 wpa_printf(MSG_DEBUG, " AT_KDF");
676 eap_sim_msg_add(msg, EAP_SIM_AT_KDF, kdf, NULL, 0);
677 return eap_sim_msg_finish(msg, NULL, NULL, 0);
681 static struct wpabuf * eap_aka_prime_kdf_neg(struct eap_aka_data *data,
682 u8 id, struct eap_sim_attrs *attr)
686 for (i = 0; i < attr->kdf_count; i++) {
687 if (attr->kdf[i] == EAP_AKA_PRIME_KDF)
688 return eap_aka_prime_kdf_select(data, id,
692 /* No matching KDF found - fail authentication as if AUTN had been
694 return eap_aka_authentication_reject(data, id);
698 static int eap_aka_prime_kdf_valid(struct eap_aka_data *data,
699 struct eap_sim_attrs *attr)
703 if (attr->kdf_count == 0)
706 /* The only allowed (and required) duplication of a KDF is the addition
707 * of the selected KDF into the beginning of the list. */
709 if (data->kdf_negotiation) {
710 if (attr->kdf[0] != data->kdf) {
711 wpa_printf(MSG_WARNING, "EAP-AKA': The server did not "
712 "accept the selected KDF");
716 for (i = 1; i < attr->kdf_count; i++) {
717 if (attr->kdf[i] == data->kdf)
720 if (i == attr->kdf_count &&
721 attr->kdf_count < EAP_AKA_PRIME_KDF_MAX) {
722 wpa_printf(MSG_WARNING, "EAP-AKA': The server did not "
723 "duplicate the selected KDF");
727 /* TODO: should check that the list is identical to the one
728 * used in the previous Challenge message apart from the added
729 * entry in the beginning. */
732 for (i = data->kdf ? 1 : 0; i < attr->kdf_count; i++) {
733 for (j = i + 1; j < attr->kdf_count; j++) {
734 if (attr->kdf[i] == attr->kdf[j]) {
735 wpa_printf(MSG_WARNING, "EAP-AKA': The server "
736 "included a duplicated KDF");
744 #endif /* EAP_AKA_PRIME */
747 static struct wpabuf * eap_aka_process_challenge(struct eap_sm *sm,
748 struct eap_aka_data *data,
750 const struct wpabuf *reqData,
751 struct eap_sim_attrs *attr)
756 struct eap_sim_attrs eattr;
758 wpa_printf(MSG_DEBUG, "EAP-AKA: subtype Challenge");
760 if (attr->checkcode &&
761 eap_aka_verify_checkcode(data, attr->checkcode,
762 attr->checkcode_len)) {
763 wpa_printf(MSG_WARNING, "EAP-AKA: Invalid AT_CHECKCODE in the "
765 return eap_aka_client_error(data, id,
766 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
770 if (data->eap_method == EAP_TYPE_AKA_PRIME) {
771 if (!attr->kdf_input || attr->kdf_input_len == 0) {
772 wpa_printf(MSG_WARNING, "EAP-AKA': Challenge message "
773 "did not include non-empty AT_KDF_INPUT");
774 /* Fail authentication as if AUTN had been incorrect */
775 return eap_aka_authentication_reject(data, id);
777 os_free(data->network_name);
778 data->network_name = os_malloc(attr->kdf_input_len);
779 if (data->network_name == NULL) {
780 wpa_printf(MSG_WARNING, "EAP-AKA': No memory for "
781 "storing Network Name");
782 return eap_aka_authentication_reject(data, id);
784 os_memcpy(data->network_name, attr->kdf_input,
785 attr->kdf_input_len);
786 data->network_name_len = attr->kdf_input_len;
787 wpa_hexdump_ascii(MSG_DEBUG, "EAP-AKA': Network Name "
789 data->network_name, data->network_name_len);
790 /* TODO: check Network Name per 3GPP.33.402 */
792 if (!eap_aka_prime_kdf_valid(data, attr))
793 return eap_aka_authentication_reject(data, id);
795 if (attr->kdf[0] != EAP_AKA_PRIME_KDF)
796 return eap_aka_prime_kdf_neg(data, id, attr);
798 data->kdf = EAP_AKA_PRIME_KDF;
799 wpa_printf(MSG_DEBUG, "EAP-AKA': KDF %d selected", data->kdf);
802 if (data->eap_method == EAP_TYPE_AKA && attr->bidding) {
803 u16 flags = WPA_GET_BE16(attr->bidding);
804 if ((flags & EAP_AKA_BIDDING_FLAG_D) &&
805 eap_allowed_method(sm, EAP_VENDOR_IETF,
806 EAP_TYPE_AKA_PRIME)) {
807 wpa_printf(MSG_WARNING, "EAP-AKA: Bidding down from "
808 "AKA' to AKA detected");
809 /* Fail authentication as if AUTN had been incorrect */
810 return eap_aka_authentication_reject(data, id);
813 #endif /* EAP_AKA_PRIME */
816 if (!attr->mac || !attr->rand || !attr->autn) {
817 wpa_printf(MSG_WARNING, "EAP-AKA: Challenge message "
818 "did not include%s%s%s",
819 !attr->mac ? " AT_MAC" : "",
820 !attr->rand ? " AT_RAND" : "",
821 !attr->autn ? " AT_AUTN" : "");
822 return eap_aka_client_error(data, id,
823 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
825 os_memcpy(data->rand, attr->rand, EAP_AKA_RAND_LEN);
826 os_memcpy(data->autn, attr->autn, EAP_AKA_AUTN_LEN);
828 res = eap_aka_umts_auth(sm, data);
830 wpa_printf(MSG_WARNING, "EAP-AKA: UMTS authentication "
832 return eap_aka_authentication_reject(data, id);
833 } else if (res == -2) {
834 wpa_printf(MSG_WARNING, "EAP-AKA: UMTS authentication "
835 "failed (AUTN seq# -> AUTS)");
836 return eap_aka_synchronization_failure(data, id);
838 wpa_printf(MSG_WARNING, "EAP-AKA: UMTS authentication failed");
839 return eap_aka_client_error(data, id,
840 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
843 if (data->eap_method == EAP_TYPE_AKA_PRIME) {
844 /* Note: AUTN = (SQN ^ AK) || AMF || MAC which gives us the
845 * needed 6-octet SQN ^ AK for CK',IK' derivation */
846 u16 amf = WPA_GET_BE16(data->autn + 6);
847 if (!(amf & 0x8000)) {
848 wpa_printf(MSG_WARNING, "EAP-AKA': AMF separation bit "
849 "not set (AMF=0x%4x)", amf);
850 return eap_aka_authentication_reject(data, id);
852 eap_aka_prime_derive_ck_ik_prime(data->ck, data->ik,
855 data->network_name_len);
857 #endif /* EAP_AKA_PRIME */
858 if (data->last_eap_identity) {
859 identity = data->last_eap_identity;
860 identity_len = data->last_eap_identity_len;
861 } else if (data->pseudonym) {
862 identity = data->pseudonym;
863 identity_len = data->pseudonym_len;
865 identity = eap_get_config_identity(sm, &identity_len);
866 wpa_hexdump_ascii(MSG_DEBUG, "EAP-AKA: Selected identity for MK "
867 "derivation", identity, identity_len);
868 if (data->eap_method == EAP_TYPE_AKA_PRIME) {
869 eap_aka_prime_derive_keys(identity, identity_len, data->ik,
870 data->ck, data->k_encr, data->k_aut,
871 data->k_re, data->msk, data->emsk);
873 eap_aka_derive_mk(identity, identity_len, data->ik, data->ck,
875 eap_sim_derive_keys(data->mk, data->k_encr, data->k_aut,
876 data->msk, data->emsk);
878 if (eap_aka_verify_mac(data, reqData, attr->mac, (u8 *) "", 0)) {
879 wpa_printf(MSG_WARNING, "EAP-AKA: Challenge message "
880 "used invalid AT_MAC");
881 return eap_aka_client_error(data, id,
882 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
885 /* Old reauthentication and pseudonym identities must not be used
886 * anymore. In other words, if no new identities are received, full
887 * authentication will be used on next reauthentication. */
888 eap_aka_clear_identities(data, CLEAR_PSEUDONYM | CLEAR_REAUTH_ID |
891 if (attr->encr_data) {
893 decrypted = eap_sim_parse_encr(data->k_encr, attr->encr_data,
894 attr->encr_data_len, attr->iv,
896 if (decrypted == NULL) {
897 return eap_aka_client_error(
898 data, id, EAP_AKA_UNABLE_TO_PROCESS_PACKET);
900 eap_aka_learn_ids(data, &eattr);
904 if (data->result_ind && attr->result_ind)
905 data->use_result_ind = 1;
907 if (data->state != FAILURE && data->state != RESULT_FAILURE) {
908 eap_aka_state(data, data->use_result_ind ?
909 RESULT_SUCCESS : SUCCESS);
912 data->num_id_req = 0;
913 data->num_notification = 0;
914 /* RFC 4187 specifies that counter is initialized to one after
915 * fullauth, but initializing it to zero makes it easier to implement
916 * reauth verification. */
918 return eap_aka_response_challenge(data, id);
922 static int eap_aka_process_notification_reauth(struct eap_aka_data *data,
923 struct eap_sim_attrs *attr)
925 struct eap_sim_attrs eattr;
928 if (attr->encr_data == NULL || attr->iv == NULL) {
929 wpa_printf(MSG_WARNING, "EAP-AKA: Notification message after "
930 "reauth did not include encrypted data");
934 decrypted = eap_sim_parse_encr(data->k_encr, attr->encr_data,
935 attr->encr_data_len, attr->iv, &eattr,
937 if (decrypted == NULL) {
938 wpa_printf(MSG_WARNING, "EAP-AKA: Failed to parse encrypted "
939 "data from notification message");
943 if (eattr.counter < 0 || (size_t) eattr.counter != data->counter) {
944 wpa_printf(MSG_WARNING, "EAP-AKA: Counter in notification "
945 "message does not match with counter in reauth "
956 static int eap_aka_process_notification_auth(struct eap_aka_data *data,
957 const struct wpabuf *reqData,
958 struct eap_sim_attrs *attr)
960 if (attr->mac == NULL) {
961 wpa_printf(MSG_INFO, "EAP-AKA: no AT_MAC in after_auth "
962 "Notification message");
966 if (eap_aka_verify_mac(data, reqData, attr->mac, (u8 *) "", 0)) {
967 wpa_printf(MSG_WARNING, "EAP-AKA: Notification message "
968 "used invalid AT_MAC");
973 eap_aka_process_notification_reauth(data, attr)) {
974 wpa_printf(MSG_WARNING, "EAP-AKA: Invalid notification "
975 "message after reauth");
983 static struct wpabuf * eap_aka_process_notification(
984 struct eap_sm *sm, struct eap_aka_data *data, u8 id,
985 const struct wpabuf *reqData, struct eap_sim_attrs *attr)
987 wpa_printf(MSG_DEBUG, "EAP-AKA: subtype Notification");
988 if (data->num_notification > 0) {
989 wpa_printf(MSG_INFO, "EAP-AKA: too many notification "
990 "rounds (only one allowed)");
991 return eap_aka_client_error(data, id,
992 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
994 data->num_notification++;
995 if (attr->notification == -1) {
996 wpa_printf(MSG_INFO, "EAP-AKA: no AT_NOTIFICATION in "
997 "Notification message");
998 return eap_aka_client_error(data, id,
999 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1002 if ((attr->notification & 0x4000) == 0 &&
1003 eap_aka_process_notification_auth(data, reqData, attr)) {
1004 return eap_aka_client_error(data, id,
1005 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1008 eap_sim_report_notification(sm->msg_ctx, attr->notification, 1);
1009 if (attr->notification >= 0 && attr->notification < 32768) {
1010 eap_aka_state(data, FAILURE);
1011 } else if (attr->notification == EAP_SIM_SUCCESS &&
1012 data->state == RESULT_SUCCESS)
1013 eap_aka_state(data, SUCCESS);
1014 return eap_aka_response_notification(data, id, attr->notification);
1018 static struct wpabuf * eap_aka_process_reauthentication(
1019 struct eap_sm *sm, struct eap_aka_data *data, u8 id,
1020 const struct wpabuf *reqData, struct eap_sim_attrs *attr)
1022 struct eap_sim_attrs eattr;
1025 wpa_printf(MSG_DEBUG, "EAP-AKA: subtype Reauthentication");
1027 if (attr->checkcode &&
1028 eap_aka_verify_checkcode(data, attr->checkcode,
1029 attr->checkcode_len)) {
1030 wpa_printf(MSG_WARNING, "EAP-AKA: Invalid AT_CHECKCODE in the "
1032 return eap_aka_client_error(data, id,
1033 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1036 if (data->reauth_id == NULL) {
1037 wpa_printf(MSG_WARNING, "EAP-AKA: Server is trying "
1038 "reauthentication, but no reauth_id available");
1039 return eap_aka_client_error(data, id,
1040 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1044 if (eap_aka_verify_mac(data, reqData, attr->mac, (u8 *) "", 0)) {
1045 wpa_printf(MSG_WARNING, "EAP-AKA: Reauthentication "
1046 "did not have valid AT_MAC");
1047 return eap_aka_client_error(data, id,
1048 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1051 if (attr->encr_data == NULL || attr->iv == NULL) {
1052 wpa_printf(MSG_WARNING, "EAP-AKA: Reauthentication "
1053 "message did not include encrypted data");
1054 return eap_aka_client_error(data, id,
1055 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1058 decrypted = eap_sim_parse_encr(data->k_encr, attr->encr_data,
1059 attr->encr_data_len, attr->iv, &eattr,
1061 if (decrypted == NULL) {
1062 wpa_printf(MSG_WARNING, "EAP-AKA: Failed to parse encrypted "
1063 "data from reauthentication message");
1064 return eap_aka_client_error(data, id,
1065 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1068 if (eattr.nonce_s == NULL || eattr.counter < 0) {
1069 wpa_printf(MSG_INFO, "EAP-AKA: (encr) No%s%s in reauth packet",
1070 !eattr.nonce_s ? " AT_NONCE_S" : "",
1071 eattr.counter < 0 ? " AT_COUNTER" : "");
1073 return eap_aka_client_error(data, id,
1074 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1077 if (eattr.counter < 0 || (size_t) eattr.counter <= data->counter) {
1079 wpa_printf(MSG_INFO, "EAP-AKA: (encr) Invalid counter "
1080 "(%d <= %d)", eattr.counter, data->counter);
1081 data->counter_too_small = eattr.counter;
1083 /* Reply using Re-auth w/ AT_COUNTER_TOO_SMALL. The current
1084 * reauth_id must not be used to start a new reauthentication.
1085 * However, since it was used in the last EAP-Response-Identity
1086 * packet, it has to saved for the following fullauth to be
1087 * used in MK derivation. */
1088 os_free(data->last_eap_identity);
1089 data->last_eap_identity = data->reauth_id;
1090 data->last_eap_identity_len = data->reauth_id_len;
1091 data->reauth_id = NULL;
1092 data->reauth_id_len = 0;
1094 res = eap_aka_response_reauth(data, id, 1, eattr.nonce_s);
1099 data->counter = eattr.counter;
1101 os_memcpy(data->nonce_s, eattr.nonce_s, EAP_SIM_NONCE_S_LEN);
1102 wpa_hexdump(MSG_DEBUG, "EAP-AKA: (encr) AT_NONCE_S",
1103 data->nonce_s, EAP_SIM_NONCE_S_LEN);
1105 if (data->eap_method == EAP_TYPE_AKA_PRIME) {
1106 eap_aka_prime_derive_keys_reauth(data->k_re, data->counter,
1108 data->reauth_id_len,
1110 data->msk, data->emsk);
1112 eap_sim_derive_keys_reauth(data->counter, data->reauth_id,
1113 data->reauth_id_len,
1114 data->nonce_s, data->mk,
1115 data->msk, data->emsk);
1117 eap_aka_clear_identities(data, CLEAR_REAUTH_ID | CLEAR_EAP_ID);
1118 eap_aka_learn_ids(data, &eattr);
1120 if (data->result_ind && attr->result_ind)
1121 data->use_result_ind = 1;
1123 if (data->state != FAILURE && data->state != RESULT_FAILURE) {
1124 eap_aka_state(data, data->use_result_ind ?
1125 RESULT_SUCCESS : SUCCESS);
1128 data->num_id_req = 0;
1129 data->num_notification = 0;
1130 if (data->counter > EAP_AKA_MAX_FAST_REAUTHS) {
1131 wpa_printf(MSG_DEBUG, "EAP-AKA: Maximum number of "
1132 "fast reauths performed - force fullauth");
1133 eap_aka_clear_identities(data, CLEAR_REAUTH_ID | CLEAR_EAP_ID);
1136 return eap_aka_response_reauth(data, id, 0, data->nonce_s);
1140 static struct wpabuf * eap_aka_process(struct eap_sm *sm, void *priv,
1141 struct eap_method_ret *ret,
1142 const struct wpabuf *reqData)
1144 struct eap_aka_data *data = priv;
1145 const struct eap_hdr *req;
1149 struct eap_sim_attrs attr;
1152 wpa_hexdump_buf(MSG_DEBUG, "EAP-AKA: EAP data", reqData);
1153 if (eap_get_config_identity(sm, &len) == NULL) {
1154 wpa_printf(MSG_INFO, "EAP-AKA: Identity not configured");
1155 eap_sm_request_identity(sm);
1160 pos = eap_hdr_validate(EAP_VENDOR_IETF, data->eap_method, reqData,
1162 if (pos == NULL || len < 1) {
1166 req = wpabuf_head(reqData);
1167 id = req->identifier;
1168 len = be_to_host16(req->length);
1170 ret->ignore = FALSE;
1171 ret->methodState = METHOD_MAY_CONT;
1172 ret->decision = DECISION_FAIL;
1173 ret->allowNotifications = TRUE;
1176 wpa_printf(MSG_DEBUG, "EAP-AKA: Subtype=%d", subtype);
1177 pos += 2; /* Reserved */
1179 if (eap_sim_parse_attr(pos, wpabuf_head_u8(reqData) + len, &attr,
1180 data->eap_method == EAP_TYPE_AKA_PRIME ? 2 : 1,
1182 res = eap_aka_client_error(data, id,
1183 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1188 case EAP_AKA_SUBTYPE_IDENTITY:
1189 res = eap_aka_process_identity(sm, data, id, reqData, &attr);
1191 case EAP_AKA_SUBTYPE_CHALLENGE:
1192 res = eap_aka_process_challenge(sm, data, id, reqData, &attr);
1194 case EAP_AKA_SUBTYPE_NOTIFICATION:
1195 res = eap_aka_process_notification(sm, data, id, reqData,
1198 case EAP_AKA_SUBTYPE_REAUTHENTICATION:
1199 res = eap_aka_process_reauthentication(sm, data, id, reqData,
1202 case EAP_AKA_SUBTYPE_CLIENT_ERROR:
1203 wpa_printf(MSG_DEBUG, "EAP-AKA: subtype Client-Error");
1204 res = eap_aka_client_error(data, id,
1205 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1208 wpa_printf(MSG_DEBUG, "EAP-AKA: Unknown subtype=%d", subtype);
1209 res = eap_aka_client_error(data, id,
1210 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1215 if (data->state == FAILURE) {
1216 ret->decision = DECISION_FAIL;
1217 ret->methodState = METHOD_DONE;
1218 } else if (data->state == SUCCESS) {
1219 ret->decision = data->use_result_ind ?
1220 DECISION_UNCOND_SUCC : DECISION_COND_SUCC;
1222 * It is possible for the server to reply with AKA
1223 * Notification, so we must allow the method to continue and
1224 * not only accept EAP-Success at this point.
1226 ret->methodState = data->use_result_ind ?
1227 METHOD_DONE : METHOD_MAY_CONT;
1228 } else if (data->state == RESULT_FAILURE)
1229 ret->methodState = METHOD_CONT;
1230 else if (data->state == RESULT_SUCCESS)
1231 ret->methodState = METHOD_CONT;
1233 if (ret->methodState == METHOD_DONE) {
1234 ret->allowNotifications = FALSE;
1241 static Boolean eap_aka_has_reauth_data(struct eap_sm *sm, void *priv)
1243 struct eap_aka_data *data = priv;
1244 return data->pseudonym || data->reauth_id;
1248 static void eap_aka_deinit_for_reauth(struct eap_sm *sm, void *priv)
1250 struct eap_aka_data *data = priv;
1251 eap_aka_clear_identities(data, CLEAR_EAP_ID);
1253 wpabuf_free(data->id_msgs);
1254 data->id_msgs = NULL;
1255 data->use_result_ind = 0;
1256 data->kdf_negotiation = 0;
1260 static void * eap_aka_init_for_reauth(struct eap_sm *sm, void *priv)
1262 struct eap_aka_data *data = priv;
1263 data->num_id_req = 0;
1264 data->num_notification = 0;
1265 eap_aka_state(data, CONTINUE);
1270 static const u8 * eap_aka_get_identity(struct eap_sm *sm, void *priv,
1273 struct eap_aka_data *data = priv;
1275 if (data->reauth_id) {
1276 *len = data->reauth_id_len;
1277 return data->reauth_id;
1280 if (data->pseudonym) {
1281 *len = data->pseudonym_len;
1282 return data->pseudonym;
1289 static Boolean eap_aka_isKeyAvailable(struct eap_sm *sm, void *priv)
1291 struct eap_aka_data *data = priv;
1292 return data->state == SUCCESS;
1296 static u8 * eap_aka_getKey(struct eap_sm *sm, void *priv, size_t *len)
1298 struct eap_aka_data *data = priv;
1301 if (data->state != SUCCESS)
1304 key = os_malloc(EAP_SIM_KEYING_DATA_LEN);
1308 *len = EAP_SIM_KEYING_DATA_LEN;
1309 os_memcpy(key, data->msk, EAP_SIM_KEYING_DATA_LEN);
1315 static u8 * eap_aka_get_emsk(struct eap_sm *sm, void *priv, size_t *len)
1317 struct eap_aka_data *data = priv;
1320 if (data->state != SUCCESS)
1323 key = os_malloc(EAP_EMSK_LEN);
1327 *len = EAP_EMSK_LEN;
1328 os_memcpy(key, data->emsk, EAP_EMSK_LEN);
1334 int eap_peer_aka_register(void)
1336 struct eap_method *eap;
1339 eap = eap_peer_method_alloc(EAP_PEER_METHOD_INTERFACE_VERSION,
1340 EAP_VENDOR_IETF, EAP_TYPE_AKA, "AKA");
1344 eap->init = eap_aka_init;
1345 eap->deinit = eap_aka_deinit;
1346 eap->process = eap_aka_process;
1347 eap->isKeyAvailable = eap_aka_isKeyAvailable;
1348 eap->getKey = eap_aka_getKey;
1349 eap->has_reauth_data = eap_aka_has_reauth_data;
1350 eap->deinit_for_reauth = eap_aka_deinit_for_reauth;
1351 eap->init_for_reauth = eap_aka_init_for_reauth;
1352 eap->get_identity = eap_aka_get_identity;
1353 eap->get_emsk = eap_aka_get_emsk;
1355 ret = eap_peer_method_register(eap);
1357 eap_peer_method_free(eap);
1362 #ifdef EAP_AKA_PRIME
1363 int eap_peer_aka_prime_register(void)
1365 struct eap_method *eap;
1368 eap = eap_peer_method_alloc(EAP_PEER_METHOD_INTERFACE_VERSION,
1369 EAP_VENDOR_IETF, EAP_TYPE_AKA_PRIME,
1374 eap->init = eap_aka_prime_init;
1375 eap->deinit = eap_aka_deinit;
1376 eap->process = eap_aka_process;
1377 eap->isKeyAvailable = eap_aka_isKeyAvailable;
1378 eap->getKey = eap_aka_getKey;
1379 eap->has_reauth_data = eap_aka_has_reauth_data;
1380 eap->deinit_for_reauth = eap_aka_deinit_for_reauth;
1381 eap->init_for_reauth = eap_aka_init_for_reauth;
1382 eap->get_identity = eap_aka_get_identity;
1383 eap->get_emsk = eap_aka_get_emsk;
1385 ret = eap_peer_method_register(eap);
1387 eap_peer_method_free(eap);
1391 #endif /* EAP_AKA_PRIME */