2 * hostapd / EAP-GPSK (RFC 5433) server
3 * Copyright (c) 2006-2007, 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_server/eap_i.h"
14 #include "eap_common/eap_gpsk_common.h"
17 struct eap_gpsk_data {
18 enum { GPSK_1, GPSK_3, SUCCESS, FAILURE } state;
19 u8 rand_server[EAP_GPSK_RAND_LEN];
20 u8 rand_peer[EAP_GPSK_RAND_LEN];
22 u8 emsk[EAP_EMSK_LEN];
23 u8 sk[EAP_GPSK_MAX_SK_LEN];
25 u8 pk[EAP_GPSK_MAX_PK_LEN];
31 #define MAX_NUM_CSUITES 2
32 struct eap_gpsk_csuite csuite_list[MAX_NUM_CSUITES];
34 int vendor; /* CSuite/Vendor */
35 int specifier; /* CSuite/Specifier */
39 static const char * eap_gpsk_state_txt(int state)
56 static void eap_gpsk_state(struct eap_gpsk_data *data, int state)
58 wpa_printf(MSG_DEBUG, "EAP-GPSK: %s -> %s",
59 eap_gpsk_state_txt(data->state),
60 eap_gpsk_state_txt(state));
65 static void * eap_gpsk_init(struct eap_sm *sm)
67 struct eap_gpsk_data *data;
69 data = os_zalloc(sizeof(*data));
74 /* TODO: add support for configuring ID_Server */
75 data->id_server = (u8 *) os_strdup("hostapd");
77 data->id_server_len = os_strlen((char *) data->id_server);
79 data->csuite_count = 0;
80 if (eap_gpsk_supported_ciphersuite(EAP_GPSK_VENDOR_IETF,
81 EAP_GPSK_CIPHER_AES)) {
82 WPA_PUT_BE32(data->csuite_list[data->csuite_count].vendor,
83 EAP_GPSK_VENDOR_IETF);
84 WPA_PUT_BE16(data->csuite_list[data->csuite_count].specifier,
88 if (eap_gpsk_supported_ciphersuite(EAP_GPSK_VENDOR_IETF,
89 EAP_GPSK_CIPHER_SHA256)) {
90 WPA_PUT_BE32(data->csuite_list[data->csuite_count].vendor,
91 EAP_GPSK_VENDOR_IETF);
92 WPA_PUT_BE16(data->csuite_list[data->csuite_count].specifier,
93 EAP_GPSK_CIPHER_SHA256);
101 static void eap_gpsk_reset(struct eap_sm *sm, void *priv)
103 struct eap_gpsk_data *data = priv;
104 os_free(data->id_server);
105 os_free(data->id_peer);
110 static struct wpabuf * eap_gpsk_build_gpsk_1(struct eap_sm *sm,
111 struct eap_gpsk_data *data, u8 id)
116 wpa_printf(MSG_DEBUG, "EAP-GPSK: Request/GPSK-1");
118 if (random_get_bytes(data->rand_server, EAP_GPSK_RAND_LEN)) {
119 wpa_printf(MSG_ERROR, "EAP-GPSK: Failed to get random data");
120 eap_gpsk_state(data, FAILURE);
123 wpa_hexdump(MSG_MSGDUMP, "EAP-GPSK: RAND_Server",
124 data->rand_server, EAP_GPSK_RAND_LEN);
126 len = 1 + 2 + data->id_server_len + EAP_GPSK_RAND_LEN + 2 +
127 data->csuite_count * sizeof(struct eap_gpsk_csuite);
128 req = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_GPSK, len,
129 EAP_CODE_REQUEST, id);
131 wpa_printf(MSG_ERROR, "EAP-GPSK: Failed to allocate memory "
132 "for request/GPSK-1");
133 eap_gpsk_state(data, FAILURE);
137 wpabuf_put_u8(req, EAP_GPSK_OPCODE_GPSK_1);
138 wpabuf_put_be16(req, data->id_server_len);
139 wpabuf_put_data(req, data->id_server, data->id_server_len);
140 wpabuf_put_data(req, data->rand_server, EAP_GPSK_RAND_LEN);
142 data->csuite_count * sizeof(struct eap_gpsk_csuite));
143 wpabuf_put_data(req, data->csuite_list,
144 data->csuite_count * sizeof(struct eap_gpsk_csuite));
150 static struct wpabuf * eap_gpsk_build_gpsk_3(struct eap_sm *sm,
151 struct eap_gpsk_data *data, u8 id)
155 struct eap_gpsk_csuite *csuite;
158 wpa_printf(MSG_DEBUG, "EAP-GPSK: Request/GPSK-3");
160 miclen = eap_gpsk_mic_len(data->vendor, data->specifier);
161 len = 1 + 2 * EAP_GPSK_RAND_LEN + 2 + data->id_server_len +
162 sizeof(struct eap_gpsk_csuite) + 2 + miclen;
163 req = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_GPSK, len,
164 EAP_CODE_REQUEST, id);
166 wpa_printf(MSG_ERROR, "EAP-GPSK: Failed to allocate memory "
167 "for request/GPSK-3");
168 eap_gpsk_state(data, FAILURE);
172 wpabuf_put_u8(req, EAP_GPSK_OPCODE_GPSK_3);
173 start = wpabuf_put(req, 0);
175 wpabuf_put_data(req, data->rand_peer, EAP_GPSK_RAND_LEN);
176 wpabuf_put_data(req, data->rand_server, EAP_GPSK_RAND_LEN);
177 wpabuf_put_be16(req, data->id_server_len);
178 wpabuf_put_data(req, data->id_server, data->id_server_len);
179 csuite = wpabuf_put(req, sizeof(*csuite));
180 WPA_PUT_BE32(csuite->vendor, data->vendor);
181 WPA_PUT_BE16(csuite->specifier, data->specifier);
183 /* no PD_Payload_2 */
184 wpabuf_put_be16(req, 0);
186 pos = wpabuf_put(req, miclen);
187 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
188 data->specifier, start, pos - start, pos) < 0)
191 eap_gpsk_state(data, FAILURE);
199 static struct wpabuf * eap_gpsk_buildReq(struct eap_sm *sm, void *priv, u8 id)
201 struct eap_gpsk_data *data = priv;
203 switch (data->state) {
205 return eap_gpsk_build_gpsk_1(sm, data, id);
207 return eap_gpsk_build_gpsk_3(sm, data, id);
209 wpa_printf(MSG_DEBUG, "EAP-GPSK: Unknown state %d in buildReq",
217 static Boolean eap_gpsk_check(struct eap_sm *sm, void *priv,
218 struct wpabuf *respData)
220 struct eap_gpsk_data *data = priv;
224 pos = eap_hdr_validate(EAP_VENDOR_IETF, EAP_TYPE_GPSK, respData, &len);
225 if (pos == NULL || len < 1) {
226 wpa_printf(MSG_INFO, "EAP-GPSK: Invalid frame");
230 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received frame: opcode=%d", *pos);
232 if (data->state == GPSK_1 && *pos == EAP_GPSK_OPCODE_GPSK_2)
235 if (data->state == GPSK_3 && *pos == EAP_GPSK_OPCODE_GPSK_4)
238 wpa_printf(MSG_INFO, "EAP-GPSK: Unexpected opcode=%d in state=%d",
245 static void eap_gpsk_process_gpsk_2(struct eap_sm *sm,
246 struct eap_gpsk_data *data,
247 const u8 *payload, size_t payloadlen)
251 const struct eap_gpsk_csuite *csuite;
253 u8 mic[EAP_GPSK_MAX_MIC_LEN];
255 if (data->state != GPSK_1)
258 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received Response/GPSK-2");
261 end = payload + payloadlen;
264 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
266 eap_gpsk_state(data, FAILURE);
269 alen = WPA_GET_BE16(pos);
271 if (end - pos < alen) {
272 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
274 eap_gpsk_state(data, FAILURE);
277 os_free(data->id_peer);
278 data->id_peer = os_malloc(alen);
279 if (data->id_peer == NULL) {
280 wpa_printf(MSG_DEBUG, "EAP-GPSK: Not enough memory to store "
281 "%d-octet ID_Peer", alen);
284 os_memcpy(data->id_peer, pos, alen);
285 data->id_peer_len = alen;
286 wpa_hexdump_ascii(MSG_DEBUG, "EAP-GPSK: ID_Peer",
287 data->id_peer, data->id_peer_len);
291 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
293 eap_gpsk_state(data, FAILURE);
296 alen = WPA_GET_BE16(pos);
298 if (end - pos < alen) {
299 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
301 eap_gpsk_state(data, FAILURE);
304 if (alen != data->id_server_len ||
305 os_memcmp(pos, data->id_server, alen) != 0) {
306 wpa_printf(MSG_DEBUG, "EAP-GPSK: ID_Server in GPSK-1 and "
307 "GPSK-2 did not match");
308 eap_gpsk_state(data, FAILURE);
313 if (end - pos < EAP_GPSK_RAND_LEN) {
314 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
316 eap_gpsk_state(data, FAILURE);
319 os_memcpy(data->rand_peer, pos, EAP_GPSK_RAND_LEN);
320 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Peer",
321 data->rand_peer, EAP_GPSK_RAND_LEN);
322 pos += EAP_GPSK_RAND_LEN;
324 if (end - pos < EAP_GPSK_RAND_LEN) {
325 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
327 eap_gpsk_state(data, FAILURE);
330 if (os_memcmp(data->rand_server, pos, EAP_GPSK_RAND_LEN) != 0) {
331 wpa_printf(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-1 and "
332 "GPSK-2 did not match");
333 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-1",
334 data->rand_server, EAP_GPSK_RAND_LEN);
335 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: RAND_Server in GPSK-2",
336 pos, EAP_GPSK_RAND_LEN);
337 eap_gpsk_state(data, FAILURE);
340 pos += EAP_GPSK_RAND_LEN;
343 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
344 "CSuite_List length");
345 eap_gpsk_state(data, FAILURE);
348 alen = WPA_GET_BE16(pos);
350 if (end - pos < alen) {
351 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
353 eap_gpsk_state(data, FAILURE);
356 if (alen != data->csuite_count * sizeof(struct eap_gpsk_csuite) ||
357 os_memcmp(pos, data->csuite_list, alen) != 0) {
358 wpa_printf(MSG_DEBUG, "EAP-GPSK: CSuite_List in GPSK-1 and "
359 "GPSK-2 did not match");
360 eap_gpsk_state(data, FAILURE);
365 if (end - pos < (int) sizeof(*csuite)) {
366 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
368 eap_gpsk_state(data, FAILURE);
371 csuite = (const struct eap_gpsk_csuite *) pos;
372 for (i = 0; i < data->csuite_count; i++) {
373 if (os_memcmp(csuite, &data->csuite_list[i], sizeof(*csuite))
377 if (i == data->csuite_count) {
378 wpa_printf(MSG_DEBUG, "EAP-GPSK: Peer selected unsupported "
380 WPA_GET_BE32(csuite->vendor),
381 WPA_GET_BE16(csuite->specifier));
382 eap_gpsk_state(data, FAILURE);
385 data->vendor = WPA_GET_BE32(csuite->vendor);
386 data->specifier = WPA_GET_BE16(csuite->specifier);
387 wpa_printf(MSG_DEBUG, "EAP-GPSK: CSuite_Sel %d:%d",
388 data->vendor, data->specifier);
389 pos += sizeof(*csuite);
392 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
393 "PD_Payload_1 length");
394 eap_gpsk_state(data, FAILURE);
397 alen = WPA_GET_BE16(pos);
399 if (end - pos < alen) {
400 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
402 eap_gpsk_state(data, FAILURE);
405 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: PD_Payload_1", pos, alen);
408 if (sm->user == NULL || sm->user->password == NULL) {
409 wpa_printf(MSG_INFO, "EAP-GPSK: No PSK/password configured "
411 eap_gpsk_state(data, FAILURE);
415 if (eap_gpsk_derive_keys(sm->user->password, sm->user->password_len,
416 data->vendor, data->specifier,
417 data->rand_peer, data->rand_server,
418 data->id_peer, data->id_peer_len,
419 data->id_server, data->id_server_len,
420 data->msk, data->emsk,
421 data->sk, &data->sk_len,
422 data->pk, &data->pk_len) < 0) {
423 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to derive keys");
424 eap_gpsk_state(data, FAILURE);
428 miclen = eap_gpsk_mic_len(data->vendor, data->specifier);
429 if (end - pos < (int) miclen) {
430 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for MIC "
431 "(left=%lu miclen=%lu)",
432 (unsigned long) (end - pos),
433 (unsigned long) miclen);
434 eap_gpsk_state(data, FAILURE);
437 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
438 data->specifier, payload, pos - payload, mic)
440 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to compute MIC");
441 eap_gpsk_state(data, FAILURE);
444 if (os_memcmp(mic, pos, miclen) != 0) {
445 wpa_printf(MSG_INFO, "EAP-GPSK: Incorrect MIC in GPSK-2");
446 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Received MIC", pos, miclen);
447 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Computed MIC", mic, miclen);
448 eap_gpsk_state(data, FAILURE);
454 wpa_printf(MSG_DEBUG, "EAP-GPSK: Ignored %lu bytes of extra "
455 "data in the end of GPSK-2",
456 (unsigned long) (end - pos));
459 eap_gpsk_state(data, GPSK_3);
463 static void eap_gpsk_process_gpsk_4(struct eap_sm *sm,
464 struct eap_gpsk_data *data,
465 const u8 *payload, size_t payloadlen)
470 u8 mic[EAP_GPSK_MAX_MIC_LEN];
472 if (data->state != GPSK_3)
475 wpa_printf(MSG_DEBUG, "EAP-GPSK: Received Response/GPSK-4");
478 end = payload + payloadlen;
481 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
482 "PD_Payload_1 length");
483 eap_gpsk_state(data, FAILURE);
486 alen = WPA_GET_BE16(pos);
488 if (end - pos < alen) {
489 wpa_printf(MSG_DEBUG, "EAP-GPSK: Too short message for "
491 eap_gpsk_state(data, FAILURE);
494 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: PD_Payload_1", pos, alen);
497 miclen = eap_gpsk_mic_len(data->vendor, data->specifier);
498 if (end - pos < (int) miclen) {
499 wpa_printf(MSG_DEBUG, "EAP-GPSK: Message too short for MIC "
500 "(left=%lu miclen=%lu)",
501 (unsigned long) (end - pos),
502 (unsigned long) miclen);
503 eap_gpsk_state(data, FAILURE);
506 if (eap_gpsk_compute_mic(data->sk, data->sk_len, data->vendor,
507 data->specifier, payload, pos - payload, mic)
509 wpa_printf(MSG_DEBUG, "EAP-GPSK: Failed to compute MIC");
510 eap_gpsk_state(data, FAILURE);
513 if (os_memcmp(mic, pos, miclen) != 0) {
514 wpa_printf(MSG_INFO, "EAP-GPSK: Incorrect MIC in GPSK-4");
515 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Received MIC", pos, miclen);
516 wpa_hexdump(MSG_DEBUG, "EAP-GPSK: Computed MIC", mic, miclen);
517 eap_gpsk_state(data, FAILURE);
523 wpa_printf(MSG_DEBUG, "EAP-GPSK: Ignored %lu bytes of extra "
524 "data in the end of GPSK-4",
525 (unsigned long) (end - pos));
528 eap_gpsk_state(data, SUCCESS);
532 static void eap_gpsk_process(struct eap_sm *sm, void *priv,
533 struct wpabuf *respData)
535 struct eap_gpsk_data *data = priv;
539 pos = eap_hdr_validate(EAP_VENDOR_IETF, EAP_TYPE_GPSK, respData, &len);
540 if (pos == NULL || len < 1)
544 case EAP_GPSK_OPCODE_GPSK_2:
545 eap_gpsk_process_gpsk_2(sm, data, pos + 1, len - 1);
547 case EAP_GPSK_OPCODE_GPSK_4:
548 eap_gpsk_process_gpsk_4(sm, data, pos + 1, len - 1);
554 static Boolean eap_gpsk_isDone(struct eap_sm *sm, void *priv)
556 struct eap_gpsk_data *data = priv;
557 return data->state == SUCCESS || data->state == FAILURE;
561 static u8 * eap_gpsk_getKey(struct eap_sm *sm, void *priv, size_t *len)
563 struct eap_gpsk_data *data = priv;
566 if (data->state != SUCCESS)
569 key = os_malloc(EAP_MSK_LEN);
572 os_memcpy(key, data->msk, EAP_MSK_LEN);
579 static u8 * eap_gpsk_get_emsk(struct eap_sm *sm, void *priv, size_t *len)
581 struct eap_gpsk_data *data = priv;
584 if (data->state != SUCCESS)
587 key = os_malloc(EAP_EMSK_LEN);
590 os_memcpy(key, data->emsk, EAP_EMSK_LEN);
597 static Boolean eap_gpsk_isSuccess(struct eap_sm *sm, void *priv)
599 struct eap_gpsk_data *data = priv;
600 return data->state == SUCCESS;
604 int eap_server_gpsk_register(void)
606 struct eap_method *eap;
609 eap = eap_server_method_alloc(EAP_SERVER_METHOD_INTERFACE_VERSION,
610 EAP_VENDOR_IETF, EAP_TYPE_GPSK, "GPSK");
614 eap->init = eap_gpsk_init;
615 eap->reset = eap_gpsk_reset;
616 eap->buildReq = eap_gpsk_buildReq;
617 eap->check = eap_gpsk_check;
618 eap->process = eap_gpsk_process;
619 eap->isDone = eap_gpsk_isDone;
620 eap->getKey = eap_gpsk_getKey;
621 eap->isSuccess = eap_gpsk_isSuccess;
622 eap->get_emsk = eap_gpsk_get_emsk;
624 ret = eap_server_method_register(eap);
626 eap_server_method_free(eap);