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.
66 #include <openssl/err.h>
69 #include <openssl/fips.h>
72 EC_KEY *EC_KEY_new(void)
76 ret=(EC_KEY *)OPENSSL_malloc(sizeof(EC_KEY));
79 ECerr(EC_F_EC_KEY_NEW, ERR_R_MALLOC_FAILURE);
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->conv_form = src->conv_form;
203 dest->version = src->version;
204 dest->flags = src->flags;
209 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
211 EC_KEY *ret = EC_KEY_new();
214 if (EC_KEY_copy(ret, ec_key) == NULL)
222 int EC_KEY_up_ref(EC_KEY *r)
224 int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
226 REF_PRINT("EC_KEY",r);
231 fprintf(stderr, "EC_KEY_up, bad reference count\n");
235 return ((i > 1) ? 1 : 0);
238 int EC_KEY_generate_key(EC_KEY *eckey)
242 BIGNUM *priv_key = NULL, *order = NULL;
243 EC_POINT *pub_key = NULL;
247 return FIPS_ec_key_generate_key(eckey);
250 if (!eckey || !eckey->group)
252 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
256 if ((order = BN_new()) == NULL) goto err;
257 if ((ctx = BN_CTX_new()) == NULL) goto err;
259 if (eckey->priv_key == NULL)
262 if (priv_key == NULL)
266 priv_key = eckey->priv_key;
268 if (!EC_GROUP_get_order(eckey->group, order, ctx))
272 if (!BN_rand_range(priv_key, order))
274 while (BN_is_zero(priv_key));
276 if (eckey->pub_key == NULL)
278 pub_key = EC_POINT_new(eckey->group);
283 pub_key = eckey->pub_key;
285 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
288 eckey->priv_key = priv_key;
289 eckey->pub_key = pub_key;
296 if (pub_key != NULL && eckey->pub_key == NULL)
297 EC_POINT_free(pub_key);
298 if (priv_key != NULL && eckey->priv_key == NULL)
305 int EC_KEY_check_key(const EC_KEY *eckey)
309 const BIGNUM *order = NULL;
310 EC_POINT *point = NULL;
312 if (!eckey || !eckey->group || !eckey->pub_key)
314 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
318 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key))
320 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
324 if ((ctx = BN_CTX_new()) == NULL)
326 if ((point = EC_POINT_new(eckey->group)) == NULL)
329 /* testing whether the pub_key is on the elliptic curve */
330 if (!EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx))
332 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
335 /* testing whether pub_key * order is the point at infinity */
336 order = &eckey->group->order;
337 if (BN_is_zero(order))
339 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
342 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx))
344 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
347 if (!EC_POINT_is_at_infinity(eckey->group, point))
349 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
352 /* in case the priv_key is present :
353 * check if generator * priv_key == pub_key
357 if (BN_cmp(eckey->priv_key, order) >= 0)
359 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
362 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
365 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
368 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key,
371 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
380 EC_POINT_free(point);
384 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y)
388 EC_POINT *point = NULL;
389 int ok = 0, tmp_nid, is_char_two = 0;
391 if (!key || !key->group || !x || !y)
393 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
394 ERR_R_PASSED_NULL_PARAMETER);
401 point = EC_POINT_new(key->group);
406 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
408 if (tmp_nid == NID_X9_62_characteristic_two_field)
411 tx = BN_CTX_get(ctx);
412 ty = BN_CTX_get(ctx);
413 #ifndef OPENSSL_NO_EC2M
416 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
419 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
426 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
429 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
433 /* Check if retrieved coordinates match originals: if not values
436 if (BN_cmp(x, tx) || BN_cmp(y, ty))
438 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
439 EC_R_COORDINATES_OUT_OF_RANGE);
443 if (!EC_KEY_set_public_key(key, point))
446 if (EC_KEY_check_key(key) == 0)
455 EC_POINT_free(point);
460 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
465 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
467 if (key->group != NULL)
468 EC_GROUP_free(key->group);
469 key->group = EC_GROUP_dup(group);
470 return (key->group == NULL) ? 0 : 1;
473 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
475 return key->priv_key;
478 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
481 BN_clear_free(key->priv_key);
482 key->priv_key = BN_dup(priv_key);
483 return (key->priv_key == NULL) ? 0 : 1;
486 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
491 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
493 if (key->pub_key != NULL)
494 EC_POINT_free(key->pub_key);
495 key->pub_key = EC_POINT_dup(pub_key, key->group);
496 return (key->pub_key == NULL) ? 0 : 1;
499 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
501 return key->enc_flag;
504 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
506 key->enc_flag = flags;
509 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
511 return key->conv_form;
514 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
516 key->conv_form = cform;
517 if (key->group != NULL)
518 EC_GROUP_set_point_conversion_form(key->group, cform);
521 void *EC_KEY_get_key_method_data(EC_KEY *key,
522 void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *))
524 return EC_EX_DATA_get_data(key->method_data, dup_func, free_func, clear_free_func);
527 void EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
528 void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *))
530 EC_EXTRA_DATA *ex_data;
531 CRYPTO_w_lock(CRYPTO_LOCK_EC);
532 ex_data = EC_EX_DATA_get_data(key->method_data, dup_func, free_func, clear_free_func);
534 EC_EX_DATA_set_data(&key->method_data, data, dup_func, free_func, clear_free_func);
535 CRYPTO_w_unlock(CRYPTO_LOCK_EC);
538 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
540 if (key->group != NULL)
541 EC_GROUP_set_asn1_flag(key->group, flag);
544 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
546 if (key->group == NULL)
548 return EC_GROUP_precompute_mult(key->group, ctx);
551 int EC_KEY_get_flags(const EC_KEY *key)
556 void EC_KEY_set_flags(EC_KEY *key, int flags)
561 void EC_KEY_clear_flags(EC_KEY *key, int flags)
563 key->flags &= ~flags;