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.
66 #include <openssl/err.h>
68 EC_KEY *EC_KEY_new(void)
72 ret = OPENSSL_malloc(sizeof(EC_KEY));
74 ECerr(EC_F_EC_KEY_NEW, ERR_R_MALLOC_FAILURE);
84 ret->conv_form = POINT_CONVERSION_UNCOMPRESSED;
86 ret->method_data = NULL;
90 EC_KEY *EC_KEY_new_by_curve_name(int nid)
92 EC_KEY *ret = EC_KEY_new();
95 ret->group = EC_GROUP_new_by_curve_name(nid);
96 if (ret->group == NULL) {
103 void EC_KEY_free(EC_KEY *r)
110 i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_EC);
112 REF_PRINT("EC_KEY", r);
118 fprintf(stderr, "EC_KEY_free, bad reference count\n");
123 EC_GROUP_free(r->group);
124 EC_POINT_free(r->pub_key);
125 if (r->priv_key != NULL)
126 BN_clear_free(r->priv_key);
128 EC_EX_DATA_free_all_data(&r->method_data);
130 OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
133 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
137 if (dest == NULL || src == NULL) {
138 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
141 /* copy the parameters */
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 && src->group) {
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 */
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))
171 /* copy method/extra data */
172 EC_EX_DATA_free_all_data(&dest->method_data);
174 for (d = src->method_data; d != NULL; d = d->next) {
175 void *t = d->dup_func(d->data);
179 if (!EC_EX_DATA_set_data
180 (&dest->method_data, t, d->dup_func, d->free_func,
186 dest->enc_flag = src->enc_flag;
187 dest->conv_form = src->conv_form;
188 dest->version = src->version;
189 dest->flags = src->flags;
194 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
196 EC_KEY *ret = EC_KEY_new();
199 if (EC_KEY_copy(ret, ec_key) == NULL) {
206 int EC_KEY_up_ref(EC_KEY *r)
208 int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
210 REF_PRINT("EC_KEY", r);
214 fprintf(stderr, "EC_KEY_up, bad reference count\n");
218 return ((i > 1) ? 1 : 0);
221 int EC_KEY_generate_key(EC_KEY *eckey)
225 BIGNUM *priv_key = NULL, *order = NULL;
226 EC_POINT *pub_key = NULL;
228 if (!eckey || !eckey->group) {
229 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
233 if ((order = BN_new()) == NULL)
235 if ((ctx = BN_CTX_new()) == NULL)
238 if (eckey->priv_key == NULL) {
240 if (priv_key == NULL)
243 priv_key = eckey->priv_key;
245 if (!EC_GROUP_get_order(eckey->group, order, ctx))
249 if (!BN_rand_range(priv_key, order))
251 while (BN_is_zero(priv_key)) ;
253 if (eckey->pub_key == NULL) {
254 pub_key = EC_POINT_new(eckey->group);
258 pub_key = eckey->pub_key;
260 if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
263 eckey->priv_key = priv_key;
264 eckey->pub_key = pub_key;
271 if (eckey->pub_key == NULL)
272 EC_POINT_free(pub_key);
273 if (priv_key != NULL && eckey->priv_key == NULL)
280 int EC_KEY_check_key(const EC_KEY *eckey)
284 const BIGNUM *order = NULL;
285 EC_POINT *point = NULL;
287 if (!eckey || !eckey->group || !eckey->pub_key) {
288 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
292 if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
293 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
297 if ((ctx = BN_CTX_new()) == NULL)
299 if ((point = EC_POINT_new(eckey->group)) == NULL)
302 /* testing whether the pub_key is on the elliptic curve */
303 if (!EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx)) {
304 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
307 /* testing whether pub_key * order is the point at infinity */
308 order = eckey->group->order;
309 if (BN_is_zero(order)) {
310 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
313 if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
314 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
317 if (!EC_POINT_is_at_infinity(eckey->group, point)) {
318 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
322 * in case the priv_key is present : check if generator * priv_key ==
325 if (eckey->priv_key) {
326 if (BN_cmp(eckey->priv_key, order) >= 0) {
327 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
330 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
332 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
335 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
336 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
344 EC_POINT_free(point);
348 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
353 EC_POINT *point = NULL;
354 int ok = 0, tmp_nid, is_char_two = 0;
356 if (!key || !key->group || !x || !y) {
357 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
358 ERR_R_PASSED_NULL_PARAMETER);
365 point = EC_POINT_new(key->group);
370 tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
372 if (tmp_nid == NID_X9_62_characteristic_two_field)
375 tx = BN_CTX_get(ctx);
376 ty = BN_CTX_get(ctx);
377 #ifndef OPENSSL_NO_EC2M
379 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
382 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
388 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
391 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
396 * Check if retrieved coordinates match originals and are less than field
397 * order: if not values are out of range.
399 if (BN_cmp(x, tx) || BN_cmp(y, ty)
400 || (BN_cmp(x, key->group->field) >= 0)
401 || (BN_cmp(y, key->group->field) >= 0)) {
402 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
403 EC_R_COORDINATES_OUT_OF_RANGE);
407 if (!EC_KEY_set_public_key(key, point))
410 if (EC_KEY_check_key(key) == 0)
418 EC_POINT_free(point);
423 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
428 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
430 EC_GROUP_free(key->group);
431 key->group = EC_GROUP_dup(group);
432 return (key->group == NULL) ? 0 : 1;
435 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
437 return key->priv_key;
440 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
443 BN_clear_free(key->priv_key);
444 key->priv_key = BN_dup(priv_key);
445 return (key->priv_key == NULL) ? 0 : 1;
448 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
453 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
455 EC_POINT_free(key->pub_key);
456 key->pub_key = EC_POINT_dup(pub_key, key->group);
457 return (key->pub_key == NULL) ? 0 : 1;
460 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
462 return key->enc_flag;
465 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
467 key->enc_flag = flags;
470 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
472 return key->conv_form;
475 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
477 key->conv_form = cform;
478 if (key->group != NULL)
479 EC_GROUP_set_point_conversion_form(key->group, cform);
482 void *EC_KEY_get_key_method_data(EC_KEY *key,
483 void *(*dup_func) (void *),
484 void (*free_func) (void *),
485 void (*clear_free_func) (void *))
489 CRYPTO_r_lock(CRYPTO_LOCK_EC);
491 EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
493 CRYPTO_r_unlock(CRYPTO_LOCK_EC);
498 void *EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
499 void *(*dup_func) (void *),
500 void (*free_func) (void *),
501 void (*clear_free_func) (void *))
503 EC_EXTRA_DATA *ex_data;
505 CRYPTO_w_lock(CRYPTO_LOCK_EC);
507 EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
510 EC_EX_DATA_set_data(&key->method_data, data, dup_func, free_func,
512 CRYPTO_w_unlock(CRYPTO_LOCK_EC);
517 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
519 if (key->group != NULL)
520 EC_GROUP_set_asn1_flag(key->group, flag);
523 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
525 if (key->group == NULL)
527 return EC_GROUP_precompute_mult(key->group, ctx);
530 int EC_KEY_get_flags(const EC_KEY *key)
535 void EC_KEY_set_flags(EC_KEY *key, int flags)
540 void EC_KEY_clear_flags(EC_KEY *key, int flags)
542 key->flags &= ~flags;