cb6bcdcbf266f2f410862eb8ab8442c06af45bbb
[openssl.git] / crypto / ec / ec_key.c
1 /* crypto/ec/ec_key.c */
2 /*
3  * Written by Nils Larsch for the OpenSSL project.
4  */
5 /* ====================================================================
6  * Copyright (c) 1998-2005 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
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
18  *    distribution.
19  *
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/)"
24  *
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.
29  *
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.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38  *
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  * ====================================================================
52  *
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).
56  *
57  */
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.
62  */
63
64 #include <internal/cryptlib.h>
65 #include <string.h>
66 #include "ec_lcl.h"
67 #include <openssl/err.h>
68 #ifndef OPENSSSL_NO_ENGINE
69 # include <openssl/engine.h>
70 #endif
71
72 EC_KEY *EC_KEY_new(void)
73 {
74     return EC_KEY_new_method(NULL);
75 }
76
77 EC_KEY *EC_KEY_new_by_curve_name(int nid)
78 {
79     EC_KEY *ret = EC_KEY_new();
80     if (ret == NULL)
81         return NULL;
82     ret->group = EC_GROUP_new_by_curve_name(nid);
83     if (ret->group == NULL) {
84         EC_KEY_free(ret);
85         return NULL;
86     }
87     return ret;
88 }
89
90 void EC_KEY_free(EC_KEY *r)
91 {
92     int i;
93
94     if (r == NULL)
95         return;
96
97     i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_EC);
98 #ifdef REF_PRINT
99     REF_PRINT("EC_KEY", r);
100 #endif
101     if (i > 0)
102         return;
103 #ifdef REF_CHECK
104     if (i < 0) {
105         fprintf(stderr, "EC_KEY_free, bad reference count\n");
106         abort();
107     }
108 #endif
109
110 #ifndef OPENSSL_NO_ENGINE
111     if (r->engine)
112         ENGINE_finish(r->engine);
113 #endif
114
115     EC_GROUP_free(r->group);
116     EC_POINT_free(r->pub_key);
117     BN_clear_free(r->priv_key);
118
119     EC_EX_DATA_free_all_data(&r->method_data);
120
121     OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
122 }
123
124 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
125 {
126     EC_EXTRA_DATA *d;
127
128     if (dest == NULL || src == NULL) {
129         ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
130         return NULL;
131     }
132     /* copy the parameters */
133     if (src->group) {
134         const EC_METHOD *meth = EC_GROUP_method_of(src->group);
135         /* clear the old group */
136         EC_GROUP_free(dest->group);
137         dest->group = EC_GROUP_new(meth);
138         if (dest->group == NULL)
139             return NULL;
140         if (!EC_GROUP_copy(dest->group, src->group))
141             return NULL;
142     }
143     /*  copy the public key */
144     if (src->pub_key && src->group) {
145         EC_POINT_free(dest->pub_key);
146         dest->pub_key = EC_POINT_new(src->group);
147         if (dest->pub_key == NULL)
148             return NULL;
149         if (!EC_POINT_copy(dest->pub_key, src->pub_key))
150             return NULL;
151     }
152     /* copy the private key */
153     if (src->priv_key) {
154         if (dest->priv_key == NULL) {
155             dest->priv_key = BN_new();
156             if (dest->priv_key == NULL)
157                 return NULL;
158         }
159         if (!BN_copy(dest->priv_key, src->priv_key))
160             return NULL;
161     }
162     /* copy method/extra data */
163     EC_EX_DATA_free_all_data(&dest->method_data);
164
165     for (d = src->method_data; d != NULL; d = d->next) {
166         void *t = d->dup_func(d->data);
167
168         if (t == NULL)
169             return 0;
170         if (!EC_EX_DATA_set_data
171             (&dest->method_data, t, d->dup_func, d->free_func,
172              d->clear_free_func))
173             return 0;
174     }
175
176     /* copy the rest */
177     dest->enc_flag = src->enc_flag;
178     dest->conv_form = src->conv_form;
179     dest->version = src->version;
180     dest->flags = src->flags;
181
182     return dest;
183 }
184
185 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
186 {
187     EC_KEY *ret = EC_KEY_new();
188     if (ret == NULL)
189         return NULL;
190     if (EC_KEY_copy(ret, ec_key) == NULL) {
191         EC_KEY_free(ret);
192         return NULL;
193     }
194     return ret;
195 }
196
197 int EC_KEY_up_ref(EC_KEY *r)
198 {
199     int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
200 #ifdef REF_PRINT
201     REF_PRINT("EC_KEY", r);
202 #endif
203 #ifdef REF_CHECK
204     if (i < 2) {
205         fprintf(stderr, "EC_KEY_up, bad reference count\n");
206         abort();
207     }
208 #endif
209     return ((i > 1) ? 1 : 0);
210 }
211
212 int EC_KEY_generate_key(EC_KEY *eckey)
213 {
214     if (!eckey || !eckey->group) {
215         ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
216         return 0;
217     }
218     if (eckey->meth->keygen)
219         return eckey->meth->keygen(eckey);
220     ECerr(EC_F_EC_KEY_GENERATE_KEY, EC_R_OPERATION_NOT_SUPPORTED);
221     return 0;
222 }
223
224 int ossl_ec_key_gen(EC_KEY *eckey)
225 {
226     int ok = 0;
227     BN_CTX *ctx = NULL;
228     BIGNUM *priv_key = NULL, *order = NULL;
229     EC_POINT *pub_key = NULL;
230
231     if ((order = BN_new()) == NULL)
232         goto err;
233     if ((ctx = BN_CTX_new()) == NULL)
234         goto err;
235
236     if (eckey->priv_key == NULL) {
237         priv_key = BN_new();
238         if (priv_key == NULL)
239             goto err;
240     } else
241         priv_key = eckey->priv_key;
242
243     if (!EC_GROUP_get_order(eckey->group, order, ctx))
244         goto err;
245
246     do
247         if (!BN_rand_range(priv_key, order))
248             goto err;
249     while (BN_is_zero(priv_key)) ;
250
251     if (eckey->pub_key == NULL) {
252         pub_key = EC_POINT_new(eckey->group);
253         if (pub_key == NULL)
254             goto err;
255     } else
256         pub_key = eckey->pub_key;
257
258     if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
259         goto err;
260
261     eckey->priv_key = priv_key;
262     eckey->pub_key = pub_key;
263
264     ok = 1;
265
266  err:
267     BN_free(order);
268     if (eckey->pub_key == NULL)
269         EC_POINT_free(pub_key);
270     if (eckey->priv_key != priv_key)
271         BN_free(priv_key);
272     BN_CTX_free(ctx);
273     return (ok);
274 }
275
276 int EC_KEY_check_key(const EC_KEY *eckey)
277 {
278     int ok = 0;
279     BN_CTX *ctx = NULL;
280     const BIGNUM *order = NULL;
281     EC_POINT *point = NULL;
282
283     if (!eckey || !eckey->group || !eckey->pub_key) {
284         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
285         return 0;
286     }
287
288     if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
289         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
290         goto err;
291     }
292
293     if ((ctx = BN_CTX_new()) == NULL)
294         goto err;
295     if ((point = EC_POINT_new(eckey->group)) == NULL)
296         goto err;
297
298     /* testing whether the pub_key is on the elliptic curve */
299     if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
300         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
301         goto err;
302     }
303     /* testing whether pub_key * order is the point at infinity */
304     order = eckey->group->order;
305     if (BN_is_zero(order)) {
306         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
307         goto err;
308     }
309     if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
310         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
311         goto err;
312     }
313     if (!EC_POINT_is_at_infinity(eckey->group, point)) {
314         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
315         goto err;
316     }
317     /*
318      * in case the priv_key is present : check if generator * priv_key ==
319      * pub_key
320      */
321     if (eckey->priv_key) {
322         if (BN_cmp(eckey->priv_key, order) >= 0) {
323             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
324             goto err;
325         }
326         if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
327                           NULL, NULL, ctx)) {
328             ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
329             goto err;
330         }
331         if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
332             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
333             goto err;
334         }
335     }
336     ok = 1;
337  err:
338     BN_CTX_free(ctx);
339     EC_POINT_free(point);
340     return (ok);
341 }
342
343 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
344                                              BIGNUM *y)
345 {
346     BN_CTX *ctx = NULL;
347     BIGNUM *tx, *ty;
348     EC_POINT *point = NULL;
349     int ok = 0;
350 #ifndef OPENSSL_NO_EC2M
351     int tmp_nid, is_char_two = 0;
352 #endif
353
354     if (!key || !key->group || !x || !y) {
355         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
356               ERR_R_PASSED_NULL_PARAMETER);
357         return 0;
358     }
359     ctx = BN_CTX_new();
360     if (ctx == NULL)
361         goto err;
362
363     point = EC_POINT_new(key->group);
364
365     if (point == NULL)
366         goto err;
367
368     tx = BN_CTX_get(ctx);
369     ty = BN_CTX_get(ctx);
370
371 #ifndef OPENSSL_NO_EC2M
372     tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
373
374     if (tmp_nid == NID_X9_62_characteristic_two_field)
375         is_char_two = 1;
376
377     if (is_char_two) {
378         if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
379                                                   x, y, ctx))
380             goto err;
381         if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
382                                                   tx, ty, ctx))
383             goto err;
384     } else
385 #endif
386     {
387         if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
388                                                  x, y, ctx))
389             goto err;
390         if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
391                                                  tx, ty, ctx))
392             goto err;
393     }
394     /*
395      * Check if retrieved coordinates match originals and are less than field
396      * order: if not values are out of range.
397      */
398     if (BN_cmp(x, tx) || BN_cmp(y, ty)
399         || (BN_cmp(x, key->group->field) >= 0)
400         || (BN_cmp(y, key->group->field) >= 0)) {
401         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
402               EC_R_COORDINATES_OUT_OF_RANGE);
403         goto err;
404     }
405
406     if (!EC_KEY_set_public_key(key, point))
407         goto err;
408
409     if (EC_KEY_check_key(key) == 0)
410         goto err;
411
412     ok = 1;
413
414  err:
415     BN_CTX_free(ctx);
416     EC_POINT_free(point);
417     return ok;
418
419 }
420
421 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
422 {
423     return key->group;
424 }
425
426 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
427 {
428     EC_GROUP_free(key->group);
429     key->group = EC_GROUP_dup(group);
430     return (key->group == NULL) ? 0 : 1;
431 }
432
433 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
434 {
435     return key->priv_key;
436 }
437
438 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
439 {
440     BN_clear_free(key->priv_key);
441     key->priv_key = BN_dup(priv_key);
442     return (key->priv_key == NULL) ? 0 : 1;
443 }
444
445 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
446 {
447     return key->pub_key;
448 }
449
450 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
451 {
452     EC_POINT_free(key->pub_key);
453     key->pub_key = EC_POINT_dup(pub_key, key->group);
454     return (key->pub_key == NULL) ? 0 : 1;
455 }
456
457 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
458 {
459     return key->enc_flag;
460 }
461
462 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
463 {
464     key->enc_flag = flags;
465 }
466
467 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
468 {
469     return key->conv_form;
470 }
471
472 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
473 {
474     key->conv_form = cform;
475     if (key->group != NULL)
476         EC_GROUP_set_point_conversion_form(key->group, cform);
477 }
478
479 void *EC_KEY_get_key_method_data(EC_KEY *key,
480                                  void *(*dup_func) (void *),
481                                  void (*free_func) (void *),
482                                  void (*clear_free_func) (void *))
483 {
484     void *ret;
485
486     CRYPTO_r_lock(CRYPTO_LOCK_EC);
487     ret =
488         EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
489                             clear_free_func);
490     CRYPTO_r_unlock(CRYPTO_LOCK_EC);
491
492     return ret;
493 }
494
495 void *EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
496                                     void *(*dup_func) (void *),
497                                     void (*free_func) (void *),
498                                     void (*clear_free_func) (void *))
499 {
500     EC_EXTRA_DATA *ex_data;
501
502     CRYPTO_w_lock(CRYPTO_LOCK_EC);
503     ex_data =
504         EC_EX_DATA_get_data(key->method_data, dup_func, free_func,
505                             clear_free_func);
506     if (ex_data == NULL)
507         EC_EX_DATA_set_data(&key->method_data, data, dup_func, free_func,
508                             clear_free_func);
509     CRYPTO_w_unlock(CRYPTO_LOCK_EC);
510
511     return ex_data;
512 }
513
514 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
515 {
516     if (key->group != NULL)
517         EC_GROUP_set_asn1_flag(key->group, flag);
518 }
519
520 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
521 {
522     if (key->group == NULL)
523         return 0;
524     return EC_GROUP_precompute_mult(key->group, ctx);
525 }
526
527 int EC_KEY_get_flags(const EC_KEY *key)
528 {
529     return key->flags;
530 }
531
532 void EC_KEY_set_flags(EC_KEY *key, int flags)
533 {
534     key->flags |= flags;
535 }
536
537 void EC_KEY_clear_flags(EC_KEY *key, int flags)
538 {
539     key->flags &= ~flags;
540 }