2 * EAP peer method: EAP-GPSK (draft-ietf-emu-eap-gpsk-08.txt)
3 * Copyright (c) 2006-2007, Jouni Malinen <j@w1.fi>
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.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
19 #include "config_ssid.h"
20 #include "eap_gpsk_common.h"
22 struct eap_gpsk_data {
23 enum { GPSK_1, GPSK_3, SUCCESS, FAILURE } state;
24 u8 rand_server[EAP_GPSK_RAND_LEN];
25 u8 rand_peer[EAP_GPSK_RAND_LEN];
27 u8 emsk[EAP_EMSK_LEN];
28 u8 sk[EAP_GPSK_MAX_SK_LEN];
30 u8 pk[EAP_GPSK_MAX_PK_LEN];
38 int vendor; /* CSuite/Specifier */
39 int specifier; /* CSuite/Specifier */
45 static u8 * eap_gpsk_send_gpsk_2(struct eap_gpsk_data *data, u8 identifier,
46 const u8 *csuite_list, size_t csuite_list_len,
48 static u8 * eap_gpsk_send_gpsk_4(struct eap_gpsk_data *data, u8 identifier,
52 #ifndef CONFIG_NO_STDOUT_DEBUG
53 static const char * eap_gpsk_state_txt(int state)
68 #endif /* CONFIG_NO_STDOUT_DEBUG */
71 static void eap_gpsk_state(struct eap_gpsk_data *data, int state)
73 wpa_printf(MSG_DEBUG, "EAP-GPSK: %s -> %s",
74 eap_gpsk_state_txt(data->state),
75 eap_gpsk_state_txt(state));
80 static void eap_gpsk_deinit(struct eap_sm *sm, void *priv);
83 static void * eap_gpsk_init(struct eap_sm *sm)
85 struct wpa_ssid *config = eap_get_config(sm);
86 struct eap_gpsk_data *data;
89 wpa_printf(MSG_INFO, "EAP-GPSK: No configuration found");
93 if (config->eappsk == NULL) {
94 wpa_printf(MSG_INFO, "EAP-GPSK: No key (eappsk) configured");
98 data = os_zalloc(sizeof(*data));
101 data->state = GPSK_1;
104 data->id_peer = os_malloc(config->nai_len);
105 if (data->id_peer == NULL) {
106 eap_gpsk_deinit(sm, data);
109 os_memcpy(data->id_peer, config->nai, config->nai_len);
110 data->id_peer_len = config->nai_len;
113 data->psk = os_malloc(config->eappsk_len);
114 if (data->psk == NULL) {
115 eap_gpsk_deinit(sm, data);
118 os_memcpy(data->psk, config->eappsk, config->eappsk_len);
119 data->psk_len = config->eappsk_len;
125 static void eap_gpsk_deinit(struct eap_sm *sm, void *priv)
127 struct eap_gpsk_data *data = priv;
128 os_free(data->id_server);
129 os_free(data->id_peer);
135 const u8 * eap_gpsk_process_id_server(struct eap_gpsk_data *data,
136 const u8 *pos, const u8 *end)
141 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short GPSK-1 packet");
144 alen = WPA_GET_BE16(pos);
146 if (end - pos < alen) {
147 wpa_printf(MSG_DEBUG, "EAP-GPSK: ID_Server overflow");
150 os_free(data->id_server);
151 data->id_server = os_malloc(alen);
152 if (data->id_server == NULL) {
153 wpa_printf(MSG_DEBUG, "EAP-GPSK: No memory for ID_Server");
156 os_memcpy(data->id_server, pos, alen);
157 data->id_server_len = alen;
158 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Server",
159 data->id_server, data->id_server_len);
166 const u8 * eap_gpsk_process_rand_server(struct eap_gpsk_data *data,
167 const u8 *pos, const u8 *end)
172 if (end - pos < EAP_GPSK_RAND_LEN) {
173 wpa_printf(MSG_DEBUG, "EAP-GPSK: RAND_Server overflow");
176 os_memcpy(data->rand_server, pos, EAP_GPSK_RAND_LEN);
177 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Server",
178 data->rand_server, EAP_GPSK_RAND_LEN);
179 pos += EAP_GPSK_RAND_LEN;
185 static int eap_gpsk_select_csuite(struct eap_sm *sm,
186 struct eap_gpsk_data *data,
187 const u8 *csuite_list,
188 size_t csuite_list_len)
190 struct eap_gpsk_csuite *csuite;
193 count = csuite_list_len / sizeof(struct eap_gpsk_csuite);
194 data->vendor = EAP_GPSK_VENDOR_IETF;
195 data->specifier = EAP_GPSK_CIPHER_RESERVED;
196 csuite = (struct eap_gpsk_csuite *) csuite_list;
197 for (i = 0; i < count; i++) {
198 int vendor, specifier;
199 vendor = WPA_GET_BE32(csuite->vendor);
200 specifier = WPA_GET_BE16(csuite->specifier);
201 wpa_printf(MSG_DEBUG, "EAP-GPSK: CSuite[%d]: %d:%d",
202 i, vendor, specifier);
203 if (data->vendor == EAP_GPSK_VENDOR_IETF &&
204 data->specifier == EAP_GPSK_CIPHER_RESERVED &&
205 eap_gpsk_supported_ciphersuite(vendor, specifier)) {
206 data->vendor = vendor;
207 data->specifier = specifier;
211 if (data->vendor == EAP_GPSK_VENDOR_IETF &&
212 data->specifier == EAP_GPSK_CIPHER_RESERVED) {
213 wpa_msg(sm->msg_ctx, MSG_INFO, "EAP-GPSK: No supported "
214 "ciphersuite found");
217 wpa_printf(MSG_DEBUG, "EAP-GPSK: Selected ciphersuite %d:%d",
218 data->vendor, data->specifier);
224 const u8 * eap_gpsk_process_csuite_list(struct eap_sm *sm,
225 struct eap_gpsk_data *data,
226 const u8 **list, size_t *list_len,
227 const u8 *pos, const u8 *end)
233 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short GPSK-1 packet");
236 *list_len = WPA_GET_BE16(pos);
238 if (end - pos < (int) *list_len) {
239 wpa_printf(MSG_DEBUG, "EAP-GPSK: CSuite_List overflow");
242 if (*list_len == 0 || (*list_len % sizeof(struct eap_gpsk_csuite))) {
243 wpa_printf(MSG_DEBUG, "EAP-GPSK: Invalid CSuite_List len %d",
250 if (eap_gpsk_select_csuite(sm, data, *list, *list_len) < 0)
257 static u8 * eap_gpsk_process_gpsk_1(struct eap_sm *sm,
258 struct eap_gpsk_data *data,
259 struct eap_method_ret *ret,
260 const u8 *reqData, size_t reqDataLen,
261 const u8 *payload, size_t payload_len,
264 size_t csuite_list_len;
265 const u8 *csuite_list, *pos, *end;
266 const struct eap_hdr *req;
269 if (data->state != GPSK_1) {
274 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received Request/GPSK-1");
276 end = payload + payload_len;
278 pos = eap_gpsk_process_id_server(data, payload, end);
279 pos = eap_gpsk_process_rand_server(data, pos, end);
280 pos = eap_gpsk_process_csuite_list(sm, data, &csuite_list,
281 &csuite_list_len, pos, end);
283 eap_gpsk_state(data, FAILURE);
287 req = (const struct eap_hdr *) reqData;
288 resp = eap_gpsk_send_gpsk_2(data, req->identifier,
289 csuite_list, csuite_list_len,
294 eap_gpsk_state(data, GPSK_3);
300 static u8 * eap_gpsk_send_gpsk_2(struct eap_gpsk_data *data, u8 identifier,
301 const u8 *csuite_list, size_t csuite_list_len,
304 struct eap_hdr *resp;
307 struct eap_gpsk_csuite *csuite;
309 wpa_printf(MSG_DEBUG, "EAP-GPSK: Sending Response/GPSK-2");
311 miclen = eap_gpsk_mic_len(data->vendor, data->specifier);
312 len = 1 + 2 + data->id_peer_len + 2 + data->id_server_len +
313 2 * EAP_GPSK_RAND_LEN + 2 + csuite_list_len +
314 sizeof(struct eap_gpsk_csuite) + 2 + miclen;
316 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_GPSK, respDataLen, len,
317 EAP_CODE_RESPONSE, identifier, &rpos);
321 *rpos++ = EAP_GPSK_OPCODE_GPSK_2;
324 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Peer",
325 data->id_peer, data->id_peer_len);
326 WPA_PUT_BE16(rpos, data->id_peer_len);
329 os_memcpy(rpos, data->id_peer, data->id_peer_len);
330 rpos += data->id_peer_len;
332 WPA_PUT_BE16(rpos, data->id_server_len);
335 os_memcpy(rpos, data->id_server, data->id_server_len);
336 rpos += data->id_server_len;
338 if (os_get_random(data->rand_peer, EAP_GPSK_RAND_LEN)) {
339 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to get random data "
341 eap_gpsk_state(data, FAILURE);
345 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Peer",
346 data->rand_peer, EAP_GPSK_RAND_LEN);
347 os_memcpy(rpos, data->rand_peer, EAP_GPSK_RAND_LEN);
348 rpos += EAP_GPSK_RAND_LEN;
350 os_memcpy(rpos, data->rand_server, EAP_GPSK_RAND_LEN);
351 rpos += EAP_GPSK_RAND_LEN;
353 WPA_PUT_BE16(rpos, csuite_list_len);
355 os_memcpy(rpos, csuite_list, csuite_list_len);
356 rpos += csuite_list_len;
358 csuite = (struct eap_gpsk_csuite *) rpos;
359 WPA_PUT_BE32(csuite->vendor, data->vendor);
360 WPA_PUT_BE16(csuite->specifier, data->specifier);
361 rpos = (u8 *) (csuite + 1);
363 if (eap_gpsk_derive_keys(data->psk, data->psk_len,
364 data->vendor, data->specifier,
365 data->rand_peer, data->rand_server,
366 data->id_peer, data->id_peer_len,
367 data->id_server, data->id_server_len,
368 data->msk, data->emsk,
369 data->sk, &data->sk_len,
370 data->pk, &data->pk_len) < 0) {
371 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to derive keys");
372 eap_gpsk_state(data, FAILURE);
377 /* No PD_Payload_1 */
378 WPA_PUT_BE16(rpos, 0);
381 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
382 data->specifier, start, rpos - start, rpos) <
384 eap_gpsk_state(data, FAILURE);
393 const u8 * eap_gpsk_validate_rand(struct eap_gpsk_data *data, const u8 *pos,
396 if (end - pos < EAP_GPSK_RAND_LEN) {
397 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
401 if (os_memcmp(pos, data->rand_peer, EAP_GPSK_RAND_LEN) != 0) {
402 wpa_printf(MSG_DEBUG, "EAP-GPSK: RAND_Peer in GPSK-2 and "
403 "GPSK-3 did not match");
404 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Peer in GPSK-2",
405 data->rand_peer, EAP_GPSK_RAND_LEN);
406 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Peer in GPSK-3",
407 pos, EAP_GPSK_RAND_LEN);
410 pos += EAP_GPSK_RAND_LEN;
412 if (end - pos < EAP_GPSK_RAND_LEN) {
413 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
417 if (os_memcmp(pos, data->rand_server, EAP_GPSK_RAND_LEN) != 0) {
418 wpa_printf(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-1 and "
419 "GPSK-3 did not match");
420 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-1",
421 data->rand_server, EAP_GPSK_RAND_LEN);
422 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-3",
423 pos, EAP_GPSK_RAND_LEN);
426 pos += EAP_GPSK_RAND_LEN;
432 const u8 * eap_gpsk_validate_id_server(struct eap_gpsk_data *data,
433 const u8 *pos, const u8 *end)
440 if (end - pos < (int) 2) {
441 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
442 "length(ID_Server)");
446 len = WPA_GET_BE16(pos);
449 if (end - pos < (int) len) {
450 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
455 if (len != data->id_server_len ||
456 os_memcmp(pos, data->id_server, len) != 0) {
457 wpa_printf(MSG_INFO, "EAP-GPSK: ID_Server did not match with "
458 "the one used in GPSK-1");
459 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Server in GPSK-1",
460 data->id_server, data->id_server_len);
461 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Server in GPSK-3",
471 const u8 * eap_gpsk_validate_csuite(struct eap_gpsk_data *data, const u8 *pos,
474 int vendor, specifier;
475 const struct eap_gpsk_csuite *csuite;
480 if (end - pos < (int) sizeof(*csuite)) {
481 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
485 csuite = (const struct eap_gpsk_csuite *) pos;
486 vendor = WPA_GET_BE32(csuite->vendor);
487 specifier = WPA_GET_BE16(csuite->specifier);
488 pos += sizeof(*csuite);
489 if (vendor != data->vendor || specifier != data->specifier) {
490 wpa_printf(MSG_DEBUG, "EAP-GPSK: CSuite_Sel (%d:%d) does not "
491 "match with the one sent in GPSK-2 (%d:%d)",
492 vendor, specifier, data->vendor, data->specifier);
500 const u8 * eap_gpsk_validate_pd_payload_2(struct eap_gpsk_data *data,
501 const u8 *pos, const u8 *end)
509 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
510 "PD_Payload_2 length");
513 alen = WPA_GET_BE16(pos);
515 if (end - pos < alen) {
516 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
517 "%d-octet PD_Payload_2", alen);
520 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: PD_Payload_2", pos, alen);
527 const u8 * eap_gpsk_validate_gpsk_3_mic(struct eap_gpsk_data *data,
529 const u8 *pos, const u8 *end)
532 u8 mic[EAP_GPSK_MAX_MIC_LEN];
537 miclen = eap_gpsk_mic_len(data->vendor, data->specifier);
538 if (end - pos < (int) miclen) {
539 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for MIC "
540 "(left=%d miclen=%d)", end - pos, miclen);
543 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
544 data->specifier, payload, pos - payload, mic)
546 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to compute MIC");
549 if (os_memcmp(mic, pos, miclen) != 0) {
550 wpa_printf(MSG_INFO, "EAP-GPSK: Incorrect MIC in GPSK-3");
551 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Received MIC", pos, miclen);
552 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Computed MIC", mic, miclen);
561 static u8 * eap_gpsk_process_gpsk_3(struct eap_sm *sm,
562 struct eap_gpsk_data *data,
563 struct eap_method_ret *ret,
564 const u8 *reqData, size_t reqDataLen,
565 const u8 *payload, size_t payload_len,
569 const struct eap_hdr *req;
572 if (data->state != GPSK_3) {
577 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received Request/GPSK-3");
579 end = payload + payload_len;
581 pos = eap_gpsk_validate_rand(data, payload, end);
582 pos = eap_gpsk_validate_id_server(data, pos, end);
583 pos = eap_gpsk_validate_csuite(data, pos, end);
584 pos = eap_gpsk_validate_pd_payload_2(data, pos, end);
585 pos = eap_gpsk_validate_gpsk_3_mic(data, payload, pos, end);
588 eap_gpsk_state(data, FAILURE);
592 wpa_printf(MSG_DEBUG, "EAP-GPSK: Ignored %d bytes of extra "
593 "data in the end of GPSK-2", end - pos);
596 req = (const struct eap_hdr *) reqData;
597 resp = eap_gpsk_send_gpsk_4(data, req->identifier, respDataLen);
601 eap_gpsk_state(data, SUCCESS);
602 ret->methodState = METHOD_DONE;
603 ret->decision = DECISION_UNCOND_SUCC;
609 static u8 * eap_gpsk_send_gpsk_4(struct eap_gpsk_data *data, u8 identifier,
612 struct eap_hdr *resp;
616 wpa_printf(MSG_DEBUG, "EAP-GPSK: Sending Response/GPSK-4");
618 len = 1 + 2 + eap_gpsk_mic_len(data->vendor, data->specifier);
620 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_GPSK, respDataLen, len,
621 EAP_CODE_RESPONSE, identifier, &rpos);
625 *rpos++ = EAP_GPSK_OPCODE_GPSK_4;
628 /* No PD_Payload_3 */
629 WPA_PUT_BE16(rpos, 0);
632 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
633 data->specifier, start, rpos - start, rpos) <
635 eap_gpsk_state(data, FAILURE);
644 static u8 * eap_gpsk_process(struct eap_sm *sm, void *priv,
645 struct eap_method_ret *ret,
646 const u8 *reqData, size_t reqDataLen,
649 struct eap_gpsk_data *data = priv;
654 pos = eap_hdr_validate(EAP_VENDOR_IETF, EAP_TYPE_GPSK,
655 reqData, reqDataLen, &len);
656 if (pos == NULL || len < 1) {
661 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received frame: opcode %d", *pos);
664 ret->methodState = METHOD_MAY_CONT;
665 ret->decision = DECISION_FAIL;
666 ret->allowNotifications = FALSE;
669 case EAP_GPSK_OPCODE_GPSK_1:
670 resp = eap_gpsk_process_gpsk_1(sm, data, ret, reqData,
671 reqDataLen, pos + 1, len - 1,
674 case EAP_GPSK_OPCODE_GPSK_3:
675 resp = eap_gpsk_process_gpsk_3(sm, data, ret, reqData,
676 reqDataLen, pos + 1, len - 1,
680 wpa_printf(MSG_DEBUG, "EAP-GPSK: Ignoring message with "
681 "unknown opcode %d", *pos);
690 static Boolean eap_gpsk_isKeyAvailable(struct eap_sm *sm, void *priv)
692 struct eap_gpsk_data *data = priv;
693 return data->state == SUCCESS;
697 static u8 * eap_gpsk_getKey(struct eap_sm *sm, void *priv, size_t *len)
699 struct eap_gpsk_data *data = priv;
702 if (data->state != SUCCESS)
705 key = os_malloc(EAP_MSK_LEN);
708 os_memcpy(key, data->msk, EAP_MSK_LEN);
715 static u8 * eap_gpsk_get_emsk(struct eap_sm *sm, void *priv, size_t *len)
717 struct eap_gpsk_data *data = priv;
720 if (data->state != SUCCESS)
723 key = os_malloc(EAP_EMSK_LEN);
726 os_memcpy(key, data->emsk, EAP_EMSK_LEN);
733 int eap_peer_gpsk_register(void)
735 struct eap_method *eap;
738 eap = eap_peer_method_alloc(EAP_PEER_METHOD_INTERFACE_VERSION,
739 EAP_VENDOR_IETF, EAP_TYPE_GPSK, "GPSK");
743 eap->init = eap_gpsk_init;
744 eap->deinit = eap_gpsk_deinit;
745 eap->process = eap_gpsk_process;
746 eap->isKeyAvailable = eap_gpsk_isKeyAvailable;
747 eap->getKey = eap_gpsk_getKey;
748 eap->get_emsk = eap_gpsk_get_emsk;
750 ret = eap_peer_method_register(eap);
752 eap_peer_method_free(eap);