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;
66 #ifndef CONFIG_NO_STDOUT_DEBUG
67 static const char * eap_aka_state_txt(int state)
73 return "RESULT_SUCCESS";
75 return "RESULT_FAILURE";
84 #endif /* CONFIG_NO_STDOUT_DEBUG */
87 static void eap_aka_state(struct eap_aka_data *data, int state)
89 wpa_printf(MSG_DEBUG, "EAP-AKA: %s -> %s",
90 eap_aka_state_txt(data->state),
91 eap_aka_state_txt(state));
96 static void * eap_aka_init(struct eap_sm *sm)
98 struct eap_aka_data *data;
99 const char *phase1 = eap_get_config_phase1(sm);
101 data = os_zalloc(sizeof(*data));
105 data->eap_method = EAP_TYPE_AKA;
107 eap_aka_state(data, CONTINUE);
110 data->result_ind = phase1 && os_strstr(phase1, "result_ind=1") != NULL;
117 static void * eap_aka_prime_init(struct eap_sm *sm)
119 struct eap_aka_data *data = eap_aka_init(sm);
122 data->eap_method = EAP_TYPE_AKA_PRIME;
125 #endif /* EAP_AKA_PRIME */
128 static void eap_aka_deinit(struct eap_sm *sm, void *priv)
130 struct eap_aka_data *data = priv;
132 os_free(data->pseudonym);
133 os_free(data->reauth_id);
134 os_free(data->last_eap_identity);
135 wpabuf_free(data->id_msgs);
136 os_free(data->network_name);
142 static int eap_aka_umts_auth(struct eap_sm *sm, struct eap_aka_data *data)
144 struct eap_peer_config *conf;
146 wpa_printf(MSG_DEBUG, "EAP-AKA: UMTS authentication algorithm");
148 conf = eap_get_config(sm);
152 return scard_umts_auth(sm->scard_ctx, data->rand,
153 data->autn, data->res, &data->res_len,
154 data->ik, data->ck, data->auts);
157 #ifdef CONFIG_USIM_SIMULATOR
158 if (conf->password) {
159 u8 opc[16], k[16], sqn[6];
161 wpa_printf(MSG_DEBUG, "EAP-AKA: Use internal Milenage "
162 "implementation for UMTS authentication");
163 if (conf->password_len < 78) {
164 wpa_printf(MSG_DEBUG, "EAP-AKA: invalid Milenage "
168 pos = (const char *) conf->password;
169 if (hexstr2bin(pos, k, 16))
176 if (hexstr2bin(pos, opc, 16))
183 if (hexstr2bin(pos, sqn, 6))
186 return milenage_check(opc, k, sqn, data->rand, data->autn,
188 data->res, &data->res_len, data->auts);
190 #endif /* CONFIG_USIM_SIMULATOR */
192 #ifdef CONFIG_USIM_HARDCODED
193 wpa_printf(MSG_DEBUG, "EAP-AKA: Use hardcoded Kc and SRES values for "
196 /* These hardcoded Kc and SRES values are used for testing.
197 * Could consider making them configurable. */
198 os_memset(data->res, '2', EAP_AKA_RES_MAX_LEN);
199 data->res_len = EAP_AKA_RES_MAX_LEN;
200 os_memset(data->ik, '3', EAP_AKA_IK_LEN);
201 os_memset(data->ck, '4', EAP_AKA_CK_LEN);
203 u8 autn[EAP_AKA_AUTN_LEN];
204 os_memset(autn, '1', EAP_AKA_AUTN_LEN);
205 if (os_memcmp(autn, data->autn, EAP_AKA_AUTN_LEN) != 0) {
206 wpa_printf(MSG_WARNING, "EAP-AKA: AUTN did not match "
207 "with expected value");
213 static int test_resync = 1;
215 /* Test Resynchronization */
223 #else /* CONFIG_USIM_HARDCODED */
225 wpa_printf(MSG_DEBUG, "EAP-AKA: No UMTS authentication algorith "
229 #endif /* CONFIG_USIM_HARDCODED */
233 #define CLEAR_PSEUDONYM 0x01
234 #define CLEAR_REAUTH_ID 0x02
235 #define CLEAR_EAP_ID 0x04
237 static void eap_aka_clear_identities(struct eap_aka_data *data, int id)
239 wpa_printf(MSG_DEBUG, "EAP-AKA: forgetting old%s%s%s",
240 id & CLEAR_PSEUDONYM ? " pseudonym" : "",
241 id & CLEAR_REAUTH_ID ? " reauth_id" : "",
242 id & CLEAR_EAP_ID ? " eap_id" : "");
243 if (id & CLEAR_PSEUDONYM) {
244 os_free(data->pseudonym);
245 data->pseudonym = NULL;
246 data->pseudonym_len = 0;
248 if (id & CLEAR_REAUTH_ID) {
249 os_free(data->reauth_id);
250 data->reauth_id = NULL;
251 data->reauth_id_len = 0;
253 if (id & CLEAR_EAP_ID) {
254 os_free(data->last_eap_identity);
255 data->last_eap_identity = NULL;
256 data->last_eap_identity_len = 0;
261 static int eap_aka_learn_ids(struct eap_aka_data *data,
262 struct eap_sim_attrs *attr)
264 if (attr->next_pseudonym) {
265 os_free(data->pseudonym);
266 data->pseudonym = os_malloc(attr->next_pseudonym_len);
267 if (data->pseudonym == NULL) {
268 wpa_printf(MSG_INFO, "EAP-AKA: (encr) No memory for "
272 os_memcpy(data->pseudonym, attr->next_pseudonym,
273 attr->next_pseudonym_len);
274 data->pseudonym_len = attr->next_pseudonym_len;
275 wpa_hexdump_ascii(MSG_DEBUG,
276 "EAP-AKA: (encr) AT_NEXT_PSEUDONYM",
278 data->pseudonym_len);
281 if (attr->next_reauth_id) {
282 os_free(data->reauth_id);
283 data->reauth_id = os_malloc(attr->next_reauth_id_len);
284 if (data->reauth_id == NULL) {
285 wpa_printf(MSG_INFO, "EAP-AKA: (encr) No memory for "
289 os_memcpy(data->reauth_id, attr->next_reauth_id,
290 attr->next_reauth_id_len);
291 data->reauth_id_len = attr->next_reauth_id_len;
292 wpa_hexdump_ascii(MSG_DEBUG,
293 "EAP-AKA: (encr) AT_NEXT_REAUTH_ID",
295 data->reauth_id_len);
302 static int eap_aka_add_id_msg(struct eap_aka_data *data,
303 const struct wpabuf *msg)
308 if (data->id_msgs == NULL) {
309 data->id_msgs = wpabuf_dup(msg);
310 return data->id_msgs == NULL ? -1 : 0;
313 if (wpabuf_resize(&data->id_msgs, wpabuf_len(msg)) < 0)
315 wpabuf_put_buf(data->id_msgs, msg);
321 static void eap_aka_add_checkcode(struct eap_aka_data *data,
322 struct eap_sim_msg *msg)
326 u8 hash[SHA256_MAC_LEN];
328 wpa_printf(MSG_DEBUG, " AT_CHECKCODE");
330 if (data->id_msgs == NULL) {
332 * No EAP-AKA/Identity packets were exchanged - send empty
335 eap_sim_msg_add(msg, EAP_SIM_AT_CHECKCODE, 0, NULL, 0);
339 /* Checkcode is SHA1/SHA256 hash over all EAP-AKA/Identity packets. */
340 addr = wpabuf_head(data->id_msgs);
341 len = wpabuf_len(data->id_msgs);
342 wpa_hexdump(MSG_MSGDUMP, "EAP-AKA: AT_CHECKCODE data", addr, len);
343 if (data->eap_method == EAP_TYPE_AKA_PRIME)
344 sha256_vector(1, &addr, &len, hash);
346 sha1_vector(1, &addr, &len, hash);
348 eap_sim_msg_add(msg, EAP_SIM_AT_CHECKCODE, 0, hash,
349 data->eap_method == EAP_TYPE_AKA_PRIME ?
350 EAP_AKA_PRIME_CHECKCODE_LEN : EAP_AKA_CHECKCODE_LEN);
354 static int eap_aka_verify_checkcode(struct eap_aka_data *data,
355 const u8 *checkcode, size_t checkcode_len)
359 u8 hash[SHA256_MAC_LEN];
362 if (checkcode == NULL)
365 if (data->id_msgs == NULL) {
366 if (checkcode_len != 0) {
367 wpa_printf(MSG_DEBUG, "EAP-AKA: Checkcode from server "
368 "indicates that AKA/Identity messages were "
369 "used, but they were not");
375 hash_len = data->eap_method == EAP_TYPE_AKA_PRIME ?
376 EAP_AKA_PRIME_CHECKCODE_LEN : EAP_AKA_CHECKCODE_LEN;
378 if (checkcode_len != hash_len) {
379 wpa_printf(MSG_DEBUG, "EAP-AKA: Checkcode from server "
380 "indicates that AKA/Identity message were not "
381 "used, but they were");
385 /* Checkcode is SHA1/SHA256 hash over all EAP-AKA/Identity packets. */
386 addr = wpabuf_head(data->id_msgs);
387 len = wpabuf_len(data->id_msgs);
388 if (data->eap_method == EAP_TYPE_AKA_PRIME)
389 sha256_vector(1, &addr, &len, hash);
391 sha1_vector(1, &addr, &len, hash);
393 if (os_memcmp(hash, checkcode, hash_len) != 0) {
394 wpa_printf(MSG_DEBUG, "EAP-AKA: Mismatch in AT_CHECKCODE");
402 static struct wpabuf * eap_aka_client_error(struct eap_aka_data *data, u8 id,
405 struct eap_sim_msg *msg;
407 eap_aka_state(data, FAILURE);
408 data->num_id_req = 0;
409 data->num_notification = 0;
411 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
412 EAP_AKA_SUBTYPE_CLIENT_ERROR);
413 eap_sim_msg_add(msg, EAP_SIM_AT_CLIENT_ERROR_CODE, err, NULL, 0);
414 return eap_sim_msg_finish(msg, NULL, NULL, 0);
418 static struct wpabuf * eap_aka_authentication_reject(struct eap_aka_data *data,
421 struct eap_sim_msg *msg;
423 eap_aka_state(data, FAILURE);
424 data->num_id_req = 0;
425 data->num_notification = 0;
427 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Authentication-Reject "
429 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
430 EAP_AKA_SUBTYPE_AUTHENTICATION_REJECT);
431 return eap_sim_msg_finish(msg, NULL, NULL, 0);
435 static struct wpabuf * eap_aka_synchronization_failure(
436 struct eap_aka_data *data, u8 id)
438 struct eap_sim_msg *msg;
440 data->num_id_req = 0;
441 data->num_notification = 0;
443 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Synchronization-Failure "
445 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
446 EAP_AKA_SUBTYPE_SYNCHRONIZATION_FAILURE);
447 wpa_printf(MSG_DEBUG, " AT_AUTS");
448 eap_sim_msg_add_full(msg, EAP_SIM_AT_AUTS, data->auts,
450 return eap_sim_msg_finish(msg, NULL, NULL, 0);
454 static struct wpabuf * eap_aka_response_identity(struct eap_sm *sm,
455 struct eap_aka_data *data,
457 enum eap_sim_id_req id_req)
459 const u8 *identity = NULL;
460 size_t identity_len = 0;
461 struct eap_sim_msg *msg;
464 if (id_req == ANY_ID && data->reauth_id) {
465 identity = data->reauth_id;
466 identity_len = data->reauth_id_len;
468 } else if ((id_req == ANY_ID || id_req == FULLAUTH_ID) &&
470 identity = data->pseudonym;
471 identity_len = data->pseudonym_len;
472 eap_aka_clear_identities(data, CLEAR_REAUTH_ID);
473 } else if (id_req != NO_ID_REQ) {
474 identity = eap_get_config_identity(sm, &identity_len);
476 eap_aka_clear_identities(data, CLEAR_PSEUDONYM |
480 if (id_req != NO_ID_REQ)
481 eap_aka_clear_identities(data, CLEAR_EAP_ID);
483 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Identity (id=%d)", id);
484 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
485 EAP_AKA_SUBTYPE_IDENTITY);
488 wpa_hexdump_ascii(MSG_DEBUG, " AT_IDENTITY",
489 identity, identity_len);
490 eap_sim_msg_add(msg, EAP_SIM_AT_IDENTITY, identity_len,
491 identity, identity_len);
494 return eap_sim_msg_finish(msg, NULL, NULL, 0);
498 static struct wpabuf * eap_aka_response_challenge(struct eap_aka_data *data,
501 struct eap_sim_msg *msg;
503 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Challenge (id=%d)", id);
504 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
505 EAP_AKA_SUBTYPE_CHALLENGE);
506 wpa_printf(MSG_DEBUG, " AT_RES");
507 eap_sim_msg_add(msg, EAP_SIM_AT_RES, data->res_len * 8,
508 data->res, data->res_len);
509 eap_aka_add_checkcode(data, msg);
510 if (data->use_result_ind) {
511 wpa_printf(MSG_DEBUG, " AT_RESULT_IND");
512 eap_sim_msg_add(msg, EAP_SIM_AT_RESULT_IND, 0, NULL, 0);
514 wpa_printf(MSG_DEBUG, " AT_MAC");
515 eap_sim_msg_add_mac(msg, EAP_SIM_AT_MAC);
516 return eap_sim_msg_finish(msg, data->k_aut, (u8 *) "", 0);
520 static struct wpabuf * eap_aka_response_reauth(struct eap_aka_data *data,
521 u8 id, int counter_too_small,
524 struct eap_sim_msg *msg;
525 unsigned int counter;
527 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Reauthentication (id=%d)",
529 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
530 EAP_AKA_SUBTYPE_REAUTHENTICATION);
531 wpa_printf(MSG_DEBUG, " AT_IV");
532 wpa_printf(MSG_DEBUG, " AT_ENCR_DATA");
533 eap_sim_msg_add_encr_start(msg, EAP_SIM_AT_IV, EAP_SIM_AT_ENCR_DATA);
535 if (counter_too_small) {
536 wpa_printf(MSG_DEBUG, " *AT_COUNTER_TOO_SMALL");
537 eap_sim_msg_add(msg, EAP_SIM_AT_COUNTER_TOO_SMALL, 0, NULL, 0);
538 counter = data->counter_too_small;
540 counter = data->counter;
542 wpa_printf(MSG_DEBUG, " *AT_COUNTER %d", counter);
543 eap_sim_msg_add(msg, EAP_SIM_AT_COUNTER, counter, NULL, 0);
545 if (eap_sim_msg_add_encr_end(msg, data->k_encr, EAP_SIM_AT_PADDING)) {
546 wpa_printf(MSG_WARNING, "EAP-AKA: Failed to encrypt "
548 eap_sim_msg_free(msg);
551 eap_aka_add_checkcode(data, msg);
552 if (data->use_result_ind) {
553 wpa_printf(MSG_DEBUG, " AT_RESULT_IND");
554 eap_sim_msg_add(msg, EAP_SIM_AT_RESULT_IND, 0, NULL, 0);
556 wpa_printf(MSG_DEBUG, " AT_MAC");
557 eap_sim_msg_add_mac(msg, EAP_SIM_AT_MAC);
558 return eap_sim_msg_finish(msg, data->k_aut, nonce_s,
559 EAP_SIM_NONCE_S_LEN);
563 static struct wpabuf * eap_aka_response_notification(struct eap_aka_data *data,
564 u8 id, u16 notification)
566 struct eap_sim_msg *msg;
567 u8 *k_aut = (notification & 0x4000) == 0 ? data->k_aut : NULL;
569 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Notification (id=%d)", id);
570 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
571 EAP_AKA_SUBTYPE_NOTIFICATION);
572 if (k_aut && data->reauth) {
573 wpa_printf(MSG_DEBUG, " AT_IV");
574 wpa_printf(MSG_DEBUG, " AT_ENCR_DATA");
575 eap_sim_msg_add_encr_start(msg, EAP_SIM_AT_IV,
576 EAP_SIM_AT_ENCR_DATA);
577 wpa_printf(MSG_DEBUG, " *AT_COUNTER %d", data->counter);
578 eap_sim_msg_add(msg, EAP_SIM_AT_COUNTER, data->counter,
580 if (eap_sim_msg_add_encr_end(msg, data->k_encr,
581 EAP_SIM_AT_PADDING)) {
582 wpa_printf(MSG_WARNING, "EAP-AKA: Failed to encrypt "
584 eap_sim_msg_free(msg);
589 wpa_printf(MSG_DEBUG, " AT_MAC");
590 eap_sim_msg_add_mac(msg, EAP_SIM_AT_MAC);
592 return eap_sim_msg_finish(msg, k_aut, (u8 *) "", 0);
596 static struct wpabuf * eap_aka_process_identity(struct eap_sm *sm,
597 struct eap_aka_data *data,
599 const struct wpabuf *reqData,
600 struct eap_sim_attrs *attr)
605 wpa_printf(MSG_DEBUG, "EAP-AKA: subtype Identity");
608 switch (attr->id_req) {
612 if (data->num_id_req > 0)
617 if (data->num_id_req > 1)
622 if (data->num_id_req > 2)
628 wpa_printf(MSG_INFO, "EAP-AKA: Too many ID requests "
629 "used within one authentication");
630 return eap_aka_client_error(data, id,
631 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
634 buf = eap_aka_response_identity(sm, data, id, attr->id_req);
636 if (data->prev_id != id) {
637 eap_aka_add_id_msg(data, reqData);
638 eap_aka_add_id_msg(data, buf);
646 static int eap_aka_verify_mac(struct eap_aka_data *data,
647 const struct wpabuf *req,
648 const u8 *mac, const u8 *extra,
651 if (data->eap_method == EAP_TYPE_AKA_PRIME)
652 return eap_sim_verify_mac_sha256(data->k_aut, req, mac, extra,
654 return eap_sim_verify_mac(data->k_aut, req, mac, extra, extra_len);
659 static struct wpabuf * eap_aka_prime_kdf_select(struct eap_aka_data *data,
662 struct eap_sim_msg *msg;
665 wpa_printf(MSG_DEBUG, "Generating EAP-AKA Challenge (id=%d) (KDF "
667 msg = eap_sim_msg_init(EAP_CODE_RESPONSE, id, data->eap_method,
668 EAP_AKA_SUBTYPE_CHALLENGE);
669 wpa_printf(MSG_DEBUG, " AT_KDF");
670 eap_sim_msg_add(msg, EAP_SIM_AT_KDF, kdf, NULL, 0);
671 return eap_sim_msg_finish(msg, NULL, NULL, 0);
675 static struct wpabuf * eap_aka_prime_kdf_neg(struct eap_aka_data *data,
676 u8 id, struct eap_sim_attrs *attr)
680 for (i = 0; i < attr->kdf_count; i++) {
681 if (attr->kdf[i] == EAP_AKA_PRIME_KDF)
682 return eap_aka_prime_kdf_select(data, id,
686 /* No matching KDF found - fail authentication as if AUTN had been
688 return eap_aka_authentication_reject(data, id);
692 static int eap_aka_prime_kdf_valid(struct eap_aka_data *data,
693 struct eap_sim_attrs *attr)
697 if (attr->kdf_count == 0)
700 /* The only allowed (and required) duplication of a KDF is the addition
701 * of the selected KDF into the beginning of the list. */
704 if (attr->kdf[0] != data->kdf) {
705 wpa_printf(MSG_WARNING, "EAP-AKA': The server did not "
706 "accept the selected KDF");
710 for (i = 1; i < attr->kdf_count; i++) {
711 if (attr->kdf[i] == data->kdf)
714 if (i == attr->kdf_count &&
715 attr->kdf_count < EAP_AKA_PRIME_KDF_MAX) {
716 wpa_printf(MSG_WARNING, "EAP-AKA': The server did not "
717 "duplicate the selected KDF");
721 /* TODO: should check that the list is identical to the one
722 * used in the previous Challenge message apart from the added
723 * entry in the beginning. */
726 for (i = data->kdf ? 1 : 0; i < attr->kdf_count; i++) {
727 for (j = i + 1; j < attr->kdf_count; j++) {
728 if (attr->kdf[i] == attr->kdf[j]) {
729 wpa_printf(MSG_WARNING, "EAP-AKA': The server "
730 "included a duplicated KDF");
738 #endif /* EAP_AKA_PRIME */
741 static struct wpabuf * eap_aka_process_challenge(struct eap_sm *sm,
742 struct eap_aka_data *data,
744 const struct wpabuf *reqData,
745 struct eap_sim_attrs *attr)
750 struct eap_sim_attrs eattr;
752 wpa_printf(MSG_DEBUG, "EAP-AKA: subtype Challenge");
754 if (attr->checkcode &&
755 eap_aka_verify_checkcode(data, attr->checkcode,
756 attr->checkcode_len)) {
757 wpa_printf(MSG_WARNING, "EAP-AKA: Invalid AT_CHECKCODE in the "
759 return eap_aka_client_error(data, id,
760 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
764 if (data->eap_method == EAP_TYPE_AKA_PRIME) {
765 if (!attr->kdf_input || attr->kdf_input_len == 0) {
766 wpa_printf(MSG_WARNING, "EAP-AKA': Challenge message "
767 "did not include non-empty AT_KDF_INPUT");
768 /* Fail authentication as if AUTN had been incorrect */
769 return eap_aka_authentication_reject(data, id);
771 os_free(data->network_name);
772 data->network_name = os_malloc(attr->kdf_input_len);
773 if (data->network_name == NULL) {
774 wpa_printf(MSG_WARNING, "EAP-AKA': No memory for "
775 "storing Network Name");
776 return eap_aka_authentication_reject(data, id);
778 os_memcpy(data->network_name, attr->kdf_input,
779 attr->kdf_input_len);
780 data->network_name_len = attr->kdf_input_len;
781 wpa_hexdump_ascii(MSG_DEBUG, "EAP-AKA': Network Name "
783 data->network_name, data->network_name_len);
784 /* TODO: check Network Name per 3GPP.33.402 */
786 if (!eap_aka_prime_kdf_valid(data, attr))
787 return eap_aka_authentication_reject(data, id);
789 if (attr->kdf[0] != EAP_AKA_PRIME_KDF)
790 return eap_aka_prime_kdf_neg(data, id, attr);
792 data->kdf = EAP_AKA_PRIME_KDF;
793 wpa_printf(MSG_DEBUG, "EAP-AKA': KDF %d selected", data->kdf);
796 if (data->eap_method == EAP_TYPE_AKA && attr->bidding) {
797 u16 flags = WPA_GET_BE16(attr->bidding);
798 if ((flags & EAP_AKA_BIDDING_FLAG_D) &&
799 eap_allowed_method(sm, EAP_VENDOR_IETF,
800 EAP_TYPE_AKA_PRIME)) {
801 wpa_printf(MSG_WARNING, "EAP-AKA: Bidding down from "
802 "AKA' to AKA detected");
803 /* Fail authentication as if AUTN had been incorrect */
804 return eap_aka_authentication_reject(data, id);
807 #endif /* EAP_AKA_PRIME */
810 if (!attr->mac || !attr->rand || !attr->autn) {
811 wpa_printf(MSG_WARNING, "EAP-AKA: Challenge message "
812 "did not include%s%s%s",
813 !attr->mac ? " AT_MAC" : "",
814 !attr->rand ? " AT_RAND" : "",
815 !attr->autn ? " AT_AUTN" : "");
816 return eap_aka_client_error(data, id,
817 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
819 os_memcpy(data->rand, attr->rand, EAP_AKA_RAND_LEN);
820 os_memcpy(data->autn, attr->autn, EAP_AKA_AUTN_LEN);
822 res = eap_aka_umts_auth(sm, data);
824 wpa_printf(MSG_WARNING, "EAP-AKA: UMTS authentication "
826 return eap_aka_authentication_reject(data, id);
827 } else if (res == -2) {
828 wpa_printf(MSG_WARNING, "EAP-AKA: UMTS authentication "
829 "failed (AUTN seq# -> AUTS)");
830 return eap_aka_synchronization_failure(data, id);
832 wpa_printf(MSG_WARNING, "EAP-AKA: UMTS authentication failed");
833 return eap_aka_client_error(data, id,
834 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
837 if (data->eap_method == EAP_TYPE_AKA_PRIME) {
838 /* Note: AUTN = (SQN ^ AK) || AMF || MAC which gives us the
839 * needed 6-octet SQN ^AK for CK',IK' derivation */
840 eap_aka_prime_derive_ck_ik_prime(data->ck, data->ik,
843 data->network_name_len);
845 #endif /* EAP_AKA_PRIME */
846 if (data->last_eap_identity) {
847 identity = data->last_eap_identity;
848 identity_len = data->last_eap_identity_len;
849 } else if (data->pseudonym) {
850 identity = data->pseudonym;
851 identity_len = data->pseudonym_len;
853 identity = eap_get_config_identity(sm, &identity_len);
854 wpa_hexdump_ascii(MSG_DEBUG, "EAP-AKA: Selected identity for MK "
855 "derivation", identity, identity_len);
856 if (data->eap_method == EAP_TYPE_AKA_PRIME) {
857 eap_aka_prime_derive_keys(identity, identity_len, data->ik,
858 data->ck, data->k_encr, data->k_aut,
859 data->k_re, data->msk, data->emsk);
861 eap_aka_derive_mk(identity, identity_len, data->ik, data->ck,
863 eap_sim_derive_keys(data->mk, data->k_encr, data->k_aut,
864 data->msk, data->emsk);
866 if (eap_aka_verify_mac(data, reqData, attr->mac, (u8 *) "", 0)) {
867 wpa_printf(MSG_WARNING, "EAP-AKA: Challenge message "
868 "used invalid AT_MAC");
869 return eap_aka_client_error(data, id,
870 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
873 /* Old reauthentication and pseudonym identities must not be used
874 * anymore. In other words, if no new identities are received, full
875 * authentication will be used on next reauthentication. */
876 eap_aka_clear_identities(data, CLEAR_PSEUDONYM | CLEAR_REAUTH_ID |
879 if (attr->encr_data) {
881 decrypted = eap_sim_parse_encr(data->k_encr, attr->encr_data,
882 attr->encr_data_len, attr->iv,
884 if (decrypted == NULL) {
885 return eap_aka_client_error(
886 data, id, EAP_AKA_UNABLE_TO_PROCESS_PACKET);
888 eap_aka_learn_ids(data, &eattr);
892 if (data->result_ind && attr->result_ind)
893 data->use_result_ind = 1;
895 if (data->state != FAILURE && data->state != RESULT_FAILURE) {
896 eap_aka_state(data, data->use_result_ind ?
897 RESULT_SUCCESS : SUCCESS);
900 data->num_id_req = 0;
901 data->num_notification = 0;
902 /* RFC 4187 specifies that counter is initialized to one after
903 * fullauth, but initializing it to zero makes it easier to implement
904 * reauth verification. */
906 return eap_aka_response_challenge(data, id);
910 static int eap_aka_process_notification_reauth(struct eap_aka_data *data,
911 struct eap_sim_attrs *attr)
913 struct eap_sim_attrs eattr;
916 if (attr->encr_data == NULL || attr->iv == NULL) {
917 wpa_printf(MSG_WARNING, "EAP-AKA: Notification message after "
918 "reauth did not include encrypted data");
922 decrypted = eap_sim_parse_encr(data->k_encr, attr->encr_data,
923 attr->encr_data_len, attr->iv, &eattr,
925 if (decrypted == NULL) {
926 wpa_printf(MSG_WARNING, "EAP-AKA: Failed to parse encrypted "
927 "data from notification message");
931 if (eattr.counter < 0 || (size_t) eattr.counter != data->counter) {
932 wpa_printf(MSG_WARNING, "EAP-AKA: Counter in notification "
933 "message does not match with counter in reauth "
944 static int eap_aka_process_notification_auth(struct eap_aka_data *data,
945 const struct wpabuf *reqData,
946 struct eap_sim_attrs *attr)
948 if (attr->mac == NULL) {
949 wpa_printf(MSG_INFO, "EAP-AKA: no AT_MAC in after_auth "
950 "Notification message");
954 if (eap_aka_verify_mac(data, reqData, attr->mac, (u8 *) "", 0)) {
955 wpa_printf(MSG_WARNING, "EAP-AKA: Notification message "
956 "used invalid AT_MAC");
961 eap_aka_process_notification_reauth(data, attr)) {
962 wpa_printf(MSG_WARNING, "EAP-AKA: Invalid notification "
963 "message after reauth");
971 static struct wpabuf * eap_aka_process_notification(
972 struct eap_sm *sm, struct eap_aka_data *data, u8 id,
973 const struct wpabuf *reqData, struct eap_sim_attrs *attr)
975 wpa_printf(MSG_DEBUG, "EAP-AKA: subtype Notification");
976 if (data->num_notification > 0) {
977 wpa_printf(MSG_INFO, "EAP-AKA: too many notification "
978 "rounds (only one allowed)");
979 return eap_aka_client_error(data, id,
980 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
982 data->num_notification++;
983 if (attr->notification == -1) {
984 wpa_printf(MSG_INFO, "EAP-AKA: no AT_NOTIFICATION in "
985 "Notification message");
986 return eap_aka_client_error(data, id,
987 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
990 if ((attr->notification & 0x4000) == 0 &&
991 eap_aka_process_notification_auth(data, reqData, attr)) {
992 return eap_aka_client_error(data, id,
993 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
996 eap_sim_report_notification(sm->msg_ctx, attr->notification, 1);
997 if (attr->notification >= 0 && attr->notification < 32768) {
998 eap_aka_state(data, FAILURE);
999 } else if (attr->notification == EAP_SIM_SUCCESS &&
1000 data->state == RESULT_SUCCESS)
1001 eap_aka_state(data, SUCCESS);
1002 return eap_aka_response_notification(data, id, attr->notification);
1006 static struct wpabuf * eap_aka_process_reauthentication(
1007 struct eap_sm *sm, struct eap_aka_data *data, u8 id,
1008 const struct wpabuf *reqData, struct eap_sim_attrs *attr)
1010 struct eap_sim_attrs eattr;
1013 wpa_printf(MSG_DEBUG, "EAP-AKA: subtype Reauthentication");
1015 if (attr->checkcode &&
1016 eap_aka_verify_checkcode(data, attr->checkcode,
1017 attr->checkcode_len)) {
1018 wpa_printf(MSG_WARNING, "EAP-AKA: Invalid AT_CHECKCODE in the "
1020 return eap_aka_client_error(data, id,
1021 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1024 if (data->reauth_id == NULL) {
1025 wpa_printf(MSG_WARNING, "EAP-AKA: Server is trying "
1026 "reauthentication, but no reauth_id available");
1027 return eap_aka_client_error(data, id,
1028 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1032 if (eap_aka_verify_mac(data, reqData, attr->mac, (u8 *) "", 0)) {
1033 wpa_printf(MSG_WARNING, "EAP-AKA: Reauthentication "
1034 "did not have valid AT_MAC");
1035 return eap_aka_client_error(data, id,
1036 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1039 if (attr->encr_data == NULL || attr->iv == NULL) {
1040 wpa_printf(MSG_WARNING, "EAP-AKA: Reauthentication "
1041 "message did not include encrypted data");
1042 return eap_aka_client_error(data, id,
1043 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1046 decrypted = eap_sim_parse_encr(data->k_encr, attr->encr_data,
1047 attr->encr_data_len, attr->iv, &eattr,
1049 if (decrypted == NULL) {
1050 wpa_printf(MSG_WARNING, "EAP-AKA: Failed to parse encrypted "
1051 "data from reauthentication message");
1052 return eap_aka_client_error(data, id,
1053 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1056 if (eattr.nonce_s == NULL || eattr.counter < 0) {
1057 wpa_printf(MSG_INFO, "EAP-AKA: (encr) No%s%s in reauth packet",
1058 !eattr.nonce_s ? " AT_NONCE_S" : "",
1059 eattr.counter < 0 ? " AT_COUNTER" : "");
1061 return eap_aka_client_error(data, id,
1062 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1065 if (eattr.counter < 0 || (size_t) eattr.counter <= data->counter) {
1067 wpa_printf(MSG_INFO, "EAP-AKA: (encr) Invalid counter "
1068 "(%d <= %d)", eattr.counter, data->counter);
1069 data->counter_too_small = eattr.counter;
1071 /* Reply using Re-auth w/ AT_COUNTER_TOO_SMALL. The current
1072 * reauth_id must not be used to start a new reauthentication.
1073 * However, since it was used in the last EAP-Response-Identity
1074 * packet, it has to saved for the following fullauth to be
1075 * used in MK derivation. */
1076 os_free(data->last_eap_identity);
1077 data->last_eap_identity = data->reauth_id;
1078 data->last_eap_identity_len = data->reauth_id_len;
1079 data->reauth_id = NULL;
1080 data->reauth_id_len = 0;
1082 res = eap_aka_response_reauth(data, id, 1, eattr.nonce_s);
1087 data->counter = eattr.counter;
1089 os_memcpy(data->nonce_s, eattr.nonce_s, EAP_SIM_NONCE_S_LEN);
1090 wpa_hexdump(MSG_DEBUG, "EAP-AKA: (encr) AT_NONCE_S",
1091 data->nonce_s, EAP_SIM_NONCE_S_LEN);
1093 if (data->eap_method == EAP_TYPE_AKA_PRIME) {
1094 eap_aka_prime_derive_keys_reauth(data->k_re, data->counter,
1096 data->reauth_id_len,
1098 data->msk, data->emsk);
1100 eap_sim_derive_keys_reauth(data->counter, data->reauth_id,
1101 data->reauth_id_len,
1102 data->nonce_s, data->mk,
1103 data->msk, data->emsk);
1105 eap_aka_clear_identities(data, CLEAR_REAUTH_ID | CLEAR_EAP_ID);
1106 eap_aka_learn_ids(data, &eattr);
1108 if (data->result_ind && attr->result_ind)
1109 data->use_result_ind = 1;
1111 if (data->state != FAILURE && data->state != RESULT_FAILURE) {
1112 eap_aka_state(data, data->use_result_ind ?
1113 RESULT_SUCCESS : SUCCESS);
1116 data->num_id_req = 0;
1117 data->num_notification = 0;
1118 if (data->counter > EAP_AKA_MAX_FAST_REAUTHS) {
1119 wpa_printf(MSG_DEBUG, "EAP-AKA: Maximum number of "
1120 "fast reauths performed - force fullauth");
1121 eap_aka_clear_identities(data, CLEAR_REAUTH_ID | CLEAR_EAP_ID);
1124 return eap_aka_response_reauth(data, id, 0, data->nonce_s);
1128 static struct wpabuf * eap_aka_process(struct eap_sm *sm, void *priv,
1129 struct eap_method_ret *ret,
1130 const struct wpabuf *reqData)
1132 struct eap_aka_data *data = priv;
1133 const struct eap_hdr *req;
1137 struct eap_sim_attrs attr;
1140 wpa_hexdump_buf(MSG_DEBUG, "EAP-AKA: EAP data", reqData);
1141 if (eap_get_config_identity(sm, &len) == NULL) {
1142 wpa_printf(MSG_INFO, "EAP-AKA: Identity not configured");
1143 eap_sm_request_identity(sm);
1148 pos = eap_hdr_validate(EAP_VENDOR_IETF, data->eap_method, reqData,
1150 if (pos == NULL || len < 1) {
1154 req = wpabuf_head(reqData);
1155 id = req->identifier;
1156 len = be_to_host16(req->length);
1158 ret->ignore = FALSE;
1159 ret->methodState = METHOD_MAY_CONT;
1160 ret->decision = DECISION_FAIL;
1161 ret->allowNotifications = TRUE;
1164 wpa_printf(MSG_DEBUG, "EAP-AKA: Subtype=%d", subtype);
1165 pos += 2; /* Reserved */
1167 if (eap_sim_parse_attr(pos, wpabuf_head_u8(reqData) + len, &attr,
1168 data->eap_method == EAP_TYPE_AKA_PRIME ? 2 : 1,
1170 res = eap_aka_client_error(data, id,
1171 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1176 case EAP_AKA_SUBTYPE_IDENTITY:
1177 res = eap_aka_process_identity(sm, data, id, reqData, &attr);
1179 case EAP_AKA_SUBTYPE_CHALLENGE:
1180 res = eap_aka_process_challenge(sm, data, id, reqData, &attr);
1182 case EAP_AKA_SUBTYPE_NOTIFICATION:
1183 res = eap_aka_process_notification(sm, data, id, reqData,
1186 case EAP_AKA_SUBTYPE_REAUTHENTICATION:
1187 res = eap_aka_process_reauthentication(sm, data, id, reqData,
1190 case EAP_AKA_SUBTYPE_CLIENT_ERROR:
1191 wpa_printf(MSG_DEBUG, "EAP-AKA: subtype Client-Error");
1192 res = eap_aka_client_error(data, id,
1193 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1196 wpa_printf(MSG_DEBUG, "EAP-AKA: Unknown subtype=%d", subtype);
1197 res = eap_aka_client_error(data, id,
1198 EAP_AKA_UNABLE_TO_PROCESS_PACKET);
1203 if (data->state == FAILURE) {
1204 ret->decision = DECISION_FAIL;
1205 ret->methodState = METHOD_DONE;
1206 } else if (data->state == SUCCESS) {
1207 ret->decision = data->use_result_ind ?
1208 DECISION_UNCOND_SUCC : DECISION_COND_SUCC;
1210 * It is possible for the server to reply with AKA
1211 * Notification, so we must allow the method to continue and
1212 * not only accept EAP-Success at this point.
1214 ret->methodState = data->use_result_ind ?
1215 METHOD_DONE : METHOD_MAY_CONT;
1216 } else if (data->state == RESULT_FAILURE)
1217 ret->methodState = METHOD_CONT;
1218 else if (data->state == RESULT_SUCCESS)
1219 ret->methodState = METHOD_CONT;
1221 if (ret->methodState == METHOD_DONE) {
1222 ret->allowNotifications = FALSE;
1229 static Boolean eap_aka_has_reauth_data(struct eap_sm *sm, void *priv)
1231 struct eap_aka_data *data = priv;
1232 return data->pseudonym || data->reauth_id;
1236 static void eap_aka_deinit_for_reauth(struct eap_sm *sm, void *priv)
1238 struct eap_aka_data *data = priv;
1239 eap_aka_clear_identities(data, CLEAR_EAP_ID);
1241 wpabuf_free(data->id_msgs);
1242 data->id_msgs = NULL;
1243 data->use_result_ind = 0;
1247 static void * eap_aka_init_for_reauth(struct eap_sm *sm, void *priv)
1249 struct eap_aka_data *data = priv;
1250 data->num_id_req = 0;
1251 data->num_notification = 0;
1252 eap_aka_state(data, CONTINUE);
1257 static const u8 * eap_aka_get_identity(struct eap_sm *sm, void *priv,
1260 struct eap_aka_data *data = priv;
1262 if (data->reauth_id) {
1263 *len = data->reauth_id_len;
1264 return data->reauth_id;
1267 if (data->pseudonym) {
1268 *len = data->pseudonym_len;
1269 return data->pseudonym;
1276 static Boolean eap_aka_isKeyAvailable(struct eap_sm *sm, void *priv)
1278 struct eap_aka_data *data = priv;
1279 return data->state == SUCCESS;
1283 static u8 * eap_aka_getKey(struct eap_sm *sm, void *priv, size_t *len)
1285 struct eap_aka_data *data = priv;
1288 if (data->state != SUCCESS)
1291 key = os_malloc(EAP_SIM_KEYING_DATA_LEN);
1295 *len = EAP_SIM_KEYING_DATA_LEN;
1296 os_memcpy(key, data->msk, EAP_SIM_KEYING_DATA_LEN);
1302 static u8 * eap_aka_get_emsk(struct eap_sm *sm, void *priv, size_t *len)
1304 struct eap_aka_data *data = priv;
1307 if (data->state != SUCCESS)
1310 key = os_malloc(EAP_EMSK_LEN);
1314 *len = EAP_EMSK_LEN;
1315 os_memcpy(key, data->emsk, EAP_EMSK_LEN);
1321 int eap_peer_aka_register(void)
1323 struct eap_method *eap;
1326 eap = eap_peer_method_alloc(EAP_PEER_METHOD_INTERFACE_VERSION,
1327 EAP_VENDOR_IETF, EAP_TYPE_AKA, "AKA");
1331 eap->init = eap_aka_init;
1332 eap->deinit = eap_aka_deinit;
1333 eap->process = eap_aka_process;
1334 eap->isKeyAvailable = eap_aka_isKeyAvailable;
1335 eap->getKey = eap_aka_getKey;
1336 eap->has_reauth_data = eap_aka_has_reauth_data;
1337 eap->deinit_for_reauth = eap_aka_deinit_for_reauth;
1338 eap->init_for_reauth = eap_aka_init_for_reauth;
1339 eap->get_identity = eap_aka_get_identity;
1340 eap->get_emsk = eap_aka_get_emsk;
1342 ret = eap_peer_method_register(eap);
1344 eap_peer_method_free(eap);
1349 #ifdef EAP_AKA_PRIME
1350 int eap_peer_aka_prime_register(void)
1352 struct eap_method *eap;
1355 eap = eap_peer_method_alloc(EAP_PEER_METHOD_INTERFACE_VERSION,
1356 EAP_VENDOR_IETF, EAP_TYPE_AKA_PRIME,
1361 eap->init = eap_aka_prime_init;
1362 eap->deinit = eap_aka_deinit;
1363 eap->process = eap_aka_process;
1364 eap->isKeyAvailable = eap_aka_isKeyAvailable;
1365 eap->getKey = eap_aka_getKey;
1366 eap->has_reauth_data = eap_aka_has_reauth_data;
1367 eap->deinit_for_reauth = eap_aka_deinit_for_reauth;
1368 eap->init_for_reauth = eap_aka_init_for_reauth;
1369 eap->get_identity = eap_aka_get_identity;
1370 eap->get_emsk = eap_aka_get_emsk;
1372 ret = eap_peer_method_register(eap);
1374 eap_peer_method_free(eap);
1378 #endif /* EAP_AKA_PRIME */