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>
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) {
87 void EC_KEY_free(EC_KEY *r)
94 i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_EC);
96 REF_PRINT("EC_KEY", r);
102 fprintf(stderr, "EC_KEY_free, bad reference count\n");
107 EC_GROUP_free(r->group);
108 EC_POINT_free(r->pub_key);
109 BN_clear_free(r->priv_key);
111 EC_EX_DATA_free_all_data(&r->method_data);
113 OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
116 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
120 if (dest == NULL || src == NULL) {
121 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
124 /* copy the parameters */
126 const EC_METHOD *meth = EC_GROUP_method_of(src->group);
127 /* clear the old group */
128 EC_GROUP_free(dest->group);
129 dest->group = EC_GROUP_new(meth);
130 if (dest->group == NULL)
132 if (!EC_GROUP_copy(dest->group, src->group))
135 /* copy the public key */
136 if (src->pub_key && src->group) {
137 EC_POINT_free(dest->pub_key);
138 dest->pub_key = EC_POINT_new(src->group);
139 if (dest->pub_key == NULL)
141 if (!EC_POINT_copy(dest->pub_key, src->pub_key))
144 /* copy the private key */
146 if (dest->priv_key == NULL) {
147 dest->priv_key = BN_new();
148 if (dest->priv_key == NULL)
151 if (!BN_copy(dest->priv_key, src->priv_key))
154 /* copy method/extra data */
155 EC_EX_DATA_free_all_data(&dest->method_data);
157 for (d = src->method_data; d != NULL; d = d->next) {
158 void *t = d->dup_func(d->data);
162 if (!EC_EX_DATA_set_data
163 (&dest->method_data, t, d->dup_func, d->free_func,
169 dest->enc_flag = src->enc_flag;
170 dest->conv_form = src->conv_form;
171 dest->version = src->version;
172 dest->flags = src->flags;
177 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
179 EC_KEY *ret = EC_KEY_new();
182 if (EC_KEY_copy(ret, ec_key) == NULL) {
189 int EC_KEY_up_ref(EC_KEY *r)
191 int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
193 REF_PRINT("EC_KEY", r);
197 fprintf(stderr, "EC_KEY_up, bad reference count\n");
201 return ((i > 1) ? 1 : 0);
204 int EC_KEY_generate_key(EC_KEY *eckey)
208 BIGNUM *priv_key = NULL, *order = NULL;
209 EC_POINT *pub_key = NULL;
211 if (!eckey || !eckey->group) {
212 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
216 if ((order = BN_new()) == NULL)
218 if ((ctx = BN_CTX_new()) == NULL)
221 if (eckey->priv_key == NULL) {
223 if (priv_key == NULL)
226 priv_key = eckey->priv_key;
228 if (!EC_GROUP_get_order(eckey->group, order, ctx))
232 if (!BN_rand_range(priv_key, order))
234 while (BN_is_zero(priv_key)) ;
236 if (eckey->pub_key == NULL) {
237 pub_key = EC_POINT_new(eckey->group);
241 pub_key = eckey->pub_key;
243 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
246 eckey->priv_key = priv_key;
247 eckey->pub_key = pub_key;
253 if (eckey->pub_key == NULL)
254 EC_POINT_free(pub_key);
255 if (eckey->priv_key != priv_key)
261 int EC_KEY_check_key(const EC_KEY *eckey)
265 const BIGNUM *order = NULL;
266 EC_POINT *point = NULL;
268 if (!eckey || !eckey->group || !eckey->pub_key) {
269 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
273 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
274 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
278 if ((ctx = BN_CTX_new()) == NULL)
280 if ((point = EC_POINT_new(eckey->group)) == NULL)
283 /* testing whether the pub_key is on the elliptic curve */
284 if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
285 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
288 /* testing whether pub_key * order is the point at infinity */
289 order = eckey->group->order;
290 if (BN_is_zero(order)) {
291 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
294 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
295 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
298 if (!EC_POINT_is_at_infinity(eckey->group, point)) {
299 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
303 * in case the priv_key is present : check if generator * priv_key ==
306 if (eckey->priv_key) {
307 if (BN_cmp(eckey->priv_key, order) >= 0) {
308 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
311 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
313 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
316 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
317 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
324 EC_POINT_free(point);
328 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
333 EC_POINT *point = NULL;
335 #ifndef OPENSSL_NO_EC2M
336 int tmp_nid, is_char_two = 0;
339 if (!key || !key->group || !x || !y) {
340 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
341 ERR_R_PASSED_NULL_PARAMETER);
348 point = EC_POINT_new(key->group);
353 tx = BN_CTX_get(ctx);
354 ty = BN_CTX_get(ctx);
356 #ifndef OPENSSL_NO_EC2M
357 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
359 if (tmp_nid == NID_X9_62_characteristic_two_field)
363 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
366 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
372 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
375 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
380 * Check if retrieved coordinates match originals and are less than field
381 * order: if not values are out of range.
383 if (BN_cmp(x, tx) || BN_cmp(y, ty)
384 || (BN_cmp(x, key->group->field) >= 0)
385 || (BN_cmp(y, key->group->field) >= 0)) {
386 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
387 EC_R_COORDINATES_OUT_OF_RANGE);
391 if (!EC_KEY_set_public_key(key, point))
394 if (EC_KEY_check_key(key) == 0)
401 EC_POINT_free(point);
406 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
411 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
413 EC_GROUP_free(key->group);
414 key->group = EC_GROUP_dup(group);
415 return (key->group == NULL) ? 0 : 1;
418 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
420 return key->priv_key;
423 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
425 BN_clear_free(key->priv_key);
426 key->priv_key = BN_dup(priv_key);
427 return (key->priv_key == NULL) ? 0 : 1;
430 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
435 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
437 EC_POINT_free(key->pub_key);
438 key->pub_key = EC_POINT_dup(pub_key, key->group);
439 return (key->pub_key == NULL) ? 0 : 1;
442 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
444 return key->enc_flag;
447 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
449 key->enc_flag = flags;
452 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
454 return key->conv_form;
457 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
459 key->conv_form = cform;
460 if (key->group != NULL)
461 EC_GROUP_set_point_conversion_form(key->group, cform);
464 void *EC_KEY_get_key_method_data(EC_KEY *key,
465 void *(*dup_func) (void *),
466 void (*free_func) (void *),
467 void (*clear_free_func) (void *))
471 CRYPTO_r_lock(CRYPTO_LOCK_EC);
473 EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
475 CRYPTO_r_unlock(CRYPTO_LOCK_EC);
480 void *EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
481 void *(*dup_func) (void *),
482 void (*free_func) (void *),
483 void (*clear_free_func) (void *))
485 EC_EXTRA_DATA *ex_data;
487 CRYPTO_w_lock(CRYPTO_LOCK_EC);
489 EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
492 EC_EX_DATA_set_data(&key->method_data, data, dup_func, free_func,
494 CRYPTO_w_unlock(CRYPTO_LOCK_EC);
499 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
501 if (key->group != NULL)
502 EC_GROUP_set_asn1_flag(key->group, flag);
505 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
507 if (key->group == NULL)
509 return EC_GROUP_precompute_mult(key->group, ctx);
512 int EC_KEY_get_flags(const EC_KEY *key)
517 void EC_KEY_set_flags(EC_KEY *key, int flags)
522 void EC_KEY_clear_flags(EC_KEY *key, int flags)
524 key->flags &= ~flags;