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