2 * Copyright (C) 2008-2013 Tobias Brunner
3 * Hochschule fuer Technik Rapperswil
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 #include <openssl/opensslconf.h>
20 #include <openssl/bn.h>
21 #include <openssl/ec.h>
22 #include <openssl/objects.h>
23 #include <openssl/bn.h>
25 #include "openssl_ec_diffie_hellman.h"
26 #include "openssl_util.h"
28 #include <utils/debug.h>
30 typedef struct private_openssl_ec_diffie_hellman_t private_openssl_ec_diffie_hellman_t
;
33 * Private data of an openssl_ec_diffie_hellman_t object.
35 struct private_openssl_ec_diffie_hellman_t
{
37 * Public openssl_ec_diffie_hellman_t interface.
39 openssl_ec_diffie_hellman_t
public;
42 * Diffie Hellman group number.
44 diffie_hellman_group_t group
;
47 * EC private (public) key
54 const EC_GROUP
*ec_group
;
64 chunk_t shared_secret
;
67 * True if shared secret is computed
73 * Convert a chunk to an EC_POINT (which must already exist). The x and y
74 * coordinates of the point have to be concatenated in the chunk.
76 static bool chunk2ecp(const EC_GROUP
*group
, chunk_t chunk
, EC_POINT
*point
)
96 if (!openssl_bn_split(chunk
, x
, y
))
101 if (!EC_POINT_set_affine_coordinates_GFp(group
, point
, x
, y
, ctx
))
106 if (!EC_POINT_is_on_curve(group
, point
, ctx
))
119 * Convert an EC_POINT to a chunk by concatenating the x and y coordinates of
120 * the point. This function allocates memory for the chunk.
122 static bool ecp2chunk(const EC_GROUP
*group
, const EC_POINT
*point
,
123 chunk_t
*chunk
, bool x_coordinate_only
)
143 if (!EC_POINT_get_affine_coordinates_GFp(group
, point
, x
, y
, ctx
))
148 if (x_coordinate_only
)
152 if (!openssl_bn_cat(EC_FIELD_ELEMENT_LEN(group
), x
, y
, chunk
))
165 * Compute the shared secret.
167 * We cannot use the function ECDH_compute_key() because that returns only the
168 * x coordinate of the shared secret point (which is defined, for instance, in
169 * 'NIST SP 800-56A').
170 * However, we need both coordinates as RFC 4753 says: "The Diffie-Hellman
171 * public value is obtained by concatenating the x and y values. The format
172 * of the Diffie-Hellman shared secret value is the same as that of the
173 * Diffie-Hellman public value."
175 static bool compute_shared_key(private_openssl_ec_diffie_hellman_t
*this,
176 chunk_t
*shared_secret
)
178 const BIGNUM
*priv_key
;
179 EC_POINT
*secret
= NULL
;
180 bool x_coordinate_only
, ret
= FALSE
;
182 priv_key
= EC_KEY_get0_private_key(this->key
);
188 secret
= EC_POINT_new(this->ec_group
);
194 if (!EC_POINT_mul(this->ec_group
, secret
, NULL
, this->pub_key
, priv_key
, NULL
))
200 * The default setting ecp_x_coordinate_only = TRUE
201 * applies the following errata for RFC 4753:
202 * http://www.rfc-editor.org/errata_search.php?eid=9
204 x_coordinate_only
= lib
->settings
->get_bool(lib
->settings
,
205 "%s.ecp_x_coordinate_only", TRUE
, lib
->ns
);
206 if (!ecp2chunk(this->ec_group
, secret
, shared_secret
, x_coordinate_only
))
215 EC_POINT_clear_free(secret
);
220 METHOD(diffie_hellman_t
, set_other_public_value
, bool,
221 private_openssl_ec_diffie_hellman_t
*this, chunk_t value
)
223 if (!diffie_hellman_verify_value(this->group
, value
))
228 if (!chunk2ecp(this->ec_group
, value
, this->pub_key
))
230 DBG1(DBG_LIB
, "ECDH public value is malformed");
234 chunk_clear(&this->shared_secret
);
236 if (!compute_shared_key(this, &this->shared_secret
)) {
237 DBG1(DBG_LIB
, "ECDH shared secret computation failed");
241 this->computed
= TRUE
;
245 METHOD(diffie_hellman_t
, get_my_public_value
, bool,
246 private_openssl_ec_diffie_hellman_t
*this,chunk_t
*value
)
248 ecp2chunk(this->ec_group
, EC_KEY_get0_public_key(this->key
), value
, FALSE
);
252 METHOD(diffie_hellman_t
, set_private_value
, bool,
253 private_openssl_ec_diffie_hellman_t
*this, chunk_t value
)
255 EC_POINT
*pub
= NULL
;
259 priv
= BN_bin2bn(value
.ptr
, value
.len
, NULL
);
264 pub
= EC_POINT_new(EC_KEY_get0_group(this->key
));
269 if (EC_POINT_mul(this->ec_group
, pub
, priv
, NULL
, NULL
, NULL
) != 1)
273 if (EC_KEY_set_private_key(this->key
, priv
) != 1)
277 if (EC_KEY_set_public_key(this->key
, pub
) != 1)
295 METHOD(diffie_hellman_t
, get_shared_secret
, bool,
296 private_openssl_ec_diffie_hellman_t
*this, chunk_t
*secret
)
302 *secret
= chunk_clone(this->shared_secret
);
306 METHOD(diffie_hellman_t
, get_dh_group
, diffie_hellman_group_t
,
307 private_openssl_ec_diffie_hellman_t
*this)
312 METHOD(diffie_hellman_t
, destroy
, void,
313 private_openssl_ec_diffie_hellman_t
*this)
317 EC_POINT_clear_free(this->pub_key
);
321 EC_KEY_free(this->key
);
323 chunk_clear(&this->shared_secret
);
328 * ECC Brainpool curves are not available in OpenSSL releases < 1.0.2, but we
329 * don't check the version in case somebody backported them.
331 #if (!defined(NID_brainpoolP224r1) || !defined(NID_brainpoolP256r1) || \
332 !defined(NID_brainpoolP384r1) || !defined(NID_brainpoolP512r1))
335 * Parameters for ECC Brainpool curves
339 diffie_hellman_group_t group
;
341 /** The prime p specifying the base field */
344 /** Coefficient a of the elliptic curve E: y^2 = x^3 + ax + b (mod p) */
350 /** x coordinate of base point G (a point in E of prime order) */
353 /** y coordinate of base point G */
356 /** Prime order q of the group generated by G */
362 * List of ECC Brainpool curves
364 static bp_curve bp_curves
[] = {
366 /* ECC Brainpool 224-bit curve (RFC 5639), brainpoolP224r1 */
368 .p
= chunk_from_chars(
369 0xD7,0xC1,0x34,0xAA,0x26,0x43,0x66,0x86,0x2A,0x18,0x30,0x25,0x75,0xD1,0xD7,0x87,
370 0xB0,0x9F,0x07,0x57,0x97,0xDA,0x89,0xF5,0x7E,0xC8,0xC0,0xFF),
371 .a
= chunk_from_chars(
372 0x68,0xA5,0xE6,0x2C,0xA9,0xCE,0x6C,0x1C,0x29,0x98,0x03,0xA6,0xC1,0x53,0x0B,0x51,
373 0x4E,0x18,0x2A,0xD8,0xB0,0x04,0x2A,0x59,0xCA,0xD2,0x9F,0x43),
374 .b
= chunk_from_chars(
375 0x25,0x80,0xF6,0x3C,0xCF,0xE4,0x41,0x38,0x87,0x07,0x13,0xB1,0xA9,0x23,0x69,0xE3,
376 0x3E,0x21,0x35,0xD2,0x66,0xDB,0xB3,0x72,0x38,0x6C,0x40,0x0B),
377 .x
= chunk_from_chars(
378 0x0D,0x90,0x29,0xAD,0x2C,0x7E,0x5C,0xF4,0x34,0x08,0x23,0xB2,0xA8,0x7D,0xC6,0x8C,
379 0x9E,0x4C,0xE3,0x17,0x4C,0x1E,0x6E,0xFD,0xEE,0x12,0xC0,0x7D),
380 .y
= chunk_from_chars(
381 0x58,0xAA,0x56,0xF7,0x72,0xC0,0x72,0x6F,0x24,0xC6,0xB8,0x9E,0x4E,0xCD,0xAC,0x24,
382 0x35,0x4B,0x9E,0x99,0xCA,0xA3,0xF6,0xD3,0x76,0x14,0x02,0xCD),
383 .q
= chunk_from_chars(
384 0xD7,0xC1,0x34,0xAA,0x26,0x43,0x66,0x86,0x2A,0x18,0x30,0x25,0x75,0xD0,0xFB,0x98,
385 0xD1,0x16,0xBC,0x4B,0x6D,0xDE,0xBC,0xA3,0xA5,0xA7,0x93,0x9F),
388 /* ECC Brainpool 256-bit curve (RFC 5639), brainpoolP256r1 */
390 .p
= chunk_from_chars(
391 0xA9,0xFB,0x57,0xDB,0xA1,0xEE,0xA9,0xBC,0x3E,0x66,0x0A,0x90,0x9D,0x83,0x8D,0x72,
392 0x6E,0x3B,0xF6,0x23,0xD5,0x26,0x20,0x28,0x20,0x13,0x48,0x1D,0x1F,0x6E,0x53,0x77),
393 .a
= chunk_from_chars(
394 0x7D,0x5A,0x09,0x75,0xFC,0x2C,0x30,0x57,0xEE,0xF6,0x75,0x30,0x41,0x7A,0xFF,0xE7,
395 0xFB,0x80,0x55,0xC1,0x26,0xDC,0x5C,0x6C,0xE9,0x4A,0x4B,0x44,0xF3,0x30,0xB5,0xD9),
396 .b
= chunk_from_chars(
397 0x26,0xDC,0x5C,0x6C,0xE9,0x4A,0x4B,0x44,0xF3,0x30,0xB5,0xD9,0xBB,0xD7,0x7C,0xBF,
398 0x95,0x84,0x16,0x29,0x5C,0xF7,0xE1,0xCE,0x6B,0xCC,0xDC,0x18,0xFF,0x8C,0x07,0xB6),
399 .x
= chunk_from_chars(
400 0x8B,0xD2,0xAE,0xB9,0xCB,0x7E,0x57,0xCB,0x2C,0x4B,0x48,0x2F,0xFC,0x81,0xB7,0xAF,
401 0xB9,0xDE,0x27,0xE1,0xE3,0xBD,0x23,0xC2,0x3A,0x44,0x53,0xBD,0x9A,0xCE,0x32,0x62),
402 .y
= chunk_from_chars(
403 0x54,0x7E,0xF8,0x35,0xC3,0xDA,0xC4,0xFD,0x97,0xF8,0x46,0x1A,0x14,0x61,0x1D,0xC9,
404 0xC2,0x77,0x45,0x13,0x2D,0xED,0x8E,0x54,0x5C,0x1D,0x54,0xC7,0x2F,0x04,0x69,0x97),
405 .q
= chunk_from_chars(
406 0xA9,0xFB,0x57,0xDB,0xA1,0xEE,0xA9,0xBC,0x3E,0x66,0x0A,0x90,0x9D,0x83,0x8D,0x71,
407 0x8C,0x39,0x7A,0xA3,0xB5,0x61,0xA6,0xF7,0x90,0x1E,0x0E,0x82,0x97,0x48,0x56,0xA7),
410 /* ECC Brainpool 384-bit curve (RFC 5639), brainpoolP384r1 */
412 .p
= chunk_from_chars(
413 0x8C,0xB9,0x1E,0x82,0xA3,0x38,0x6D,0x28,0x0F,0x5D,0x6F,0x7E,0x50,0xE6,0x41,0xDF,
414 0x15,0x2F,0x71,0x09,0xED,0x54,0x56,0xB4,0x12,0xB1,0xDA,0x19,0x7F,0xB7,0x11,0x23,
415 0xAC,0xD3,0xA7,0x29,0x90,0x1D,0x1A,0x71,0x87,0x47,0x00,0x13,0x31,0x07,0xEC,0x53),
416 .a
= chunk_from_chars(
417 0x7B,0xC3,0x82,0xC6,0x3D,0x8C,0x15,0x0C,0x3C,0x72,0x08,0x0A,0xCE,0x05,0xAF,0xA0,
418 0xC2,0xBE,0xA2,0x8E,0x4F,0xB2,0x27,0x87,0x13,0x91,0x65,0xEF,0xBA,0x91,0xF9,0x0F,
419 0x8A,0xA5,0x81,0x4A,0x50,0x3A,0xD4,0xEB,0x04,0xA8,0xC7,0xDD,0x22,0xCE,0x28,0x26),
420 .b
= chunk_from_chars(
421 0x04,0xA8,0xC7,0xDD,0x22,0xCE,0x28,0x26,0x8B,0x39,0xB5,0x54,0x16,0xF0,0x44,0x7C,
422 0x2F,0xB7,0x7D,0xE1,0x07,0xDC,0xD2,0xA6,0x2E,0x88,0x0E,0xA5,0x3E,0xEB,0x62,0xD5,
423 0x7C,0xB4,0x39,0x02,0x95,0xDB,0xC9,0x94,0x3A,0xB7,0x86,0x96,0xFA,0x50,0x4C,0x11),
424 .x
= chunk_from_chars(
425 0x1D,0x1C,0x64,0xF0,0x68,0xCF,0x45,0xFF,0xA2,0xA6,0x3A,0x81,0xB7,0xC1,0x3F,0x6B,
426 0x88,0x47,0xA3,0xE7,0x7E,0xF1,0x4F,0xE3,0xDB,0x7F,0xCA,0xFE,0x0C,0xBD,0x10,0xE8,
427 0xE8,0x26,0xE0,0x34,0x36,0xD6,0x46,0xAA,0xEF,0x87,0xB2,0xE2,0x47,0xD4,0xAF,0x1E),
428 .y
= chunk_from_chars(
429 0x8A,0xBE,0x1D,0x75,0x20,0xF9,0xC2,0xA4,0x5C,0xB1,0xEB,0x8E,0x95,0xCF,0xD5,0x52,
430 0x62,0xB7,0x0B,0x29,0xFE,0xEC,0x58,0x64,0xE1,0x9C,0x05,0x4F,0xF9,0x91,0x29,0x28,
431 0x0E,0x46,0x46,0x21,0x77,0x91,0x81,0x11,0x42,0x82,0x03,0x41,0x26,0x3C,0x53,0x15),
432 .q
= chunk_from_chars(
433 0x8C,0xB9,0x1E,0x82,0xA3,0x38,0x6D,0x28,0x0F,0x5D,0x6F,0x7E,0x50,0xE6,0x41,0xDF,
434 0x15,0x2F,0x71,0x09,0xED,0x54,0x56,0xB3,0x1F,0x16,0x6E,0x6C,0xAC,0x04,0x25,0xA7,
435 0xCF,0x3A,0xB6,0xAF,0x6B,0x7F,0xC3,0x10,0x3B,0x88,0x32,0x02,0xE9,0x04,0x65,0x65),
438 /* ECC Brainpool 512-bit curve (RFC 5639), brainpoolP512r1 */
440 .p
= chunk_from_chars(
441 0xAA,0xDD,0x9D,0xB8,0xDB,0xE9,0xC4,0x8B,0x3F,0xD4,0xE6,0xAE,0x33,0xC9,0xFC,0x07,
442 0xCB,0x30,0x8D,0xB3,0xB3,0xC9,0xD2,0x0E,0xD6,0x63,0x9C,0xCA,0x70,0x33,0x08,0x71,
443 0x7D,0x4D,0x9B,0x00,0x9B,0xC6,0x68,0x42,0xAE,0xCD,0xA1,0x2A,0xE6,0xA3,0x80,0xE6,
444 0x28,0x81,0xFF,0x2F,0x2D,0x82,0xC6,0x85,0x28,0xAA,0x60,0x56,0x58,0x3A,0x48,0xF3),
445 .a
= chunk_from_chars(
446 0x78,0x30,0xA3,0x31,0x8B,0x60,0x3B,0x89,0xE2,0x32,0x71,0x45,0xAC,0x23,0x4C,0xC5,
447 0x94,0xCB,0xDD,0x8D,0x3D,0xF9,0x16,0x10,0xA8,0x34,0x41,0xCA,0xEA,0x98,0x63,0xBC,
448 0x2D,0xED,0x5D,0x5A,0xA8,0x25,0x3A,0xA1,0x0A,0x2E,0xF1,0xC9,0x8B,0x9A,0xC8,0xB5,
449 0x7F,0x11,0x17,0xA7,0x2B,0xF2,0xC7,0xB9,0xE7,0xC1,0xAC,0x4D,0x77,0xFC,0x94,0xCA),
450 .b
= chunk_from_chars(
451 0x3D,0xF9,0x16,0x10,0xA8,0x34,0x41,0xCA,0xEA,0x98,0x63,0xBC,0x2D,0xED,0x5D,0x5A,
452 0xA8,0x25,0x3A,0xA1,0x0A,0x2E,0xF1,0xC9,0x8B,0x9A,0xC8,0xB5,0x7F,0x11,0x17,0xA7,
453 0x2B,0xF2,0xC7,0xB9,0xE7,0xC1,0xAC,0x4D,0x77,0xFC,0x94,0xCA,0xDC,0x08,0x3E,0x67,
454 0x98,0x40,0x50,0xB7,0x5E,0xBA,0xE5,0xDD,0x28,0x09,0xBD,0x63,0x80,0x16,0xF7,0x23),
455 .x
= chunk_from_chars(
456 0x81,0xAE,0xE4,0xBD,0xD8,0x2E,0xD9,0x64,0x5A,0x21,0x32,0x2E,0x9C,0x4C,0x6A,0x93,
457 0x85,0xED,0x9F,0x70,0xB5,0xD9,0x16,0xC1,0xB4,0x3B,0x62,0xEE,0xF4,0xD0,0x09,0x8E,
458 0xFF,0x3B,0x1F,0x78,0xE2,0xD0,0xD4,0x8D,0x50,0xD1,0x68,0x7B,0x93,0xB9,0x7D,0x5F,
459 0x7C,0x6D,0x50,0x47,0x40,0x6A,0x5E,0x68,0x8B,0x35,0x22,0x09,0xBC,0xB9,0xF8,0x22),
460 .y
= chunk_from_chars(
461 0x7D,0xDE,0x38,0x5D,0x56,0x63,0x32,0xEC,0xC0,0xEA,0xBF,0xA9,0xCF,0x78,0x22,0xFD,
462 0xF2,0x09,0xF7,0x00,0x24,0xA5,0x7B,0x1A,0xA0,0x00,0xC5,0x5B,0x88,0x1F,0x81,0x11,
463 0xB2,0xDC,0xDE,0x49,0x4A,0x5F,0x48,0x5E,0x5B,0xCA,0x4B,0xD8,0x8A,0x27,0x63,0xAE,
464 0xD1,0xCA,0x2B,0x2F,0xA8,0xF0,0x54,0x06,0x78,0xCD,0x1E,0x0F,0x3A,0xD8,0x08,0x92),
465 .q
= chunk_from_chars(
466 0xAA,0xDD,0x9D,0xB8,0xDB,0xE9,0xC4,0x8B,0x3F,0xD4,0xE6,0xAE,0x33,0xC9,0xFC,0x07,
467 0xCB,0x30,0x8D,0xB3,0xB3,0xC9,0xD2,0x0E,0xD6,0x63,0x9C,0xCA,0x70,0x33,0x08,0x70,
468 0x55,0x3E,0x5C,0x41,0x4C,0xA9,0x26,0x19,0x41,0x86,0x61,0x19,0x7F,0xAC,0x10,0x47,
469 0x1D,0xB1,0xD3,0x81,0x08,0x5D,0xDA,0xDD,0xB5,0x87,0x96,0x82,0x9C,0xA9,0x00,0x69),
474 * Create an EC_GROUP object for an ECC Brainpool curve
476 EC_GROUP
*ec_group_new_brainpool(bp_curve
*curve
)
478 BIGNUM
*p
, *a
, *b
, *x
, *y
, *q
;
481 EC_GROUP
*group
= NULL
, *result
= NULL
;
485 p
= BN_bin2bn(curve
->p
.ptr
, curve
->p
.len
, NULL
);
486 a
= BN_bin2bn(curve
->a
.ptr
, curve
->a
.len
, NULL
);
487 b
= BN_bin2bn(curve
->b
.ptr
, curve
->b
.len
, NULL
);
488 x
= BN_bin2bn(curve
->x
.ptr
, curve
->x
.len
, NULL
);
489 y
= BN_bin2bn(curve
->y
.ptr
, curve
->y
.len
, NULL
);
490 q
= BN_bin2bn(curve
->q
.ptr
, curve
->q
.len
, NULL
);
491 /* all supported groups have a cofactor of 1 */
493 if (!ctx
|| !p
|| !a
|| !b
|| !x
|| !y
|| !q
)
497 group
= EC_GROUP_new_curve_GFp(p
, a
, b
, ctx
);
502 G
= EC_POINT_new(group
);
503 if (!G
|| !EC_POINT_set_affine_coordinates_GFp(group
, G
, x
, y
, ctx
))
507 if (!EC_GROUP_set_generator(group
, G
, q
, h
))
514 if (!result
&& group
)
516 EC_GROUP_free(group
);
533 * Create an EC_KEY for ECC Brainpool curves as defined above
535 static EC_KEY
*ec_key_new_brainpool(diffie_hellman_group_t group
)
537 bp_curve
*curve
= NULL
;
542 for (i
= 0; i
< countof(bp_curves
); i
++)
544 if (bp_curves
[i
].group
== group
)
546 curve
= &bp_curves
[i
];
553 ec_group
= ec_group_new_brainpool(curve
);
559 if (!key
|| !EC_KEY_set_group(key
, ec_group
))
564 EC_GROUP_free(ec_group
);
568 #else /* !NID_brainpoolP224r1 || ... */
571 * Create an EC_KEY for ECC Brainpool curves as defined by OpenSSL
573 static EC_KEY
*ec_key_new_brainpool(diffie_hellman_group_t group
)
578 return EC_KEY_new_by_curve_name(NID_brainpoolP224r1
);
580 return EC_KEY_new_by_curve_name(NID_brainpoolP256r1
);
582 return EC_KEY_new_by_curve_name(NID_brainpoolP384r1
);
584 return EC_KEY_new_by_curve_name(NID_brainpoolP512r1
);
590 #endif /* !NID_brainpoolP224r1 || ... */
593 * Described in header.
595 openssl_ec_diffie_hellman_t
*openssl_ec_diffie_hellman_create(diffie_hellman_group_t group
)
597 private_openssl_ec_diffie_hellman_t
*this;
602 .get_shared_secret
= _get_shared_secret
,
603 .set_other_public_value
= _set_other_public_value
,
604 .get_my_public_value
= _get_my_public_value
,
605 .set_private_value
= _set_private_value
,
606 .get_dh_group
= _get_dh_group
,
616 this->key
= EC_KEY_new_by_curve_name(NID_X9_62_prime192v1
);
619 this->key
= EC_KEY_new_by_curve_name(NID_secp224r1
);
622 this->key
= EC_KEY_new_by_curve_name(NID_X9_62_prime256v1
);
625 this->key
= EC_KEY_new_by_curve_name(NID_secp384r1
);
628 this->key
= EC_KEY_new_by_curve_name(NID_secp521r1
);
634 this->key
= ec_key_new_brainpool(group
);
647 /* caching the EC group */
648 this->ec_group
= EC_KEY_get0_group(this->key
);
650 this->pub_key
= EC_POINT_new(this->ec_group
);
657 /* generate an EC private (public) key */
658 if (!EC_KEY_generate_key(this->key
))
664 return &this->public;
666 #endif /* OPENSSL_NO_EC */