2 * EAP peer method: EAP-pwd (RFC 5931)
3 * Copyright (c) 2010, Dan Harkins <dharkins@lounge.org>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the BSD license.
8 * Alternatively, this software may be distributed under the terms of the
9 * GNU General Public License version 2 as published by the Free Software
12 * See README and COPYING for more details.
18 #include "eap_peer/eap_i.h"
19 #include "eap_common/eap_pwd_common.h"
24 PWD_ID_Req, PWD_Commit_Req, PWD_Confirm_Req, SUCCESS, FAILURE
36 BIGNUM *private_value;
37 BIGNUM *server_scalar;
40 EC_POINT *server_element;
43 u8 emsk[EAP_EMSK_LEN];
49 #ifndef CONFIG_NO_STDOUT_DEBUG
50 static const char * eap_pwd_state_txt(int state)
56 return "PWD-Commit-Req";
58 return "PWD-Confirm-Req";
67 #endif /* CONFIG_NO_STDOUT_DEBUG */
70 static void eap_pwd_state(struct eap_pwd_data *data, int state)
72 wpa_printf(MSG_INFO, "EAP-PWD: %s -> %s",
73 eap_pwd_state_txt(data->state), eap_pwd_state_txt(state));
78 static void * eap_pwd_init(struct eap_sm *sm)
80 struct eap_pwd_data *data;
81 const u8 *identity, *password;
82 size_t identity_len, password_len;
84 password = eap_get_config_password(sm, &password_len);
85 if (password == NULL) {
86 wpa_printf(MSG_INFO, "EAP-PWD: No password configured!");
90 identity = eap_get_config_identity(sm, &identity_len);
91 if (identity == NULL) {
92 wpa_printf(MSG_INFO, "EAP-PWD: No identity configured!");
96 if ((data = os_zalloc(sizeof(*data))) == NULL) {
97 wpa_printf(MSG_INFO, "EAP-PWD: memory allocation data fail");
101 if ((data->bnctx = BN_CTX_new()) == NULL) {
102 wpa_printf(MSG_INFO, "EAP-PWD: bn context allocation fail");
107 if ((data->id_peer = os_malloc(identity_len)) == NULL) {
108 wpa_printf(MSG_INFO, "EAP-PWD: memory allocation id fail");
109 BN_CTX_free(data->bnctx);
114 os_memcpy(data->id_peer, identity, identity_len);
115 data->id_peer_len = identity_len;
117 if ((data->password = os_malloc(password_len)) == NULL) {
118 wpa_printf(MSG_INFO, "EAP-PWD: memory allocation psk fail");
119 BN_CTX_free(data->bnctx);
120 os_free(data->id_peer);
124 os_memcpy(data->password, password, password_len);
125 data->password_len = password_len;
127 data->state = PWD_ID_Req;
133 static void eap_pwd_deinit(struct eap_sm *sm, void *priv)
135 struct eap_pwd_data *data = priv;
137 BN_free(data->private_value);
138 BN_free(data->server_scalar);
139 BN_free(data->my_scalar);
141 BN_CTX_free(data->bnctx);
142 EC_POINT_free(data->my_element);
143 EC_POINT_free(data->server_element);
144 os_free(data->id_peer);
145 os_free(data->password);
151 static u8 * eap_pwd_getkey(struct eap_sm *sm, void *priv, size_t *len)
153 struct eap_pwd_data *data = priv;
156 if (data->state != SUCCESS)
159 key = os_malloc(EAP_MSK_LEN);
163 os_memcpy(key, data->msk, EAP_MSK_LEN);
170 static struct wpabuf *
171 eap_pwd_perform_id_exchange(struct eap_sm *sm, struct eap_pwd_data *data,
172 struct eap_method_ret *ret,
173 const struct wpabuf *reqData,
174 const u8 *payload, size_t payload_len)
176 struct eap_pwd_id *id;
179 if (data->state != PWD_ID_Req) {
184 if (payload_len < sizeof(struct eap_pwd_id)) {
189 id = (struct eap_pwd_id *) payload;
190 data->group_num = be_to_host16(id->group_num);
191 if ((id->random_function != EAP_PWD_DEFAULT_RAND_FUNC) ||
192 (id->prf != EAP_PWD_DEFAULT_PRF)) {
197 wpa_printf(MSG_DEBUG, "EAP-PWD (peer): server said group %d",
200 data->id_server = os_malloc(payload_len - sizeof(struct eap_pwd_id));
201 if (data->id_server == NULL) {
202 wpa_printf(MSG_INFO, "EAP-PWD: memory allocation id fail");
205 data->id_server_len = payload_len - sizeof(struct eap_pwd_id);
206 os_memcpy(data->id_server, id->identity, data->id_server_len);
207 wpa_hexdump_ascii(MSG_INFO, "EAP-PWD (peer): server sent id of",
208 data->id_server, data->id_server_len);
210 if ((data->grp = (EAP_PWD_group *) os_malloc(sizeof(EAP_PWD_group))) ==
212 wpa_printf(MSG_INFO, "EAP-PWD: failed to allocate memory for "
218 if (compute_password_element(data->grp, data->group_num,
219 data->password, data->password_len,
220 data->id_server, data->id_server_len,
221 data->id_peer, data->id_peer_len,
223 wpa_printf(MSG_INFO, "EAP-PWD (peer): unable to compute PWE");
227 wpa_printf(MSG_INFO, "EAP-PWD (peer): computed %d bit PWE...",
228 BN_num_bits(data->grp->prime));
230 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_PWD,
231 1 + sizeof(struct eap_pwd_id) + data->id_peer_len,
232 EAP_CODE_RESPONSE, eap_get_id(reqData));
236 wpabuf_put_u8(resp, EAP_PWD_OPCODE_ID_EXCH);
237 wpabuf_put_be16(resp, data->group_num);
238 wpabuf_put_u8(resp, EAP_PWD_DEFAULT_RAND_FUNC);
239 wpabuf_put_u8(resp, EAP_PWD_DEFAULT_PRF);
240 wpabuf_put_data(resp, id->token, sizeof(id->token));
241 wpabuf_put_u8(resp, EAP_PWD_PREP_NONE);
242 wpabuf_put_data(resp, data->id_peer, data->id_peer_len);
244 eap_pwd_state(data, PWD_Commit_Req);
250 static struct wpabuf *
251 eap_pwd_perform_commit_exchange(struct eap_sm *sm, struct eap_pwd_data *data,
252 struct eap_method_ret *ret,
253 const struct wpabuf *reqData,
254 const u8 *payload, size_t payload_len)
256 struct wpabuf *resp = NULL;
257 EC_POINT *K = NULL, *point = NULL;
258 BIGNUM *mask = NULL, *x = NULL, *y = NULL, *cofactor = NULL;
260 u8 *ptr, *scalar = NULL, *element = NULL;
262 if (((data->private_value = BN_new()) == NULL) ||
263 ((data->my_element = EC_POINT_new(data->grp->group)) == NULL) ||
264 ((cofactor = BN_new()) == NULL) ||
265 ((data->my_scalar = BN_new()) == NULL) ||
266 ((mask = BN_new()) == NULL)) {
267 wpa_printf(MSG_INFO, "EAP-PWD (peer): scalar allocation fail");
271 if (!EC_GROUP_get_cofactor(data->grp->group, cofactor, NULL)) {
272 wpa_printf(MSG_INFO, "EAP-pwd (peer): unable to get cofactor "
277 BN_rand_range(data->private_value, data->grp->order);
278 BN_rand_range(mask, data->grp->order);
279 BN_add(data->my_scalar, data->private_value, mask);
280 BN_mod(data->my_scalar, data->my_scalar, data->grp->order,
283 if (!EC_POINT_mul(data->grp->group, data->my_element, NULL,
284 data->grp->pwe, mask, data->bnctx)) {
285 wpa_printf(MSG_INFO, "EAP-PWD (peer): element allocation "
287 eap_pwd_state(data, FAILURE);
291 if (!EC_POINT_invert(data->grp->group, data->my_element, data->bnctx))
293 wpa_printf(MSG_INFO, "EAP-PWD (peer): element inversion fail");
298 if (((x = BN_new()) == NULL) ||
299 ((y = BN_new()) == NULL)) {
300 wpa_printf(MSG_INFO, "EAP-PWD (peer): point allocation fail");
304 /* process the request */
305 if (((data->server_scalar = BN_new()) == NULL) ||
306 ((data->k = BN_new()) == NULL) ||
307 ((K = EC_POINT_new(data->grp->group)) == NULL) ||
308 ((point = EC_POINT_new(data->grp->group)) == NULL) ||
309 ((data->server_element = EC_POINT_new(data->grp->group)) == NULL))
311 wpa_printf(MSG_INFO, "EAP-PWD (peer): peer data allocation "
316 /* element, x then y, followed by scalar */
317 ptr = (u8 *) payload;
318 BN_bin2bn(ptr, BN_num_bytes(data->grp->prime), x);
319 ptr += BN_num_bytes(data->grp->prime);
320 BN_bin2bn(ptr, BN_num_bytes(data->grp->prime), y);
321 ptr += BN_num_bytes(data->grp->prime);
322 BN_bin2bn(ptr, BN_num_bytes(data->grp->order), data->server_scalar);
323 if (!EC_POINT_set_affine_coordinates_GFp(data->grp->group,
324 data->server_element, x, y,
326 wpa_printf(MSG_INFO, "EAP-PWD (peer): setting peer element "
331 /* check to ensure server's element is not in a small sub-group */
332 if (BN_cmp(cofactor, BN_value_one())) {
333 if (!EC_POINT_mul(data->grp->group, point, NULL,
334 data->server_element, cofactor, NULL)) {
335 wpa_printf(MSG_INFO, "EAP-PWD (peer): cannot multiply "
336 "server element by order!\n");
339 if (EC_POINT_is_at_infinity(data->grp->group, point)) {
340 wpa_printf(MSG_INFO, "EAP-PWD (peer): server element "
341 "is at infinity!\n");
346 /* compute the shared key, k */
347 if ((!EC_POINT_mul(data->grp->group, K, NULL, data->grp->pwe,
348 data->server_scalar, data->bnctx)) ||
349 (!EC_POINT_add(data->grp->group, K, K, data->server_element,
351 (!EC_POINT_mul(data->grp->group, K, NULL, K, data->private_value,
353 wpa_printf(MSG_INFO, "EAP-PWD (peer): computing shared key "
358 /* ensure that the shared key isn't in a small sub-group */
359 if (BN_cmp(cofactor, BN_value_one())) {
360 if (!EC_POINT_mul(data->grp->group, K, NULL, K, cofactor,
362 wpa_printf(MSG_INFO, "EAP-PWD (peer): cannot multiply "
363 "shared key point by order");
369 * This check is strictly speaking just for the case above where
370 * co-factor > 1 but it was suggested that even though this is probably
371 * never going to happen it is a simple and safe check "just to be
372 * sure" so let's be safe.
374 if (EC_POINT_is_at_infinity(data->grp->group, K)) {
375 wpa_printf(MSG_INFO, "EAP-PWD (peer): shared key point is at "
380 if (!EC_POINT_get_affine_coordinates_GFp(data->grp->group, K, data->k,
381 NULL, data->bnctx)) {
382 wpa_printf(MSG_INFO, "EAP-PWD (peer): unable to extract "
383 "shared secret from point");
387 /* now do the response */
388 if (!EC_POINT_get_affine_coordinates_GFp(data->grp->group,
389 data->my_element, x, y,
391 wpa_printf(MSG_INFO, "EAP-PWD (peer): point assignment fail");
395 if (((scalar = os_malloc(BN_num_bytes(data->grp->order))) == NULL) ||
396 ((element = os_malloc(BN_num_bytes(data->grp->prime) * 2)) ==
398 wpa_printf(MSG_INFO, "EAP-PWD (peer): data allocation fail");
403 * bignums occupy as little memory as possible so one that is
404 * sufficiently smaller than the prime or order might need pre-pending
407 os_memset(scalar, 0, BN_num_bytes(data->grp->order));
408 os_memset(element, 0, BN_num_bytes(data->grp->prime) * 2);
409 offset = BN_num_bytes(data->grp->order) -
410 BN_num_bytes(data->my_scalar);
411 BN_bn2bin(data->my_scalar, scalar + offset);
413 offset = BN_num_bytes(data->grp->prime) - BN_num_bytes(x);
414 BN_bn2bin(x, element + offset);
415 offset = BN_num_bytes(data->grp->prime) - BN_num_bytes(y);
416 BN_bn2bin(y, element + BN_num_bytes(data->grp->prime) + offset);
418 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_PWD,
419 sizeof(struct eap_pwd_hdr) +
420 BN_num_bytes(data->grp->order) +
421 (2 * BN_num_bytes(data->grp->prime)),
422 EAP_CODE_RESPONSE, eap_get_id(reqData));
426 wpabuf_put_u8(resp, EAP_PWD_OPCODE_COMMIT_EXCH);
428 /* we send the element as (x,y) follwed by the scalar */
429 wpabuf_put_data(resp, element, (2 * BN_num_bytes(data->grp->prime)));
430 wpabuf_put_data(resp, scalar, BN_num_bytes(data->grp->order));
439 EC_POINT_free(point);
441 eap_pwd_state(data, FAILURE);
443 eap_pwd_state(data, PWD_Confirm_Req);
449 static struct wpabuf *
450 eap_pwd_perform_confirm_exchange(struct eap_sm *sm, struct eap_pwd_data *data,
451 struct eap_method_ret *ret,
452 const struct wpabuf *reqData,
453 const u8 *payload, size_t payload_len)
455 struct wpabuf *resp = NULL;
456 BIGNUM *x = NULL, *y = NULL;
459 u8 conf[SHA256_DIGEST_LENGTH], *cruft = NULL, *ptr;
462 * first build up the ciphersuite which is group | random_function |
466 os_memcpy(ptr, &data->group_num, sizeof(u16));
468 *ptr = EAP_PWD_DEFAULT_RAND_FUNC;
470 *ptr = EAP_PWD_DEFAULT_PRF;
472 /* each component of the cruft will be at most as big as the prime */
473 if (((cruft = os_malloc(BN_num_bytes(data->grp->prime))) == NULL) ||
474 ((x = BN_new()) == NULL) || ((y = BN_new()) == NULL)) {
475 wpa_printf(MSG_INFO, "EAP-PWD (server): debug allocation "
481 * server's commit is H(k | server_element | server_scalar |
482 * peer_element | peer_scalar | ciphersuite)
487 * zero the memory each time because this is mod prime math and some
488 * value may start with a few zeros and the previous one did not.
490 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
491 BN_bn2bin(data->k, cruft);
492 H_Update(&ctx, cruft, BN_num_bytes(data->grp->prime));
494 /* server element: x, y */
495 if (!EC_POINT_get_affine_coordinates_GFp(data->grp->group,
496 data->server_element, x, y,
498 wpa_printf(MSG_INFO, "EAP-PWD (server): confirm point "
502 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
504 H_Update(&ctx, cruft, BN_num_bytes(data->grp->prime));
505 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
507 H_Update(&ctx, cruft, BN_num_bytes(data->grp->prime));
510 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
511 BN_bn2bin(data->server_scalar, cruft);
512 H_Update(&ctx, cruft, BN_num_bytes(data->grp->order));
514 /* my element: x, y */
515 if (!EC_POINT_get_affine_coordinates_GFp(data->grp->group,
516 data->my_element, x, y,
518 wpa_printf(MSG_INFO, "EAP-PWD (server): confirm point "
523 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
525 H_Update(&ctx, cruft, BN_num_bytes(data->grp->prime));
526 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
528 H_Update(&ctx, cruft, BN_num_bytes(data->grp->prime));
531 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
532 BN_bn2bin(data->my_scalar, cruft);
533 H_Update(&ctx, cruft, BN_num_bytes(data->grp->order));
535 /* the ciphersuite */
536 H_Update(&ctx, (u8 *) &cs, sizeof(u32));
538 /* random function fin */
541 ptr = (u8 *) payload;
542 if (os_memcmp(conf, ptr, SHA256_DIGEST_LENGTH)) {
543 wpa_printf(MSG_INFO, "EAP-PWD (peer): confirm did not verify");
547 wpa_printf(MSG_DEBUG, "EAP-pwd (peer): confirm verified");
551 * H(k | peer_element | peer_scalar | server_element | server_scalar |
557 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
558 BN_bn2bin(data->k, cruft);
559 H_Update(&ctx, cruft, BN_num_bytes(data->grp->prime));
562 if (!EC_POINT_get_affine_coordinates_GFp(data->grp->group,
563 data->my_element, x, y,
565 wpa_printf(MSG_INFO, "EAP-PWD (peer): confirm point "
569 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
571 H_Update(&ctx, cruft, BN_num_bytes(data->grp->prime));
572 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
574 H_Update(&ctx, cruft, BN_num_bytes(data->grp->prime));
577 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
578 BN_bn2bin(data->my_scalar, cruft);
579 H_Update(&ctx, cruft, BN_num_bytes(data->grp->order));
581 /* server element: x, y */
582 if (!EC_POINT_get_affine_coordinates_GFp(data->grp->group,
583 data->server_element, x, y,
585 wpa_printf(MSG_INFO, "EAP-PWD (peer): confirm point "
589 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
591 H_Update(&ctx, cruft, BN_num_bytes(data->grp->prime));
592 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
594 H_Update(&ctx, cruft, BN_num_bytes(data->grp->prime));
597 os_memset(cruft, 0, BN_num_bytes(data->grp->prime));
598 BN_bn2bin(data->server_scalar, cruft);
599 H_Update(&ctx, cruft, BN_num_bytes(data->grp->order));
601 /* the ciphersuite */
602 H_Update(&ctx, (u8 *) &cs, sizeof(u32));
607 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_PWD,
608 sizeof(struct eap_pwd_hdr) + SHA256_DIGEST_LENGTH,
609 EAP_CODE_RESPONSE, eap_get_id(reqData));
613 wpabuf_put_u8(resp, EAP_PWD_OPCODE_CONFIRM_EXCH);
614 wpabuf_put_data(resp, conf, SHA256_DIGEST_LENGTH);
616 if (compute_keys(data->grp, data->bnctx, data->k, data->server_element,
617 data->my_element, data->server_scalar,
618 data->my_scalar, &cs, data->msk, data->emsk) < 0) {
619 wpa_printf(MSG_INFO, "EAP-PWD (peer): unable to compute MSK | "
628 ret->methodState = METHOD_DONE;
630 ret->decision = DECISION_FAIL;
631 eap_pwd_state(data, FAILURE);
633 ret->decision = DECISION_UNCOND_SUCC;
634 eap_pwd_state(data, SUCCESS);
641 static struct wpabuf *
642 eap_pwd_process(struct eap_sm *sm, void *priv, struct eap_method_ret *ret,
643 const struct wpabuf *reqData)
645 struct eap_pwd_data *data = priv;
646 struct wpabuf *resp = NULL;
651 pos = eap_hdr_validate(EAP_VENDOR_IETF, EAP_TYPE_PWD, reqData, &len);
652 if ((pos == NULL) || (len < 1)) {
657 wpa_printf(MSG_INFO, "EAP-pwd: Received frame: opcode %d", *pos);
660 ret->methodState = METHOD_MAY_CONT;
661 ret->decision = DECISION_FAIL;
662 ret->allowNotifications = FALSE;
666 case EAP_PWD_OPCODE_ID_EXCH:
667 resp = eap_pwd_perform_id_exchange(sm, data, ret, reqData,
670 case EAP_PWD_OPCODE_COMMIT_EXCH:
671 resp = eap_pwd_perform_commit_exchange(sm, data, ret, reqData,
674 case EAP_PWD_OPCODE_CONFIRM_EXCH:
675 resp = eap_pwd_perform_confirm_exchange(sm, data, ret, reqData,
679 wpa_printf(MSG_INFO, "EAP-pwd: Ignoring message with unknown "
688 static Boolean eap_pwd_key_available(struct eap_sm *sm, void *priv)
690 struct eap_pwd_data *data = priv;
691 return data->state == SUCCESS;
695 static u8 * eap_pwd_get_emsk(struct eap_sm *sm, void *priv, size_t *len)
697 struct eap_pwd_data *data = priv;
700 if (data->state != SUCCESS)
703 if ((key = os_malloc(EAP_EMSK_LEN)) == NULL)
706 os_memcpy(key, data->emsk, EAP_EMSK_LEN);
713 int eap_peer_pwd_register(void)
715 struct eap_method *eap;
718 EVP_add_digest(EVP_sha256());
719 eap = eap_peer_method_alloc(EAP_PEER_METHOD_INTERFACE_VERSION,
720 EAP_VENDOR_IETF, EAP_TYPE_PWD, "PWD");
724 eap->init = eap_pwd_init;
725 eap->deinit = eap_pwd_deinit;
726 eap->process = eap_pwd_process;
727 eap->isKeyAvailable = eap_pwd_key_available;
728 eap->getKey = eap_pwd_getkey;
729 eap->get_emsk = eap_pwd_get_emsk;
731 ret = eap_peer_method_register(eap);
733 eap_peer_method_free(eap);