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 ENGINE_finish(r->engine);
114 if (r->group && r->group->meth->keyfinish)
115 r->group->meth->keyfinish(r);
117 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EC_KEY, r, &r->ex_data);
118 EC_GROUP_free(r->group);
119 EC_POINT_free(r->pub_key);
120 BN_clear_free(r->priv_key);
122 OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
125 EC_KEY *EC_KEY_copy(EC_KEY *dest, EC_KEY *src)
127 if (dest == NULL || src == NULL) {
128 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
131 if (src->meth != dest->meth) {
132 if (dest->meth->finish != NULL)
133 dest->meth->finish(dest);
134 if (dest->group && dest->group->meth->keyfinish)
135 dest->group->meth->keyfinish(dest);
136 #ifndef OPENSSL_NO_ENGINE
137 if (ENGINE_finish(dest->engine) == 0)
142 /* copy the parameters */
143 if (src->group != NULL) {
144 const EC_METHOD *meth = EC_GROUP_method_of(src->group);
145 /* clear the old group */
146 EC_GROUP_free(dest->group);
147 dest->group = EC_GROUP_new(meth);
148 if (dest->group == NULL)
150 if (!EC_GROUP_copy(dest->group, src->group))
153 /* copy the public key */
154 if (src->pub_key != NULL && src->group != NULL) {
155 EC_POINT_free(dest->pub_key);
156 dest->pub_key = EC_POINT_new(src->group);
157 if (dest->pub_key == NULL)
159 if (!EC_POINT_copy(dest->pub_key, src->pub_key))
162 /* copy the private key */
163 if (src->priv_key != NULL) {
164 if (dest->priv_key == NULL) {
165 dest->priv_key = BN_new();
166 if (dest->priv_key == NULL)
169 if (!BN_copy(dest->priv_key, src->priv_key))
171 if (src->group->meth->keycopy
172 && 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);
207 if (EC_KEY_copy(ret, ec_key) == NULL) {
214 int EC_KEY_up_ref(EC_KEY *r)
216 int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
218 REF_PRINT_COUNT("EC_KEY", r);
219 REF_ASSERT_ISNT(i < 2);
220 return ((i > 1) ? 1 : 0);
223 int EC_KEY_generate_key(EC_KEY *eckey)
225 if (eckey == NULL || eckey->group == NULL) {
226 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
229 if (eckey->meth->keygen != NULL)
230 return eckey->meth->keygen(eckey);
231 ECerr(EC_F_EC_KEY_GENERATE_KEY, EC_R_OPERATION_NOT_SUPPORTED);
235 int ossl_ec_key_gen(EC_KEY *eckey)
239 BIGNUM *priv_key = NULL;
240 const BIGNUM *order = NULL;
241 EC_POINT *pub_key = NULL;
243 if (eckey->group->meth->keygen != NULL)
244 return eckey->group->meth->keygen(eckey);
246 if ((ctx = BN_CTX_new()) == NULL)
249 if (eckey->priv_key == NULL) {
251 if (priv_key == NULL)
254 priv_key = eckey->priv_key;
256 order = EC_GROUP_get0_order(eckey->group);
261 if (!BN_rand_range(priv_key, order))
263 while (BN_is_zero(priv_key)) ;
265 if (eckey->pub_key == NULL) {
266 pub_key = EC_POINT_new(eckey->group);
270 pub_key = eckey->pub_key;
272 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
275 eckey->priv_key = priv_key;
276 eckey->pub_key = pub_key;
281 if (eckey->pub_key == NULL)
282 EC_POINT_free(pub_key);
283 if (eckey->priv_key != priv_key)
289 int EC_KEY_check_key(const EC_KEY *eckey)
293 const BIGNUM *order = NULL;
294 EC_POINT *point = NULL;
296 if (eckey == NULL || eckey->group == NULL || eckey->pub_key == NULL) {
297 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
301 if (eckey->group->meth->keycheck)
302 return eckey->group->meth->keycheck(eckey);
304 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
305 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
309 if ((ctx = BN_CTX_new()) == NULL)
311 if ((point = EC_POINT_new(eckey->group)) == NULL)
314 /* testing whether the pub_key is on the elliptic curve */
315 if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
316 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
319 /* testing whether pub_key * order is the point at infinity */
320 order = eckey->group->order;
321 if (BN_is_zero(order)) {
322 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
325 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
326 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
329 if (!EC_POINT_is_at_infinity(eckey->group, point)) {
330 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
334 * in case the priv_key is present : check if generator * priv_key ==
337 if (eckey->priv_key != NULL) {
338 if (BN_cmp(eckey->priv_key, order) >= 0) {
339 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
342 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
344 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
347 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
348 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
355 EC_POINT_free(point);
359 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
364 EC_POINT *point = NULL;
366 #ifndef OPENSSL_NO_EC2M
367 int tmp_nid, is_char_two = 0;
370 if (key == NULL || key->group == NULL || x == NULL || y == NULL) {
371 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
372 ERR_R_PASSED_NULL_PARAMETER);
379 point = EC_POINT_new(key->group);
384 tx = BN_CTX_get(ctx);
385 ty = BN_CTX_get(ctx);
389 #ifndef OPENSSL_NO_EC2M
390 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
392 if (tmp_nid == NID_X9_62_characteristic_two_field)
396 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
399 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
405 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
408 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
413 * Check if retrieved coordinates match originals and are less than field
414 * order: if not values are out of range.
416 if (BN_cmp(x, tx) || BN_cmp(y, ty)
417 || (BN_cmp(x, key->group->field) >= 0)
418 || (BN_cmp(y, key->group->field) >= 0)) {
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)
434 EC_POINT_free(point);
439 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
444 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
446 if (key->meth->set_group != NULL && key->meth->set_group(key, group) == 0)
448 EC_GROUP_free(key->group);
449 key->group = EC_GROUP_dup(group);
450 return (key->group == NULL) ? 0 : 1;
453 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
455 return key->priv_key;
458 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
460 if (key->group == NULL || key->group->meth == NULL)
462 if (key->group->meth->set_private
463 && key->meth->set_private(key, priv_key) == 0)
465 if (key->meth->set_private != NULL
466 && key->meth->set_private(key, priv_key) == 0)
468 BN_clear_free(key->priv_key);
469 key->priv_key = BN_dup(priv_key);
470 return (key->priv_key == NULL) ? 0 : 1;
473 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
478 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
480 if (key->meth->set_public != NULL
481 && key->meth->set_public(key, pub_key) == 0)
483 EC_POINT_free(key->pub_key);
484 key->pub_key = EC_POINT_dup(pub_key, key->group);
485 return (key->pub_key == NULL) ? 0 : 1;
488 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
490 return key->enc_flag;
493 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
495 key->enc_flag = flags;
498 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
500 return key->conv_form;
503 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
505 key->conv_form = cform;
506 if (key->group != NULL)
507 EC_GROUP_set_point_conversion_form(key->group, cform);
510 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
512 if (key->group != NULL)
513 EC_GROUP_set_asn1_flag(key->group, flag);
516 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
518 if (key->group == NULL)
520 return EC_GROUP_precompute_mult(key->group, ctx);
523 int EC_KEY_get_flags(const EC_KEY *key)
528 void EC_KEY_set_flags(EC_KEY *key, int flags)
533 void EC_KEY_clear_flags(EC_KEY *key, int flags)
535 key->flags &= ~flags;
538 size_t EC_KEY_key2buf(const EC_KEY *key, point_conversion_form_t form,
539 unsigned char **pbuf, BN_CTX *ctx)
541 if (key == NULL || key->pub_key == NULL || key->group == NULL)
543 return EC_POINT_point2buf(key->group, key->pub_key, form, pbuf, ctx);
546 int EC_KEY_oct2key(EC_KEY *key, const unsigned char *buf, size_t len,
549 if (key == NULL || key->group == NULL)
551 if (key->pub_key == NULL)
552 key->pub_key = EC_POINT_new(key->group);
553 if (key->pub_key == NULL)
555 if (EC_POINT_oct2point(key->group, key->pub_key, buf, len, ctx) == 0)
558 * Save the point conversion form.
559 * For non-custom curves the first octet of the buffer (excluding
560 * the last significant bit) contains the point conversion form.
561 * EC_POINT_oct2point() has already performed sanity checking of
562 * the buffer so we know it is valid.
564 if ((key->group->meth->flags & EC_FLAGS_CUSTOM_CURVE) == 0)
565 key->conv_form = (point_conversion_form_t)(buf[0] & ~0x01);
569 size_t EC_KEY_priv2oct(const EC_KEY *eckey, unsigned char *buf, size_t len)
572 if (eckey->group == NULL || eckey->group->meth == NULL)
574 if (eckey->group->meth->priv2oct)
575 return eckey->group->meth->priv2oct(eckey, buf, len);
577 buf_len = (EC_GROUP_get_degree(eckey->group) + 7) / 8;
578 if (eckey->priv_key == NULL)
582 else if (len < buf_len)
585 /* Octetstring may need leading zeros if BN is to short */
587 if (BN_bn2binpad(eckey->priv_key, buf, buf_len) == -1) {
588 ECerr(EC_F_EC_KEY_PRIV2OCT, EC_R_BUFFER_TOO_SMALL);
595 int EC_KEY_oct2priv(EC_KEY *eckey, unsigned char *buf, size_t len)
597 if (eckey->group == NULL || eckey->group->meth == NULL)
599 if (eckey->group->meth->oct2priv)
600 return eckey->group->meth->oct2priv(eckey, buf, len);
602 if (eckey->priv_key == NULL)
603 eckey->priv_key = BN_secure_new();
604 if (eckey->priv_key == NULL) {
605 ECerr(EC_F_EC_KEY_OCT2PRIV, ERR_R_MALLOC_FAILURE);
608 eckey->priv_key = BN_bin2bn(buf, len, eckey->priv_key);
609 if (eckey->priv_key == NULL) {
610 ECerr(EC_F_EC_KEY_OCT2PRIV, ERR_R_BN_LIB);
616 size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf)
620 len = EC_KEY_priv2oct(eckey, NULL, 0);
623 buf = OPENSSL_malloc(len);
626 len = EC_KEY_priv2oct(eckey, buf, len);