GH715: ENGINE_finish can take NULL
[openssl.git] / crypto / ec / ec_key.c
1 /*
2  * Written by Nils Larsch for the OpenSSL project.
3  */
4 /* ====================================================================
5  * Copyright (c) 1998-2005 The OpenSSL Project.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the
17  *    distribution.
18  *
19  * 3. All advertising materials mentioning features or use of this
20  *    software must display the following acknowledgment:
21  *    "This product includes software developed by the OpenSSL Project
22  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23  *
24  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25  *    endorse or promote products derived from this software without
26  *    prior written permission. For written permission, please contact
27  *    openssl-core@openssl.org.
28  *
29  * 5. Products derived from this software may not be called "OpenSSL"
30  *    nor may "OpenSSL" appear in their names without prior written
31  *    permission of the OpenSSL Project.
32  *
33  * 6. Redistributions of any form whatsoever must retain the following
34  *    acknowledgment:
35  *    "This product includes software developed by the OpenSSL Project
36  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37  *
38  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49  * OF THE POSSIBILITY OF SUCH DAMAGE.
50  * ====================================================================
51  *
52  * This product includes cryptographic software written by Eric Young
53  * (eay@cryptsoft.com).  This product includes software written by Tim
54  * Hudson (tjh@cryptsoft.com).
55  *
56  */
57 /* ====================================================================
58  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
59  * Portions originally developed by SUN MICROSYSTEMS, INC., and
60  * contributed to the OpenSSL project.
61  */
62
63 #include <internal/cryptlib.h>
64 #include <string.h>
65 #include "ec_lcl.h"
66 #include <openssl/err.h>
67 #ifndef OPENSSL_NO_ENGINE
68 # include <openssl/engine.h>
69 #endif
70
71 EC_KEY *EC_KEY_new(void)
72 {
73     return EC_KEY_new_method(NULL);
74 }
75
76 EC_KEY *EC_KEY_new_by_curve_name(int nid)
77 {
78     EC_KEY *ret = EC_KEY_new();
79     if (ret == NULL)
80         return NULL;
81     ret->group = EC_GROUP_new_by_curve_name(nid);
82     if (ret->group == NULL) {
83         EC_KEY_free(ret);
84         return NULL;
85     }
86     if (ret->meth->set_group != NULL
87         && ret->meth->set_group(ret, ret->group) == 0) {
88         EC_KEY_free(ret);
89         return NULL;
90     }
91     return ret;
92 }
93
94 void EC_KEY_free(EC_KEY *r)
95 {
96     int i;
97
98     if (r == NULL)
99         return;
100
101     i = CRYPTO_add(&r->references, -1, CRYPTO_LOCK_EC);
102     REF_PRINT_COUNT("EC_KEY", r);
103     if (i > 0)
104         return;
105     REF_ASSERT_ISNT(i < 0);
106
107     if (r->meth->finish != NULL)
108         r->meth->finish(r);
109
110 #ifndef OPENSSL_NO_ENGINE
111     ENGINE_finish(r->engine);
112 #endif
113
114     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EC_KEY, r, &r->ex_data);
115     EC_GROUP_free(r->group);
116     EC_POINT_free(r->pub_key);
117     BN_clear_free(r->priv_key);
118
119     OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
120 }
121
122 EC_KEY *EC_KEY_copy(EC_KEY *dest, EC_KEY *src)
123 {
124     if (dest == NULL || src == NULL) {
125         ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
126         return NULL;
127     }
128     if (src->meth != dest->meth) {
129         if (dest->meth->finish != NULL)
130             dest->meth->finish(dest);
131 #ifndef OPENSSL_NO_ENGINE
132         if (ENGINE_finish(dest->engine) == 0)
133             return 0;
134         dest->engine = NULL;
135 #endif
136     }
137     /* copy the parameters */
138     if (src->group != NULL) {
139         const EC_METHOD *meth = EC_GROUP_method_of(src->group);
140         /* clear the old group */
141         EC_GROUP_free(dest->group);
142         dest->group = EC_GROUP_new(meth);
143         if (dest->group == NULL)
144             return NULL;
145         if (!EC_GROUP_copy(dest->group, src->group))
146             return NULL;
147     }
148     /*  copy the public key */
149     if (src->pub_key != NULL && src->group != NULL) {
150         EC_POINT_free(dest->pub_key);
151         dest->pub_key = EC_POINT_new(src->group);
152         if (dest->pub_key == NULL)
153             return NULL;
154         if (!EC_POINT_copy(dest->pub_key, src->pub_key))
155             return NULL;
156     }
157     /* copy the private key */
158     if (src->priv_key != NULL) {
159         if (dest->priv_key == NULL) {
160             dest->priv_key = BN_new();
161             if (dest->priv_key == NULL)
162                 return NULL;
163         }
164         if (!BN_copy(dest->priv_key, src->priv_key))
165             return NULL;
166     }
167
168     /* copy the rest */
169     dest->enc_flag = src->enc_flag;
170     dest->conv_form = src->conv_form;
171     dest->version = src->version;
172     dest->flags = src->flags;
173     if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_EC_KEY,
174                             &dest->ex_data, &src->ex_data))
175         return NULL;
176
177     if (src->meth != dest->meth) {
178 #ifndef OPENSSL_NO_ENGINE
179         if (src->engine != NULL && ENGINE_init(src->engine) == 0)
180             return NULL;
181         dest->engine = src->engine;
182 #endif
183         dest->meth = src->meth;
184     }
185
186     if (src->meth->copy != NULL && src->meth->copy(dest, src) == 0)
187         return NULL;
188
189     return dest;
190 }
191
192 EC_KEY *EC_KEY_dup(EC_KEY *ec_key)
193 {
194     EC_KEY *ret = EC_KEY_new_method(ec_key->engine);
195
196     if (ret == NULL)
197         return NULL;
198     if (EC_KEY_copy(ret, ec_key) == NULL) {
199         EC_KEY_free(ret);
200         return NULL;
201     }
202     return ret;
203 }
204
205 int EC_KEY_up_ref(EC_KEY *r)
206 {
207     int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
208
209     REF_PRINT_COUNT("EC_KEY", r);
210     REF_ASSERT_ISNT(i < 2);
211     return ((i > 1) ? 1 : 0);
212 }
213
214 int EC_KEY_generate_key(EC_KEY *eckey)
215 {
216     if (eckey == NULL || eckey->group == NULL) {
217         ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
218         return 0;
219     }
220     if (eckey->meth->keygen != NULL)
221         return eckey->meth->keygen(eckey);
222     ECerr(EC_F_EC_KEY_GENERATE_KEY, EC_R_OPERATION_NOT_SUPPORTED);
223     return 0;
224 }
225
226 int ossl_ec_key_gen(EC_KEY *eckey)
227 {
228     int ok = 0;
229     BN_CTX *ctx = NULL;
230     BIGNUM *priv_key = NULL;
231     const BIGNUM *order = NULL;
232     EC_POINT *pub_key = NULL;
233
234     if ((ctx = BN_CTX_new()) == NULL)
235         goto err;
236
237     if (eckey->priv_key == NULL) {
238         priv_key = BN_new();
239         if (priv_key == NULL)
240             goto err;
241     } else
242         priv_key = eckey->priv_key;
243
244     order = EC_GROUP_get0_order(eckey->group);
245     if (order == NULL)
246         goto err;
247
248     do
249         if (!BN_rand_range(priv_key, order))
250             goto err;
251     while (BN_is_zero(priv_key)) ;
252
253     if (eckey->pub_key == NULL) {
254         pub_key = EC_POINT_new(eckey->group);
255         if (pub_key == NULL)
256             goto err;
257     } else
258         pub_key = eckey->pub_key;
259
260     if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
261         goto err;
262
263     eckey->priv_key = priv_key;
264     eckey->pub_key = pub_key;
265
266     ok = 1;
267
268  err:
269     if (eckey->pub_key == NULL)
270         EC_POINT_free(pub_key);
271     if (eckey->priv_key != priv_key)
272         BN_free(priv_key);
273     BN_CTX_free(ctx);
274     return (ok);
275 }
276
277 int EC_KEY_check_key(const EC_KEY *eckey)
278 {
279     int ok = 0;
280     BN_CTX *ctx = NULL;
281     const BIGNUM *order = NULL;
282     EC_POINT *point = NULL;
283
284     if (eckey == NULL || eckey->group == NULL || eckey->pub_key == NULL) {
285         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
286         return 0;
287     }
288
289     if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
290         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
291         goto err;
292     }
293
294     if ((ctx = BN_CTX_new()) == NULL)
295         goto err;
296     if ((point = EC_POINT_new(eckey->group)) == NULL)
297         goto err;
298
299     /* testing whether the pub_key is on the elliptic curve */
300     if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
301         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
302         goto err;
303     }
304     /* testing whether pub_key * order is the point at infinity */
305     order = eckey->group->order;
306     if (BN_is_zero(order)) {
307         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
308         goto err;
309     }
310     if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
311         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
312         goto err;
313     }
314     if (!EC_POINT_is_at_infinity(eckey->group, point)) {
315         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
316         goto err;
317     }
318     /*
319      * in case the priv_key is present : check if generator * priv_key ==
320      * pub_key
321      */
322     if (eckey->priv_key != NULL) {
323         if (BN_cmp(eckey->priv_key, order) >= 0) {
324             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
325             goto err;
326         }
327         if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
328                           NULL, NULL, ctx)) {
329             ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
330             goto err;
331         }
332         if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
333             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
334             goto err;
335         }
336     }
337     ok = 1;
338  err:
339     BN_CTX_free(ctx);
340     EC_POINT_free(point);
341     return (ok);
342 }
343
344 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
345                                              BIGNUM *y)
346 {
347     BN_CTX *ctx = NULL;
348     BIGNUM *tx, *ty;
349     EC_POINT *point = NULL;
350     int ok = 0;
351 #ifndef OPENSSL_NO_EC2M
352     int tmp_nid, is_char_two = 0;
353 #endif
354
355     if (key == NULL || key->group == NULL || x == NULL || y == NULL) {
356         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
357               ERR_R_PASSED_NULL_PARAMETER);
358         return 0;
359     }
360     ctx = BN_CTX_new();
361     if (ctx == NULL)
362         goto err;
363
364     point = EC_POINT_new(key->group);
365
366     if (point == NULL)
367         goto err;
368
369     tx = BN_CTX_get(ctx);
370     ty = BN_CTX_get(ctx);
371     if (ty == NULL)
372         goto err;
373
374 #ifndef OPENSSL_NO_EC2M
375     tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
376
377     if (tmp_nid == NID_X9_62_characteristic_two_field)
378         is_char_two = 1;
379
380     if (is_char_two) {
381         if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
382                                                   x, y, ctx))
383             goto err;
384         if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
385                                                   tx, ty, ctx))
386             goto err;
387     } else
388 #endif
389     {
390         if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
391                                                  x, y, ctx))
392             goto err;
393         if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
394                                                  tx, ty, ctx))
395             goto err;
396     }
397     /*
398      * Check if retrieved coordinates match originals and are less than field
399      * order: if not values are out of range.
400      */
401     if (BN_cmp(x, tx) || BN_cmp(y, ty)
402         || (BN_cmp(x, key->group->field) >= 0)
403         || (BN_cmp(y, key->group->field) >= 0)) {
404         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
405               EC_R_COORDINATES_OUT_OF_RANGE);
406         goto err;
407     }
408
409     if (!EC_KEY_set_public_key(key, point))
410         goto err;
411
412     if (EC_KEY_check_key(key) == 0)
413         goto err;
414
415     ok = 1;
416
417  err:
418     BN_CTX_free(ctx);
419     EC_POINT_free(point);
420     return ok;
421
422 }
423
424 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
425 {
426     return key->group;
427 }
428
429 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
430 {
431     if (key->meth->set_group != NULL && key->meth->set_group(key, group) == 0)
432         return 0;
433     EC_GROUP_free(key->group);
434     key->group = EC_GROUP_dup(group);
435     return (key->group == NULL) ? 0 : 1;
436 }
437
438 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
439 {
440     return key->priv_key;
441 }
442
443 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
444 {
445     if (key->meth->set_private != NULL
446         && key->meth->set_private(key, priv_key) == 0)
447         return 0;
448     BN_clear_free(key->priv_key);
449     key->priv_key = BN_dup(priv_key);
450     return (key->priv_key == NULL) ? 0 : 1;
451 }
452
453 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
454 {
455     return key->pub_key;
456 }
457
458 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
459 {
460     if (key->meth->set_public != NULL
461         && key->meth->set_public(key, pub_key) == 0)
462         return 0;
463     EC_POINT_free(key->pub_key);
464     key->pub_key = EC_POINT_dup(pub_key, key->group);
465     return (key->pub_key == NULL) ? 0 : 1;
466 }
467
468 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
469 {
470     return key->enc_flag;
471 }
472
473 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
474 {
475     key->enc_flag = flags;
476 }
477
478 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
479 {
480     return key->conv_form;
481 }
482
483 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
484 {
485     key->conv_form = cform;
486     if (key->group != NULL)
487         EC_GROUP_set_point_conversion_form(key->group, cform);
488 }
489
490 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
491 {
492     if (key->group != NULL)
493         EC_GROUP_set_asn1_flag(key->group, flag);
494 }
495
496 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
497 {
498     if (key->group == NULL)
499         return 0;
500     return EC_GROUP_precompute_mult(key->group, ctx);
501 }
502
503 int EC_KEY_get_flags(const EC_KEY *key)
504 {
505     return key->flags;
506 }
507
508 void EC_KEY_set_flags(EC_KEY *key, int flags)
509 {
510     key->flags |= flags;
511 }
512
513 void EC_KEY_clear_flags(EC_KEY *key, int flags)
514 {
515     key->flags &= ~flags;
516 }
517
518 size_t EC_KEY_key2buf(const EC_KEY *key, point_conversion_form_t form,
519                         unsigned char **pbuf, BN_CTX *ctx)
520 {
521     if (key == NULL || key->pub_key == NULL || key->group == NULL)
522         return 0;
523     return EC_POINT_point2buf(key->group, key->pub_key, form, pbuf, ctx);
524 }
525
526 int EC_KEY_oct2key(EC_KEY *key, const unsigned char *buf, size_t len,
527                    BN_CTX *ctx)
528 {
529     if (key == NULL || key->group == NULL)
530         return 0;
531     if (key->pub_key == NULL)
532         key->pub_key = EC_POINT_new(key->group);
533     if (key->pub_key == NULL)
534         return 0;
535     return EC_POINT_oct2point(key->group, key->pub_key, buf, len, ctx);
536 }
537
538 size_t EC_KEY_priv2oct(const EC_KEY *eckey, unsigned char *buf, size_t len)
539 {
540     size_t buf_len;
541     if (eckey->group == NULL || eckey->group->meth == NULL)
542         return 0;
543
544     buf_len = (EC_GROUP_get_degree(eckey->group) + 7) / 8;
545     if (eckey->priv_key == NULL)
546         return 0;
547     if (buf == NULL)
548         return buf_len;
549     else if (len < buf_len)
550         return 0;
551
552     /* Octetstring may need leading zeros if BN is to short */
553
554     if (BN_bn2binpad(eckey->priv_key, buf, buf_len) == -1) {
555         ECerr(EC_F_EC_KEY_PRIV2OCT, EC_R_BUFFER_TOO_SMALL);
556         return 0;
557     }
558
559     return buf_len;
560 }
561
562 int EC_KEY_oct2priv(EC_KEY *eckey, unsigned char *buf, size_t len)
563 {
564     if (eckey->group == NULL || eckey->group->meth == NULL)
565         return 0;
566
567     if (eckey->priv_key == NULL)
568         eckey->priv_key = BN_secure_new();
569     if (eckey->priv_key == NULL) {
570         ECerr(EC_F_EC_KEY_OCT2PRIV, ERR_R_MALLOC_FAILURE);
571         return 0;
572     }
573     eckey->priv_key = BN_bin2bn(buf, len, eckey->priv_key);
574     if (eckey->priv_key == NULL) {
575         ECerr(EC_F_EC_KEY_OCT2PRIV, ERR_R_BN_LIB);
576         return 0;
577     }
578     return 1;
579 }
580
581 size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf)
582 {
583     size_t len;
584     unsigned char *buf;
585     len = EC_KEY_priv2oct(eckey, NULL, 0);
586     if (len == 0)
587         return 0;
588     buf = OPENSSL_malloc(len);
589     if (buf == NULL)
590         return 0;
591     len = EC_KEY_priv2oct(eckey, buf, len);
592     if (len == 0) {
593         OPENSSL_free(buf);
594         return 0;
595     }
596     *pbuf = buf;
597     return len;
598 }