New option no-ssl3-method which removes SSLv3_*method
[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 #define OPENSSL_FIPSAPI
65
66 #include <string.h>
67 #include "ec_lcl.h"
68 #include <openssl/err.h>
69
70 EC_KEY *EC_KEY_new(void)
71         {
72         EC_KEY *ret;
73
74         ret=(EC_KEY *)OPENSSL_malloc(sizeof(EC_KEY));
75         if (ret == NULL)
76                 {
77                 ECerr(EC_F_EC_KEY_NEW, ERR_R_MALLOC_FAILURE);
78                 return(NULL);
79                 }
80
81         ret->version = 1;       
82         ret->flags = 0;
83         ret->group   = NULL;
84         ret->pub_key = NULL;
85         ret->priv_key= NULL;
86         ret->enc_flag= 0; 
87         ret->conv_form = POINT_CONVERSION_UNCOMPRESSED;
88         ret->references= 1;
89         ret->method_data = NULL;
90         return(ret);
91         }
92
93 EC_KEY *EC_KEY_new_by_curve_name(int nid)
94         {
95         EC_KEY *ret = EC_KEY_new();
96         if (ret == NULL)
97                 return NULL;
98         ret->group = EC_GROUP_new_by_curve_name(nid);
99         if (ret->group == NULL)
100                 {
101                 EC_KEY_free(ret);
102                 return NULL;
103                 }
104         return ret;
105         }
106
107 void EC_KEY_free(EC_KEY *r)
108         {
109         int i;
110
111         if (r == NULL) return;
112
113         i=CRYPTO_add(&r->references,-1,CRYPTO_LOCK_EC);
114 #ifdef REF_PRINT
115         REF_PRINT("EC_KEY",r);
116 #endif
117         if (i > 0) return;
118 #ifdef REF_CHECK
119         if (i < 0)
120                 {
121                 fprintf(stderr,"EC_KEY_free, bad reference count\n");
122                 abort();
123                 }
124 #endif
125
126         if (r->group    != NULL) 
127                 EC_GROUP_free(r->group);
128         if (r->pub_key  != NULL)
129                 EC_POINT_free(r->pub_key);
130         if (r->priv_key != NULL)
131                 BN_clear_free(r->priv_key);
132
133         EC_EX_DATA_free_all_data(&r->method_data);
134
135         OPENSSL_cleanse((void *)r, sizeof(EC_KEY));
136
137         OPENSSL_free(r);
138         }
139
140 EC_KEY *EC_KEY_copy(EC_KEY *dest, const EC_KEY *src)
141         {
142         EC_EXTRA_DATA *d;
143
144         if (dest == NULL || src == NULL)
145                 {
146                 ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
147                 return NULL;
148                 }
149         /* copy the parameters */
150         if (src->group)
151                 {
152                 const EC_METHOD *meth = EC_GROUP_method_of(src->group);
153                 /* clear the old group */
154                 if (dest->group)
155                         EC_GROUP_free(dest->group);
156                 dest->group = EC_GROUP_new(meth);
157                 if (dest->group == NULL)
158                         return NULL;
159                 if (!EC_GROUP_copy(dest->group, src->group))
160                         return NULL;
161                 }
162         /*  copy the public key */
163         if (src->pub_key && src->group)
164                 {
165                 if (dest->pub_key)
166                         EC_POINT_free(dest->pub_key);
167                 dest->pub_key = EC_POINT_new(src->group);
168                 if (dest->pub_key == NULL)
169                         return NULL;
170                 if (!EC_POINT_copy(dest->pub_key, src->pub_key))
171                         return NULL;
172                 }
173         /* copy the private key */
174         if (src->priv_key)
175                 {
176                 if (dest->priv_key == NULL)
177                         {
178                         dest->priv_key = BN_new();
179                         if (dest->priv_key == NULL)
180                                 return NULL;
181                         }
182                 if (!BN_copy(dest->priv_key, src->priv_key))
183                         return NULL;
184                 }
185         /* copy method/extra data */
186         EC_EX_DATA_free_all_data(&dest->method_data);
187
188         for (d = src->method_data; d != NULL; d = d->next)
189                 {
190                 void *t = d->dup_func(d->data);
191                 
192                 if (t == NULL)
193                         return 0;
194                 if (!EC_EX_DATA_set_data(&dest->method_data, t, d->dup_func, d->free_func, d->clear_free_func))
195                         return 0;
196                 }
197
198         /* copy the rest */
199         dest->enc_flag  = src->enc_flag;
200         dest->conv_form = src->conv_form;
201         dest->version   = src->version;
202         dest->flags = src->flags;
203
204         return dest;
205         }
206
207 EC_KEY *EC_KEY_dup(const EC_KEY *ec_key)
208         {
209         EC_KEY *ret = EC_KEY_new();
210         if (ret == NULL)
211                 return NULL;
212         if (EC_KEY_copy(ret, ec_key) == NULL)
213                 {
214                 EC_KEY_free(ret);
215                 return NULL;
216                 }
217         return ret;
218         }
219
220 int EC_KEY_up_ref(EC_KEY *r)
221         {
222         int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
223 #ifdef REF_PRINT
224         REF_PRINT("EC_KEY",r);
225 #endif
226 #ifdef REF_CHECK
227         if (i < 2)
228                 {
229                 fprintf(stderr, "EC_KEY_up, bad reference count\n");
230                 abort();
231                 }
232 #endif
233         return ((i > 1) ? 1 : 0);
234         }
235
236 #ifdef OPENSSL_FIPS
237
238 #include <openssl/evp.h>
239 #include <openssl/fips.h>
240 #include <openssl/fips_rand.h>
241
242 static int fips_check_ec(EC_KEY *key)
243         {
244         EVP_PKEY pk;
245         unsigned char tbs[] = "ECDSA Pairwise Check Data";
246         pk.type = EVP_PKEY_EC;
247         pk.pkey.ec = key;
248
249         if (!fips_pkey_signature_test(FIPS_TEST_PAIRWISE,
250                                         &pk, tbs, 0, NULL, 0, NULL, 0, NULL))
251                 {
252                 FIPSerr(FIPS_F_FIPS_CHECK_EC,FIPS_R_PAIRWISE_TEST_FAILED);
253                 fips_set_selftest_fail();
254                 return 0;
255                 }
256         return 1;
257         }
258
259 int fips_check_ec_prng(EC_KEY *ec)
260         {
261         int bits, strength;
262         if (!FIPS_module_mode())
263                 return 1;
264
265         if (ec->flags & (EC_FLAG_NON_FIPS_ALLOW|EC_FLAG_FIPS_CHECKED))
266                 return 1;
267
268         if (!ec->group)
269                 return 1;
270
271         bits = BN_num_bits(&ec->group->order);
272
273         if (bits < 160)
274                 {
275                 FIPSerr(FIPS_F_FIPS_CHECK_EC_PRNG,FIPS_R_KEY_TOO_SHORT);
276                 return 0;
277                 }
278         /* Comparable algorithm strengths: from SP800-57 table 2 */
279         if (bits >= 512)
280                 strength = 256;
281         else if (bits >= 384)
282                 strength = 192;
283         else if (bits >= 256)
284                 strength = 128;
285         else if (bits >= 224)
286                 strength = 112;
287         else
288                 strength = 80;
289
290
291         if (FIPS_rand_strength() >= strength)
292                 return 1;
293
294         FIPSerr(FIPS_F_FIPS_CHECK_EC_PRNG,FIPS_R_PRNG_STRENGTH_TOO_LOW);
295         return 0;
296
297         }
298
299 #endif
300
301 int EC_KEY_generate_key(EC_KEY *eckey)
302         {       
303         int     ok = 0;
304         BN_CTX  *ctx = NULL;
305         BIGNUM  *priv_key = NULL, *order = NULL;
306         EC_POINT *pub_key = NULL;
307
308 #ifdef OPENSSL_FIPS
309         if(FIPS_selftest_failed())
310                 {
311                 FIPSerr(FIPS_F_EC_KEY_GENERATE_KEY,FIPS_R_FIPS_SELFTEST_FAILED);
312                 return 0;
313                 }
314 #endif
315
316         if (!eckey || !eckey->group)
317                 {
318                 ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
319                 return 0;
320                 }
321
322         if ((order = BN_new()) == NULL) goto err;
323         if ((ctx = BN_CTX_new()) == NULL) goto err;
324
325         if (eckey->priv_key == NULL)
326                 {
327                 priv_key = BN_new();
328                 if (priv_key == NULL)
329                         goto err;
330                 }
331         else
332                 priv_key = eckey->priv_key;
333
334         if (!EC_GROUP_get_order(eckey->group, order, ctx))
335                 goto err;
336
337 #ifdef OPENSSL_FIPS
338         if (!fips_check_ec_prng(eckey))
339                 goto err;
340 #endif
341
342         do
343                 if (!BN_rand_range(priv_key, order))
344                         goto err;
345         while (BN_is_zero(priv_key));
346
347         if (eckey->pub_key == NULL)
348                 {
349                 pub_key = EC_POINT_new(eckey->group);
350                 if (pub_key == NULL)
351                         goto err;
352                 }
353         else
354                 pub_key = eckey->pub_key;
355
356         if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
357                 goto err;
358
359         eckey->priv_key = priv_key;
360         eckey->pub_key  = pub_key;
361
362 #ifdef OPENSSL_FIPS
363         if(!fips_check_ec(eckey))
364                 {
365                 eckey->priv_key = NULL;
366                 eckey->pub_key  = NULL;
367                 goto err;
368                 }
369 #endif
370
371         ok=1;
372
373 err:    
374         if (order)
375                 BN_free(order);
376         if (pub_key  != NULL && eckey->pub_key  == NULL)
377                 EC_POINT_free(pub_key);
378         if (priv_key != NULL && eckey->priv_key == NULL)
379                 BN_free(priv_key);
380         if (ctx != NULL)
381                 BN_CTX_free(ctx);
382         return(ok);
383         }
384
385 int EC_KEY_check_key(const EC_KEY *eckey)
386         {
387         int     ok   = 0;
388         BN_CTX  *ctx = NULL;
389         const BIGNUM    *order  = NULL;
390         EC_POINT *point = NULL;
391
392         if (!eckey || !eckey->group || !eckey->pub_key)
393                 {
394                 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
395                 return 0;
396                 }
397
398         if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key))
399                 {
400                 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
401                 goto err;
402                 }
403
404         if ((ctx = BN_CTX_new()) == NULL)
405                 goto err;
406         if ((point = EC_POINT_new(eckey->group)) == NULL)
407                 goto err;
408
409         /* testing whether the pub_key is on the elliptic curve */
410         if (!EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx))
411                 {
412                 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
413                 goto err;
414                 }
415         /* testing whether pub_key * order is the point at infinity */
416         order = &eckey->group->order;
417         if (BN_is_zero(order))
418                 {
419                 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
420                 goto err;
421                 }
422         if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx))
423                 {
424                 ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
425                 goto err;
426                 }
427         if (!EC_POINT_is_at_infinity(eckey->group, point))
428                 {
429                 ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
430                 goto err;
431                 }
432         /* in case the priv_key is present : 
433          * check if generator * priv_key == pub_key 
434          */
435         if (eckey->priv_key)
436                 {
437                 if (BN_cmp(eckey->priv_key, order) >= 0)
438                         {
439                         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
440                         goto err;
441                         }
442                 if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
443                         NULL, NULL, ctx))
444                         {
445                         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
446                         goto err;
447                         }
448                 if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, 
449                         ctx) != 0)
450                         {
451                         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
452                         goto err;
453                         }
454                 }
455         ok = 1;
456 err:
457         if (ctx   != NULL)
458                 BN_CTX_free(ctx);
459         if (point != NULL)
460                 EC_POINT_free(point);
461         return(ok);
462         }
463
464 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y)
465         {
466         BN_CTX *ctx = NULL;
467         BIGNUM *tx, *ty;
468         EC_POINT *point = NULL;
469         int ok = 0, tmp_nid, is_char_two = 0;
470
471         if (!key || !key->group || !x || !y)
472                 {
473                 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
474                                                 ERR_R_PASSED_NULL_PARAMETER);
475                 return 0;
476                 }
477         ctx = BN_CTX_new();
478         if (!ctx)
479                 goto err;
480
481         point = EC_POINT_new(key->group);
482
483         if (!point)
484                 goto err;
485
486         tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
487
488         if (tmp_nid == NID_X9_62_characteristic_two_field)
489                 is_char_two = 1;
490
491         tx = BN_CTX_get(ctx);
492         ty = BN_CTX_get(ctx);
493 #ifndef OPENSSL_NO_EC2M
494         if (is_char_two)
495                 {
496                 if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
497                                                                 x, y, ctx))
498                         goto err;
499                 if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
500                                                                 tx, ty, ctx))
501                         goto err;
502                 }
503         else
504 #endif
505                 {
506                 if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
507                                                                 x, y, ctx))
508                         goto err;
509                 if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
510                                                                 tx, ty, ctx))
511                         goto err;
512                 }
513         /* Check if retrieved coordinates match originals and are less than
514          * field order: if not values are out of range.
515          */
516         if (BN_cmp(x, tx) || BN_cmp(y, ty)
517                 || (BN_cmp(x, &key->group->field) >= 0)
518                 || (BN_cmp(y, &key->group->field) >= 0))
519                 {
520                 ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
521                         EC_R_COORDINATES_OUT_OF_RANGE);
522                 goto err;
523                 }
524
525         if (!EC_KEY_set_public_key(key, point))
526                 goto err;
527
528         if (EC_KEY_check_key(key) == 0)
529                 goto err;
530
531         ok = 1;
532
533         err:
534         if (ctx)
535                 BN_CTX_free(ctx);
536         if (point)
537                 EC_POINT_free(point);
538         return ok;
539
540         }
541
542 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
543         {
544         return key->group;
545         }
546
547 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
548         {
549         if (key->group != NULL)
550                 EC_GROUP_free(key->group);
551         key->group = EC_GROUP_dup(group);
552         return (key->group == NULL) ? 0 : 1;
553         }
554
555 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
556         {
557         return key->priv_key;
558         }
559
560 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
561         {
562         if (key->priv_key)
563                 BN_clear_free(key->priv_key);
564         key->priv_key = BN_dup(priv_key);
565         return (key->priv_key == NULL) ? 0 : 1;
566         }
567
568 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
569         {
570         return key->pub_key;
571         }
572
573 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
574         {
575         if (key->pub_key != NULL)
576                 EC_POINT_free(key->pub_key);
577         key->pub_key = EC_POINT_dup(pub_key, key->group);
578         return (key->pub_key == NULL) ? 0 : 1;
579         }
580
581 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
582         {
583         return key->enc_flag;
584         }
585
586 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
587         {
588         key->enc_flag = flags;
589         }
590
591 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
592         {
593         return key->conv_form;
594         }
595
596 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
597         {
598         key->conv_form = cform;
599         if (key->group != NULL)
600                 EC_GROUP_set_point_conversion_form(key->group, cform);
601         }
602
603 void *EC_KEY_get_key_method_data(EC_KEY *key,
604         void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *))
605         {
606         void *ret;
607
608         CRYPTO_r_lock(CRYPTO_LOCK_EC);
609         ret = EC_EX_DATA_get_data(key->method_data, dup_func, free_func, clear_free_func);
610         CRYPTO_r_unlock(CRYPTO_LOCK_EC);
611
612         return ret;
613         }
614
615 void *EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
616         void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *))
617         {
618         EC_EXTRA_DATA *ex_data;
619
620         CRYPTO_w_lock(CRYPTO_LOCK_EC);
621         ex_data = EC_EX_DATA_get_data(key->method_data, dup_func, free_func, clear_free_func);
622         if (ex_data == NULL)
623                 EC_EX_DATA_set_data(&key->method_data, data, dup_func, free_func, clear_free_func);
624         CRYPTO_w_unlock(CRYPTO_LOCK_EC);
625
626         return ex_data;
627         }
628
629 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
630         {
631         if (key->group != NULL)
632                 EC_GROUP_set_asn1_flag(key->group, flag);
633         }
634
635 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
636         {
637         if (key->group == NULL)
638                 return 0;
639         return EC_GROUP_precompute_mult(key->group, ctx);
640         }
641
642 int EC_KEY_get_flags(const EC_KEY *key)
643         {
644         return key->flags;
645         }
646
647 void EC_KEY_set_flags(EC_KEY *key, int flags)
648         {
649         key->flags |= flags;
650         }
651
652 void EC_KEY_clear_flags(EC_KEY *key, int flags)
653         {
654         key->flags &= ~flags;
655         }