libeap/src/eap_common/eap_sim_common.h

   1 /*
   2  * EAP peer/server: EAP-SIM/AKA/AKA' shared routines
   3  * Copyright (c) 2004-2008, Jouni Malinen <j@w1.fi>
   4  *
   5  * This software may be distributed under the terms of the BSD license.
   6  * See README for more details.
   7  */
   8
   9 #ifndef EAP_SIM_COMMON_H
  10 #define EAP_SIM_COMMON_H
  11
  12 #ifdef __cplusplus
  13 extern "C" {
  14 #endif
  15
  16 #define EAP_SIM_NONCE_S_LEN 16
  17 #define EAP_SIM_NONCE_MT_LEN 16
  18 #define EAP_SIM_MAC_LEN 16
  19 #define EAP_SIM_MK_LEN 20
  20 #define EAP_SIM_K_AUT_LEN 16
  21 #define EAP_SIM_K_ENCR_LEN 16
  22 #define EAP_SIM_KEYING_DATA_LEN 64
  23 #define EAP_SIM_IV_LEN 16
  24 #define EAP_SIM_KC_LEN 8
  25 #define EAP_SIM_SRES_LEN 4
  26
  27 #define GSM_RAND_LEN 16
  28
  29 #define EAP_SIM_VERSION 1
  30
  31 /* EAP-SIM Subtypes */
  32 #define EAP_SIM_SUBTYPE_START 10
  33 #define EAP_SIM_SUBTYPE_CHALLENGE 11
  34 #define EAP_SIM_SUBTYPE_NOTIFICATION 12
  35 #define EAP_SIM_SUBTYPE_REAUTHENTICATION 13
  36 #define EAP_SIM_SUBTYPE_CLIENT_ERROR 14
  37
  38 /* AT_CLIENT_ERROR_CODE error codes */
  39 #define EAP_SIM_UNABLE_TO_PROCESS_PACKET 0
  40 #define EAP_SIM_UNSUPPORTED_VERSION 1
  41 #define EAP_SIM_INSUFFICIENT_NUM_OF_CHAL 2
  42 #define EAP_SIM_RAND_NOT_FRESH 3
  43
  44 #define EAP_SIM_MAX_FAST_REAUTHS 1000
  45
  46 #define EAP_SIM_MAX_CHAL 3
  47
  48
  49 /* EAP-AKA Subtypes */
  50 #define EAP_AKA_SUBTYPE_CHALLENGE 1
  51 #define EAP_AKA_SUBTYPE_AUTHENTICATION_REJECT 2
  52 #define EAP_AKA_SUBTYPE_SYNCHRONIZATION_FAILURE 4
  53 #define EAP_AKA_SUBTYPE_IDENTITY 5
  54 #define EAP_AKA_SUBTYPE_NOTIFICATION 12
  55 #define EAP_AKA_SUBTYPE_REAUTHENTICATION 13
  56 #define EAP_AKA_SUBTYPE_CLIENT_ERROR 14
  57
  58 /* AT_CLIENT_ERROR_CODE error codes */
  59 #define EAP_AKA_UNABLE_TO_PROCESS_PACKET 0
  60
  61 #define EAP_AKA_RAND_LEN 16
  62 #define EAP_AKA_AUTN_LEN 16
  63 #define EAP_AKA_AUTS_LEN 14
  64 #define EAP_AKA_RES_MAX_LEN 16
  65 #define EAP_AKA_IK_LEN 16
  66 #define EAP_AKA_CK_LEN 16
  67 #define EAP_AKA_MAX_FAST_REAUTHS 1000
  68 #define EAP_AKA_MIN_RES_LEN 4
  69 #define EAP_AKA_MAX_RES_LEN 16
  70 #define EAP_AKA_CHECKCODE_LEN 20
  71
  72 #define EAP_AKA_PRIME_K_AUT_LEN 32
  73 #define EAP_AKA_PRIME_CHECKCODE_LEN 32
  74 #define EAP_AKA_PRIME_K_RE_LEN 32
  75
  76 struct wpabuf;
  77
  78 void eap_sim_derive_mk(const u8 *identity, size_t identity_len,
  79                        const u8 *nonce_mt, u16 selected_version,
  80                        const u8 *ver_list, size_t ver_list_len,
  81                        int num_chal, const u8 *kc, u8 *mk);
  82 void eap_aka_derive_mk(const u8 *identity, size_t identity_len,
  83                        const u8 *ik, const u8 *ck, u8 *mk);
  84 int eap_sim_derive_keys(const u8 *mk, u8 *k_encr, u8 *k_aut, u8 *msk,
  85                         u8 *emsk);
  86 int eap_sim_derive_keys_reauth(u16 _counter,
  87                                const u8 *identity, size_t identity_len,
  88                                const u8 *nonce_s, const u8 *mk, u8 *msk,
  89                                u8 *emsk);
  90 int eap_sim_verify_mac(const u8 *k_aut, const struct wpabuf *req,
  91                        const u8 *mac, const u8 *extra, size_t extra_len);
  92 void eap_sim_add_mac(const u8 *k_aut, const u8 *msg, size_t msg_len, u8 *mac,
  93                      const u8 *extra, size_t extra_len);
  94
  95 #if defined(EAP_AKA_PRIME) || defined(EAP_SERVER_AKA_PRIME)
  96 void eap_aka_prime_derive_keys(const u8 *identity, size_t identity_len,
  97                                const u8 *ik, const u8 *ck, u8 *k_encr,
  98                                u8 *k_aut, u8 *k_re, u8 *msk, u8 *emsk);
  99 int eap_aka_prime_derive_keys_reauth(const u8 *k_re, u16 counter,
 100                                      const u8 *identity, size_t identity_len,
 101                                      const u8 *nonce_s, u8 *msk, u8 *emsk);
 102 int eap_sim_verify_mac_sha256(const u8 *k_aut, const struct wpabuf *req,
 103                               const u8 *mac, const u8 *extra,
 104                               size_t extra_len);
 105 void eap_sim_add_mac_sha256(const u8 *k_aut, const u8 *msg, size_t msg_len,
 106                             u8 *mac, const u8 *extra, size_t extra_len);
 107
 108 void eap_aka_prime_derive_ck_ik_prime(u8 *ck, u8 *ik, const u8 *sqn_ak,
 109                                       const u8 *network_name,
 110                                       size_t network_name_len);
 111 #else /* EAP_AKA_PRIME || EAP_SERVER_AKA_PRIME */
 112 static inline void eap_aka_prime_derive_keys(const u8 *identity,
 113                                              size_t identity_len,
 114                                              const u8 *ik, const u8 *ck,
 115                                              u8 *k_encr, u8 *k_aut, u8 *k_re,
 116                                              u8 *msk, u8 *emsk)
 117 {
 118 }
 119
 120 static inline int eap_aka_prime_derive_keys_reauth(const u8 *k_re, u16 counter,
 121                                                    const u8 *identity,
 122                                                    size_t identity_len,
 123                                                    const u8 *nonce_s, u8 *msk,
 124                                                    u8 *emsk)
 125 {
 126         return -1;
 127 }
 128
 129 static inline int eap_sim_verify_mac_sha256(const u8 *k_aut,
 130                                             const struct wpabuf *req,
 131                                             const u8 *mac, const u8 *extra,
 132                                             size_t extra_len)
 133 {
 134         return -1;
 135 }
 136 #endif /* EAP_AKA_PRIME || EAP_SERVER_AKA_PRIME */
 137
 138
 139 /* EAP-SIM/AKA Attributes (0..127 non-skippable) */
 140 #define EAP_SIM_AT_RAND 1
 141 #define EAP_SIM_AT_AUTN 2 /* only AKA */
 142 #define EAP_SIM_AT_RES 3 /* only AKA, only peer->server */
 143 #define EAP_SIM_AT_AUTS 4 /* only AKA, only peer->server */
 144 #define EAP_SIM_AT_PADDING 6 /* only encrypted */
 145 #define EAP_SIM_AT_NONCE_MT 7 /* only SIM, only send */
 146 #define EAP_SIM_AT_PERMANENT_ID_REQ 10
 147 #define EAP_SIM_AT_MAC 11
 148 #define EAP_SIM_AT_NOTIFICATION 12
 149 #define EAP_SIM_AT_ANY_ID_REQ 13
 150 #define EAP_SIM_AT_IDENTITY 14 /* only send */
 151 #define EAP_SIM_AT_VERSION_LIST 15 /* only SIM */
 152 #define EAP_SIM_AT_SELECTED_VERSION 16 /* only SIM */
 153 #define EAP_SIM_AT_FULLAUTH_ID_REQ 17
 154 #define EAP_SIM_AT_COUNTER 19 /* only encrypted */
 155 #define EAP_SIM_AT_COUNTER_TOO_SMALL 20 /* only encrypted */
 156 #define EAP_SIM_AT_NONCE_S 21 /* only encrypted */
 157 #define EAP_SIM_AT_CLIENT_ERROR_CODE 22 /* only send */
 158 #define EAP_SIM_AT_KDF_INPUT 23 /* only AKA' */
 159 #define EAP_SIM_AT_KDF 24 /* only AKA' */
 160 #define EAP_SIM_AT_IV 129
 161 #define EAP_SIM_AT_ENCR_DATA 130
 162 #define EAP_SIM_AT_NEXT_PSEUDONYM 132 /* only encrypted */
 163 #define EAP_SIM_AT_NEXT_REAUTH_ID 133 /* only encrypted */
 164 #define EAP_SIM_AT_CHECKCODE 134 /* only AKA */
 165 #define EAP_SIM_AT_RESULT_IND 135
 166 #define EAP_SIM_AT_BIDDING 136
 167
 168 /* AT_NOTIFICATION notification code values */
 169 #define EAP_SIM_GENERAL_FAILURE_AFTER_AUTH 0
 170 #define EAP_SIM_TEMPORARILY_DENIED 1026
 171 #define EAP_SIM_NOT_SUBSCRIBED 1031
 172 #define EAP_SIM_GENERAL_FAILURE_BEFORE_AUTH 16384
 173 #define EAP_SIM_SUCCESS 32768
 174
 175 /* EAP-AKA' AT_KDF Key Derivation Function values */
 176 #define EAP_AKA_PRIME_KDF 1
 177
 178 /* AT_BIDDING flags */
 179 #define EAP_AKA_BIDDING_FLAG_D 0x8000
 180
 181
 182 enum eap_sim_id_req {
 183         NO_ID_REQ, ANY_ID, FULLAUTH_ID, PERMANENT_ID
 184 };
 185
 186
 187 struct eap_sim_attrs {
 188         const u8 *rand, *autn, *mac, *iv, *encr_data, *version_list, *nonce_s;
 189         const u8 *next_pseudonym, *next_reauth_id;
 190         const u8 *nonce_mt, *identity, *res, *auts;
 191         const u8 *checkcode;
 192         const u8 *kdf_input;
 193         const u8 *bidding;
 194         size_t num_chal, version_list_len, encr_data_len;
 195         size_t next_pseudonym_len, next_reauth_id_len, identity_len, res_len;
 196         size_t res_len_bits;
 197         size_t checkcode_len;
 198         size_t kdf_input_len;
 199         enum eap_sim_id_req id_req;
 200         int notification, counter, selected_version, client_error_code;
 201         int counter_too_small;
 202         int result_ind;
 203 #define EAP_AKA_PRIME_KDF_MAX 10
 204         u16 kdf[EAP_AKA_PRIME_KDF_MAX];
 205         size_t kdf_count;
 206 };
 207
 208 int eap_sim_parse_attr(const u8 *start, const u8 *end,
 209                        struct eap_sim_attrs *attr, int aka, int encr);
 210 u8 * eap_sim_parse_encr(const u8 *k_encr, const u8 *encr_data,
 211                         size_t encr_data_len, const u8 *iv,
 212                         struct eap_sim_attrs *attr, int aka);
 213
 214
 215 struct eap_sim_msg;
 216
 217 struct eap_sim_msg * eap_sim_msg_init(int code, int id, int type, int subtype);
 218 struct wpabuf * eap_sim_msg_finish(struct eap_sim_msg *msg, int type,
 219                                    const u8 *k_aut,
 220                                    const u8 *extra, size_t extra_len);
 221 void eap_sim_msg_free(struct eap_sim_msg *msg);
 222 u8 * eap_sim_msg_add_full(struct eap_sim_msg *msg, u8 attr,
 223                           const u8 *data, size_t len);
 224 u8 * eap_sim_msg_add(struct eap_sim_msg *msg, u8 attr,
 225                      u16 value, const u8 *data, size_t len);
 226 u8 * eap_sim_msg_add_mac(struct eap_sim_msg *msg, u8 attr);
 227 int eap_sim_msg_add_encr_start(struct eap_sim_msg *msg, u8 attr_iv,
 228                                u8 attr_encr);
 229 int eap_sim_msg_add_encr_end(struct eap_sim_msg *msg, u8 *k_encr,
 230                              int attr_pad);
 231
 232 void eap_sim_report_notification(void *msg_ctx, int notification, int aka);
 233
 234 #ifdef __cplusplus
 235 }
 236 #endif
 237
 238 #endif /* EAP_SIM_COMMON_H */