1189251Ssam/* 2189251Ssam * EAP peer/server: EAP-SIM/AKA/AKA' shared routines 3189251Ssam * Copyright (c) 2004-2008, Jouni Malinen <j@w1.fi> 4189251Ssam * 5252726Srpaulo * This software may be distributed under the terms of the BSD license. 6252726Srpaulo * See README for more details. 7189251Ssam */ 8189251Ssam 9189251Ssam#ifndef EAP_SIM_COMMON_H 10189251Ssam#define EAP_SIM_COMMON_H 11189251Ssam 12189251Ssam#define EAP_SIM_NONCE_S_LEN 16 13189251Ssam#define EAP_SIM_NONCE_MT_LEN 16 14189251Ssam#define EAP_SIM_MAC_LEN 16 15189251Ssam#define EAP_SIM_MK_LEN 20 16189251Ssam#define EAP_SIM_K_AUT_LEN 16 17189251Ssam#define EAP_SIM_K_ENCR_LEN 16 18189251Ssam#define EAP_SIM_KEYING_DATA_LEN 64 19189251Ssam#define EAP_SIM_IV_LEN 16 20189251Ssam#define EAP_SIM_KC_LEN 8 21189251Ssam#define EAP_SIM_SRES_LEN 4 22189251Ssam 23189251Ssam#define GSM_RAND_LEN 16 24189251Ssam 25189251Ssam#define EAP_SIM_VERSION 1 26189251Ssam 27189251Ssam/* EAP-SIM Subtypes */ 28189251Ssam#define EAP_SIM_SUBTYPE_START 10 29189251Ssam#define EAP_SIM_SUBTYPE_CHALLENGE 11 30189251Ssam#define EAP_SIM_SUBTYPE_NOTIFICATION 12 31189251Ssam#define EAP_SIM_SUBTYPE_REAUTHENTICATION 13 32189251Ssam#define EAP_SIM_SUBTYPE_CLIENT_ERROR 14 33189251Ssam 34189251Ssam/* AT_CLIENT_ERROR_CODE error codes */ 35189251Ssam#define EAP_SIM_UNABLE_TO_PROCESS_PACKET 0 36189251Ssam#define EAP_SIM_UNSUPPORTED_VERSION 1 37189251Ssam#define EAP_SIM_INSUFFICIENT_NUM_OF_CHAL 2 38189251Ssam#define EAP_SIM_RAND_NOT_FRESH 3 39189251Ssam 40189251Ssam#define EAP_SIM_MAX_FAST_REAUTHS 1000 41189251Ssam 42189251Ssam#define EAP_SIM_MAX_CHAL 3 43189251Ssam 44189251Ssam 45189251Ssam/* EAP-AKA Subtypes */ 46189251Ssam#define EAP_AKA_SUBTYPE_CHALLENGE 1 47189251Ssam#define EAP_AKA_SUBTYPE_AUTHENTICATION_REJECT 2 48189251Ssam#define EAP_AKA_SUBTYPE_SYNCHRONIZATION_FAILURE 4 49189251Ssam#define EAP_AKA_SUBTYPE_IDENTITY 5 50189251Ssam#define EAP_AKA_SUBTYPE_NOTIFICATION 12 51189251Ssam#define EAP_AKA_SUBTYPE_REAUTHENTICATION 13 52189251Ssam#define EAP_AKA_SUBTYPE_CLIENT_ERROR 14 53189251Ssam 54189251Ssam/* AT_CLIENT_ERROR_CODE error codes */ 55189251Ssam#define EAP_AKA_UNABLE_TO_PROCESS_PACKET 0 56189251Ssam 57189251Ssam#define EAP_AKA_RAND_LEN 16 58189251Ssam#define EAP_AKA_AUTN_LEN 16 59189251Ssam#define EAP_AKA_AUTS_LEN 14 60189251Ssam#define EAP_AKA_RES_MAX_LEN 16 61189251Ssam#define EAP_AKA_IK_LEN 16 62189251Ssam#define EAP_AKA_CK_LEN 16 63189251Ssam#define EAP_AKA_MAX_FAST_REAUTHS 1000 64189251Ssam#define EAP_AKA_MIN_RES_LEN 4 65189251Ssam#define EAP_AKA_MAX_RES_LEN 16 66189251Ssam#define EAP_AKA_CHECKCODE_LEN 20 67189251Ssam 68189251Ssam#define EAP_AKA_PRIME_K_AUT_LEN 32 69189251Ssam#define EAP_AKA_PRIME_CHECKCODE_LEN 32 70189251Ssam#define EAP_AKA_PRIME_K_RE_LEN 32 71189251Ssam 72189251Ssamstruct wpabuf; 73189251Ssam 74189251Ssamvoid eap_sim_derive_mk(const u8 *identity, size_t identity_len, 75189251Ssam const u8 *nonce_mt, u16 selected_version, 76189251Ssam const u8 *ver_list, size_t ver_list_len, 77189251Ssam int num_chal, const u8 *kc, u8 *mk); 78189251Ssamvoid eap_aka_derive_mk(const u8 *identity, size_t identity_len, 79189251Ssam const u8 *ik, const u8 *ck, u8 *mk); 80189251Ssamint eap_sim_derive_keys(const u8 *mk, u8 *k_encr, u8 *k_aut, u8 *msk, 81189251Ssam u8 *emsk); 82189251Ssamint eap_sim_derive_keys_reauth(u16 _counter, 83189251Ssam const u8 *identity, size_t identity_len, 84189251Ssam const u8 *nonce_s, const u8 *mk, u8 *msk, 85189251Ssam u8 *emsk); 86189251Ssamint eap_sim_verify_mac(const u8 *k_aut, const struct wpabuf *req, 87189251Ssam const u8 *mac, const u8 *extra, size_t extra_len); 88189251Ssamvoid eap_sim_add_mac(const u8 *k_aut, const u8 *msg, size_t msg_len, u8 *mac, 89189251Ssam const u8 *extra, size_t extra_len); 90189251Ssam 91214734Srpaulo#if defined(EAP_AKA_PRIME) || defined(EAP_SERVER_AKA_PRIME) 92189251Ssamvoid eap_aka_prime_derive_keys(const u8 *identity, size_t identity_len, 93189251Ssam const u8 *ik, const u8 *ck, u8 *k_encr, 94189251Ssam u8 *k_aut, u8 *k_re, u8 *msk, u8 *emsk); 95189251Ssamint eap_aka_prime_derive_keys_reauth(const u8 *k_re, u16 counter, 96189251Ssam const u8 *identity, size_t identity_len, 97189251Ssam const u8 *nonce_s, u8 *msk, u8 *emsk); 98189251Ssamint eap_sim_verify_mac_sha256(const u8 *k_aut, const struct wpabuf *req, 99189251Ssam const u8 *mac, const u8 *extra, 100189251Ssam size_t extra_len); 101189251Ssamvoid eap_sim_add_mac_sha256(const u8 *k_aut, const u8 *msg, size_t msg_len, 102189251Ssam u8 *mac, const u8 *extra, size_t extra_len); 103189251Ssam 104189251Ssamvoid eap_aka_prime_derive_ck_ik_prime(u8 *ck, u8 *ik, const u8 *sqn_ak, 105189251Ssam const u8 *network_name, 106189251Ssam size_t network_name_len); 107214734Srpaulo#else /* EAP_AKA_PRIME || EAP_SERVER_AKA_PRIME */ 108189251Ssamstatic inline void eap_aka_prime_derive_keys(const u8 *identity, 109189251Ssam size_t identity_len, 110189251Ssam const u8 *ik, const u8 *ck, 111189251Ssam u8 *k_encr, u8 *k_aut, u8 *k_re, 112189251Ssam u8 *msk, u8 *emsk) 113189251Ssam{ 114189251Ssam} 115189251Ssam 116189251Ssamstatic inline int eap_aka_prime_derive_keys_reauth(const u8 *k_re, u16 counter, 117189251Ssam const u8 *identity, 118189251Ssam size_t identity_len, 119189251Ssam const u8 *nonce_s, u8 *msk, 120189251Ssam u8 *emsk) 121189251Ssam{ 122189251Ssam return -1; 123189251Ssam} 124189251Ssam 125189251Ssamstatic inline int eap_sim_verify_mac_sha256(const u8 *k_aut, 126189251Ssam const struct wpabuf *req, 127189251Ssam const u8 *mac, const u8 *extra, 128189251Ssam size_t extra_len) 129189251Ssam{ 130189251Ssam return -1; 131189251Ssam} 132214734Srpaulo#endif /* EAP_AKA_PRIME || EAP_SERVER_AKA_PRIME */ 133189251Ssam 134189251Ssam 135189251Ssam/* EAP-SIM/AKA Attributes (0..127 non-skippable) */ 136189251Ssam#define EAP_SIM_AT_RAND 1 137189251Ssam#define EAP_SIM_AT_AUTN 2 /* only AKA */ 138189251Ssam#define EAP_SIM_AT_RES 3 /* only AKA, only peer->server */ 139189251Ssam#define EAP_SIM_AT_AUTS 4 /* only AKA, only peer->server */ 140189251Ssam#define EAP_SIM_AT_PADDING 6 /* only encrypted */ 141189251Ssam#define EAP_SIM_AT_NONCE_MT 7 /* only SIM, only send */ 142189251Ssam#define EAP_SIM_AT_PERMANENT_ID_REQ 10 143189251Ssam#define EAP_SIM_AT_MAC 11 144189251Ssam#define EAP_SIM_AT_NOTIFICATION 12 145189251Ssam#define EAP_SIM_AT_ANY_ID_REQ 13 146189251Ssam#define EAP_SIM_AT_IDENTITY 14 /* only send */ 147189251Ssam#define EAP_SIM_AT_VERSION_LIST 15 /* only SIM */ 148189251Ssam#define EAP_SIM_AT_SELECTED_VERSION 16 /* only SIM */ 149189251Ssam#define EAP_SIM_AT_FULLAUTH_ID_REQ 17 150189251Ssam#define EAP_SIM_AT_COUNTER 19 /* only encrypted */ 151189251Ssam#define EAP_SIM_AT_COUNTER_TOO_SMALL 20 /* only encrypted */ 152189251Ssam#define EAP_SIM_AT_NONCE_S 21 /* only encrypted */ 153189251Ssam#define EAP_SIM_AT_CLIENT_ERROR_CODE 22 /* only send */ 154189251Ssam#define EAP_SIM_AT_KDF_INPUT 23 /* only AKA' */ 155189251Ssam#define EAP_SIM_AT_KDF 24 /* only AKA' */ 156189251Ssam#define EAP_SIM_AT_IV 129 157189251Ssam#define EAP_SIM_AT_ENCR_DATA 130 158189251Ssam#define EAP_SIM_AT_NEXT_PSEUDONYM 132 /* only encrypted */ 159189251Ssam#define EAP_SIM_AT_NEXT_REAUTH_ID 133 /* only encrypted */ 160189251Ssam#define EAP_SIM_AT_CHECKCODE 134 /* only AKA */ 161189251Ssam#define EAP_SIM_AT_RESULT_IND 135 162189251Ssam#define EAP_SIM_AT_BIDDING 136 163189251Ssam 164189251Ssam/* AT_NOTIFICATION notification code values */ 165189251Ssam#define EAP_SIM_GENERAL_FAILURE_AFTER_AUTH 0 166189251Ssam#define EAP_SIM_TEMPORARILY_DENIED 1026 167189251Ssam#define EAP_SIM_NOT_SUBSCRIBED 1031 168189251Ssam#define EAP_SIM_GENERAL_FAILURE_BEFORE_AUTH 16384 169189251Ssam#define EAP_SIM_SUCCESS 32768 170189251Ssam 171189251Ssam/* EAP-AKA' AT_KDF Key Derivation Function values */ 172189251Ssam#define EAP_AKA_PRIME_KDF 1 173189251Ssam 174189251Ssam/* AT_BIDDING flags */ 175189251Ssam#define EAP_AKA_BIDDING_FLAG_D 0x8000 176189251Ssam 177189251Ssam 178189251Ssamenum eap_sim_id_req { 179189251Ssam NO_ID_REQ, ANY_ID, FULLAUTH_ID, PERMANENT_ID 180189251Ssam}; 181189251Ssam 182189251Ssam 183189251Ssamstruct eap_sim_attrs { 184189251Ssam const u8 *rand, *autn, *mac, *iv, *encr_data, *version_list, *nonce_s; 185189251Ssam const u8 *next_pseudonym, *next_reauth_id; 186189251Ssam const u8 *nonce_mt, *identity, *res, *auts; 187189251Ssam const u8 *checkcode; 188189251Ssam const u8 *kdf_input; 189189251Ssam const u8 *bidding; 190189251Ssam size_t num_chal, version_list_len, encr_data_len; 191189251Ssam size_t next_pseudonym_len, next_reauth_id_len, identity_len, res_len; 192189251Ssam size_t res_len_bits; 193189251Ssam size_t checkcode_len; 194189251Ssam size_t kdf_input_len; 195189251Ssam enum eap_sim_id_req id_req; 196189251Ssam int notification, counter, selected_version, client_error_code; 197189251Ssam int counter_too_small; 198189251Ssam int result_ind; 199189251Ssam#define EAP_AKA_PRIME_KDF_MAX 10 200189251Ssam u16 kdf[EAP_AKA_PRIME_KDF_MAX]; 201189251Ssam size_t kdf_count; 202189251Ssam}; 203189251Ssam 204189251Ssamint eap_sim_parse_attr(const u8 *start, const u8 *end, 205189251Ssam struct eap_sim_attrs *attr, int aka, int encr); 206189251Ssamu8 * eap_sim_parse_encr(const u8 *k_encr, const u8 *encr_data, 207189251Ssam size_t encr_data_len, const u8 *iv, 208189251Ssam struct eap_sim_attrs *attr, int aka); 209189251Ssam 210189251Ssam 211189251Ssamstruct eap_sim_msg; 212189251Ssam 213189251Ssamstruct eap_sim_msg * eap_sim_msg_init(int code, int id, int type, int subtype); 214189251Ssamstruct wpabuf * eap_sim_msg_finish(struct eap_sim_msg *msg, const u8 *k_aut, 215189251Ssam const u8 *extra, size_t extra_len); 216189251Ssamvoid eap_sim_msg_free(struct eap_sim_msg *msg); 217189251Ssamu8 * eap_sim_msg_add_full(struct eap_sim_msg *msg, u8 attr, 218189251Ssam const u8 *data, size_t len); 219189251Ssamu8 * eap_sim_msg_add(struct eap_sim_msg *msg, u8 attr, 220189251Ssam u16 value, const u8 *data, size_t len); 221189251Ssamu8 * eap_sim_msg_add_mac(struct eap_sim_msg *msg, u8 attr); 222189251Ssamint eap_sim_msg_add_encr_start(struct eap_sim_msg *msg, u8 attr_iv, 223189251Ssam u8 attr_encr); 224189251Ssamint eap_sim_msg_add_encr_end(struct eap_sim_msg *msg, u8 *k_encr, 225189251Ssam int attr_pad); 226189251Ssam 227189251Ssamvoid eap_sim_report_notification(void *msg_ctx, int notification, int aka); 228189251Ssam 229189251Ssam#endif /* EAP_SIM_COMMON_H */ 230