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->conv_form = POINT_CONVERSION_UNCOMPRESSED;
90 ret->method_data = NULL;
94 EC_KEY *EC_KEY_new_by_curve_name(int nid)
96 EC_KEY *ret = EC_KEY_new();
99 ret->group = EC_GROUP_new_by_curve_name(nid);
100 if (ret->group == NULL)
108 void EC_KEY_free(EC_KEY *r)
112 if (r == NULL) return;
114 i=CRYPTO_add(&r->references,-1,CRYPTO_LOCK_EC);
116 REF_PRINT("EC_KEY",r);
122 fprintf(stderr,"EC_KEY_free, bad reference count\n");
127 if (r->group != NULL)
128 EC_GROUP_free(r->group);
129 if (r->pub_key != NULL)
130 EC_POINT_free(r->pub_key);
131 if (r->priv_key != NULL)
132 BN_clear_free(r->priv_key);
134 EC_EX_DATA_free_all_data(&r->method_data);
136 OPENSSL_cleanse((void *)r, sizeof(EC_KEY));
141 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
145 if (dest == NULL || src == NULL)
147 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
150 /* copy the parameters */
153 const EC_METHOD *meth = EC_GROUP_method_of(src->group);
154 /* clear the old group */
156 EC_GROUP_free(dest->group);
157 dest->group = EC_GROUP_new(meth);
158 if (dest->group == NULL)
160 if (!EC_GROUP_copy(dest->group, src->group))
163 /* copy the public key */
164 if (src->pub_key && src->group)
167 EC_POINT_free(dest->pub_key);
168 dest->pub_key = EC_POINT_new(src->group);
169 if (dest->pub_key == NULL)
171 if (!EC_POINT_copy(dest->pub_key, src->pub_key))
174 /* copy the private key */
177 if (dest->priv_key == NULL)
179 dest->priv_key = BN_new();
180 if (dest->priv_key == NULL)
183 if (!BN_copy(dest->priv_key, src->priv_key))
186 /* copy method/extra data */
187 EC_EX_DATA_free_all_data(&dest->method_data);
189 for (d = src->method_data; d != NULL; d = d->next)
191 void *t = d->dup_func(d->data);
195 if (!EC_EX_DATA_set_data(&dest->method_data, t, d->dup_func, d->free_func, d->clear_free_func))
200 dest->enc_flag = src->enc_flag;
201 dest->conv_form = src->conv_form;
202 dest->version = src->version;
203 dest->flags = src->flags;
208 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
210 EC_KEY *ret = EC_KEY_new();
213 if (EC_KEY_copy(ret, ec_key) == NULL)
221 int EC_KEY_up_ref(EC_KEY *r)
223 int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
225 REF_PRINT("EC_KEY",r);
230 fprintf(stderr, "EC_KEY_up, bad reference count\n");
234 return ((i > 1) ? 1 : 0);
239 #include <openssl/evp.h>
240 #include <openssl/fips.h>
241 #include <openssl/fips_rand.h>
243 static int fips_check_ec(EC_KEY *key)
246 unsigned char tbs[] = "ECDSA Pairwise Check Data";
247 pk.type = EVP_PKEY_EC;
250 if (!fips_pkey_signature_test(FIPS_TEST_PAIRWISE,
251 &pk, tbs, 0, NULL, 0, NULL, 0, NULL))
253 FIPSerr(FIPS_F_FIPS_CHECK_EC,FIPS_R_PAIRWISE_TEST_FAILED);
254 fips_set_selftest_fail();
260 int fips_check_ec_prng(EC_KEY *ec)
266 if (ec->flags & (EC_FLAG_NON_FIPS_ALLOW|EC_FLAG_FIPS_CHECKED))
272 bits = BN_num_bits(&ec->group->order);
276 FIPSerr(FIPS_F_FIPS_CHECK_EC_PRNG,FIPS_R_KEY_TOO_SHORT);
279 /* Comparable algorithm strengths: from SP800-57 table 2 */
282 else if (bits >= 384)
284 else if (bits >= 256)
286 else if (bits >= 224)
292 if (FIPS_rand_strength() >= strength)
295 FIPSerr(FIPS_F_FIPS_CHECK_EC_PRNG,FIPS_R_PRNG_STRENGTH_TOO_LOW);
302 int EC_KEY_generate_key(EC_KEY *eckey)
306 BIGNUM *priv_key = NULL, *order = NULL;
307 EC_POINT *pub_key = NULL;
309 if (!eckey || !eckey->group)
311 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
315 if ((order = BN_new()) == NULL) goto err;
316 if ((ctx = BN_CTX_new()) == NULL) goto err;
318 if (eckey->priv_key == NULL)
321 if (priv_key == NULL)
325 priv_key = eckey->priv_key;
327 if (!EC_GROUP_get_order(eckey->group, order, ctx))
331 if (!fips_check_ec_prng(eckey))
336 if (!BN_rand_range(priv_key, order))
338 while (BN_is_zero(priv_key));
340 if (eckey->pub_key == NULL)
342 pub_key = EC_POINT_new(eckey->group);
347 pub_key = eckey->pub_key;
349 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
352 eckey->priv_key = priv_key;
353 eckey->pub_key = pub_key;
356 if(!fips_check_ec(eckey))
358 eckey->priv_key = NULL;
359 eckey->pub_key = NULL;
369 if (pub_key != NULL && eckey->pub_key == NULL)
370 EC_POINT_free(pub_key);
371 if (priv_key != NULL && eckey->priv_key == NULL)
378 int EC_KEY_check_key(const EC_KEY *eckey)
382 const BIGNUM *order = NULL;
383 EC_POINT *point = NULL;
385 if (!eckey || !eckey->group || !eckey->pub_key)
387 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
391 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key))
393 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
397 if ((ctx = BN_CTX_new()) == NULL)
399 if ((point = EC_POINT_new(eckey->group)) == NULL)
402 /* testing whether the pub_key is on the elliptic curve */
403 if (!EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx))
405 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
408 /* testing whether pub_key * order is the point at infinity */
409 order = &eckey->group->order;
410 if (BN_is_zero(order))
412 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
415 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx))
417 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
420 if (!EC_POINT_is_at_infinity(eckey->group, point))
422 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
425 /* in case the priv_key is present :
426 * check if generator * priv_key == pub_key
430 if (BN_cmp(eckey->priv_key, order) >= 0)
432 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
435 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
438 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
441 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key,
444 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
453 EC_POINT_free(point);
457 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y)
461 EC_POINT *point = NULL;
462 int ok = 0, tmp_nid, is_char_two = 0;
464 if (!key || !key->group || !x || !y)
466 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
467 ERR_R_PASSED_NULL_PARAMETER);
474 point = EC_POINT_new(key->group);
479 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
481 if (tmp_nid == NID_X9_62_characteristic_two_field)
484 tx = BN_CTX_get(ctx);
485 ty = BN_CTX_get(ctx);
486 #ifndef OPENSSL_NO_EC2M
489 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
492 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
499 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
502 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
506 /* Check if retrieved coordinates match originals: if not values
509 if (BN_cmp(x, tx) || BN_cmp(y, ty))
511 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
512 EC_R_COORDINATES_OUT_OF_RANGE);
516 if (!EC_KEY_set_public_key(key, point))
519 if (EC_KEY_check_key(key) == 0)
528 EC_POINT_free(point);
533 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
538 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
540 if (key->group != NULL)
541 EC_GROUP_free(key->group);
542 key->group = EC_GROUP_dup(group);
543 return (key->group == NULL) ? 0 : 1;
546 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
548 return key->priv_key;
551 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
554 BN_clear_free(key->priv_key);
555 key->priv_key = BN_dup(priv_key);
556 return (key->priv_key == NULL) ? 0 : 1;
559 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
564 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
566 if (key->pub_key != NULL)
567 EC_POINT_free(key->pub_key);
568 key->pub_key = EC_POINT_dup(pub_key, key->group);
569 return (key->pub_key == NULL) ? 0 : 1;
572 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
574 return key->enc_flag;
577 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
579 key->enc_flag = flags;
582 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
584 return key->conv_form;
587 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
589 key->conv_form = cform;
590 if (key->group != NULL)
591 EC_GROUP_set_point_conversion_form(key->group, cform);
594 void *EC_KEY_get_key_method_data(EC_KEY *key,
595 void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *))
597 return EC_EX_DATA_get_data(key->method_data, dup_func, free_func, clear_free_func);
600 void EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
601 void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *))
603 EC_EXTRA_DATA *ex_data;
604 CRYPTO_w_lock(CRYPTO_LOCK_EC);
605 ex_data = EC_EX_DATA_get_data(key->method_data, dup_func, free_func, clear_free_func);
607 EC_EX_DATA_set_data(&key->method_data, data, dup_func, free_func, clear_free_func);
608 CRYPTO_w_unlock(CRYPTO_LOCK_EC);
611 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
613 if (key->group != NULL)
614 EC_GROUP_set_asn1_flag(key->group, flag);
617 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
619 if (key->group == NULL)
621 return EC_GROUP_precompute_mult(key->group, ctx);
624 int EC_KEY_get_flags(const EC_KEY *key)
629 void EC_KEY_set_flags(EC_KEY *key, int flags)
634 void EC_KEY_clear_flags(EC_KEY *key, int flags)
636 key->flags &= ~flags;