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>
68 # include <openssl/fips.h>
71 EC_KEY *EC_KEY_new(void)
75 ret = (EC_KEY *)OPENSSL_malloc(sizeof(EC_KEY));
77 ECerr(EC_F_EC_KEY_NEW, ERR_R_MALLOC_FAILURE);
87 ret->conv_form = POINT_CONVERSION_UNCOMPRESSED;
89 ret->method_data = NULL;
93 EC_KEY *EC_KEY_new_by_curve_name(int nid)
95 EC_KEY *ret = EC_KEY_new();
98 ret->group = EC_GROUP_new_by_curve_name(nid);
99 if (ret->group == NULL) {
106 void EC_KEY_free(EC_KEY *r)
113 i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_EC);
115 REF_PRINT("EC_KEY", r);
121 fprintf(stderr, "EC_KEY_free, bad reference count\n");
126 if (r->group != NULL)
127 EC_GROUP_free(r->group);
128 if (r->pub_key != NULL)
129 EC_POINT_free(r->pub_key);
130 if (r->priv_key != NULL)
131 BN_clear_free(r->priv_key);
133 EC_EX_DATA_free_all_data(&r->method_data);
135 OPENSSL_cleanse((void *)r, sizeof(EC_KEY));
140 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
144 if (dest == NULL || src == NULL) {
145 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
148 /* copy the parameters */
150 const EC_METHOD *meth = EC_GROUP_method_of(src->group);
151 /* clear the old group */
153 EC_GROUP_free(dest->group);
154 dest->group = EC_GROUP_new(meth);
155 if (dest->group == NULL)
157 if (!EC_GROUP_copy(dest->group, src->group))
160 /* copy the public key */
161 if (src->pub_key && src->group) {
163 EC_POINT_free(dest->pub_key);
164 dest->pub_key = EC_POINT_new(src->group);
165 if (dest->pub_key == NULL)
167 if (!EC_POINT_copy(dest->pub_key, src->pub_key))
170 /* copy the private key */
172 if (dest->priv_key == NULL) {
173 dest->priv_key = BN_new();
174 if (dest->priv_key == NULL)
177 if (!BN_copy(dest->priv_key, src->priv_key))
180 /* copy method/extra data */
181 EC_EX_DATA_free_all_data(&dest->method_data);
183 for (d = src->method_data; d != NULL; d = d->next) {
184 void *t = d->dup_func(d->data);
188 if (!EC_EX_DATA_set_data
189 (&dest->method_data, t, d->dup_func, d->free_func,
195 dest->enc_flag = src->enc_flag;
196 dest->conv_form = src->conv_form;
197 dest->version = src->version;
198 dest->flags = src->flags;
203 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
205 EC_KEY *ret = EC_KEY_new();
208 if (EC_KEY_copy(ret, ec_key) == NULL) {
215 int EC_KEY_up_ref(EC_KEY *r)
217 int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
219 REF_PRINT("EC_KEY", r);
223 fprintf(stderr, "EC_KEY_up, bad reference count\n");
227 return ((i > 1) ? 1 : 0);
230 int EC_KEY_generate_key(EC_KEY *eckey)
234 BIGNUM *priv_key = NULL, *order = NULL;
235 EC_POINT *pub_key = NULL;
239 return FIPS_ec_key_generate_key(eckey);
242 if (!eckey || !eckey->group) {
243 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
247 if ((order = BN_new()) == NULL)
249 if ((ctx = BN_CTX_new()) == NULL)
252 if (eckey->priv_key == NULL) {
254 if (priv_key == NULL)
257 priv_key = eckey->priv_key;
259 if (!EC_GROUP_get_order(eckey->group, order, ctx))
263 if (!BN_rand_range(priv_key, order))
265 while (BN_is_zero(priv_key)) ;
267 if (eckey->pub_key == NULL) {
268 pub_key = EC_POINT_new(eckey->group);
272 pub_key = eckey->pub_key;
274 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
277 eckey->priv_key = priv_key;
278 eckey->pub_key = pub_key;
285 if (pub_key != NULL && eckey->pub_key == NULL)
286 EC_POINT_free(pub_key);
287 if (priv_key != NULL && eckey->priv_key == NULL)
294 int EC_KEY_check_key(const EC_KEY *eckey)
298 const BIGNUM *order = NULL;
299 EC_POINT *point = NULL;
301 if (!eckey || !eckey->group || !eckey->pub_key) {
302 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
306 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
307 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
311 if ((ctx = BN_CTX_new()) == NULL)
313 if ((point = EC_POINT_new(eckey->group)) == NULL)
316 /* testing whether the pub_key is on the elliptic curve */
317 if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
318 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
321 /* testing whether pub_key * order is the point at infinity */
322 order = &eckey->group->order;
323 if (BN_is_zero(order)) {
324 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
327 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
328 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
331 if (!EC_POINT_is_at_infinity(eckey->group, point)) {
332 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
336 * in case the priv_key is present : check if generator * priv_key ==
339 if (eckey->priv_key) {
340 if (BN_cmp(eckey->priv_key, order) >= 0) {
341 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
344 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
346 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
349 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
350 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
359 EC_POINT_free(point);
363 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
368 EC_POINT *point = NULL;
370 #ifndef OPENSSL_NO_EC2M
371 int tmp_nid, is_char_two = 0;
374 if (!key || !key->group || !x || !y) {
375 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
376 ERR_R_PASSED_NULL_PARAMETER);
383 point = EC_POINT_new(key->group);
388 tx = BN_CTX_get(ctx);
389 ty = BN_CTX_get(ctx);
391 #ifndef OPENSSL_NO_EC2M
392 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
394 if (tmp_nid == NID_X9_62_characteristic_two_field)
398 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
401 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
407 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
410 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
415 * Check if retrieved coordinates match originals: if not values are out
418 if (BN_cmp(x, tx) || BN_cmp(y, ty)) {
419 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
420 EC_R_COORDINATES_OUT_OF_RANGE);
424 if (!EC_KEY_set_public_key(key, point))
427 if (EC_KEY_check_key(key) == 0)
436 EC_POINT_free(point);
441 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
446 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
448 if (key->group != NULL)
449 EC_GROUP_free(key->group);
450 key->group = EC_GROUP_dup(group);
451 return (key->group == NULL) ? 0 : 1;
454 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
456 return key->priv_key;
459 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
462 BN_clear_free(key->priv_key);
463 key->priv_key = BN_dup(priv_key);
464 return (key->priv_key == NULL) ? 0 : 1;
467 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
472 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
474 if (key->pub_key != NULL)
475 EC_POINT_free(key->pub_key);
476 key->pub_key = EC_POINT_dup(pub_key, key->group);
477 return (key->pub_key == NULL) ? 0 : 1;
480 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
482 return key->enc_flag;
485 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
487 key->enc_flag = flags;
490 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
492 return key->conv_form;
495 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
497 key->conv_form = cform;
498 if (key->group != NULL)
499 EC_GROUP_set_point_conversion_form(key->group, cform);
502 void *EC_KEY_get_key_method_data(EC_KEY *key,
503 void *(*dup_func) (void *),
504 void (*free_func) (void *),
505 void (*clear_free_func) (void *))
509 CRYPTO_r_lock(CRYPTO_LOCK_EC);
511 EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
513 CRYPTO_r_unlock(CRYPTO_LOCK_EC);
518 void *EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
519 void *(*dup_func) (void *),
520 void (*free_func) (void *),
521 void (*clear_free_func) (void *))
523 EC_EXTRA_DATA *ex_data;
525 CRYPTO_w_lock(CRYPTO_LOCK_EC);
527 EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
530 EC_EX_DATA_set_data(&key->method_data, data, dup_func, free_func,
532 CRYPTO_w_unlock(CRYPTO_LOCK_EC);
537 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
539 if (key->group != NULL)
540 EC_GROUP_set_asn1_flag(key->group, flag);
543 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
545 if (key->group == NULL)
547 return EC_GROUP_precompute_mult(key->group, ctx);
550 int EC_KEY_get_flags(const EC_KEY *key)
555 void EC_KEY_set_flags(EC_KEY *key, int flags)
560 void EC_KEY_clear_flags(EC_KEY *key, int flags)
562 key->flags &= ~flags;