2 * Written by Nils Larsch for the OpenSSL project.
4 /* ====================================================================
5 * Copyright (c) 1998-2005 The OpenSSL Project. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. All advertising materials mentioning features or use of this
20 * software must display the following acknowledgment:
21 * "This product includes software developed by the OpenSSL Project
22 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
24 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25 * endorse or promote products derived from this software without
26 * prior written permission. For written permission, please contact
27 * openssl-core@openssl.org.
29 * 5. Products derived from this software may not be called "OpenSSL"
30 * nor may "OpenSSL" appear in their names without prior written
31 * permission of the OpenSSL Project.
33 * 6. Redistributions of any form whatsoever must retain the following
35 * "This product includes software developed by the OpenSSL Project
36 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49 * OF THE POSSIBILITY OF SUCH DAMAGE.
50 * ====================================================================
52 * This product includes cryptographic software written by Eric Young
53 * (eay@cryptsoft.com). This product includes software written by Tim
54 * Hudson (tjh@cryptsoft.com).
57 /* ====================================================================
58 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
59 * Portions originally developed by SUN MICROSYSTEMS, INC., and
60 * contributed to the OpenSSL project.
63 #include <internal/cryptlib.h>
66 #include <openssl/err.h>
67 #ifndef OPENSSL_NO_ENGINE
68 # include <openssl/engine.h>
71 EC_KEY *EC_KEY_new(void)
73 return EC_KEY_new_method(NULL);
76 EC_KEY *EC_KEY_new_by_curve_name(int nid)
78 EC_KEY *ret = EC_KEY_new();
81 ret->group = EC_GROUP_new_by_curve_name(nid);
82 if (ret->group == NULL) {
86 if (ret->meth->set_group != NULL
87 && ret->meth->set_group(ret, ret->group) == 0) {
94 void EC_KEY_free(EC_KEY *r)
101 i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_EC);
102 REF_PRINT_COUNT("EC_KEY", r);
105 REF_ASSERT_ISNT(i < 0);
107 if (r->meth->finish != NULL)
110 #ifndef OPENSSL_NO_ENGINE
111 if (r->engine != NULL)
112 ENGINE_finish(r->engine);
115 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EC_KEY, r, &r->ex_data);
116 EC_GROUP_free(r->group);
117 EC_POINT_free(r->pub_key);
118 BN_clear_free(r->priv_key);
120 OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
123 EC_KEY *EC_KEY_copy(EC_KEY *dest, EC_KEY *src)
125 if (dest == NULL || src == NULL) {
126 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
129 if (src->meth != dest->meth) {
130 if (dest->meth->finish != NULL)
131 dest->meth->finish(dest);
132 #ifndef OPENSSL_NO_ENGINE
133 if (dest->engine != NULL && ENGINE_finish(dest->engine) == 0)
138 /* copy the parameters */
139 if (src->group != NULL) {
140 const EC_METHOD *meth = EC_GROUP_method_of(src->group);
141 /* clear the old group */
142 EC_GROUP_free(dest->group);
143 dest->group = EC_GROUP_new(meth);
144 if (dest->group == NULL)
146 if (!EC_GROUP_copy(dest->group, src->group))
149 /* copy the public key */
150 if (src->pub_key != NULL && src->group != NULL) {
151 EC_POINT_free(dest->pub_key);
152 dest->pub_key = EC_POINT_new(src->group);
153 if (dest->pub_key == NULL)
155 if (!EC_POINT_copy(dest->pub_key, src->pub_key))
158 /* copy the private key */
159 if (src->priv_key != NULL) {
160 if (dest->priv_key == NULL) {
161 dest->priv_key = BN_new();
162 if (dest->priv_key == NULL)
165 if (!BN_copy(dest->priv_key, src->priv_key))
170 dest->enc_flag = src->enc_flag;
171 dest->conv_form = src->conv_form;
172 dest->version = src->version;
173 dest->flags = src->flags;
174 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_EC_KEY,
175 &dest->ex_data, &src->ex_data))
178 if (src->meth != dest->meth) {
179 #ifndef OPENSSL_NO_ENGINE
180 if (src->engine != NULL && ENGINE_init(src->engine) == 0)
182 dest->engine = src->engine;
184 dest->meth = src->meth;
187 if (src->meth->copy != NULL && src->meth->copy(dest, src) == 0)
193 EC_KEY *EC_KEY_dup(EC_KEY *ec_key)
195 EC_KEY *ret = EC_KEY_new_method(ec_key->engine);
199 if (EC_KEY_copy(ret, ec_key) == NULL) {
206 int EC_KEY_up_ref(EC_KEY *r)
208 int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
210 REF_PRINT_COUNT("EC_KEY", r);
211 REF_ASSERT_ISNT(i < 2);
212 return ((i > 1) ? 1 : 0);
215 int EC_KEY_generate_key(EC_KEY *eckey)
217 if (eckey == NULL || eckey->group == NULL) {
218 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
221 if (eckey->meth->keygen != NULL)
222 return eckey->meth->keygen(eckey);
223 ECerr(EC_F_EC_KEY_GENERATE_KEY, EC_R_OPERATION_NOT_SUPPORTED);
227 int ossl_ec_key_gen(EC_KEY *eckey)
231 BIGNUM *priv_key = NULL;
232 const BIGNUM *order = NULL;
233 EC_POINT *pub_key = NULL;
235 if ((ctx = BN_CTX_new()) == NULL)
238 if (eckey->priv_key == NULL) {
240 if (priv_key == NULL)
243 priv_key = eckey->priv_key;
245 order = EC_GROUP_get0_order(eckey->group);
250 if (!BN_rand_range(priv_key, order))
252 while (BN_is_zero(priv_key)) ;
254 if (eckey->pub_key == NULL) {
255 pub_key = EC_POINT_new(eckey->group);
259 pub_key = eckey->pub_key;
261 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
264 eckey->priv_key = priv_key;
265 eckey->pub_key = pub_key;
270 if (eckey->pub_key == NULL)
271 EC_POINT_free(pub_key);
272 if (eckey->priv_key != priv_key)
278 int EC_KEY_check_key(const EC_KEY *eckey)
282 const BIGNUM *order = NULL;
283 EC_POINT *point = NULL;
285 if (eckey == NULL || eckey->group == NULL || eckey->pub_key == NULL) {
286 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
290 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
291 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
295 if ((ctx = BN_CTX_new()) == NULL)
297 if ((point = EC_POINT_new(eckey->group)) == NULL)
300 /* testing whether the pub_key is on the elliptic curve */
301 if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
302 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
305 /* testing whether pub_key * order is the point at infinity */
306 order = eckey->group->order;
307 if (BN_is_zero(order)) {
308 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
311 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
312 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
315 if (!EC_POINT_is_at_infinity(eckey->group, point)) {
316 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
320 * in case the priv_key is present : check if generator * priv_key ==
323 if (eckey->priv_key != NULL) {
324 if (BN_cmp(eckey->priv_key, order) >= 0) {
325 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
328 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
330 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
333 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
334 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
341 EC_POINT_free(point);
345 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
350 EC_POINT *point = NULL;
352 #ifndef OPENSSL_NO_EC2M
353 int tmp_nid, is_char_two = 0;
356 if (key == NULL || key->group == NULL || x == NULL || y == NULL) {
357 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
358 ERR_R_PASSED_NULL_PARAMETER);
365 point = EC_POINT_new(key->group);
370 tx = BN_CTX_get(ctx);
371 ty = BN_CTX_get(ctx);
375 #ifndef OPENSSL_NO_EC2M
376 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
378 if (tmp_nid == NID_X9_62_characteristic_two_field)
382 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
385 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
391 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
394 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
399 * Check if retrieved coordinates match originals and are less than field
400 * order: if not values are out of range.
402 if (BN_cmp(x, tx) || BN_cmp(y, ty)
403 || (BN_cmp(x, key->group->field) >= 0)
404 || (BN_cmp(y, key->group->field) >= 0)) {
405 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
406 EC_R_COORDINATES_OUT_OF_RANGE);
410 if (!EC_KEY_set_public_key(key, point))
413 if (EC_KEY_check_key(key) == 0)
420 EC_POINT_free(point);
425 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
430 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
432 if (key->meth->set_group != NULL && key->meth->set_group(key, group) == 0)
434 EC_GROUP_free(key->group);
435 key->group = EC_GROUP_dup(group);
436 return (key->group == NULL) ? 0 : 1;
439 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
441 return key->priv_key;
444 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
446 if (key->meth->set_private != NULL
447 && key->meth->set_private(key, priv_key) == 0)
449 BN_clear_free(key->priv_key);
450 key->priv_key = BN_dup(priv_key);
451 return (key->priv_key == NULL) ? 0 : 1;
454 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
459 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
461 if (key->meth->set_public != NULL
462 && key->meth->set_public(key, pub_key) == 0)
464 EC_POINT_free(key->pub_key);
465 key->pub_key = EC_POINT_dup(pub_key, key->group);
466 return (key->pub_key == NULL) ? 0 : 1;
469 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
471 return key->enc_flag;
474 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
476 key->enc_flag = flags;
479 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
481 return key->conv_form;
484 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
486 key->conv_form = cform;
487 if (key->group != NULL)
488 EC_GROUP_set_point_conversion_form(key->group, cform);
491 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
493 if (key->group != NULL)
494 EC_GROUP_set_asn1_flag(key->group, flag);
497 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
499 if (key->group == NULL)
501 return EC_GROUP_precompute_mult(key->group, ctx);
504 int EC_KEY_get_flags(const EC_KEY *key)
509 void EC_KEY_set_flags(EC_KEY *key, int flags)
514 void EC_KEY_clear_flags(EC_KEY *key, int flags)
516 key->flags &= ~flags;
519 size_t EC_KEY_key2buf(const EC_KEY *key, point_conversion_form_t form,
520 unsigned char **pbuf, BN_CTX *ctx)
522 if (key == NULL || key->pub_key == NULL || key->group == NULL)
524 return EC_POINT_point2buf(key->group, key->pub_key, form, pbuf, ctx);
527 int EC_KEY_oct2key(EC_KEY *key, const unsigned char *buf, size_t len,
530 if (key == NULL || key->group == NULL)
532 if (key->pub_key == NULL)
533 key->pub_key = EC_POINT_new(key->group);
534 if (key->pub_key == NULL)
536 return EC_POINT_oct2point(key->group, key->pub_key, buf, len, ctx);
539 size_t EC_KEY_priv2oct(const EC_KEY *eckey, unsigned char *buf, size_t len)
542 if (eckey->group == NULL || eckey->group->meth == NULL)
545 buf_len = (EC_GROUP_get_degree(eckey->group) + 7) / 8;
546 if (eckey->priv_key == NULL)
550 else if (len < buf_len)
553 /* Octetstring may need leading zeros if BN is to short */
555 if (BN_bn2binpad(eckey->priv_key, buf, buf_len) == -1) {
556 ECerr(EC_F_EC_KEY_PRIV2OCT, EC_R_BUFFER_TOO_SMALL);
563 int EC_KEY_oct2priv(EC_KEY *eckey, unsigned char *buf, size_t len)
565 if (eckey->group == NULL || eckey->group->meth == NULL)
568 if (eckey->priv_key == NULL)
569 eckey->priv_key = BN_secure_new();
570 if (eckey->priv_key == NULL) {
571 ECerr(EC_F_EC_KEY_OCT2PRIV, ERR_R_MALLOC_FAILURE);
574 eckey->priv_key = BN_bin2bn(buf, len, eckey->priv_key);
575 if (eckey->priv_key == NULL) {
576 ECerr(EC_F_EC_KEY_OCT2PRIV, ERR_R_BN_LIB);
582 size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf)
586 len = EC_KEY_priv2oct(eckey, NULL, 0);
589 buf = OPENSSL_malloc(len);
592 len = EC_KEY_priv2oct(eckey, buf, len);