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 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EC_KEY, r, &r->ex_data);
124 EC_GROUP_free(r->group);
125 EC_POINT_free(r->pub_key);
126 BN_clear_free(r->priv_key);
128 OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
131 EC_KEY *EC_KEY_copy(EC_KEY *dest, EC_KEY *src)
133 if (dest == NULL || src == NULL) {
134 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
137 if (src->meth != dest->meth) {
138 if (dest->meth->finish != NULL)
139 dest->meth->finish(dest);
140 #ifndef OPENSSL_NO_ENGINE
141 if (dest->engine != NULL && ENGINE_finish(dest->engine) == 0)
146 /* copy the parameters */
147 if (src->group != NULL) {
148 const EC_METHOD *meth = EC_GROUP_method_of(src->group);
149 /* clear the old group */
150 EC_GROUP_free(dest->group);
151 dest->group = EC_GROUP_new(meth);
152 if (dest->group == NULL)
154 if (!EC_GROUP_copy(dest->group, src->group))
157 /* copy the public key */
158 if (src->pub_key != NULL && src->group != NULL) {
159 EC_POINT_free(dest->pub_key);
160 dest->pub_key = EC_POINT_new(src->group);
161 if (dest->pub_key == NULL)
163 if (!EC_POINT_copy(dest->pub_key, src->pub_key))
166 /* copy the private key */
167 if (src->priv_key != NULL) {
168 if (dest->priv_key == NULL) {
169 dest->priv_key = BN_new();
170 if (dest->priv_key == NULL)
173 if (!BN_copy(dest->priv_key, src->priv_key))
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("EC_KEY", r);
222 fprintf(stderr, "EC_KEY_up, bad reference count\n");
226 return ((i > 1) ? 1 : 0);
229 int EC_KEY_generate_key(EC_KEY *eckey)
231 if (eckey == NULL || eckey->group == NULL) {
232 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
235 if (eckey->meth->keygen != NULL)
236 return eckey->meth->keygen(eckey);
237 ECerr(EC_F_EC_KEY_GENERATE_KEY, EC_R_OPERATION_NOT_SUPPORTED);
241 int ossl_ec_key_gen(EC_KEY *eckey)
245 BIGNUM *priv_key = NULL, *order = NULL;
246 EC_POINT *pub_key = NULL;
248 if ((order = BN_new()) == NULL)
250 if ((ctx = BN_CTX_new()) == NULL)
253 if (eckey->priv_key == NULL) {
255 if (priv_key == NULL)
258 priv_key = eckey->priv_key;
260 if (!EC_GROUP_get_order(eckey->group, order, ctx))
264 if (!BN_rand_range(priv_key, order))
266 while (BN_is_zero(priv_key)) ;
268 if (eckey->pub_key == NULL) {
269 pub_key = EC_POINT_new(eckey->group);
273 pub_key = eckey->pub_key;
275 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
278 eckey->priv_key = priv_key;
279 eckey->pub_key = pub_key;
285 if (eckey->pub_key == NULL)
286 EC_POINT_free(pub_key);
287 if (eckey->priv_key != priv_key)
293 int EC_KEY_check_key(const EC_KEY *eckey)
297 const BIGNUM *order = NULL;
298 EC_POINT *point = NULL;
300 if (eckey == NULL || eckey->group == NULL || eckey->pub_key == NULL) {
301 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
305 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
306 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
310 if ((ctx = BN_CTX_new()) == NULL)
312 if ((point = EC_POINT_new(eckey->group)) == NULL)
315 /* testing whether the pub_key is on the elliptic curve */
316 if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
317 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
320 /* testing whether pub_key * order is the point at infinity */
321 order = eckey->group->order;
322 if (BN_is_zero(order)) {
323 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
326 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
327 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
330 if (!EC_POINT_is_at_infinity(eckey->group, point)) {
331 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
335 * in case the priv_key is present : check if generator * priv_key ==
338 if (eckey->priv_key != NULL) {
339 if (BN_cmp(eckey->priv_key, order) >= 0) {
340 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
343 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
345 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
348 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
349 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
356 EC_POINT_free(point);
360 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
365 EC_POINT *point = NULL;
367 #ifndef OPENSSL_NO_EC2M
368 int tmp_nid, is_char_two = 0;
371 if (key == NULL || key->group == NULL || x == NULL || y == NULL) {
372 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
373 ERR_R_PASSED_NULL_PARAMETER);
380 point = EC_POINT_new(key->group);
385 tx = BN_CTX_get(ctx);
386 ty = BN_CTX_get(ctx);
388 #ifndef OPENSSL_NO_EC2M
389 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
391 if (tmp_nid == NID_X9_62_characteristic_two_field)
395 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
398 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
404 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
407 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
412 * Check if retrieved coordinates match originals and are less than field
413 * order: if not values are out of range.
415 if (BN_cmp(x, tx) || BN_cmp(y, ty)
416 || (BN_cmp(x, key->group->field) >= 0)
417 || (BN_cmp(y, key->group->field) >= 0)) {
418 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
419 EC_R_COORDINATES_OUT_OF_RANGE);
423 if (!EC_KEY_set_public_key(key, point))
426 if (EC_KEY_check_key(key) == 0)
433 EC_POINT_free(point);
438 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
443 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
445 if (key->meth->set_group != NULL && key->meth->set_group(key, group) == 0)
447 EC_GROUP_free(key->group);
448 key->group = EC_GROUP_dup(group);
449 return (key->group == NULL) ? 0 : 1;
452 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
454 return key->priv_key;
457 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
459 if (key->meth->set_private != NULL
460 && key->meth->set_private(key, priv_key) == 0)
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->meth->set_public != NULL
475 && key->meth->set_public(key, pub_key) == 0)
477 EC_POINT_free(key->pub_key);
478 key->pub_key = EC_POINT_dup(pub_key, key->group);
479 return (key->pub_key == NULL) ? 0 : 1;
482 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
484 return key->enc_flag;
487 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
489 key->enc_flag = flags;
492 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
494 return key->conv_form;
497 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
499 key->conv_form = cform;
500 if (key->group != NULL)
501 EC_GROUP_set_point_conversion_form(key->group, cform);
504 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
506 if (key->group != NULL)
507 EC_GROUP_set_asn1_flag(key->group, flag);
510 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
512 if (key->group == NULL)
514 return EC_GROUP_precompute_mult(key->group, ctx);
517 int EC_KEY_get_flags(const EC_KEY *key)
522 void EC_KEY_set_flags(EC_KEY *key, int flags)
527 void EC_KEY_clear_flags(EC_KEY *key, int flags)
529 key->flags &= ~flags;
532 size_t EC_KEY_key2buf(const EC_KEY *key, point_conversion_form_t form,
533 unsigned char **pbuf, BN_CTX *ctx)
535 if (key == NULL || key->pub_key == NULL || key->group == NULL)
537 return EC_POINT_point2buf(key->group, key->pub_key, form, pbuf, ctx);
540 int EC_KEY_oct2key(EC_KEY *key, const unsigned char *buf, size_t len,
543 if (key == NULL || key->group == NULL)
545 if (key->pub_key == NULL)
546 key->pub_key = EC_POINT_new(key->group);
547 if (key->pub_key == NULL)
549 return EC_POINT_oct2point(key->group, key->pub_key, buf, len, ctx);