2 * EAP peer method: EAP-GPSK (RFC 5433)
3 * Copyright (c) 2006-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.
12 #include "crypto/random.h"
13 #include "eap_peer/eap_i.h"
14 #include "eap_common/eap_gpsk_common.h"
16 struct eap_gpsk_data {
17 enum { GPSK_1, GPSK_3, SUCCESS, FAILURE } state;
18 u8 rand_server[EAP_GPSK_RAND_LEN];
19 u8 rand_peer[EAP_GPSK_RAND_LEN];
21 u8 emsk[EAP_EMSK_LEN];
22 u8 sk[EAP_GPSK_MAX_SK_LEN];
24 u8 pk[EAP_GPSK_MAX_PK_LEN];
32 int vendor; /* CSuite/Specifier */
33 int specifier; /* CSuite/Specifier */
36 u16 forced_cipher; /* force cipher or 0 to allow all supported */
40 static struct wpabuf * eap_gpsk_send_gpsk_2(struct eap_gpsk_data *data,
42 const u8 *csuite_list,
43 size_t csuite_list_len);
44 static struct wpabuf * eap_gpsk_send_gpsk_4(struct eap_gpsk_data *data,
48 #ifndef CONFIG_NO_STDOUT_DEBUG
49 static const char * eap_gpsk_state_txt(int state)
64 #endif /* CONFIG_NO_STDOUT_DEBUG */
67 static void eap_gpsk_state(struct eap_gpsk_data *data, int state)
69 wpa_printf(MSG_DEBUG, "EAP-GPSK: %s -> %s",
70 eap_gpsk_state_txt(data->state),
71 eap_gpsk_state_txt(state));
76 static void eap_gpsk_deinit(struct eap_sm *sm, void *priv);
79 static void * eap_gpsk_init(struct eap_sm *sm)
81 struct eap_gpsk_data *data;
82 const u8 *identity, *password;
83 size_t identity_len, password_len;
86 password = eap_get_config_password(sm, &password_len);
87 if (password == NULL) {
88 wpa_printf(MSG_INFO, "EAP-GPSK: No key (password) configured");
92 data = os_zalloc(sizeof(*data));
97 identity = eap_get_config_identity(sm, &identity_len);
99 data->id_peer = os_malloc(identity_len);
100 if (data->id_peer == NULL) {
101 eap_gpsk_deinit(sm, data);
104 os_memcpy(data->id_peer, identity, identity_len);
105 data->id_peer_len = identity_len;
108 phase1 = eap_get_config_phase1(sm);
112 pos = os_strstr(phase1, "cipher=");
114 data->forced_cipher = atoi(pos + 7);
115 wpa_printf(MSG_DEBUG, "EAP-GPSK: Forced cipher %u",
116 data->forced_cipher);
120 data->psk = os_malloc(password_len);
121 if (data->psk == NULL) {
122 eap_gpsk_deinit(sm, data);
125 os_memcpy(data->psk, password, password_len);
126 data->psk_len = password_len;
132 static void eap_gpsk_deinit(struct eap_sm *sm, void *priv)
134 struct eap_gpsk_data *data = priv;
135 os_free(data->id_server);
136 os_free(data->id_peer);
138 os_memset(data->psk, 0, data->psk_len);
141 bin_clear_free(data, sizeof(*data));
145 static const u8 * eap_gpsk_process_id_server(struct eap_gpsk_data *data,
146 const u8 *pos, const u8 *end)
151 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short GPSK-1 packet");
154 alen = WPA_GET_BE16(pos);
156 if (end - pos < alen) {
157 wpa_printf(MSG_DEBUG, "EAP-GPSK: ID_Server overflow");
160 os_free(data->id_server);
161 data->id_server = os_malloc(alen);
162 if (data->id_server == NULL) {
163 wpa_printf(MSG_DEBUG, "EAP-GPSK: No memory for ID_Server");
166 os_memcpy(data->id_server, pos, alen);
167 data->id_server_len = alen;
168 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Server",
169 data->id_server, data->id_server_len);
176 static const u8 * eap_gpsk_process_rand_server(struct eap_gpsk_data *data,
177 const u8 *pos, const u8 *end)
182 if (end - pos < EAP_GPSK_RAND_LEN) {
183 wpa_printf(MSG_DEBUG, "EAP-GPSK: RAND_Server overflow");
186 os_memcpy(data->rand_server, pos, EAP_GPSK_RAND_LEN);
187 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Server",
188 data->rand_server, EAP_GPSK_RAND_LEN);
189 pos += EAP_GPSK_RAND_LEN;
195 static int eap_gpsk_select_csuite(struct eap_sm *sm,
196 struct eap_gpsk_data *data,
197 const u8 *csuite_list,
198 size_t csuite_list_len)
200 struct eap_gpsk_csuite *csuite;
203 count = csuite_list_len / sizeof(struct eap_gpsk_csuite);
204 data->vendor = EAP_GPSK_VENDOR_IETF;
205 data->specifier = EAP_GPSK_CIPHER_RESERVED;
206 csuite = (struct eap_gpsk_csuite *) csuite_list;
207 for (i = 0; i < count; i++) {
208 int vendor, specifier;
209 vendor = WPA_GET_BE32(csuite->vendor);
210 specifier = WPA_GET_BE16(csuite->specifier);
211 wpa_printf(MSG_DEBUG, "EAP-GPSK: CSuite[%d]: %d:%d",
212 i, vendor, specifier);
213 if (data->vendor == EAP_GPSK_VENDOR_IETF &&
214 data->specifier == EAP_GPSK_CIPHER_RESERVED &&
215 eap_gpsk_supported_ciphersuite(vendor, specifier) &&
216 (!data->forced_cipher || data->forced_cipher == specifier))
218 data->vendor = vendor;
219 data->specifier = specifier;
223 if (data->vendor == EAP_GPSK_VENDOR_IETF &&
224 data->specifier == EAP_GPSK_CIPHER_RESERVED) {
225 wpa_msg(sm->msg_ctx, MSG_INFO, "EAP-GPSK: No supported "
226 "ciphersuite found");
229 wpa_printf(MSG_DEBUG, "EAP-GPSK: Selected ciphersuite %d:%d",
230 data->vendor, data->specifier);
236 static const u8 * eap_gpsk_process_csuite_list(struct eap_sm *sm,
237 struct eap_gpsk_data *data,
240 const u8 *pos, const u8 *end)
248 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short GPSK-1 packet");
251 len = WPA_GET_BE16(pos);
253 if (len > (size_t) (end - pos)) {
254 wpa_printf(MSG_DEBUG, "EAP-GPSK: CSuite_List overflow");
257 if (len == 0 || (len % sizeof(struct eap_gpsk_csuite))) {
258 wpa_printf(MSG_DEBUG, "EAP-GPSK: Invalid CSuite_List len %lu",
259 (unsigned long) len);
263 if (eap_gpsk_select_csuite(sm, data, pos, len) < 0)
274 static struct wpabuf * eap_gpsk_process_gpsk_1(struct eap_sm *sm,
275 struct eap_gpsk_data *data,
276 struct eap_method_ret *ret,
281 size_t csuite_list_len;
282 const u8 *csuite_list, *pos, *end;
285 if (data->state != GPSK_1) {
290 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received Request/GPSK-1");
292 end = payload + payload_len;
294 pos = eap_gpsk_process_id_server(data, payload, end);
295 pos = eap_gpsk_process_rand_server(data, pos, end);
296 pos = eap_gpsk_process_csuite_list(sm, data, &csuite_list,
297 &csuite_list_len, pos, end);
299 ret->methodState = METHOD_DONE;
300 eap_gpsk_state(data, FAILURE);
304 resp = eap_gpsk_send_gpsk_2(data, identifier,
305 csuite_list, csuite_list_len);
309 eap_gpsk_state(data, GPSK_3);
315 static struct wpabuf * eap_gpsk_send_gpsk_2(struct eap_gpsk_data *data,
317 const u8 *csuite_list,
318 size_t csuite_list_len)
323 struct eap_gpsk_csuite *csuite;
325 wpa_printf(MSG_DEBUG, "EAP-GPSK: Sending Response/GPSK-2");
327 miclen = eap_gpsk_mic_len(data->vendor, data->specifier);
328 len = 1 + 2 + data->id_peer_len + 2 + data->id_server_len +
329 2 * EAP_GPSK_RAND_LEN + 2 + csuite_list_len +
330 sizeof(struct eap_gpsk_csuite) + 2 + miclen;
332 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_GPSK, len,
333 EAP_CODE_RESPONSE, identifier);
337 wpabuf_put_u8(resp, EAP_GPSK_OPCODE_GPSK_2);
338 start = wpabuf_put(resp, 0);
340 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Peer",
341 data->id_peer, data->id_peer_len);
342 wpabuf_put_be16(resp, data->id_peer_len);
343 wpabuf_put_data(resp, data->id_peer, data->id_peer_len);
345 wpabuf_put_be16(resp, data->id_server_len);
346 wpabuf_put_data(resp, data->id_server, data->id_server_len);
348 if (random_get_bytes(data->rand_peer, EAP_GPSK_RAND_LEN)) {
349 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to get random data "
351 eap_gpsk_state(data, FAILURE);
355 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Peer",
356 data->rand_peer, EAP_GPSK_RAND_LEN);
357 wpabuf_put_data(resp, data->rand_peer, EAP_GPSK_RAND_LEN);
358 wpabuf_put_data(resp, data->rand_server, EAP_GPSK_RAND_LEN);
360 wpabuf_put_be16(resp, csuite_list_len);
361 wpabuf_put_data(resp, csuite_list, csuite_list_len);
363 csuite = wpabuf_put(resp, sizeof(*csuite));
364 WPA_PUT_BE32(csuite->vendor, data->vendor);
365 WPA_PUT_BE16(csuite->specifier, data->specifier);
367 if (eap_gpsk_derive_keys(data->psk, data->psk_len,
368 data->vendor, data->specifier,
369 data->rand_peer, data->rand_server,
370 data->id_peer, data->id_peer_len,
371 data->id_server, data->id_server_len,
372 data->msk, data->emsk,
373 data->sk, &data->sk_len,
374 data->pk, &data->pk_len) < 0) {
375 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to derive keys");
376 eap_gpsk_state(data, FAILURE);
381 if (eap_gpsk_derive_session_id(data->psk, data->psk_len,
382 data->vendor, data->specifier,
383 data->rand_peer, data->rand_server,
384 data->id_peer, data->id_peer_len,
385 data->id_server, data->id_server_len,
387 data->session_id, &data->id_len) < 0) {
388 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to derive Session-Id");
389 eap_gpsk_state(data, FAILURE);
393 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Derived Session-Id",
394 data->session_id, data->id_len);
396 /* No PD_Payload_1 */
397 wpabuf_put_be16(resp, 0);
399 rpos = wpabuf_put(resp, miclen);
400 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
401 data->specifier, start, rpos - start, rpos) <
403 eap_gpsk_state(data, FAILURE);
412 static const u8 * eap_gpsk_validate_rand(struct eap_gpsk_data *data,
413 const u8 *pos, const u8 *end)
415 if (end - pos < EAP_GPSK_RAND_LEN) {
416 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
420 if (os_memcmp(pos, data->rand_peer, EAP_GPSK_RAND_LEN) != 0) {
421 wpa_printf(MSG_DEBUG, "EAP-GPSK: RAND_Peer in GPSK-2 and "
422 "GPSK-3 did not match");
423 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Peer in GPSK-2",
424 data->rand_peer, EAP_GPSK_RAND_LEN);
425 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Peer in GPSK-3",
426 pos, EAP_GPSK_RAND_LEN);
429 pos += EAP_GPSK_RAND_LEN;
431 if (end - pos < EAP_GPSK_RAND_LEN) {
432 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
436 if (os_memcmp(pos, data->rand_server, EAP_GPSK_RAND_LEN) != 0) {
437 wpa_printf(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-1 and "
438 "GPSK-3 did not match");
439 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-1",
440 data->rand_server, EAP_GPSK_RAND_LEN);
441 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-3",
442 pos, EAP_GPSK_RAND_LEN);
445 pos += EAP_GPSK_RAND_LEN;
451 static const u8 * eap_gpsk_validate_id_server(struct eap_gpsk_data *data,
452 const u8 *pos, const u8 *end)
459 if (end - pos < (int) 2) {
460 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
461 "length(ID_Server)");
465 len = WPA_GET_BE16(pos);
468 if (end - pos < (int) len) {
469 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
474 if (len != data->id_server_len ||
475 os_memcmp(pos, data->id_server, len) != 0) {
476 wpa_printf(MSG_INFO, "EAP-GPSK: ID_Server did not match with "
477 "the one used in GPSK-1");
478 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Server in GPSK-1",
479 data->id_server, data->id_server_len);
480 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Server in GPSK-3",
491 static const u8 * eap_gpsk_validate_csuite(struct eap_gpsk_data *data,
492 const u8 *pos, const u8 *end)
494 int vendor, specifier;
495 const struct eap_gpsk_csuite *csuite;
500 if (end - pos < (int) sizeof(*csuite)) {
501 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
505 csuite = (const struct eap_gpsk_csuite *) pos;
506 vendor = WPA_GET_BE32(csuite->vendor);
507 specifier = WPA_GET_BE16(csuite->specifier);
508 pos += sizeof(*csuite);
509 if (vendor != data->vendor || specifier != data->specifier) {
510 wpa_printf(MSG_DEBUG, "EAP-GPSK: CSuite_Sel (%d:%d) does not "
511 "match with the one sent in GPSK-2 (%d:%d)",
512 vendor, specifier, data->vendor, data->specifier);
520 static const u8 * eap_gpsk_validate_pd_payload_2(struct eap_gpsk_data *data,
521 const u8 *pos, const u8 *end)
529 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
530 "PD_Payload_2 length");
533 alen = WPA_GET_BE16(pos);
535 if (end - pos < alen) {
536 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
537 "%d-octet PD_Payload_2", alen);
540 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: PD_Payload_2", pos, alen);
547 static const u8 * eap_gpsk_validate_gpsk_3_mic(struct eap_gpsk_data *data,
549 const u8 *pos, const u8 *end)
552 u8 mic[EAP_GPSK_MAX_MIC_LEN];
557 miclen = eap_gpsk_mic_len(data->vendor, data->specifier);
558 if (end - pos < (int) miclen) {
559 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for MIC "
560 "(left=%lu miclen=%lu)",
561 (unsigned long) (end - pos),
562 (unsigned long) miclen);
565 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
566 data->specifier, payload, pos - payload, mic)
568 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to compute MIC");
571 if (os_memcmp_const(mic, pos, miclen) != 0) {
572 wpa_printf(MSG_INFO, "EAP-GPSK: Incorrect MIC in GPSK-3");
573 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Received MIC", pos, miclen);
574 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Computed MIC", mic, miclen);
583 static struct wpabuf * eap_gpsk_process_gpsk_3(struct eap_sm *sm,
584 struct eap_gpsk_data *data,
585 struct eap_method_ret *ret,
593 if (data->state != GPSK_3) {
598 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received Request/GPSK-3");
600 end = payload + payload_len;
602 pos = eap_gpsk_validate_rand(data, payload, end);
603 pos = eap_gpsk_validate_id_server(data, pos, end);
604 pos = eap_gpsk_validate_csuite(data, pos, end);
605 pos = eap_gpsk_validate_pd_payload_2(data, pos, end);
606 pos = eap_gpsk_validate_gpsk_3_mic(data, payload, pos, end);
609 eap_gpsk_state(data, FAILURE);
613 wpa_printf(MSG_DEBUG, "EAP-GPSK: Ignored %lu bytes of extra "
614 "data in the end of GPSK-2",
615 (unsigned long) (end - pos));
618 resp = eap_gpsk_send_gpsk_4(data, identifier);
622 eap_gpsk_state(data, SUCCESS);
623 ret->methodState = METHOD_DONE;
624 ret->decision = DECISION_UNCOND_SUCC;
630 static struct wpabuf * eap_gpsk_send_gpsk_4(struct eap_gpsk_data *data,
637 wpa_printf(MSG_DEBUG, "EAP-GPSK: Sending Response/GPSK-4");
639 mlen = eap_gpsk_mic_len(data->vendor, data->specifier);
641 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_GPSK, 1 + 2 + mlen,
642 EAP_CODE_RESPONSE, identifier);
646 wpabuf_put_u8(resp, EAP_GPSK_OPCODE_GPSK_4);
647 start = wpabuf_put(resp, 0);
649 /* No PD_Payload_3 */
650 wpabuf_put_be16(resp, 0);
652 rpos = wpabuf_put(resp, mlen);
653 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
654 data->specifier, start, rpos - start, rpos) <
656 eap_gpsk_state(data, FAILURE);
665 static struct wpabuf * eap_gpsk_process(struct eap_sm *sm, void *priv,
666 struct eap_method_ret *ret,
667 const struct wpabuf *reqData)
669 struct eap_gpsk_data *data = priv;
675 pos = eap_hdr_validate(EAP_VENDOR_IETF, EAP_TYPE_GPSK, reqData, &len);
676 if (pos == NULL || len < 1) {
681 id = eap_get_id(reqData);
684 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received frame: opcode %d", opcode);
687 ret->methodState = METHOD_MAY_CONT;
688 ret->decision = DECISION_FAIL;
689 ret->allowNotifications = FALSE;
692 case EAP_GPSK_OPCODE_GPSK_1:
693 resp = eap_gpsk_process_gpsk_1(sm, data, ret, id, pos, len);
695 case EAP_GPSK_OPCODE_GPSK_3:
696 resp = eap_gpsk_process_gpsk_3(sm, data, ret, id, pos, len);
699 wpa_printf(MSG_DEBUG,
700 "EAP-GPSK: Ignoring message with unknown opcode %d",
710 static Boolean eap_gpsk_isKeyAvailable(struct eap_sm *sm, void *priv)
712 struct eap_gpsk_data *data = priv;
713 return data->state == SUCCESS;
717 static u8 * eap_gpsk_getKey(struct eap_sm *sm, void *priv, size_t *len)
719 struct eap_gpsk_data *data = priv;
722 if (data->state != SUCCESS)
725 key = os_malloc(EAP_MSK_LEN);
728 os_memcpy(key, data->msk, EAP_MSK_LEN);
735 static u8 * eap_gpsk_get_emsk(struct eap_sm *sm, void *priv, size_t *len)
737 struct eap_gpsk_data *data = priv;
740 if (data->state != SUCCESS)
743 key = os_malloc(EAP_EMSK_LEN);
746 os_memcpy(key, data->emsk, EAP_EMSK_LEN);
753 static u8 * eap_gpsk_get_session_id(struct eap_sm *sm, void *priv, size_t *len)
755 struct eap_gpsk_data *data = priv;
758 if (data->state != SUCCESS)
761 sid = os_malloc(data->id_len);
764 os_memcpy(sid, data->session_id, data->id_len);
771 int eap_peer_gpsk_register(void)
773 struct eap_method *eap;
776 eap = eap_peer_method_alloc(EAP_PEER_METHOD_INTERFACE_VERSION,
777 EAP_VENDOR_IETF, EAP_TYPE_GPSK, "GPSK");
781 eap->init = eap_gpsk_init;
782 eap->deinit = eap_gpsk_deinit;
783 eap->process = eap_gpsk_process;
784 eap->isKeyAvailable = eap_gpsk_isKeyAvailable;
785 eap->getKey = eap_gpsk_getKey;
786 eap->get_emsk = eap_gpsk_get_emsk;
787 eap->getSessionId = eap_gpsk_get_session_id;
789 ret = eap_peer_method_register(eap);
791 eap_peer_method_free(eap);