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 #include <internal/cryptlib.h>
67 #include <openssl/err.h>
68 #ifndef OPENSSL_NO_ENGINE
69 # include <openssl/engine.h>
72 EC_KEY *EC_KEY_new(void)
74 return EC_KEY_new_method(NULL);
77 EC_KEY *EC_KEY_new_by_curve_name(int nid)
79 EC_KEY *ret = EC_KEY_new();
82 ret->group = EC_GROUP_new_by_curve_name(nid);
83 if (ret->group == NULL) {
87 if (ret->meth->set_group != NULL
88 && ret->meth->set_group(ret, ret->group) == 0) {
95 void EC_KEY_free(EC_KEY *r)
102 i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_EC);
104 REF_PRINT("EC_KEY", r);
110 fprintf(stderr, "EC_KEY_free, bad reference count\n");
115 if (r->meth->finish != NULL)
118 #ifndef OPENSSL_NO_ENGINE
119 if (r->engine != NULL)
120 ENGINE_finish(r->engine);
123 EC_GROUP_free(r->group);
124 EC_POINT_free(r->pub_key);
125 BN_clear_free(r->priv_key);
127 EC_EX_DATA_free_all_data(&r->method_data);
129 OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
132 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
136 if (dest == NULL || src == NULL) {
137 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
140 if (src->meth != dest->meth) {
141 if (dest->meth->finish != NULL)
142 dest->meth->finish(dest);
143 #ifndef OPENSSL_NO_ENGINE
144 if (dest->engine != NULL && ENGINE_finish(dest->engine) == 0)
149 /* copy the parameters */
150 if (src->group != NULL) {
151 const EC_METHOD *meth = EC_GROUP_method_of(src->group);
152 /* 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 != NULL && src->group != NULL) {
162 EC_POINT_free(dest->pub_key);
163 dest->pub_key = EC_POINT_new(src->group);
164 if (dest->pub_key == NULL)
166 if (!EC_POINT_copy(dest->pub_key, src->pub_key))
169 /* copy the private key */
170 if (src->priv_key != NULL) {
171 if (dest->priv_key == NULL) {
172 dest->priv_key = BN_new();
173 if (dest->priv_key == NULL)
176 if (!BN_copy(dest->priv_key, src->priv_key))
179 /* copy method/extra data */
180 EC_EX_DATA_free_all_data(&dest->method_data);
182 for (d = src->method_data; d != NULL; d = d->next) {
183 void *t = d->dup_func(d->data);
187 if (!EC_EX_DATA_set_data
188 (&dest->method_data, t, d->dup_func, d->free_func,
194 dest->enc_flag = src->enc_flag;
195 dest->conv_form = src->conv_form;
196 dest->version = src->version;
197 dest->flags = src->flags;
199 if (src->meth != dest->meth) {
200 #ifndef OPENSSL_NO_ENGINE
201 if (src->engine != NULL && ENGINE_init(src->engine) == 0)
203 dest->engine = src->engine;
205 dest->meth = src->meth;
208 if (src->meth->copy != NULL && src->meth->copy(dest, src) == 0)
214 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
216 EC_KEY *ret = EC_KEY_new_method(ec_key->engine);
219 if (EC_KEY_copy(ret, ec_key) == NULL) {
226 int EC_KEY_up_ref(EC_KEY *r)
228 int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
230 REF_PRINT("EC_KEY", r);
234 fprintf(stderr, "EC_KEY_up, bad reference count\n");
238 return ((i > 1) ? 1 : 0);
241 int EC_KEY_generate_key(EC_KEY *eckey)
243 if (eckey == NULL || eckey->group == NULL) {
244 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
247 if (eckey->meth->keygen != NULL)
248 return eckey->meth->keygen(eckey);
249 ECerr(EC_F_EC_KEY_GENERATE_KEY, EC_R_OPERATION_NOT_SUPPORTED);
253 int ossl_ec_key_gen(EC_KEY *eckey)
257 BIGNUM *priv_key = NULL, *order = NULL;
258 EC_POINT *pub_key = NULL;
260 if ((order = BN_new()) == NULL)
262 if ((ctx = BN_CTX_new()) == NULL)
265 if (eckey->priv_key == NULL) {
267 if (priv_key == NULL)
270 priv_key = eckey->priv_key;
272 if (!EC_GROUP_get_order(eckey->group, order, ctx))
276 if (!BN_rand_range(priv_key, order))
278 while (BN_is_zero(priv_key)) ;
280 if (eckey->pub_key == NULL) {
281 pub_key = EC_POINT_new(eckey->group);
285 pub_key = eckey->pub_key;
287 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
290 eckey->priv_key = priv_key;
291 eckey->pub_key = pub_key;
297 if (eckey->pub_key == NULL)
298 EC_POINT_free(pub_key);
299 if (eckey->priv_key != priv_key)
305 int EC_KEY_check_key(const EC_KEY *eckey)
309 const BIGNUM *order = NULL;
310 EC_POINT *point = NULL;
312 if (eckey == NULL || eckey->group == NULL || eckey->pub_key == NULL) {
313 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
317 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
318 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
322 if ((ctx = BN_CTX_new()) == NULL)
324 if ((point = EC_POINT_new(eckey->group)) == NULL)
327 /* testing whether the pub_key is on the elliptic curve */
328 if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
329 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
332 /* testing whether pub_key * order is the point at infinity */
333 order = eckey->group->order;
334 if (BN_is_zero(order)) {
335 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
338 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
339 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
342 if (!EC_POINT_is_at_infinity(eckey->group, point)) {
343 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
347 * in case the priv_key is present : check if generator * priv_key ==
350 if (eckey->priv_key != NULL) {
351 if (BN_cmp(eckey->priv_key, order) >= 0) {
352 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
355 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
357 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
360 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
361 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
368 EC_POINT_free(point);
372 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
377 EC_POINT *point = NULL;
379 #ifndef OPENSSL_NO_EC2M
380 int tmp_nid, is_char_two = 0;
383 if (key == NULL || key->group == NULL || x == NULL || y == NULL) {
384 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
385 ERR_R_PASSED_NULL_PARAMETER);
392 point = EC_POINT_new(key->group);
397 tx = BN_CTX_get(ctx);
398 ty = BN_CTX_get(ctx);
400 #ifndef OPENSSL_NO_EC2M
401 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
403 if (tmp_nid == NID_X9_62_characteristic_two_field)
407 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
410 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
416 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
419 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
424 * Check if retrieved coordinates match originals and are less than field
425 * order: if not values are out of range.
427 if (BN_cmp(x, tx) || BN_cmp(y, ty)
428 || (BN_cmp(x, key->group->field) >= 0)
429 || (BN_cmp(y, key->group->field) >= 0)) {
430 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
431 EC_R_COORDINATES_OUT_OF_RANGE);
435 if (!EC_KEY_set_public_key(key, point))
438 if (EC_KEY_check_key(key) == 0)
445 EC_POINT_free(point);
450 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
455 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
457 if (key->meth->set_group != NULL && key->meth->set_group(key, group) == 0)
459 EC_GROUP_free(key->group);
460 key->group = EC_GROUP_dup(group);
461 return (key->group == NULL) ? 0 : 1;
464 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
466 return key->priv_key;
469 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
471 if (key->meth->set_private != NULL
472 && key->meth->set_private(key, priv_key) == 0)
474 BN_clear_free(key->priv_key);
475 key->priv_key = BN_dup(priv_key);
476 return (key->priv_key == NULL) ? 0 : 1;
479 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
484 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
486 if (key->meth->set_public != NULL
487 && key->meth->set_public(key, pub_key) == 0)
489 EC_POINT_free(key->pub_key);
490 key->pub_key = EC_POINT_dup(pub_key, key->group);
491 return (key->pub_key == NULL) ? 0 : 1;
494 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
496 return key->enc_flag;
499 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
501 key->enc_flag = flags;
504 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
506 return key->conv_form;
509 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
511 key->conv_form = cform;
512 if (key->group != NULL)
513 EC_GROUP_set_point_conversion_form(key->group, cform);
516 void *EC_KEY_get_key_method_data(EC_KEY *key,
517 void *(*dup_func) (void *),
518 void (*free_func) (void *),
519 void (*clear_free_func) (void *))
523 CRYPTO_r_lock(CRYPTO_LOCK_EC);
525 EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
527 CRYPTO_r_unlock(CRYPTO_LOCK_EC);
532 void *EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
533 void *(*dup_func) (void *),
534 void (*free_func) (void *),
535 void (*clear_free_func) (void *))
537 EC_EXTRA_DATA *ex_data;
539 CRYPTO_w_lock(CRYPTO_LOCK_EC);
541 EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
544 EC_EX_DATA_set_data(&key->method_data, data, dup_func, free_func,
546 CRYPTO_w_unlock(CRYPTO_LOCK_EC);
551 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
553 if (key->group != NULL)
554 EC_GROUP_set_asn1_flag(key->group, flag);
557 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
559 if (key->group == NULL)
561 return EC_GROUP_precompute_mult(key->group, ctx);
564 int EC_KEY_get_flags(const EC_KEY *key)
569 void EC_KEY_set_flags(EC_KEY *key, int flags)
574 void EC_KEY_clear_flags(EC_KEY *key, int flags)
576 key->flags &= ~flags;
579 size_t EC_KEY_key2buf(const EC_KEY *key, point_conversion_form_t form,
580 unsigned char **pbuf, BN_CTX *ctx)
582 if (key == NULL || key->pub_key == NULL || key->group == NULL)
584 return EC_POINT_point2buf(key->group, key->pub_key, form, pbuf, ctx);
587 int EC_KEY_oct2key(EC_KEY *key, const unsigned char *buf, size_t len,
590 if (key == NULL || key->group == NULL)
592 if (key->pub_key == NULL)
593 key->pub_key = EC_POINT_new(key->group);
594 if (key->pub_key == NULL)
596 return EC_POINT_oct2point(key->group, key->pub_key, buf, len, ctx);