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 #include <openssl/engine.h>
69 EC_KEY *EC_KEY_new(void)
71 return EC_KEY_new_method(NULL);
74 EC_KEY *EC_KEY_new_by_curve_name(int nid)
76 EC_KEY *ret = EC_KEY_new();
79 ret->group = EC_GROUP_new_by_curve_name(nid);
80 if (ret->group == NULL) {
84 if (ret->meth->set_group != NULL
85 && ret->meth->set_group(ret, ret->group) == 0) {
92 void EC_KEY_free(EC_KEY *r)
99 CRYPTO_atomic_add(&r->references, -1, &i, r->lock);
100 REF_PRINT_COUNT("EC_KEY", r);
103 REF_ASSERT_ISNT(i < 0);
105 if (r->meth->finish != NULL)
108 #ifndef OPENSSL_NO_ENGINE
109 ENGINE_finish(r->engine);
112 if (r->group && r->group->meth->keyfinish)
113 r->group->meth->keyfinish(r);
115 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EC_KEY, r, &r->ex_data);
116 CRYPTO_THREAD_lock_free(r->lock);
117 EC_GROUP_free(r->group);
118 EC_POINT_free(r->pub_key);
119 BN_clear_free(r->priv_key);
121 OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
124 EC_KEY *EC_KEY_copy(EC_KEY *dest, EC_KEY *src)
126 if (dest == NULL || src == NULL) {
127 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
130 if (src->meth != dest->meth) {
131 if (dest->meth->finish != NULL)
132 dest->meth->finish(dest);
133 if (dest->group && dest->group->meth->keyfinish)
134 dest->group->meth->keyfinish(dest);
135 #ifndef OPENSSL_NO_ENGINE
136 if (ENGINE_finish(dest->engine) == 0)
141 /* copy the parameters */
142 if (src->group != NULL) {
143 const EC_METHOD *meth = EC_GROUP_method_of(src->group);
144 /* clear the old group */
145 EC_GROUP_free(dest->group);
146 dest->group = EC_GROUP_new(meth);
147 if (dest->group == NULL)
149 if (!EC_GROUP_copy(dest->group, src->group))
152 /* copy the public key */
153 if (src->pub_key != NULL) {
154 EC_POINT_free(dest->pub_key);
155 dest->pub_key = EC_POINT_new(src->group);
156 if (dest->pub_key == NULL)
158 if (!EC_POINT_copy(dest->pub_key, src->pub_key))
161 /* copy the private key */
162 if (src->priv_key != NULL) {
163 if (dest->priv_key == NULL) {
164 dest->priv_key = BN_new();
165 if (dest->priv_key == NULL)
168 if (!BN_copy(dest->priv_key, src->priv_key))
170 if (src->group->meth->keycopy
171 && src->group->meth->keycopy(dest, src) == 0)
178 dest->enc_flag = src->enc_flag;
179 dest->conv_form = src->conv_form;
180 dest->version = src->version;
181 dest->flags = src->flags;
182 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_EC_KEY,
183 &dest->ex_data, &src->ex_data))
186 if (src->meth != dest->meth) {
187 #ifndef OPENSSL_NO_ENGINE
188 if (src->engine != NULL && ENGINE_init(src->engine) == 0)
190 dest->engine = src->engine;
192 dest->meth = src->meth;
195 if (src->meth->copy != NULL && src->meth->copy(dest, src) == 0)
201 EC_KEY *EC_KEY_dup(EC_KEY *ec_key)
203 EC_KEY *ret = EC_KEY_new_method(ec_key->engine);
208 if (EC_KEY_copy(ret, ec_key) == NULL) {
215 int EC_KEY_up_ref(EC_KEY *r)
219 if (CRYPTO_atomic_add(&r->references, 1, &i, r->lock) <= 0)
222 REF_PRINT_COUNT("EC_KEY", r);
223 REF_ASSERT_ISNT(i < 2);
224 return ((i > 1) ? 1 : 0);
227 int EC_KEY_generate_key(EC_KEY *eckey)
229 if (eckey == NULL || eckey->group == NULL) {
230 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
233 if (eckey->meth->keygen != NULL)
234 return eckey->meth->keygen(eckey);
235 ECerr(EC_F_EC_KEY_GENERATE_KEY, EC_R_OPERATION_NOT_SUPPORTED);
239 int ossl_ec_key_gen(EC_KEY *eckey)
241 OPENSSL_assert(eckey->group->meth->keygen != NULL);
242 return eckey->group->meth->keygen(eckey);
245 int ec_key_simple_generate_key(EC_KEY *eckey)
249 BIGNUM *priv_key = NULL;
250 const BIGNUM *order = NULL;
251 EC_POINT *pub_key = NULL;
253 if ((ctx = BN_CTX_new()) == NULL)
256 if (eckey->priv_key == NULL) {
258 if (priv_key == NULL)
261 priv_key = eckey->priv_key;
263 order = EC_GROUP_get0_order(eckey->group);
268 if (!BN_rand_range(priv_key, order))
270 while (BN_is_zero(priv_key)) ;
272 if (eckey->pub_key == NULL) {
273 pub_key = EC_POINT_new(eckey->group);
277 pub_key = eckey->pub_key;
279 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
282 eckey->priv_key = priv_key;
283 eckey->pub_key = pub_key;
288 if (eckey->pub_key == NULL)
289 EC_POINT_free(pub_key);
290 if (eckey->priv_key != priv_key)
296 int ec_key_simple_generate_public_key(EC_KEY *eckey)
298 return EC_POINT_mul(eckey->group, eckey->pub_key, eckey->priv_key, NULL,
302 int EC_KEY_check_key(const EC_KEY *eckey)
304 if (eckey == NULL || eckey->group == NULL || eckey->pub_key == NULL) {
305 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
309 if (eckey->group->meth->keycheck == NULL) {
310 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
314 return eckey->group->meth->keycheck(eckey);
317 int ec_key_simple_check_key(const EC_KEY *eckey)
321 const BIGNUM *order = NULL;
322 EC_POINT *point = NULL;
324 if (eckey == NULL || eckey->group == NULL || eckey->pub_key == NULL) {
325 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
329 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
330 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, EC_R_POINT_AT_INFINITY);
334 if ((ctx = BN_CTX_new()) == NULL)
336 if ((point = EC_POINT_new(eckey->group)) == NULL)
339 /* testing whether the pub_key is on the elliptic curve */
340 if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
341 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
344 /* testing whether pub_key * order is the point at infinity */
345 order = eckey->group->order;
346 if (BN_is_zero(order)) {
347 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
350 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
351 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, ERR_R_EC_LIB);
354 if (!EC_POINT_is_at_infinity(eckey->group, point)) {
355 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, EC_R_WRONG_ORDER);
359 * in case the priv_key is present : check if generator * priv_key ==
362 if (eckey->priv_key != NULL) {
363 if (BN_cmp(eckey->priv_key, order) >= 0) {
364 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, EC_R_WRONG_ORDER);
367 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
369 ECerr(EC_F_EC_KEY_SIMPLE_CHECK_KEY, ERR_R_EC_LIB);
372 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
373 ECerr(EC_F_EC_KEY_SIMPLE_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,
389 EC_POINT *point = NULL;
391 #ifndef OPENSSL_NO_EC2M
392 int tmp_nid, is_char_two = 0;
395 if (key == NULL || key->group == NULL || x == NULL || y == NULL) {
396 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
397 ERR_R_PASSED_NULL_PARAMETER);
405 point = EC_POINT_new(key->group);
410 tx = BN_CTX_get(ctx);
411 ty = BN_CTX_get(ctx);
415 #ifndef OPENSSL_NO_EC2M
416 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
418 if (tmp_nid == NID_X9_62_characteristic_two_field)
422 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
425 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
431 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
434 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
439 * Check if retrieved coordinates match originals and are less than field
440 * order: if not values are out of range.
442 if (BN_cmp(x, tx) || BN_cmp(y, ty)
443 || (BN_cmp(x, key->group->field) >= 0)
444 || (BN_cmp(y, key->group->field) >= 0)) {
445 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
446 EC_R_COORDINATES_OUT_OF_RANGE);
450 if (!EC_KEY_set_public_key(key, point))
453 if (EC_KEY_check_key(key) == 0)
461 EC_POINT_free(point);
466 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
471 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
473 if (key->meth->set_group != NULL && key->meth->set_group(key, group) == 0)
475 EC_GROUP_free(key->group);
476 key->group = EC_GROUP_dup(group);
477 return (key->group == NULL) ? 0 : 1;
480 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
482 return key->priv_key;
485 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
487 if (key->group == NULL || key->group->meth == NULL)
489 if (key->group->meth->set_private != NULL
490 && key->group->meth->set_private(key, priv_key) == 0)
492 if (key->meth->set_private != NULL
493 && key->meth->set_private(key, priv_key) == 0)
495 BN_clear_free(key->priv_key);
496 key->priv_key = BN_dup(priv_key);
497 return (key->priv_key == NULL) ? 0 : 1;
500 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
505 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
507 if (key->meth->set_public != NULL
508 && key->meth->set_public(key, pub_key) == 0)
510 EC_POINT_free(key->pub_key);
511 key->pub_key = EC_POINT_dup(pub_key, key->group);
512 return (key->pub_key == NULL) ? 0 : 1;
515 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
517 return key->enc_flag;
520 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
522 key->enc_flag = flags;
525 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
527 return key->conv_form;
530 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
532 key->conv_form = cform;
533 if (key->group != NULL)
534 EC_GROUP_set_point_conversion_form(key->group, cform);
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;
565 size_t EC_KEY_key2buf(const EC_KEY *key, point_conversion_form_t form,
566 unsigned char **pbuf, BN_CTX *ctx)
568 if (key == NULL || key->pub_key == NULL || key->group == NULL)
570 return EC_POINT_point2buf(key->group, key->pub_key, form, pbuf, ctx);
573 int EC_KEY_oct2key(EC_KEY *key, const unsigned char *buf, size_t len,
576 if (key == NULL || key->group == NULL)
578 if (key->pub_key == NULL)
579 key->pub_key = EC_POINT_new(key->group);
580 if (key->pub_key == NULL)
582 if (EC_POINT_oct2point(key->group, key->pub_key, buf, len, ctx) == 0)
585 * Save the point conversion form.
586 * For non-custom curves the first octet of the buffer (excluding
587 * the last significant bit) contains the point conversion form.
588 * EC_POINT_oct2point() has already performed sanity checking of
589 * the buffer so we know it is valid.
591 if ((key->group->meth->flags & EC_FLAGS_CUSTOM_CURVE) == 0)
592 key->conv_form = (point_conversion_form_t)(buf[0] & ~0x01);
596 size_t EC_KEY_priv2oct(const EC_KEY *eckey, unsigned char *buf, size_t len)
598 if (eckey->group == NULL || eckey->group->meth == NULL)
600 if (eckey->group->meth->priv2oct == NULL) {
601 ECerr(EC_F_EC_KEY_PRIV2OCT, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
605 return eckey->group->meth->priv2oct(eckey, buf, len);
608 size_t ec_key_simple_priv2oct(const EC_KEY *eckey,
609 unsigned char *buf, size_t len)
613 buf_len = (EC_GROUP_order_bits(eckey->group) + 7) / 8;
614 if (eckey->priv_key == NULL)
618 else if (len < buf_len)
621 /* Octetstring may need leading zeros if BN is to short */
623 if (BN_bn2binpad(eckey->priv_key, buf, buf_len) == -1) {
624 ECerr(EC_F_EC_KEY_SIMPLE_PRIV2OCT, EC_R_BUFFER_TOO_SMALL);
631 int EC_KEY_oct2priv(EC_KEY *eckey, unsigned char *buf, size_t len)
633 if (eckey->group == NULL || eckey->group->meth == NULL)
635 if (eckey->group->meth->oct2priv == NULL) {
636 ECerr(EC_F_EC_KEY_OCT2PRIV, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED);
639 return eckey->group->meth->oct2priv(eckey, buf, len);
642 int ec_key_simple_oct2priv(EC_KEY *eckey, unsigned char *buf, size_t len)
644 if (eckey->priv_key == NULL)
645 eckey->priv_key = BN_secure_new();
646 if (eckey->priv_key == NULL) {
647 ECerr(EC_F_EC_KEY_SIMPLE_OCT2PRIV, ERR_R_MALLOC_FAILURE);
650 eckey->priv_key = BN_bin2bn(buf, len, eckey->priv_key);
651 if (eckey->priv_key == NULL) {
652 ECerr(EC_F_EC_KEY_SIMPLE_OCT2PRIV, ERR_R_BN_LIB);
658 size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf)
662 len = EC_KEY_priv2oct(eckey, NULL, 0);
665 buf = OPENSSL_malloc(len);
668 len = EC_KEY_priv2oct(eckey, buf, len);
677 int EC_KEY_can_sign(const EC_KEY *eckey)
679 if (eckey->group == NULL || eckey->group->meth == NULL
680 || (eckey->group->meth->flags & EC_FLAGS_NO_SIGN))