1 /* crypto/ec/ec_key.c */
3 * Written by Nils Larsch for the OpenSSL project.
5 /* ====================================================================
6 * Copyright (c) 1998-2005 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * openssl-core@openssl.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
58 /* ====================================================================
59 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60 * Portions originally developed by SUN MICROSYSTEMS, INC., and
61 * contributed to the OpenSSL project.
64 #define OPENSSL_FIPSAPI
68 #include <openssl/err.h>
71 EC_KEY
*EC_KEY_new(void)
75 ret
=(EC_KEY
*)OPENSSL_malloc(sizeof(EC_KEY
));
78 ECerr(EC_F_EC_KEY_NEW
, ERR_R_MALLOC_FAILURE
);
88 ret
->nonce_from_hash_flag
= 0;
89 ret
->conv_form
= POINT_CONVERSION_UNCOMPRESSED
;
91 ret
->method_data
= NULL
;
95 EC_KEY
*EC_KEY_new_by_curve_name(int nid
)
97 EC_KEY
*ret
= EC_KEY_new();
100 ret
->group
= EC_GROUP_new_by_curve_name(nid
);
101 if (ret
->group
== NULL
)
109 void EC_KEY_free(EC_KEY
*r
)
113 if (r
== NULL
) return;
115 i
=CRYPTO_add(&r
->references
,-1,CRYPTO_LOCK_EC
);
117 REF_PRINT("EC_KEY",r
);
123 fprintf(stderr
,"EC_KEY_free, bad reference count\n");
128 if (r
->group
!= NULL
)
129 EC_GROUP_free(r
->group
);
130 if (r
->pub_key
!= NULL
)
131 EC_POINT_free(r
->pub_key
);
132 if (r
->priv_key
!= NULL
)
133 BN_clear_free(r
->priv_key
);
135 EC_EX_DATA_free_all_data(&r
->method_data
);
137 OPENSSL_cleanse((void *)r
, sizeof(EC_KEY
));
142 EC_KEY
*EC_KEY_copy(EC_KEY
*dest
, const EC_KEY
*src
)
146 if (dest
== NULL
|| src
== NULL
)
148 ECerr(EC_F_EC_KEY_COPY
, ERR_R_PASSED_NULL_PARAMETER
);
151 /* copy the parameters */
154 const EC_METHOD
*meth
= EC_GROUP_method_of(src
->group
);
155 /* clear the old group */
157 EC_GROUP_free(dest
->group
);
158 dest
->group
= EC_GROUP_new(meth
);
159 if (dest
->group
== NULL
)
161 if (!EC_GROUP_copy(dest
->group
, src
->group
))
164 /* copy the public key */
165 if (src
->pub_key
&& src
->group
)
168 EC_POINT_free(dest
->pub_key
);
169 dest
->pub_key
= EC_POINT_new(src
->group
);
170 if (dest
->pub_key
== NULL
)
172 if (!EC_POINT_copy(dest
->pub_key
, src
->pub_key
))
175 /* copy the private key */
178 if (dest
->priv_key
== NULL
)
180 dest
->priv_key
= BN_new();
181 if (dest
->priv_key
== NULL
)
184 if (!BN_copy(dest
->priv_key
, src
->priv_key
))
187 /* copy method/extra data */
188 EC_EX_DATA_free_all_data(&dest
->method_data
);
190 for (d
= src
->method_data
; d
!= NULL
; d
= d
->next
)
192 void *t
= d
->dup_func(d
->data
);
196 if (!EC_EX_DATA_set_data(&dest
->method_data
, t
, d
->dup_func
, d
->free_func
, d
->clear_free_func
))
201 dest
->enc_flag
= src
->enc_flag
;
202 dest
->nonce_from_hash_flag
= src
->nonce_from_hash_flag
;
203 dest
->conv_form
= src
->conv_form
;
204 dest
->version
= src
->version
;
205 dest
->flags
= src
->flags
;
210 EC_KEY
*EC_KEY_dup(const EC_KEY
*ec_key
)
212 EC_KEY
*ret
= EC_KEY_new();
215 if (EC_KEY_copy(ret
, ec_key
) == NULL
)
223 int EC_KEY_up_ref(EC_KEY
*r
)
225 int i
= CRYPTO_add(&r
->references
, 1, CRYPTO_LOCK_EC
);
227 REF_PRINT("EC_KEY",r
);
232 fprintf(stderr
, "EC_KEY_up, bad reference count\n");
236 return ((i
> 1) ? 1 : 0);
241 #include <openssl/evp.h>
242 #include <openssl/fips.h>
243 #include <openssl/fips_rand.h>
245 static int fips_check_ec(EC_KEY
*key
)
248 unsigned char tbs
[] = "ECDSA Pairwise Check Data";
249 pk
.type
= EVP_PKEY_EC
;
252 if (!fips_pkey_signature_test(FIPS_TEST_PAIRWISE
,
253 &pk
, tbs
, 0, NULL
, 0, NULL
, 0, NULL
))
255 FIPSerr(FIPS_F_FIPS_CHECK_EC
,FIPS_R_PAIRWISE_TEST_FAILED
);
256 fips_set_selftest_fail();
262 int fips_check_ec_prng(EC_KEY
*ec
)
265 if (!FIPS_module_mode())
268 if (ec
->flags
& (EC_FLAG_NON_FIPS_ALLOW
|EC_FLAG_FIPS_CHECKED
))
274 bits
= BN_num_bits(&ec
->group
->order
);
278 FIPSerr(FIPS_F_FIPS_CHECK_EC_PRNG
,FIPS_R_KEY_TOO_SHORT
);
281 /* Comparable algorithm strengths: from SP800-57 table 2 */
284 else if (bits
>= 384)
286 else if (bits
>= 256)
288 else if (bits
>= 224)
294 if (FIPS_rand_strength() >= strength
)
297 FIPSerr(FIPS_F_FIPS_CHECK_EC_PRNG
,FIPS_R_PRNG_STRENGTH_TOO_LOW
);
304 int EC_KEY_generate_key(EC_KEY
*eckey
)
308 BIGNUM
*priv_key
= NULL
, *order
= NULL
;
309 EC_POINT
*pub_key
= NULL
;
312 if(FIPS_selftest_failed())
314 FIPSerr(FIPS_F_EC_KEY_GENERATE_KEY
,FIPS_R_FIPS_SELFTEST_FAILED
);
319 if (!eckey
|| !eckey
->group
)
321 ECerr(EC_F_EC_KEY_GENERATE_KEY
, ERR_R_PASSED_NULL_PARAMETER
);
325 if ((order
= BN_new()) == NULL
) goto err
;
326 if ((ctx
= BN_CTX_new()) == NULL
) goto err
;
328 if (eckey
->priv_key
== NULL
)
331 if (priv_key
== NULL
)
335 priv_key
= eckey
->priv_key
;
337 if (!EC_GROUP_get_order(eckey
->group
, order
, ctx
))
341 if (!fips_check_ec_prng(eckey
))
346 if (!BN_rand_range(priv_key
, order
))
348 while (BN_is_zero(priv_key
));
350 if (eckey
->pub_key
== NULL
)
352 pub_key
= EC_POINT_new(eckey
->group
);
357 pub_key
= eckey
->pub_key
;
359 if (!EC_POINT_mul(eckey
->group
, pub_key
, priv_key
, NULL
, NULL
, ctx
))
362 eckey
->priv_key
= priv_key
;
363 eckey
->pub_key
= pub_key
;
366 if(!fips_check_ec(eckey
))
368 eckey
->priv_key
= NULL
;
369 eckey
->pub_key
= NULL
;
379 if (pub_key
!= NULL
&& eckey
->pub_key
== NULL
)
380 EC_POINT_free(pub_key
);
381 if (priv_key
!= NULL
&& eckey
->priv_key
== NULL
)
388 int EC_KEY_check_key(const EC_KEY
*eckey
)
392 const BIGNUM
*order
= NULL
;
393 EC_POINT
*point
= NULL
;
395 if (!eckey
|| !eckey
->group
|| !eckey
->pub_key
)
397 ECerr(EC_F_EC_KEY_CHECK_KEY
, ERR_R_PASSED_NULL_PARAMETER
);
401 if (EC_POINT_is_at_infinity(eckey
->group
, eckey
->pub_key
))
403 ECerr(EC_F_EC_KEY_CHECK_KEY
, EC_R_POINT_AT_INFINITY
);
407 if ((ctx
= BN_CTX_new()) == NULL
)
409 if ((point
= EC_POINT_new(eckey
->group
)) == NULL
)
412 /* testing whether the pub_key is on the elliptic curve */
413 if (!EC_POINT_is_on_curve(eckey
->group
, eckey
->pub_key
, ctx
))
415 ECerr(EC_F_EC_KEY_CHECK_KEY
, EC_R_POINT_IS_NOT_ON_CURVE
);
418 /* testing whether pub_key * order is the point at infinity */
419 order
= &eckey
->group
->order
;
420 if (BN_is_zero(order
))
422 ECerr(EC_F_EC_KEY_CHECK_KEY
, EC_R_INVALID_GROUP_ORDER
);
425 if (!EC_POINT_mul(eckey
->group
, point
, NULL
, eckey
->pub_key
, order
, ctx
))
427 ECerr(EC_F_EC_KEY_CHECK_KEY
, ERR_R_EC_LIB
);
430 if (!EC_POINT_is_at_infinity(eckey
->group
, point
))
432 ECerr(EC_F_EC_KEY_CHECK_KEY
, EC_R_WRONG_ORDER
);
435 /* in case the priv_key is present :
436 * check if generator * priv_key == pub_key
440 if (BN_cmp(eckey
->priv_key
, order
) >= 0)
442 ECerr(EC_F_EC_KEY_CHECK_KEY
, EC_R_WRONG_ORDER
);
445 if (!EC_POINT_mul(eckey
->group
, point
, eckey
->priv_key
,
448 ECerr(EC_F_EC_KEY_CHECK_KEY
, ERR_R_EC_LIB
);
451 if (EC_POINT_cmp(eckey
->group
, point
, eckey
->pub_key
,
454 ECerr(EC_F_EC_KEY_CHECK_KEY
, EC_R_INVALID_PRIVATE_KEY
);
463 EC_POINT_free(point
);
467 int EC_KEY_set_public_key_affine_coordinates(EC_KEY
*key
, BIGNUM
*x
, BIGNUM
*y
)
471 EC_POINT
*point
= NULL
;
472 int ok
= 0, tmp_nid
, is_char_two
= 0;
474 if (!key
|| !key
->group
|| !x
|| !y
)
476 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES
,
477 ERR_R_PASSED_NULL_PARAMETER
);
484 point
= EC_POINT_new(key
->group
);
489 tmp_nid
= EC_METHOD_get_field_type(EC_GROUP_method_of(key
->group
));
491 if (tmp_nid
== NID_X9_62_characteristic_two_field
)
494 tx
= BN_CTX_get(ctx
);
495 ty
= BN_CTX_get(ctx
);
496 #ifndef OPENSSL_NO_EC2M
499 if (!EC_POINT_set_affine_coordinates_GF2m(key
->group
, point
,
502 if (!EC_POINT_get_affine_coordinates_GF2m(key
->group
, point
,
509 if (!EC_POINT_set_affine_coordinates_GFp(key
->group
, point
,
512 if (!EC_POINT_get_affine_coordinates_GFp(key
->group
, point
,
516 /* Check if retrieved coordinates match originals and are less than
517 * field order: if not values are out of range.
519 if (BN_cmp(x
, tx
) || BN_cmp(y
, ty
)
520 || (BN_cmp(x
, &key
->group
->field
) >= 0)
521 || (BN_cmp(y
, &key
->group
->field
) >= 0))
523 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES
,
524 EC_R_COORDINATES_OUT_OF_RANGE
);
528 if (!EC_KEY_set_public_key(key
, point
))
531 if (EC_KEY_check_key(key
) == 0)
540 EC_POINT_free(point
);
545 const EC_GROUP
*EC_KEY_get0_group(const EC_KEY
*key
)
550 int EC_KEY_set_group(EC_KEY
*key
, const EC_GROUP
*group
)
552 if (key
->group
!= NULL
)
553 EC_GROUP_free(key
->group
);
554 key
->group
= EC_GROUP_dup(group
);
555 return (key
->group
== NULL
) ? 0 : 1;
558 const BIGNUM
*EC_KEY_get0_private_key(const EC_KEY
*key
)
560 return key
->priv_key
;
563 int EC_KEY_set_private_key(EC_KEY
*key
, const BIGNUM
*priv_key
)
566 BN_clear_free(key
->priv_key
);
567 key
->priv_key
= BN_dup(priv_key
);
568 return (key
->priv_key
== NULL
) ? 0 : 1;
571 const EC_POINT
*EC_KEY_get0_public_key(const EC_KEY
*key
)
576 int EC_KEY_set_public_key(EC_KEY
*key
, const EC_POINT
*pub_key
)
578 if (key
->pub_key
!= NULL
)
579 EC_POINT_free(key
->pub_key
);
580 key
->pub_key
= EC_POINT_dup(pub_key
, key
->group
);
581 return (key
->pub_key
== NULL
) ? 0 : 1;
584 unsigned int EC_KEY_get_enc_flags(const EC_KEY
*key
)
586 return key
->enc_flag
;
589 void EC_KEY_set_enc_flags(EC_KEY
*key
, unsigned int flags
)
591 key
->enc_flag
= flags
;
594 int EC_KEY_get_nonce_from_hash(const EC_KEY
*key
)
596 return key
->nonce_from_hash_flag
;
599 void EC_KEY_set_nonce_from_hash(EC_KEY
*key
, int on
)
601 key
->nonce_from_hash_flag
= on
!= 0;
604 point_conversion_form_t
EC_KEY_get_conv_form(const EC_KEY
*key
)
606 return key
->conv_form
;
609 void EC_KEY_set_conv_form(EC_KEY
*key
, point_conversion_form_t cform
)
611 key
->conv_form
= cform
;
612 if (key
->group
!= NULL
)
613 EC_GROUP_set_point_conversion_form(key
->group
, cform
);
616 void *EC_KEY_get_key_method_data(EC_KEY
*key
,
617 void *(*dup_func
)(void *), void (*free_func
)(void *), void (*clear_free_func
)(void *))
621 CRYPTO_r_lock(CRYPTO_LOCK_EC
);
622 ret
= EC_EX_DATA_get_data(key
->method_data
, dup_func
, free_func
, clear_free_func
);
623 CRYPTO_r_unlock(CRYPTO_LOCK_EC
);
628 void *EC_KEY_insert_key_method_data(EC_KEY
*key
, void *data
,
629 void *(*dup_func
)(void *), void (*free_func
)(void *), void (*clear_free_func
)(void *))
631 EC_EXTRA_DATA
*ex_data
;
633 CRYPTO_w_lock(CRYPTO_LOCK_EC
);
634 ex_data
= EC_EX_DATA_get_data(key
->method_data
, dup_func
, free_func
, clear_free_func
);
636 EC_EX_DATA_set_data(&key
->method_data
, data
, dup_func
, free_func
, clear_free_func
);
637 CRYPTO_w_unlock(CRYPTO_LOCK_EC
);
642 void EC_KEY_set_asn1_flag(EC_KEY
*key
, int flag
)
644 if (key
->group
!= NULL
)
645 EC_GROUP_set_asn1_flag(key
->group
, flag
);
648 int EC_KEY_precompute_mult(EC_KEY
*key
, BN_CTX
*ctx
)
650 if (key
->group
== NULL
)
652 return EC_GROUP_precompute_mult(key
->group
, ctx
);
655 int EC_KEY_get_flags(const EC_KEY
*key
)
660 void EC_KEY_set_flags(EC_KEY
*key
, int flags
)
665 void EC_KEY_clear_flags(EC_KEY
*key
, int flags
)
667 key
->flags
&= ~flags
;