Add no signing flag.
[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     if (r->group && r->group->meth->keyfinish)
115         r->group->meth->keyfinish(r);
116
117     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EC_KEY, r, &r->ex_data);
118     EC_GROUP_free(r->group);
119     EC_POINT_free(r->pub_key);
120     BN_clear_free(r->priv_key);
121
122     OPENSSL_clear_free((void *)r, sizeof(EC_KEY));
123 }
124
125 EC_KEY *EC_KEY_copy(EC_KEY *dest, EC_KEY *src)
126 {
127     if (dest == NULL || src == NULL) {
128         ECerr(EC_F_EC_KEY_COPY, ERR_R_PASSED_NULL_PARAMETER);
129         return NULL;
130     }
131     if (src->meth != dest->meth) {
132         if (dest->meth->finish != NULL)
133             dest->meth->finish(dest);
134         if (dest->group && dest->group->meth->keyfinish)
135             dest->group->meth->keyfinish(dest);
136 #ifndef OPENSSL_NO_ENGINE
137         if (ENGINE_finish(dest->engine) == 0)
138             return 0;
139         dest->engine = NULL;
140 #endif
141     }
142     /* copy the parameters */
143     if (src->group != NULL) {
144         const EC_METHOD *meth = EC_GROUP_method_of(src->group);
145         /* clear the old group */
146         EC_GROUP_free(dest->group);
147         dest->group = EC_GROUP_new(meth);
148         if (dest->group == NULL)
149             return NULL;
150         if (!EC_GROUP_copy(dest->group, src->group))
151             return NULL;
152     }
153     /*  copy the public key */
154     if (src->pub_key != NULL && src->group != NULL) {
155         EC_POINT_free(dest->pub_key);
156         dest->pub_key = EC_POINT_new(src->group);
157         if (dest->pub_key == NULL)
158             return NULL;
159         if (!EC_POINT_copy(dest->pub_key, src->pub_key))
160             return NULL;
161     }
162     /* copy the private key */
163     if (src->priv_key != NULL) {
164         if (dest->priv_key == NULL) {
165             dest->priv_key = BN_new();
166             if (dest->priv_key == NULL)
167                 return NULL;
168         }
169         if (!BN_copy(dest->priv_key, src->priv_key))
170             return NULL;
171         if (src->group->meth->keycopy
172             && src->group->meth->keycopy(dest, src) == 0)
173             return NULL;
174     }
175
176
177     /* copy the rest */
178     dest->enc_flag = src->enc_flag;
179     dest->conv_form = src->conv_form;
180     dest->version = src->version;
181     dest->flags = src->flags;
182     if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_EC_KEY,
183                             &dest->ex_data, &src->ex_data))
184         return NULL;
185
186     if (src->meth != dest->meth) {
187 #ifndef OPENSSL_NO_ENGINE
188         if (src->engine != NULL && ENGINE_init(src->engine) == 0)
189             return NULL;
190         dest->engine = src->engine;
191 #endif
192         dest->meth = src->meth;
193     }
194
195     if (src->meth->copy != NULL && src->meth->copy(dest, src) == 0)
196         return NULL;
197
198     return dest;
199 }
200
201 EC_KEY *EC_KEY_dup(EC_KEY *ec_key)
202 {
203     EC_KEY *ret = EC_KEY_new_method(ec_key->engine);
204
205     if (ret == NULL)
206         return NULL;
207     if (EC_KEY_copy(ret, ec_key) == NULL) {
208         EC_KEY_free(ret);
209         return NULL;
210     }
211     return ret;
212 }
213
214 int EC_KEY_up_ref(EC_KEY *r)
215 {
216     int i = CRYPTO_add(&r->references, 1, CRYPTO_LOCK_EC);
217
218     REF_PRINT_COUNT("EC_KEY", r);
219     REF_ASSERT_ISNT(i < 2);
220     return ((i > 1) ? 1 : 0);
221 }
222
223 int EC_KEY_generate_key(EC_KEY *eckey)
224 {
225     if (eckey == NULL || eckey->group == NULL) {
226         ECerr(EC_F_EC_KEY_GENERATE_KEY, ERR_R_PASSED_NULL_PARAMETER);
227         return 0;
228     }
229     if (eckey->meth->keygen != NULL)
230         return eckey->meth->keygen(eckey);
231     ECerr(EC_F_EC_KEY_GENERATE_KEY, EC_R_OPERATION_NOT_SUPPORTED);
232     return 0;
233 }
234
235 int ossl_ec_key_gen(EC_KEY *eckey)
236 {
237     int ok = 0;
238     BN_CTX *ctx = NULL;
239     BIGNUM *priv_key = NULL;
240     const BIGNUM *order = NULL;
241     EC_POINT *pub_key = NULL;
242
243     if (eckey->group->meth->keygen != NULL)
244         return eckey->group->meth->keygen(eckey);
245
246     if ((ctx = BN_CTX_new()) == NULL)
247         goto err;
248
249     if (eckey->priv_key == NULL) {
250         priv_key = BN_new();
251         if (priv_key == NULL)
252             goto err;
253     } else
254         priv_key = eckey->priv_key;
255
256     order = EC_GROUP_get0_order(eckey->group);
257     if (order == NULL)
258         goto err;
259
260     do
261         if (!BN_rand_range(priv_key, order))
262             goto err;
263     while (BN_is_zero(priv_key)) ;
264
265     if (eckey->pub_key == NULL) {
266         pub_key = EC_POINT_new(eckey->group);
267         if (pub_key == NULL)
268             goto err;
269     } else
270         pub_key = eckey->pub_key;
271
272     if (!EC_POINT_mul(eckey->group, pub_key, priv_key, NULL, NULL, ctx))
273         goto err;
274
275     eckey->priv_key = priv_key;
276     eckey->pub_key = pub_key;
277
278     ok = 1;
279
280  err:
281     if (eckey->pub_key == NULL)
282         EC_POINT_free(pub_key);
283     if (eckey->priv_key != priv_key)
284         BN_free(priv_key);
285     BN_CTX_free(ctx);
286     return (ok);
287 }
288
289 int EC_KEY_check_key(const EC_KEY *eckey)
290 {
291     int ok = 0;
292     BN_CTX *ctx = NULL;
293     const BIGNUM *order = NULL;
294     EC_POINT *point = NULL;
295
296     if (eckey == NULL || eckey->group == NULL || eckey->pub_key == NULL) {
297         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_PASSED_NULL_PARAMETER);
298         return 0;
299     }
300
301     if (eckey->group->meth->keycheck)
302         return eckey->group->meth->keycheck(eckey);
303
304     if (EC_POINT_is_at_infinity(eckey->group, eckey->pub_key)) {
305         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_AT_INFINITY);
306         goto err;
307     }
308
309     if ((ctx = BN_CTX_new()) == NULL)
310         goto err;
311     if ((point = EC_POINT_new(eckey->group)) == NULL)
312         goto err;
313
314     /* testing whether the pub_key is on the elliptic curve */
315     if (EC_POINT_is_on_curve(eckey->group, eckey->pub_key, ctx) <= 0) {
316         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_POINT_IS_NOT_ON_CURVE);
317         goto err;
318     }
319     /* testing whether pub_key * order is the point at infinity */
320     order = eckey->group->order;
321     if (BN_is_zero(order)) {
322         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_GROUP_ORDER);
323         goto err;
324     }
325     if (!EC_POINT_mul(eckey->group, point, NULL, eckey->pub_key, order, ctx)) {
326         ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
327         goto err;
328     }
329     if (!EC_POINT_is_at_infinity(eckey->group, point)) {
330         ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
331         goto err;
332     }
333     /*
334      * in case the priv_key is present : check if generator * priv_key ==
335      * pub_key
336      */
337     if (eckey->priv_key != NULL) {
338         if (BN_cmp(eckey->priv_key, order) >= 0) {
339             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_WRONG_ORDER);
340             goto err;
341         }
342         if (!EC_POINT_mul(eckey->group, point, eckey->priv_key,
343                           NULL, NULL, ctx)) {
344             ECerr(EC_F_EC_KEY_CHECK_KEY, ERR_R_EC_LIB);
345             goto err;
346         }
347         if (EC_POINT_cmp(eckey->group, point, eckey->pub_key, ctx) != 0) {
348             ECerr(EC_F_EC_KEY_CHECK_KEY, EC_R_INVALID_PRIVATE_KEY);
349             goto err;
350         }
351     }
352     ok = 1;
353  err:
354     BN_CTX_free(ctx);
355     EC_POINT_free(point);
356     return (ok);
357 }
358
359 int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x,
360                                              BIGNUM *y)
361 {
362     BN_CTX *ctx = NULL;
363     BIGNUM *tx, *ty;
364     EC_POINT *point = NULL;
365     int ok = 0;
366 #ifndef OPENSSL_NO_EC2M
367     int tmp_nid, is_char_two = 0;
368 #endif
369
370     if (key == NULL || key->group == NULL || x == NULL || y == NULL) {
371         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
372               ERR_R_PASSED_NULL_PARAMETER);
373         return 0;
374     }
375     ctx = BN_CTX_new();
376     if (ctx == NULL)
377         goto err;
378
379     point = EC_POINT_new(key->group);
380
381     if (point == NULL)
382         goto err;
383
384     tx = BN_CTX_get(ctx);
385     ty = BN_CTX_get(ctx);
386     if (ty == NULL)
387         goto err;
388
389 #ifndef OPENSSL_NO_EC2M
390     tmp_nid = EC_METHOD_get_field_type(EC_GROUP_method_of(key->group));
391
392     if (tmp_nid == NID_X9_62_characteristic_two_field)
393         is_char_two = 1;
394
395     if (is_char_two) {
396         if (!EC_POINT_set_affine_coordinates_GF2m(key->group, point,
397                                                   x, y, ctx))
398             goto err;
399         if (!EC_POINT_get_affine_coordinates_GF2m(key->group, point,
400                                                   tx, ty, ctx))
401             goto err;
402     } else
403 #endif
404     {
405         if (!EC_POINT_set_affine_coordinates_GFp(key->group, point,
406                                                  x, y, ctx))
407             goto err;
408         if (!EC_POINT_get_affine_coordinates_GFp(key->group, point,
409                                                  tx, ty, ctx))
410             goto err;
411     }
412     /*
413      * Check if retrieved coordinates match originals and are less than field
414      * order: if not values are out of range.
415      */
416     if (BN_cmp(x, tx) || BN_cmp(y, ty)
417         || (BN_cmp(x, key->group->field) >= 0)
418         || (BN_cmp(y, key->group->field) >= 0)) {
419         ECerr(EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES,
420               EC_R_COORDINATES_OUT_OF_RANGE);
421         goto err;
422     }
423
424     if (!EC_KEY_set_public_key(key, point))
425         goto err;
426
427     if (EC_KEY_check_key(key) == 0)
428         goto err;
429
430     ok = 1;
431
432  err:
433     BN_CTX_free(ctx);
434     EC_POINT_free(point);
435     return ok;
436
437 }
438
439 const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key)
440 {
441     return key->group;
442 }
443
444 int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group)
445 {
446     if (key->meth->set_group != NULL && key->meth->set_group(key, group) == 0)
447         return 0;
448     EC_GROUP_free(key->group);
449     key->group = EC_GROUP_dup(group);
450     return (key->group == NULL) ? 0 : 1;
451 }
452
453 const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key)
454 {
455     return key->priv_key;
456 }
457
458 int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *priv_key)
459 {
460     if (key->group == NULL || key->group->meth == NULL)
461         return 0;
462     if (key->group->meth->set_private
463         && key->meth->set_private(key, priv_key) == 0)
464         return 0;
465     if (key->meth->set_private != NULL
466         && key->meth->set_private(key, priv_key) == 0)
467         return 0;
468     BN_clear_free(key->priv_key);
469     key->priv_key = BN_dup(priv_key);
470     return (key->priv_key == NULL) ? 0 : 1;
471 }
472
473 const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key)
474 {
475     return key->pub_key;
476 }
477
478 int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub_key)
479 {
480     if (key->meth->set_public != NULL
481         && key->meth->set_public(key, pub_key) == 0)
482         return 0;
483     EC_POINT_free(key->pub_key);
484     key->pub_key = EC_POINT_dup(pub_key, key->group);
485     return (key->pub_key == NULL) ? 0 : 1;
486 }
487
488 unsigned int EC_KEY_get_enc_flags(const EC_KEY *key)
489 {
490     return key->enc_flag;
491 }
492
493 void EC_KEY_set_enc_flags(EC_KEY *key, unsigned int flags)
494 {
495     key->enc_flag = flags;
496 }
497
498 point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key)
499 {
500     return key->conv_form;
501 }
502
503 void EC_KEY_set_conv_form(EC_KEY *key, point_conversion_form_t cform)
504 {
505     key->conv_form = cform;
506     if (key->group != NULL)
507         EC_GROUP_set_point_conversion_form(key->group, cform);
508 }
509
510 void EC_KEY_set_asn1_flag(EC_KEY *key, int flag)
511 {
512     if (key->group != NULL)
513         EC_GROUP_set_asn1_flag(key->group, flag);
514 }
515
516 int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx)
517 {
518     if (key->group == NULL)
519         return 0;
520     return EC_GROUP_precompute_mult(key->group, ctx);
521 }
522
523 int EC_KEY_get_flags(const EC_KEY *key)
524 {
525     return key->flags;
526 }
527
528 void EC_KEY_set_flags(EC_KEY *key, int flags)
529 {
530     key->flags |= flags;
531 }
532
533 void EC_KEY_clear_flags(EC_KEY *key, int flags)
534 {
535     key->flags &= ~flags;
536 }
537
538 size_t EC_KEY_key2buf(const EC_KEY *key, point_conversion_form_t form,
539                         unsigned char **pbuf, BN_CTX *ctx)
540 {
541     if (key == NULL || key->pub_key == NULL || key->group == NULL)
542         return 0;
543     return EC_POINT_point2buf(key->group, key->pub_key, form, pbuf, ctx);
544 }
545
546 int EC_KEY_oct2key(EC_KEY *key, const unsigned char *buf, size_t len,
547                    BN_CTX *ctx)
548 {
549     if (key == NULL || key->group == NULL)
550         return 0;
551     if (key->pub_key == NULL)
552         key->pub_key = EC_POINT_new(key->group);
553     if (key->pub_key == NULL)
554         return 0;
555     if (EC_POINT_oct2point(key->group, key->pub_key, buf, len, ctx) == 0)
556         return 0;
557     /*
558      * Save the point conversion form.
559      * For non-custom curves the first octet of the buffer (excluding
560      * the last significant bit) contains the point conversion form.
561      * EC_POINT_oct2point() has already performed sanity checking of
562      * the buffer so we know it is valid.
563      */
564     if ((key->group->meth->flags & EC_FLAGS_CUSTOM_CURVE) == 0)
565         key->conv_form = (point_conversion_form_t)(buf[0] & ~0x01);
566     return 1;
567 }
568
569 size_t EC_KEY_priv2oct(const EC_KEY *eckey, unsigned char *buf, size_t len)
570 {
571     size_t buf_len;
572     if (eckey->group == NULL || eckey->group->meth == NULL)
573         return 0;
574     if (eckey->group->meth->priv2oct)
575         return eckey->group->meth->priv2oct(eckey, buf, len);
576
577     buf_len = (EC_GROUP_get_degree(eckey->group) + 7) / 8;
578     if (eckey->priv_key == NULL)
579         return 0;
580     if (buf == NULL)
581         return buf_len;
582     else if (len < buf_len)
583         return 0;
584
585     /* Octetstring may need leading zeros if BN is to short */
586
587     if (BN_bn2binpad(eckey->priv_key, buf, buf_len) == -1) {
588         ECerr(EC_F_EC_KEY_PRIV2OCT, EC_R_BUFFER_TOO_SMALL);
589         return 0;
590     }
591
592     return buf_len;
593 }
594
595 int EC_KEY_oct2priv(EC_KEY *eckey, unsigned char *buf, size_t len)
596 {
597     if (eckey->group == NULL || eckey->group->meth == NULL)
598         return 0;
599     if (eckey->group->meth->oct2priv)
600         return eckey->group->meth->oct2priv(eckey, buf, len);
601
602     if (eckey->priv_key == NULL)
603         eckey->priv_key = BN_secure_new();
604     if (eckey->priv_key == NULL) {
605         ECerr(EC_F_EC_KEY_OCT2PRIV, ERR_R_MALLOC_FAILURE);
606         return 0;
607     }
608     eckey->priv_key = BN_bin2bn(buf, len, eckey->priv_key);
609     if (eckey->priv_key == NULL) {
610         ECerr(EC_F_EC_KEY_OCT2PRIV, ERR_R_BN_LIB);
611         return 0;
612     }
613     return 1;
614 }
615
616 size_t EC_KEY_priv2buf(const EC_KEY *eckey, unsigned char **pbuf)
617 {
618     size_t len;
619     unsigned char *buf;
620     len = EC_KEY_priv2oct(eckey, NULL, 0);
621     if (len == 0)
622         return 0;
623     buf = OPENSSL_malloc(len);
624     if (buf == NULL)
625         return 0;
626     len = EC_KEY_priv2oct(eckey, buf, len);
627     if (len == 0) {
628         OPENSSL_free(buf);
629         return 0;
630     }
631     *pbuf = buf;
632     return len;
633 }
634
635 int EC_KEY_can_sign(const EC_KEY *eckey)
636 {
637     if (eckey->group == NULL || eckey->group->meth == NULL
638         || (eckey->group->meth->flags & EC_FLAGS_NO_SIGN))
639         return 0;
640     return 1;
641 }