← Back to branch summary

~ubuntu-branches/ubuntu/utopic/moonshot-gss-eap/utopic-backports

« back to all changes in this revision

Viewing changes to libeap/src/eap_common/eap_sim_common.h

  • Committer: Package Import Robot
  • Author(s): Sam Hartman
  • Date: 2014-09-16 08:38:39 UTC
  • Revision ID: package-import@ubuntu.com-20140916083839-ipqco3thb1wcwvs0
Tags: upstream-0.9.2
Import upstream version 0.9.2

Show diffs side-by-side

added added

removed removed

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