2 * EAP-IKEv2 peer (RFC 5106)
3 * Copyright (c) 2007-2014, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
13 #include "eap_common/eap_ikev2_common.h"
17 struct eap_ikev2_data {
18 struct ikev2_responder_data ikev2;
19 enum { WAIT_START, PROC_MSG, WAIT_FRAG_ACK, DONE, FAIL } state;
20 struct wpabuf *in_buf;
21 struct wpabuf *out_buf;
25 u8 keymat[EAP_MSK_LEN + EAP_EMSK_LEN];
30 static const char * eap_ikev2_state_txt(int state)
38 return "WAIT_FRAG_ACK";
49 static void eap_ikev2_state(struct eap_ikev2_data *data, int state)
51 wpa_printf(MSG_DEBUG, "EAP-IKEV2: %s -> %s",
52 eap_ikev2_state_txt(data->state),
53 eap_ikev2_state_txt(state));
58 static void * eap_ikev2_init(struct eap_sm *sm)
60 struct eap_ikev2_data *data;
61 const u8 *identity, *password;
62 size_t identity_len, password_len;
65 identity = eap_get_config_identity(sm, &identity_len);
66 if (identity == NULL) {
67 wpa_printf(MSG_INFO, "EAP-IKEV2: No identity available");
71 data = os_zalloc(sizeof(*data));
74 data->state = WAIT_START;
75 fragment_size = eap_get_config_fragment_size(sm);
76 if (fragment_size <= 0)
77 data->fragment_size = IKEV2_FRAGMENT_SIZE;
79 data->fragment_size = fragment_size;
80 data->ikev2.state = SA_INIT;
81 data->ikev2.peer_auth = PEER_AUTH_SECRET;
82 data->ikev2.key_pad = (u8 *) os_strdup("Key Pad for EAP-IKEv2");
83 if (data->ikev2.key_pad == NULL)
85 data->ikev2.key_pad_len = 21;
86 data->ikev2.IDr = os_malloc(identity_len);
87 if (data->ikev2.IDr == NULL)
89 os_memcpy(data->ikev2.IDr, identity, identity_len);
90 data->ikev2.IDr_len = identity_len;
92 password = eap_get_config_password(sm, &password_len);
94 data->ikev2.shared_secret = os_malloc(password_len);
95 if (data->ikev2.shared_secret == NULL)
97 os_memcpy(data->ikev2.shared_secret, password, password_len);
98 data->ikev2.shared_secret_len = password_len;
104 ikev2_responder_deinit(&data->ikev2);
110 static void eap_ikev2_deinit(struct eap_sm *sm, void *priv)
112 struct eap_ikev2_data *data = priv;
113 wpabuf_free(data->in_buf);
114 wpabuf_free(data->out_buf);
115 ikev2_responder_deinit(&data->ikev2);
120 static int eap_ikev2_peer_keymat(struct eap_ikev2_data *data)
122 if (eap_ikev2_derive_keymat(
123 data->ikev2.proposal.prf, &data->ikev2.keys,
124 data->ikev2.i_nonce, data->ikev2.i_nonce_len,
125 data->ikev2.r_nonce, data->ikev2.r_nonce_len,
127 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Failed to "
128 "derive key material");
136 static struct wpabuf * eap_ikev2_build_msg(struct eap_ikev2_data *data,
137 struct eap_method_ret *ret, u8 id)
141 size_t send_len, plen, icv_len = 0;
144 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Generating Response");
145 ret->allowNotifications = TRUE;
148 send_len = wpabuf_len(data->out_buf) - data->out_used;
149 if (1 + send_len > data->fragment_size) {
150 send_len = data->fragment_size - 1;
151 flags |= IKEV2_FLAGS_MORE_FRAGMENTS;
152 if (data->out_used == 0) {
153 flags |= IKEV2_FLAGS_LENGTH_INCLUDED;
158 /* Some issues figuring out the length of the message if Message Length
159 * field not included?! */
160 if (!(flags & IKEV2_FLAGS_LENGTH_INCLUDED))
161 flags |= IKEV2_FLAGS_LENGTH_INCLUDED;
165 if (flags & IKEV2_FLAGS_LENGTH_INCLUDED)
167 if (data->keys_ready) {
168 const struct ikev2_integ_alg *integ;
169 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Add Integrity Checksum "
171 flags |= IKEV2_FLAGS_ICV_INCLUDED;
172 integ = ikev2_get_integ(data->ikev2.proposal.integ);
174 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Unknown INTEG "
175 "transform / cannot generate ICV");
178 icv_len = integ->hash_len;
182 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_IKEV2, plen,
183 EAP_CODE_RESPONSE, id);
187 wpabuf_put_u8(resp, flags); /* Flags */
188 if (flags & IKEV2_FLAGS_LENGTH_INCLUDED)
189 wpabuf_put_be32(resp, wpabuf_len(data->out_buf));
191 wpabuf_put_data(resp, wpabuf_head_u8(data->out_buf) + data->out_used,
193 data->out_used += send_len;
195 if (flags & IKEV2_FLAGS_ICV_INCLUDED) {
196 const u8 *msg = wpabuf_head(resp);
197 size_t len = wpabuf_len(resp);
198 ikev2_integ_hash(data->ikev2.proposal.integ,
199 data->ikev2.keys.SK_ar,
200 data->ikev2.keys.SK_integ_len,
201 msg, len, wpabuf_put(resp, icv_len));
204 ret->methodState = METHOD_MAY_CONT;
205 ret->decision = DECISION_FAIL;
207 if (data->out_used == wpabuf_len(data->out_buf)) {
208 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Sending out %lu bytes "
209 "(message sent completely)",
210 (unsigned long) send_len);
211 wpabuf_free(data->out_buf);
212 data->out_buf = NULL;
214 switch (data->ikev2.state) {
216 /* SA_INIT was sent out, so message have to be
217 * integrity protected from now on. */
218 data->keys_ready = 1;
221 ret->methodState = METHOD_DONE;
222 if (data->state == FAIL)
224 ret->decision = DECISION_COND_SUCC;
225 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Authentication "
226 "completed successfully");
227 if (eap_ikev2_peer_keymat(data))
229 eap_ikev2_state(data, DONE);
232 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Authentication "
234 ret->methodState = METHOD_DONE;
235 ret->decision = DECISION_FAIL;
241 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Sending out %lu bytes "
242 "(%lu more to send)", (unsigned long) send_len,
243 (unsigned long) wpabuf_len(data->out_buf) -
245 eap_ikev2_state(data, WAIT_FRAG_ACK);
252 static int eap_ikev2_process_icv(struct eap_ikev2_data *data,
253 const struct wpabuf *reqData,
254 u8 flags, const u8 *pos, const u8 **end)
256 if (flags & IKEV2_FLAGS_ICV_INCLUDED) {
257 int icv_len = eap_ikev2_validate_icv(
258 data->ikev2.proposal.integ, &data->ikev2.keys, 1,
262 /* Hide Integrity Checksum Data from further processing */
264 } else if (data->keys_ready) {
265 wpa_printf(MSG_INFO, "EAP-IKEV2: The message should have "
266 "included integrity checksum");
274 static int eap_ikev2_process_cont(struct eap_ikev2_data *data,
275 const u8 *buf, size_t len)
277 /* Process continuation of a pending message */
278 if (len > wpabuf_tailroom(data->in_buf)) {
279 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Fragment overflow");
280 eap_ikev2_state(data, FAIL);
284 wpabuf_put_data(data->in_buf, buf, len);
285 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Received %lu bytes, waiting "
286 "for %lu bytes more", (unsigned long) len,
287 (unsigned long) wpabuf_tailroom(data->in_buf));
293 static struct wpabuf * eap_ikev2_process_fragment(struct eap_ikev2_data *data,
294 struct eap_method_ret *ret,
297 const u8 *buf, size_t len)
299 /* Process a fragment that is not the last one of the message */
300 if (data->in_buf == NULL && !(flags & IKEV2_FLAGS_LENGTH_INCLUDED)) {
301 wpa_printf(MSG_DEBUG, "EAP-IKEV2: No Message Length field in "
302 "a fragmented packet");
307 if (data->in_buf == NULL) {
308 /* First fragment of the message */
309 data->in_buf = wpabuf_alloc(message_length);
310 if (data->in_buf == NULL) {
311 wpa_printf(MSG_DEBUG, "EAP-IKEV2: No memory for "
316 wpabuf_put_data(data->in_buf, buf, len);
317 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Received %lu bytes in first "
318 "fragment, waiting for %lu bytes more",
320 (unsigned long) wpabuf_tailroom(data->in_buf));
323 return eap_ikev2_build_frag_ack(id, EAP_CODE_RESPONSE);
327 static struct wpabuf * eap_ikev2_process(struct eap_sm *sm, void *priv,
328 struct eap_method_ret *ret,
329 const struct wpabuf *reqData)
331 struct eap_ikev2_data *data = priv;
332 const u8 *start, *pos, *end;
335 u32 message_length = 0;
336 struct wpabuf tmpbuf;
338 pos = eap_hdr_validate(EAP_VENDOR_IETF, EAP_TYPE_IKEV2, reqData, &len);
344 id = eap_get_id(reqData);
350 flags = 0; /* fragment ack */
354 if (eap_ikev2_process_icv(data, reqData, flags, pos, &end) < 0) {
359 if (flags & IKEV2_FLAGS_LENGTH_INCLUDED) {
361 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Message underflow");
365 message_length = WPA_GET_BE32(pos);
368 if (message_length < (u32) (end - pos)) {
369 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Invalid Message "
370 "Length (%d; %ld remaining in this msg)",
371 message_length, (long) (end - pos));
377 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Received packet: Flags 0x%x "
378 "Message Length %u", flags, message_length);
380 if (data->state == WAIT_FRAG_ACK) {
382 if (len > 1) /* Empty Flags field included in ACK */
387 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Unexpected payload "
388 "in WAIT_FRAG_ACK state");
392 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Fragment acknowledged");
393 eap_ikev2_state(data, PROC_MSG);
394 return eap_ikev2_build_msg(data, ret, id);
397 if (data->in_buf && eap_ikev2_process_cont(data, pos, end - pos) < 0) {
402 if (flags & IKEV2_FLAGS_MORE_FRAGMENTS) {
403 return eap_ikev2_process_fragment(data, ret, id, flags,
408 if (data->in_buf == NULL) {
409 /* Wrap unfragmented messages as wpabuf without extra copy */
410 wpabuf_set(&tmpbuf, pos, end - pos);
411 data->in_buf = &tmpbuf;
414 if (ikev2_responder_process(&data->ikev2, data->in_buf) < 0) {
415 if (data->in_buf == &tmpbuf)
417 eap_ikev2_state(data, FAIL);
421 if (data->in_buf != &tmpbuf)
422 wpabuf_free(data->in_buf);
425 if (data->out_buf == NULL) {
426 data->out_buf = ikev2_responder_build(&data->ikev2);
427 if (data->out_buf == NULL) {
428 wpa_printf(MSG_DEBUG, "EAP-IKEV2: Failed to generate "
435 eap_ikev2_state(data, PROC_MSG);
436 return eap_ikev2_build_msg(data, ret, id);
440 static Boolean eap_ikev2_isKeyAvailable(struct eap_sm *sm, void *priv)
442 struct eap_ikev2_data *data = priv;
443 return data->state == DONE && data->keymat_ok;
447 static u8 * eap_ikev2_getKey(struct eap_sm *sm, void *priv, size_t *len)
449 struct eap_ikev2_data *data = priv;
452 if (data->state != DONE || !data->keymat_ok)
455 key = os_malloc(EAP_MSK_LEN);
457 os_memcpy(key, data->keymat, EAP_MSK_LEN);
465 static u8 * eap_ikev2_get_emsk(struct eap_sm *sm, void *priv, size_t *len)
467 struct eap_ikev2_data *data = priv;
470 if (data->state != DONE || !data->keymat_ok)
473 key = os_malloc(EAP_EMSK_LEN);
475 os_memcpy(key, data->keymat + EAP_MSK_LEN, EAP_EMSK_LEN);
483 static u8 * eap_ikev2_get_session_id(struct eap_sm *sm, void *priv, size_t *len)
485 struct eap_ikev2_data *data = priv;
490 if (data->state != DONE || !data->keymat_ok)
493 sid_len = 1 + data->ikev2.i_nonce_len + data->ikev2.r_nonce_len;
494 sid = os_malloc(sid_len);
497 sid[offset] = EAP_TYPE_IKEV2;
499 os_memcpy(sid + offset, data->ikev2.i_nonce,
500 data->ikev2.i_nonce_len);
501 offset += data->ikev2.i_nonce_len;
502 os_memcpy(sid + offset, data->ikev2.r_nonce,
503 data->ikev2.r_nonce_len);
505 wpa_hexdump(MSG_DEBUG, "EAP-IKEV2: Derived Session-Id",
513 int eap_peer_ikev2_register(void)
515 struct eap_method *eap;
518 eap = eap_peer_method_alloc(EAP_PEER_METHOD_INTERFACE_VERSION,
519 EAP_VENDOR_IETF, EAP_TYPE_IKEV2,
524 eap->init = eap_ikev2_init;
525 eap->deinit = eap_ikev2_deinit;
526 eap->process = eap_ikev2_process;
527 eap->isKeyAvailable = eap_ikev2_isKeyAvailable;
528 eap->getKey = eap_ikev2_getKey;
529 eap->get_emsk = eap_ikev2_get_emsk;
530 eap->getSessionId = eap_ikev2_get_session_id;
532 ret = eap_peer_method_register(eap);
534 eap_peer_method_free(eap);