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_memdup(identity, identity_len);
100 if (data->id_peer == NULL) {
101 eap_gpsk_deinit(sm, data);
104 data->id_peer_len = identity_len;
107 phase1 = eap_get_config_phase1(sm);
111 pos = os_strstr(phase1, "cipher=");
113 data->forced_cipher = atoi(pos + 7);
114 wpa_printf(MSG_DEBUG, "EAP-GPSK: Forced cipher %u",
115 data->forced_cipher);
119 data->psk = os_memdup(password, password_len);
120 if (data->psk == NULL) {
121 eap_gpsk_deinit(sm, data);
124 data->psk_len = password_len;
130 static void eap_gpsk_deinit(struct eap_sm *sm, void *priv)
132 struct eap_gpsk_data *data = priv;
133 os_free(data->id_server);
134 os_free(data->id_peer);
136 os_memset(data->psk, 0, data->psk_len);
139 bin_clear_free(data, sizeof(*data));
143 static const u8 * eap_gpsk_process_id_server(struct eap_gpsk_data *data,
144 const u8 *pos, const u8 *end)
149 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short GPSK-1 packet");
152 alen = WPA_GET_BE16(pos);
154 if (end - pos < alen) {
155 wpa_printf(MSG_DEBUG, "EAP-GPSK: ID_Server overflow");
158 os_free(data->id_server);
159 data->id_server = os_memdup(pos, alen);
160 if (data->id_server == NULL) {
161 wpa_printf(MSG_DEBUG, "EAP-GPSK: No memory for ID_Server");
164 data->id_server_len = alen;
165 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Server",
166 data->id_server, data->id_server_len);
173 static const u8 * eap_gpsk_process_rand_server(struct eap_gpsk_data *data,
174 const u8 *pos, const u8 *end)
179 if (end - pos < EAP_GPSK_RAND_LEN) {
180 wpa_printf(MSG_DEBUG, "EAP-GPSK: RAND_Server overflow");
183 os_memcpy(data->rand_server, pos, EAP_GPSK_RAND_LEN);
184 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Server",
185 data->rand_server, EAP_GPSK_RAND_LEN);
186 pos += EAP_GPSK_RAND_LEN;
192 static int eap_gpsk_select_csuite(struct eap_sm *sm,
193 struct eap_gpsk_data *data,
194 const u8 *csuite_list,
195 size_t csuite_list_len)
197 struct eap_gpsk_csuite *csuite;
200 count = csuite_list_len / sizeof(struct eap_gpsk_csuite);
201 data->vendor = EAP_GPSK_VENDOR_IETF;
202 data->specifier = EAP_GPSK_CIPHER_RESERVED;
203 csuite = (struct eap_gpsk_csuite *) csuite_list;
204 for (i = 0; i < count; i++) {
205 int vendor, specifier;
206 vendor = WPA_GET_BE32(csuite->vendor);
207 specifier = WPA_GET_BE16(csuite->specifier);
208 wpa_printf(MSG_DEBUG, "EAP-GPSK: CSuite[%d]: %d:%d",
209 i, vendor, specifier);
210 if (data->vendor == EAP_GPSK_VENDOR_IETF &&
211 data->specifier == EAP_GPSK_CIPHER_RESERVED &&
212 eap_gpsk_supported_ciphersuite(vendor, specifier) &&
213 (!data->forced_cipher || data->forced_cipher == specifier))
215 data->vendor = vendor;
216 data->specifier = specifier;
220 if (data->vendor == EAP_GPSK_VENDOR_IETF &&
221 data->specifier == EAP_GPSK_CIPHER_RESERVED) {
222 wpa_msg(sm->msg_ctx, MSG_INFO, "EAP-GPSK: No supported "
223 "ciphersuite found");
226 wpa_printf(MSG_DEBUG, "EAP-GPSK: Selected ciphersuite %d:%d",
227 data->vendor, data->specifier);
233 static const u8 * eap_gpsk_process_csuite_list(struct eap_sm *sm,
234 struct eap_gpsk_data *data,
237 const u8 *pos, const u8 *end)
245 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short GPSK-1 packet");
248 len = WPA_GET_BE16(pos);
250 if (len > (size_t) (end - pos)) {
251 wpa_printf(MSG_DEBUG, "EAP-GPSK: CSuite_List overflow");
254 if (len == 0 || (len % sizeof(struct eap_gpsk_csuite))) {
255 wpa_printf(MSG_DEBUG, "EAP-GPSK: Invalid CSuite_List len %lu",
256 (unsigned long) len);
260 if (eap_gpsk_select_csuite(sm, data, pos, len) < 0)
271 static struct wpabuf * eap_gpsk_process_gpsk_1(struct eap_sm *sm,
272 struct eap_gpsk_data *data,
273 struct eap_method_ret *ret,
278 size_t csuite_list_len;
279 const u8 *csuite_list, *pos, *end;
282 if (data->state != GPSK_1) {
287 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received Request/GPSK-1");
289 end = payload + payload_len;
291 pos = eap_gpsk_process_id_server(data, payload, end);
292 pos = eap_gpsk_process_rand_server(data, pos, end);
293 pos = eap_gpsk_process_csuite_list(sm, data, &csuite_list,
294 &csuite_list_len, pos, end);
296 ret->methodState = METHOD_DONE;
297 eap_gpsk_state(data, FAILURE);
301 resp = eap_gpsk_send_gpsk_2(data, identifier,
302 csuite_list, csuite_list_len);
306 eap_gpsk_state(data, GPSK_3);
312 static struct wpabuf * eap_gpsk_send_gpsk_2(struct eap_gpsk_data *data,
314 const u8 *csuite_list,
315 size_t csuite_list_len)
320 struct eap_gpsk_csuite *csuite;
322 wpa_printf(MSG_DEBUG, "EAP-GPSK: Sending Response/GPSK-2");
324 miclen = eap_gpsk_mic_len(data->vendor, data->specifier);
325 len = 1 + 2 + data->id_peer_len + 2 + data->id_server_len +
326 2 * EAP_GPSK_RAND_LEN + 2 + csuite_list_len +
327 sizeof(struct eap_gpsk_csuite) + 2 + miclen;
329 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_GPSK, len,
330 EAP_CODE_RESPONSE, identifier);
334 wpabuf_put_u8(resp, EAP_GPSK_OPCODE_GPSK_2);
335 start = wpabuf_put(resp, 0);
337 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Peer",
338 data->id_peer, data->id_peer_len);
339 wpabuf_put_be16(resp, data->id_peer_len);
340 wpabuf_put_data(resp, data->id_peer, data->id_peer_len);
342 wpabuf_put_be16(resp, data->id_server_len);
343 wpabuf_put_data(resp, data->id_server, data->id_server_len);
345 if (random_get_bytes(data->rand_peer, EAP_GPSK_RAND_LEN)) {
346 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to get random data "
348 eap_gpsk_state(data, FAILURE);
352 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Peer",
353 data->rand_peer, EAP_GPSK_RAND_LEN);
354 wpabuf_put_data(resp, data->rand_peer, EAP_GPSK_RAND_LEN);
355 wpabuf_put_data(resp, data->rand_server, EAP_GPSK_RAND_LEN);
357 wpabuf_put_be16(resp, csuite_list_len);
358 wpabuf_put_data(resp, csuite_list, csuite_list_len);
360 csuite = wpabuf_put(resp, sizeof(*csuite));
361 WPA_PUT_BE32(csuite->vendor, data->vendor);
362 WPA_PUT_BE16(csuite->specifier, data->specifier);
364 if (eap_gpsk_derive_keys(data->psk, data->psk_len,
365 data->vendor, data->specifier,
366 data->rand_peer, data->rand_server,
367 data->id_peer, data->id_peer_len,
368 data->id_server, data->id_server_len,
369 data->msk, data->emsk,
370 data->sk, &data->sk_len,
371 data->pk, &data->pk_len) < 0) {
372 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to derive keys");
373 eap_gpsk_state(data, FAILURE);
378 if (eap_gpsk_derive_session_id(data->psk, data->psk_len,
379 data->vendor, data->specifier,
380 data->rand_peer, data->rand_server,
381 data->id_peer, data->id_peer_len,
382 data->id_server, data->id_server_len,
384 data->session_id, &data->id_len) < 0) {
385 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to derive Session-Id");
386 eap_gpsk_state(data, FAILURE);
390 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Derived Session-Id",
391 data->session_id, data->id_len);
393 /* No PD_Payload_1 */
394 wpabuf_put_be16(resp, 0);
396 rpos = wpabuf_put(resp, miclen);
397 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
398 data->specifier, start, rpos - start, rpos) <
400 eap_gpsk_state(data, FAILURE);
409 static const u8 * eap_gpsk_validate_rand(struct eap_gpsk_data *data,
410 const u8 *pos, const u8 *end)
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_peer, EAP_GPSK_RAND_LEN) != 0) {
418 wpa_printf(MSG_DEBUG, "EAP-GPSK: RAND_Peer in GPSK-2 and "
419 "GPSK-3 did not match");
420 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Peer in GPSK-2",
421 data->rand_peer, EAP_GPSK_RAND_LEN);
422 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Peer in GPSK-3",
423 pos, EAP_GPSK_RAND_LEN);
426 pos += EAP_GPSK_RAND_LEN;
428 if (end - pos < EAP_GPSK_RAND_LEN) {
429 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
433 if (os_memcmp(pos, data->rand_server, EAP_GPSK_RAND_LEN) != 0) {
434 wpa_printf(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-1 and "
435 "GPSK-3 did not match");
436 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-1",
437 data->rand_server, EAP_GPSK_RAND_LEN);
438 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-3",
439 pos, EAP_GPSK_RAND_LEN);
442 pos += EAP_GPSK_RAND_LEN;
448 static const u8 * eap_gpsk_validate_id_server(struct eap_gpsk_data *data,
449 const u8 *pos, const u8 *end)
456 if (end - pos < (int) 2) {
457 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
458 "length(ID_Server)");
462 len = WPA_GET_BE16(pos);
465 if (end - pos < (int) len) {
466 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
471 if (len != data->id_server_len ||
472 os_memcmp(pos, data->id_server, len) != 0) {
473 wpa_printf(MSG_INFO, "EAP-GPSK: ID_Server did not match with "
474 "the one used in GPSK-1");
475 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Server in GPSK-1",
476 data->id_server, data->id_server_len);
477 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Server in GPSK-3",
488 static const u8 * eap_gpsk_validate_csuite(struct eap_gpsk_data *data,
489 const u8 *pos, const u8 *end)
491 int vendor, specifier;
492 const struct eap_gpsk_csuite *csuite;
497 if (end - pos < (int) sizeof(*csuite)) {
498 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
502 csuite = (const struct eap_gpsk_csuite *) pos;
503 vendor = WPA_GET_BE32(csuite->vendor);
504 specifier = WPA_GET_BE16(csuite->specifier);
505 pos += sizeof(*csuite);
506 if (vendor != data->vendor || specifier != data->specifier) {
507 wpa_printf(MSG_DEBUG, "EAP-GPSK: CSuite_Sel (%d:%d) does not "
508 "match with the one sent in GPSK-2 (%d:%d)",
509 vendor, specifier, data->vendor, data->specifier);
517 static const u8 * eap_gpsk_validate_pd_payload_2(struct eap_gpsk_data *data,
518 const u8 *pos, const u8 *end)
526 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
527 "PD_Payload_2 length");
530 alen = WPA_GET_BE16(pos);
532 if (end - pos < alen) {
533 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for "
534 "%d-octet PD_Payload_2", alen);
537 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: PD_Payload_2", pos, alen);
544 static const u8 * eap_gpsk_validate_gpsk_3_mic(struct eap_gpsk_data *data,
546 const u8 *pos, const u8 *end)
549 u8 mic[EAP_GPSK_MAX_MIC_LEN];
554 miclen = eap_gpsk_mic_len(data->vendor, data->specifier);
555 if (end - pos < (int) miclen) {
556 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for MIC "
557 "(left=%lu miclen=%lu)",
558 (unsigned long) (end - pos),
559 (unsigned long) miclen);
562 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
563 data->specifier, payload, pos - payload, mic)
565 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to compute MIC");
568 if (os_memcmp_const(mic, pos, miclen) != 0) {
569 wpa_printf(MSG_INFO, "EAP-GPSK: Incorrect MIC in GPSK-3");
570 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Received MIC", pos, miclen);
571 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Computed MIC", mic, miclen);
580 static struct wpabuf * eap_gpsk_process_gpsk_3(struct eap_sm *sm,
581 struct eap_gpsk_data *data,
582 struct eap_method_ret *ret,
590 if (data->state != GPSK_3) {
595 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received Request/GPSK-3");
597 end = payload + payload_len;
599 pos = eap_gpsk_validate_rand(data, payload, end);
600 pos = eap_gpsk_validate_id_server(data, pos, end);
601 pos = eap_gpsk_validate_csuite(data, pos, end);
602 pos = eap_gpsk_validate_pd_payload_2(data, pos, end);
603 pos = eap_gpsk_validate_gpsk_3_mic(data, payload, pos, end);
606 eap_gpsk_state(data, FAILURE);
610 wpa_printf(MSG_DEBUG, "EAP-GPSK: Ignored %lu bytes of extra "
611 "data in the end of GPSK-2",
612 (unsigned long) (end - pos));
615 resp = eap_gpsk_send_gpsk_4(data, identifier);
619 eap_gpsk_state(data, SUCCESS);
620 ret->methodState = METHOD_DONE;
621 ret->decision = DECISION_UNCOND_SUCC;
627 static struct wpabuf * eap_gpsk_send_gpsk_4(struct eap_gpsk_data *data,
634 wpa_printf(MSG_DEBUG, "EAP-GPSK: Sending Response/GPSK-4");
636 mlen = eap_gpsk_mic_len(data->vendor, data->specifier);
638 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_GPSK, 1 + 2 + mlen,
639 EAP_CODE_RESPONSE, identifier);
643 wpabuf_put_u8(resp, EAP_GPSK_OPCODE_GPSK_4);
644 start = wpabuf_put(resp, 0);
646 /* No PD_Payload_3 */
647 wpabuf_put_be16(resp, 0);
649 rpos = wpabuf_put(resp, mlen);
650 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
651 data->specifier, start, rpos - start, rpos) <
653 eap_gpsk_state(data, FAILURE);
662 static struct wpabuf * eap_gpsk_process(struct eap_sm *sm, void *priv,
663 struct eap_method_ret *ret,
664 const struct wpabuf *reqData)
666 struct eap_gpsk_data *data = priv;
672 pos = eap_hdr_validate(EAP_VENDOR_IETF, EAP_TYPE_GPSK, reqData, &len);
673 if (pos == NULL || len < 1) {
678 id = eap_get_id(reqData);
681 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received frame: opcode %d", opcode);
684 ret->methodState = METHOD_MAY_CONT;
685 ret->decision = DECISION_FAIL;
686 ret->allowNotifications = FALSE;
689 case EAP_GPSK_OPCODE_GPSK_1:
690 resp = eap_gpsk_process_gpsk_1(sm, data, ret, id, pos, len);
692 case EAP_GPSK_OPCODE_GPSK_3:
693 resp = eap_gpsk_process_gpsk_3(sm, data, ret, id, pos, len);
696 wpa_printf(MSG_DEBUG,
697 "EAP-GPSK: Ignoring message with unknown opcode %d",
707 static Boolean eap_gpsk_isKeyAvailable(struct eap_sm *sm, void *priv)
709 struct eap_gpsk_data *data = priv;
710 return data->state == SUCCESS;
714 static u8 * eap_gpsk_getKey(struct eap_sm *sm, void *priv, size_t *len)
716 struct eap_gpsk_data *data = priv;
719 if (data->state != SUCCESS)
722 key = os_memdup(data->msk, EAP_MSK_LEN);
731 static u8 * eap_gpsk_get_emsk(struct eap_sm *sm, void *priv, size_t *len)
733 struct eap_gpsk_data *data = priv;
736 if (data->state != SUCCESS)
739 key = os_memdup(data->emsk, EAP_EMSK_LEN);
748 static u8 * eap_gpsk_get_session_id(struct eap_sm *sm, void *priv, size_t *len)
750 struct eap_gpsk_data *data = priv;
753 if (data->state != SUCCESS)
756 sid = os_memdup(data->session_id, data->id_len);
765 int eap_peer_gpsk_register(void)
767 struct eap_method *eap;
769 eap = eap_peer_method_alloc(EAP_PEER_METHOD_INTERFACE_VERSION,
770 EAP_VENDOR_IETF, EAP_TYPE_GPSK, "GPSK");
774 eap->init = eap_gpsk_init;
775 eap->deinit = eap_gpsk_deinit;
776 eap->process = eap_gpsk_process;
777 eap->isKeyAvailable = eap_gpsk_isKeyAvailable;
778 eap->getKey = eap_gpsk_getKey;
779 eap->get_emsk = eap_gpsk_get_emsk;
780 eap->getSessionId = eap_gpsk_get_session_id;
782 return eap_peer_method_register(eap);