2 * Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
5 * Licensed under the OpenSSL license (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
11 #include "internal/cryptlib.h"
14 #include <openssl/err.h>
15 #include <openssl/engine.h>
17 EC_KEY *EC_KEY_new(void)
19 return EC_KEY_new_method(NULL);
22 EC_KEY *EC_KEY_new_by_curve_name(int nid)
24 EC_KEY *ret = EC_KEY_new();
27 ret->group = EC_GROUP_new_by_curve_name(nid);
28 if (ret->group == NULL) {
32 if (ret->meth->set_group != NULL
33 && ret->meth->set_group(ret, ret->group) == 0) {
40 void EC_KEY_free(EC_KEY *r)
47 CRYPTO_DOWN_REF(&r->references, &i, r->lock);
48 REF_PRINT_COUNT("EC_KEY", r);
51 REF_ASSERT_ISNT(i < 0);
53 if (r->meth->finish != NULL)
56 #ifndef OPENSSL_NO_ENGINE
57 ENGINE_finish(r->engine);
60 if (r->group && r->group->meth->keyfinish)
61 r->group->meth->keyfinish(r);
63 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EC_KEY, r, &r->ex_data);
64 CRYPTO_THREAD_lock_free(r->lock);
65 EC_GROUP_free(r->group);
66 EC_POINT_free(r->pub_key);
67 BN_clear_free(r->priv_key);
69 OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
72 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
74 if (dest == NULL || src == NULL) {
75 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
78 if (src->meth != dest->meth) {
79 if (dest->meth->finish != NULL)
80 dest->meth->finish(dest);
81 if (dest->group && dest->group->meth->keyfinish)
82 dest->group->meth->keyfinish(dest);
83 #ifndef OPENSSL_NO_ENGINE
84 if (ENGINE_finish(dest->engine) == 0)
89 /* copy the parameters */
90 if (src->group != NULL) {
91 const EC_METHOD *meth = EC_GROUP_method_of(src->group);
92 /* clear the old group */
93 EC_GROUP_free(dest->group);
94 dest->group = EC_GROUP_new(meth);
95 if (dest->group == NULL)
97 if (!EC_GROUP_copy(dest->group, src->group))
100 /* copy the public key */
101 if (src->pub_key != NULL) {
102 EC_POINT_free(dest->pub_key);
103 dest->pub_key = EC_POINT_new(src->group);
104 if (dest->pub_key == NULL)
106 if (!EC_POINT_copy(dest->pub_key, src->pub_key))
109 /* copy the private key */
110 if (src->priv_key != NULL) {
111 if (dest->priv_key == NULL) {
112 dest->priv_key = BN_new();
113 if (dest->priv_key == NULL)
116 if (!BN_copy(dest->priv_key, src->priv_key))
118 if (src->group->meth->keycopy
119 && src->group->meth->keycopy(dest, src) == 0)
126 dest->enc_flag = src->enc_flag;
127 dest->conv_form = src->conv_form;
128 dest->version = src->version;
129 dest->flags = src->flags;
130 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_EC_KEY,
131 &dest->ex_data, &src->ex_data))
134 if (src->meth != dest->meth) {
135 #ifndef OPENSSL_NO_ENGINE
136 if (src->engine != NULL && ENGINE_init(src->engine) == 0)
138 dest->engine = src->engine;
140 dest->meth = src->meth;
143 if (src->meth->copy != NULL && src->meth->copy(dest, src) == 0)
149 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
151 EC_KEY *ret = EC_KEY_new_method(ec_key->engine);
156 if (EC_KEY_copy(ret, ec_key) == NULL) {
163 int EC_KEY_up_ref(EC_KEY *r)
167 if (CRYPTO_UP_REF(&r->references, &i, r->lock) <= 0)
170 REF_PRINT_COUNT("EC_KEY", r);
171 REF_ASSERT_ISNT(i < 2);
172 return ((i > 1) ? 1 : 0);
175 ENGINE *EC_KEY_get0_engine(const EC_KEY *eckey)
177 return eckey->engine;
180 int EC_KEY_generate_key(EC_KEY *eckey)
182 if (eckey == NULL || eckey->group == NULL) {
183 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
186 if (eckey->meth->keygen != NULL)
187 return eckey->meth->keygen(eckey);
188 ECerr(EC_F_EC_KEY_GENERATE_KEY, EC_R_OPERATION_NOT_SUPPORTED);
192 int ossl_ec_key_gen(EC_KEY *eckey)
194 OPENSSL_assert(eckey->group->meth->keygen != NULL);
195 return eckey->group->meth->keygen(eckey);
198 int ec_key_simple_generate_key(EC_KEY *eckey)
202 BIGNUM *priv_key = NULL;
203 const BIGNUM *order = NULL;
204 EC_POINT *pub_key = NULL;
206 if ((ctx = BN_CTX_new()) == NULL)
209 if (eckey->priv_key == NULL) {
211 if (priv_key == NULL)
214 priv_key = eckey->priv_key;
216 order = EC_GROUP_get0_order(eckey->group);
221 if (!BN_priv_rand_range(priv_key, order))
223 while (BN_is_zero(priv_key)) ;
225 if (eckey->pub_key == NULL) {
226 pub_key = EC_POINT_new(eckey->group);
230 pub_key = eckey->pub_key;
232 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
235 eckey->priv_key = priv_key;
236 eckey->pub_key = pub_key;
241 if (eckey->pub_key == NULL)
242 EC_POINT_free(pub_key);
243 if (eckey->priv_key != priv_key)
249 int ec_key_simple_generate_public_key(EC_KEY *eckey)
251 return EC_POINT_mul(eckey->group, eckey->pub_key, eckey->priv_key, NULL,
255 int EC_KEY_check_key(const EC_KEY *eckey)
257 if (eckey == NULL || eckey->group == NULL || eckey->pub_key == NULL) {
258 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
262 if (eckey->group->meth->keycheck == NULL) {
263 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
267 return eckey->group->meth->keycheck(eckey);
270 int ec_key_simple_check_key(const EC_KEY *eckey)
274 const BIGNUM *order = NULL;
275 EC_POINT *point = NULL;
277 if (eckey == NULL || eckey->group == NULL || eckey->pub_key == NULL) {
278 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
282 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
283 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, EC_R_POINT_AT_INFINITY);
287 if ((ctx = BN_CTX_new()) == NULL)
289 if ((point = EC_POINT_new(eckey->group)) == NULL)
292 /* testing whether the pub_key is on the elliptic curve */
293 if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
294 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
297 /* testing whether pub_key * order is the point at infinity */
298 order = eckey->group->order;
299 if (BN_is_zero(order)) {
300 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
303 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
304 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, ERR_R_EC_LIB);
307 if (!EC_POINT_is_at_infinity(eckey->group, point)) {
308 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, EC_R_WRONG_ORDER);
312 * in case the priv_key is present : check if generator * priv_key ==
315 if (eckey->priv_key != NULL) {
316 if (BN_cmp(eckey->priv_key, order) >= 0) {
317 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, EC_R_WRONG_ORDER);
320 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
322 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, ERR_R_EC_LIB);
325 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
326 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
333 EC_POINT_free(point);
337 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
342 EC_POINT *point = NULL;
344 #ifndef OPENSSL_NO_EC2M
345 int tmp_nid, is_char_two = 0;
348 if (key == NULL || key->group == NULL || x == NULL || y == NULL) {
349 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
350 ERR_R_PASSED_NULL_PARAMETER);
358 point = EC_POINT_new(key->group);
363 tx = BN_CTX_get(ctx);
364 ty = BN_CTX_get(ctx);
368 #ifndef OPENSSL_NO_EC2M
369 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
371 if (tmp_nid == NID_X9_62_characteristic_two_field)
375 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
378 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
384 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
387 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
392 * Check if retrieved coordinates match originals and are less than field
393 * order: if not values are out of range.
395 if (BN_cmp(x, tx) || BN_cmp(y, ty)
396 || (BN_cmp(x, key->group->field) >= 0)
397 || (BN_cmp(y, key->group->field) >= 0)) {
398 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
399 EC_R_COORDINATES_OUT_OF_RANGE);
403 if (!EC_KEY_set_public_key(key, point))
406 if (EC_KEY_check_key(key) == 0)
414 EC_POINT_free(point);
419 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
424 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
426 if (key->meth->set_group != NULL && key->meth->set_group(key, group) == 0)
428 EC_GROUP_free(key->group);
429 key->group = EC_GROUP_dup(group);
430 return (key->group == NULL) ? 0 : 1;
433 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
435 return key->priv_key;
438 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
440 if (key->group == NULL || key->group->meth == NULL)
442 if (key->group->meth->set_private != NULL
443 && key->group->meth->set_private(key, priv_key) == 0)
445 if (key->meth->set_private != NULL
446 && key->meth->set_private(key, priv_key) == 0)
448 BN_clear_free(key->priv_key);
449 key->priv_key = BN_dup(priv_key);
450 return (key->priv_key == NULL) ? 0 : 1;
453 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
458 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
460 if (key->meth->set_public != NULL
461 && key->meth->set_public(key, pub_key) == 0)
463 EC_POINT_free(key->pub_key);
464 key->pub_key = EC_POINT_dup(pub_key, key->group);
465 return (key->pub_key == NULL) ? 0 : 1;
468 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
470 return key->enc_flag;
473 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
475 key->enc_flag = flags;
478 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
480 return key->conv_form;
483 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
485 key->conv_form = cform;
486 if (key->group != NULL)
487 EC_GROUP_set_point_conversion_form(key->group, cform);
490 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
492 if (key->group != NULL)
493 EC_GROUP_set_asn1_flag(key->group, flag);
496 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
498 if (key->group == NULL)
500 return EC_GROUP_precompute_mult(key->group, ctx);
503 int EC_KEY_get_flags(const EC_KEY *key)
508 void EC_KEY_set_flags(EC_KEY *key, int flags)
513 void EC_KEY_clear_flags(EC_KEY *key, int flags)
515 key->flags &= ~flags;
518 size_t EC_KEY_key2buf(const EC_KEY *key, point_conversion_form_t form,
519 unsigned char **pbuf, BN_CTX *ctx)
521 if (key == NULL || key->pub_key == NULL || key->group == NULL)
523 return EC_POINT_point2buf(key->group, key->pub_key, form, pbuf, ctx);
526 int EC_KEY_oct2key(EC_KEY *key, const unsigned char *buf, size_t len,
529 if (key == NULL || key->group == NULL)
531 if (key->pub_key == NULL)
532 key->pub_key = EC_POINT_new(key->group);
533 if (key->pub_key == NULL)
535 if (EC_POINT_oct2point(key->group, key->pub_key, buf, len, ctx) == 0)
538 * Save the point conversion form.
539 * For non-custom curves the first octet of the buffer (excluding
540 * the last significant bit) contains the point conversion form.
541 * EC_POINT_oct2point() has already performed sanity checking of
542 * the buffer so we know it is valid.
544 if ((key->group->meth->flags & EC_FLAGS_CUSTOM_CURVE) == 0)
545 key->conv_form = (point_conversion_form_t)(buf[0] & ~0x01);
549 size_t EC_KEY_priv2oct(const EC_KEY *eckey,
550 unsigned char *buf, size_t len)
552 if (eckey->group == NULL || eckey->group->meth == NULL)
554 if (eckey->group->meth->priv2oct == NULL) {
555 ECerr(EC_F_EC_KEY_PRIV2OCT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
559 return eckey->group->meth->priv2oct(eckey, buf, len);
562 size_t ec_key_simple_priv2oct(const EC_KEY *eckey,
563 unsigned char *buf, size_t len)
567 buf_len = (EC_GROUP_order_bits(eckey->group) + 7) / 8;
568 if (eckey->priv_key == NULL)
572 else if (len < buf_len)
575 /* Octetstring may need leading zeros if BN is to short */
577 if (BN_bn2binpad(eckey->priv_key, buf, buf_len) == -1) {
578 ECerr(EC_F_EC_KEY_SIMPLE_PRIV2OCT, EC_R_BUFFER_TOO_SMALL);
585 int EC_KEY_oct2priv(EC_KEY *eckey, const unsigned char *buf, size_t len)
587 if (eckey->group == NULL || eckey->group->meth == NULL)
589 if (eckey->group->meth->oct2priv == NULL) {
590 ECerr(EC_F_EC_KEY_OCT2PRIV, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
593 return eckey->group->meth->oct2priv(eckey, buf, len);
596 int ec_key_simple_oct2priv(EC_KEY *eckey, const unsigned char *buf, size_t len)
598 if (eckey->priv_key == NULL)
599 eckey->priv_key = BN_secure_new();
600 if (eckey->priv_key == NULL) {
601 ECerr(EC_F_EC_KEY_SIMPLE_OCT2PRIV, ERR_R_MALLOC_FAILURE);
604 eckey->priv_key = BN_bin2bn(buf, len, eckey->priv_key);
605 if (eckey->priv_key == NULL) {
606 ECerr(EC_F_EC_KEY_SIMPLE_OCT2PRIV, ERR_R_BN_LIB);
612 size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf)
616 len = EC_KEY_priv2oct(eckey, NULL, 0);
619 buf = OPENSSL_malloc(len);
622 len = EC_KEY_priv2oct(eckey, buf, len);
631 int EC_KEY_can_sign(const EC_KEY *eckey)
633 if (eckey->group == NULL || eckey->group->meth == NULL
634 || (eckey->group->meth->flags & EC_FLAGS_NO_SIGN))