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 OPENSSSL_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) {
90 void EC_KEY_free(EC_KEY *r)
97 i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_EC);
99 REF_PRINT("EC_KEY", r);
105 fprintf(stderr, "EC_KEY_free, bad reference count\n");
113 #ifndef OPENSSL_NO_ENGINE
115 ENGINE_finish(r->engine);
118 EC_GROUP_free(r->group);
119 EC_POINT_free(r->pub_key);
120 BN_clear_free(r->priv_key);
122 EC_EX_DATA_free_all_data(&r->method_data);
124 OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
127 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
131 if (dest == NULL || src == NULL) {
132 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
135 if (src->meth != dest->meth) {
136 if (dest->meth->finish)
137 dest->meth->finish(dest);
138 #ifndef OPENSSL_NO_ENGINE
139 if (dest->engine && ENGINE_finish(dest->engine) == 0)
144 /* copy the parameters */
146 const EC_METHOD *meth = EC_GROUP_method_of(src->group);
147 /* clear the old group */
148 EC_GROUP_free(dest->group);
149 dest->group = EC_GROUP_new(meth);
150 if (dest->group == NULL)
152 if (!EC_GROUP_copy(dest->group, src->group))
155 /* copy the public key */
156 if (src->pub_key && src->group) {
157 EC_POINT_free(dest->pub_key);
158 dest->pub_key = EC_POINT_new(src->group);
159 if (dest->pub_key == NULL)
161 if (!EC_POINT_copy(dest->pub_key, src->pub_key))
164 /* copy the private key */
166 if (dest->priv_key == NULL) {
167 dest->priv_key = BN_new();
168 if (dest->priv_key == NULL)
171 if (!BN_copy(dest->priv_key, src->priv_key))
174 /* copy method/extra data */
175 EC_EX_DATA_free_all_data(&dest->method_data);
177 for (d = src->method_data; d != NULL; d = d->next) {
178 void *t = d->dup_func(d->data);
182 if (!EC_EX_DATA_set_data
183 (&dest->method_data, t, d->dup_func, d->free_func,
189 dest->enc_flag = src->enc_flag;
190 dest->conv_form = src->conv_form;
191 dest->version = src->version;
192 dest->flags = src->flags;
194 if (src->meth != dest->meth) {
195 #ifndef OPENSSL_NO_ENGINE
196 if (src->engine && ENGINE_init(src->engine) == 0)
198 dest->engine = src->engine;
200 dest->meth = src->meth;
203 if (src->meth->copy && src->meth->copy(dest, src) == 0)
209 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
211 EC_KEY *ret = EC_KEY_new_method(ec_key->engine);
214 if (EC_KEY_copy(ret, ec_key) == NULL) {
221 int EC_KEY_up_ref(EC_KEY *r)
223 int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
225 REF_PRINT("EC_KEY", r);
229 fprintf(stderr, "EC_KEY_up, bad reference count\n");
233 return ((i > 1) ? 1 : 0);
236 int EC_KEY_generate_key(EC_KEY *eckey)
238 if (!eckey || !eckey->group) {
239 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
242 if (eckey->meth->keygen)
243 return eckey->meth->keygen(eckey);
244 ECerr(EC_F_EC_KEY_GENERATE_KEY, EC_R_OPERATION_NOT_SUPPORTED);
248 int ossl_ec_key_gen(EC_KEY *eckey)
252 BIGNUM *priv_key = NULL, *order = NULL;
253 EC_POINT *pub_key = NULL;
255 if ((order = BN_new()) == NULL)
257 if ((ctx = BN_CTX_new()) == NULL)
260 if (eckey->priv_key == NULL) {
262 if (priv_key == NULL)
265 priv_key = eckey->priv_key;
267 if (!EC_GROUP_get_order(eckey->group, order, ctx))
271 if (!BN_rand_range(priv_key, order))
273 while (BN_is_zero(priv_key)) ;
275 if (eckey->pub_key == NULL) {
276 pub_key = EC_POINT_new(eckey->group);
280 pub_key = eckey->pub_key;
282 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
285 eckey->priv_key = priv_key;
286 eckey->pub_key = pub_key;
292 if (eckey->pub_key == NULL)
293 EC_POINT_free(pub_key);
294 if (eckey->priv_key != priv_key)
300 int EC_KEY_check_key(const EC_KEY *eckey)
304 const BIGNUM *order = NULL;
305 EC_POINT *point = NULL;
307 if (!eckey || !eckey->group || !eckey->pub_key) {
308 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
312 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
313 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
317 if ((ctx = BN_CTX_new()) == NULL)
319 if ((point = EC_POINT_new(eckey->group)) == NULL)
322 /* testing whether the pub_key is on the elliptic curve */
323 if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
324 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
327 /* testing whether pub_key * order is the point at infinity */
328 order = eckey->group->order;
329 if (BN_is_zero(order)) {
330 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
333 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
334 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
337 if (!EC_POINT_is_at_infinity(eckey->group, point)) {
338 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
342 * in case the priv_key is present : check if generator * priv_key ==
345 if (eckey->priv_key) {
346 if (BN_cmp(eckey->priv_key, order) >= 0) {
347 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
350 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
352 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
355 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
356 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
363 EC_POINT_free(point);
367 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
372 EC_POINT *point = NULL;
374 #ifndef OPENSSL_NO_EC2M
375 int tmp_nid, is_char_two = 0;
378 if (!key || !key->group || !x || !y) {
379 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
380 ERR_R_PASSED_NULL_PARAMETER);
387 point = EC_POINT_new(key->group);
392 tx = BN_CTX_get(ctx);
393 ty = BN_CTX_get(ctx);
395 #ifndef OPENSSL_NO_EC2M
396 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
398 if (tmp_nid == NID_X9_62_characteristic_two_field)
402 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
405 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
411 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
414 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
419 * Check if retrieved coordinates match originals and are less than field
420 * order: if not values are out of range.
422 if (BN_cmp(x, tx) || BN_cmp(y, ty)
423 || (BN_cmp(x, key->group->field) >= 0)
424 || (BN_cmp(y, key->group->field) >= 0)) {
425 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
426 EC_R_COORDINATES_OUT_OF_RANGE);
430 if (!EC_KEY_set_public_key(key, point))
433 if (EC_KEY_check_key(key) == 0)
440 EC_POINT_free(point);
445 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
450 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
452 EC_GROUP_free(key->group);
453 key->group = EC_GROUP_dup(group);
454 return (key->group == NULL) ? 0 : 1;
457 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
459 return key->priv_key;
462 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
464 BN_clear_free(key->priv_key);
465 key->priv_key = BN_dup(priv_key);
466 return (key->priv_key == NULL) ? 0 : 1;
469 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
474 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
476 EC_POINT_free(key->pub_key);
477 key->pub_key = EC_POINT_dup(pub_key, key->group);
478 return (key->pub_key == NULL) ? 0 : 1;
481 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
483 return key->enc_flag;
486 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
488 key->enc_flag = flags;
491 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
493 return key->conv_form;
496 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
498 key->conv_form = cform;
499 if (key->group != NULL)
500 EC_GROUP_set_point_conversion_form(key->group, cform);
503 void *EC_KEY_get_key_method_data(EC_KEY *key,
504 void *(*dup_func) (void *),
505 void (*free_func) (void *),
506 void (*clear_free_func) (void *))
510 CRYPTO_r_lock(CRYPTO_LOCK_EC);
512 EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
514 CRYPTO_r_unlock(CRYPTO_LOCK_EC);
519 void *EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
520 void *(*dup_func) (void *),
521 void (*free_func) (void *),
522 void (*clear_free_func) (void *))
524 EC_EXTRA_DATA *ex_data;
526 CRYPTO_w_lock(CRYPTO_LOCK_EC);
528 EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
531 EC_EX_DATA_set_data(&key->method_data, data, dup_func, free_func,
533 CRYPTO_w_unlock(CRYPTO_LOCK_EC);
538 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
540 if (key->group != NULL)
541 EC_GROUP_set_asn1_flag(key->group, flag);
544 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
546 if (key->group == NULL)
548 return EC_GROUP_precompute_mult(key->group, ctx);
551 int EC_KEY_get_flags(const EC_KEY *key)
556 void EC_KEY_set_flags(EC_KEY *key, int flags)
561 void EC_KEY_clear_flags(EC_KEY *key, int flags)
563 key->flags &= ~flags;