acdeea83d4a789c356547546de2f7b56d1170ac1
[openssl.git] / crypto / ecdsa / ecs_ossl.c
1 /* crypto/ecdsa/ecs_ossl.c */
2 /*
3  * Written by Nils Larsch for the OpenSSL project
4  */
5 /* ====================================================================
6  * Copyright (c) 1998-2004 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 #define OPENSSL_FIPSAPI
60
61 #include "ecs_locl.h"
62 #include <openssl/err.h>
63 #include <openssl/obj_mac.h>
64 #include <openssl/bn.h>
65
66 static ECDSA_SIG *ecdsa_do_sign(const unsigned char *dgst, int dlen, 
67                 const BIGNUM *, const BIGNUM *, EC_KEY *eckey);
68 static int ecdsa_sign_setup(EC_KEY *eckey, BN_CTX *ctx_in, BIGNUM **kinvp, 
69                 BIGNUM **rp);
70 static int ecdsa_do_verify(const unsigned char *dgst, int dgst_len, 
71                 const ECDSA_SIG *sig, EC_KEY *eckey);
72
73 static ECDSA_METHOD openssl_ecdsa_meth = {
74         "OpenSSL ECDSA method",
75         ecdsa_do_sign,
76         ecdsa_sign_setup,
77         ecdsa_do_verify,
78 #if 0
79         NULL, /* init     */
80         NULL, /* finish   */
81 #endif
82         ECDSA_FLAG_FIPS_METHOD,    /* flags    */
83         NULL  /* app_data */
84 };
85
86 const ECDSA_METHOD *ECDSA_OpenSSL(void)
87 {
88         return &openssl_ecdsa_meth;
89 }
90
91 static int ecdsa_sign_setup(EC_KEY *eckey, BN_CTX *ctx_in, BIGNUM **kinvp,
92                 BIGNUM **rp)
93 {
94         BN_CTX   *ctx = NULL;
95         BIGNUM   *k = NULL, *r = NULL, *order = NULL, *X = NULL;
96         EC_POINT *tmp_point=NULL;
97         const EC_GROUP *group;
98         int      ret = 0;
99
100         if (eckey == NULL || (group = EC_KEY_get0_group(eckey)) == NULL)
101         {
102                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_PASSED_NULL_PARAMETER);
103                 return 0;
104         }
105
106         if (ctx_in == NULL) 
107         {
108                 if ((ctx = BN_CTX_new()) == NULL)
109                 {
110                         ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP,ERR_R_MALLOC_FAILURE);
111                         return 0;
112                 }
113         }
114         else
115                 ctx = ctx_in;
116
117         k     = BN_new();       /* this value is later returned in *kinvp */
118         r     = BN_new();       /* this value is later returned in *rp    */
119         order = BN_new();
120         X     = BN_new();
121         if (!k || !r || !order || !X)
122         {
123                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_MALLOC_FAILURE);
124                 goto err;
125         }
126         if ((tmp_point = EC_POINT_new(group)) == NULL)
127         {
128                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_EC_LIB);
129                 goto err;
130         }
131         if (!EC_GROUP_get_order(group, order, ctx))
132         {
133                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_EC_LIB);
134                 goto err;
135         }
136
137 #ifdef OPENSSL_FIPS
138         if (!fips_check_ec_prng(eckey))
139                 goto err;
140 #endif
141         
142         do
143         {
144                 /* get random k */      
145                 do
146                         if (!BN_rand_range(k, order))
147                         {
148                                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP,
149                                  ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED);      
150                                 goto err;
151                         }
152                 while (BN_is_zero(k));
153
154                 /* We do not want timing information to leak the length of k,
155                  * so we compute G*k using an equivalent scalar of fixed
156                  * bit-length. */
157
158                 if (!BN_add(k, k, order)) goto err;
159                 if (BN_num_bits(k) <= BN_num_bits(order))
160                         if (!BN_add(k, k, order)) goto err;
161
162                 /* compute r the x-coordinate of generator * k */
163                 if (!EC_POINT_mul(group, tmp_point, k, NULL, NULL, ctx))
164                 {
165                         ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_EC_LIB);
166                         goto err;
167                 }
168                 if (EC_METHOD_get_field_type(EC_GROUP_method_of(group)) == NID_X9_62_prime_field)
169                 {
170                         if (!EC_POINT_get_affine_coordinates_GFp(group,
171                                 tmp_point, X, NULL, ctx))
172                         {
173                                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP,ERR_R_EC_LIB);
174                                 goto err;
175                         }
176                 }
177 #ifndef OPENSSL_NO_EC2M
178                 else /* NID_X9_62_characteristic_two_field */
179                 {
180                         if (!EC_POINT_get_affine_coordinates_GF2m(group,
181                                 tmp_point, X, NULL, ctx))
182                         {
183                                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP,ERR_R_EC_LIB);
184                                 goto err;
185                         }
186                 }
187 #endif
188                 if (!BN_nnmod(r, X, order, ctx))
189                 {
190                         ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_BN_LIB);
191                         goto err;
192                 }
193         }
194         while (BN_is_zero(r));
195
196         /* compute the inverse of k */
197         if (!BN_mod_inverse(k, k, order, ctx))
198         {
199                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_BN_LIB);
200                 goto err;       
201         }
202         /* clear old values if necessary */
203         if (*rp != NULL)
204                 BN_clear_free(*rp);
205         if (*kinvp != NULL) 
206                 BN_clear_free(*kinvp);
207         /* save the pre-computed values  */
208         *rp    = r;
209         *kinvp = k;
210         ret = 1;
211 err:
212         if (!ret)
213         {
214                 if (k != NULL) BN_clear_free(k);
215                 if (r != NULL) BN_clear_free(r);
216         }
217         if (ctx_in == NULL) 
218                 BN_CTX_free(ctx);
219         if (order != NULL)
220                 BN_free(order);
221         if (tmp_point != NULL) 
222                 EC_POINT_free(tmp_point);
223         if (X)
224                 BN_clear_free(X);
225         return(ret);
226 }
227
228
229 static ECDSA_SIG *ecdsa_do_sign(const unsigned char *dgst, int dgst_len, 
230                 const BIGNUM *in_kinv, const BIGNUM *in_r, EC_KEY *eckey)
231 {
232         int     ok = 0, i;
233         BIGNUM *kinv=NULL, *s, *m=NULL,*tmp=NULL,*order=NULL;
234         const BIGNUM *ckinv;
235         BN_CTX     *ctx = NULL;
236         const EC_GROUP   *group;
237         ECDSA_SIG  *ret;
238         ECDSA_DATA *ecdsa;
239         const BIGNUM *priv_key;
240
241         ecdsa    = ecdsa_check(eckey);
242         group    = EC_KEY_get0_group(eckey);
243         priv_key = EC_KEY_get0_private_key(eckey);
244         
245         if (group == NULL || priv_key == NULL || ecdsa == NULL)
246         {
247                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_PASSED_NULL_PARAMETER);
248                 return NULL;
249         }
250
251 #ifdef OPENSSL_FIPS
252         if (!fips_check_ec_prng(eckey))
253                 return NULL;
254 #endif
255
256         ret = ECDSA_SIG_new();
257         if (!ret)
258         {
259                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_MALLOC_FAILURE);
260                 return NULL;
261         }
262         s = ret->s;
263
264         if ((ctx = BN_CTX_new()) == NULL || (order = BN_new()) == NULL ||
265                 (tmp = BN_new()) == NULL || (m = BN_new()) == NULL)
266         {
267                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_MALLOC_FAILURE);
268                 goto err;
269         }
270
271         if (!EC_GROUP_get_order(group, order, ctx))
272         {
273                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_EC_LIB);
274                 goto err;
275         }
276         i = BN_num_bits(order);
277         /* Need to truncate digest if it is too long: first truncate whole
278          * bytes.
279          */
280         if (8 * dgst_len > i)
281                 dgst_len = (i + 7)/8;
282         if (!BN_bin2bn(dgst, dgst_len, m))
283         {
284                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
285                 goto err;
286         }
287         /* If still too long truncate remaining bits with a shift */
288         if ((8 * dgst_len > i) && !BN_rshift(m, m, 8 - (i & 0x7)))
289         {
290                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
291                 goto err;
292         }
293         do
294         {
295                 if (in_kinv == NULL || in_r == NULL)
296                 {
297                         if (!ecdsa->meth->ecdsa_sign_setup(eckey, ctx,
298                                                                 &kinv, &ret->r))
299                         {
300                                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN,ERR_R_ECDSA_LIB);
301                                 goto err;
302                         }
303                         ckinv = kinv;
304                 }
305                 else
306                 {
307                         ckinv  = in_kinv;
308                         if (BN_copy(ret->r, in_r) == NULL)
309                         {
310                                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_MALLOC_FAILURE);
311                                 goto err;
312                         }
313                 }
314
315                 if (!BN_mod_mul(tmp, priv_key, ret->r, order, ctx))
316                 {
317                         ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
318                         goto err;
319                 }
320                 if (!BN_mod_add_quick(s, tmp, m, order))
321                 {
322                         ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
323                         goto err;
324                 }
325                 if (!BN_mod_mul(s, s, ckinv, order, ctx))
326                 {
327                         ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
328                         goto err;
329                 }
330                 if (BN_is_zero(s))
331                 {
332                         /* if kinv and r have been supplied by the caller
333                          * don't to generate new kinv and r values */
334                         if (in_kinv != NULL && in_r != NULL)
335                         {
336                                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ECDSA_R_NEED_NEW_SETUP_VALUES);
337                                 goto err;
338                         }
339                 }
340                 else
341                         /* s != 0 => we have a valid signature */
342                         break;
343         }
344         while (1);
345
346         ok = 1;
347 err:
348         if (!ok)
349         {
350                 ECDSA_SIG_free(ret);
351                 ret = NULL;
352         }
353         if (ctx)
354                 BN_CTX_free(ctx);
355         if (m)
356                 BN_clear_free(m);
357         if (tmp)
358                 BN_clear_free(tmp);
359         if (order)
360                 BN_free(order);
361         if (kinv)
362                 BN_clear_free(kinv);
363         return ret;
364 }
365
366 static int ecdsa_do_verify(const unsigned char *dgst, int dgst_len,
367                 const ECDSA_SIG *sig, EC_KEY *eckey)
368 {
369         int ret = -1, i;
370         BN_CTX   *ctx;
371         BIGNUM   *order, *u1, *u2, *m, *X;
372         EC_POINT *point = NULL;
373         const EC_GROUP *group;
374         const EC_POINT *pub_key;
375
376         /* check input values */
377         if (eckey == NULL || (group = EC_KEY_get0_group(eckey)) == NULL ||
378             (pub_key = EC_KEY_get0_public_key(eckey)) == NULL || sig == NULL)
379         {
380                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ECDSA_R_MISSING_PARAMETERS);
381                 return -1;
382         }
383
384         ctx = BN_CTX_new();
385         if (!ctx)
386         {
387                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_MALLOC_FAILURE);
388                 return -1;
389         }
390         BN_CTX_start(ctx);
391         order = BN_CTX_get(ctx);        
392         u1    = BN_CTX_get(ctx);
393         u2    = BN_CTX_get(ctx);
394         m     = BN_CTX_get(ctx);
395         X     = BN_CTX_get(ctx);
396         if (!X)
397         {
398                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
399                 goto err;
400         }
401         
402         if (!EC_GROUP_get_order(group, order, ctx))
403         {
404                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
405                 goto err;
406         }
407
408         if (BN_is_zero(sig->r)          || BN_is_negative(sig->r) || 
409             BN_ucmp(sig->r, order) >= 0 || BN_is_zero(sig->s)  ||
410             BN_is_negative(sig->s)      || BN_ucmp(sig->s, order) >= 0)
411         {
412                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ECDSA_R_BAD_SIGNATURE);
413                 ret = 0;        /* signature is invalid */
414                 goto err;
415         }
416         /* calculate tmp1 = inv(S) mod order */
417         if (!BN_mod_inverse(u2, sig->s, order, ctx))
418         {
419                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
420                 goto err;
421         }
422         /* digest -> m */
423         i = BN_num_bits(order);
424         /* Need to truncate digest if it is too long: first truncate whole
425          * bytes.
426          */
427         if (8 * dgst_len > i)
428                 dgst_len = (i + 7)/8;
429         if (!BN_bin2bn(dgst, dgst_len, m))
430         {
431                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
432                 goto err;
433         }
434         /* If still too long truncate remaining bits with a shift */
435         if ((8 * dgst_len > i) && !BN_rshift(m, m, 8 - (i & 0x7)))
436         {
437                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
438                 goto err;
439         }
440         /* u1 = m * tmp mod order */
441         if (!BN_mod_mul(u1, m, u2, order, ctx))
442         {
443                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
444                 goto err;
445         }
446         /* u2 = r * w mod q */
447         if (!BN_mod_mul(u2, sig->r, u2, order, ctx))
448         {
449                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
450                 goto err;
451         }
452
453         if ((point = EC_POINT_new(group)) == NULL)
454         {
455                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_MALLOC_FAILURE);
456                 goto err;
457         }
458         if (!EC_POINT_mul(group, point, u1, pub_key, u2, ctx))
459         {
460                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
461                 goto err;
462         }
463         if (EC_METHOD_get_field_type(EC_GROUP_method_of(group)) == NID_X9_62_prime_field)
464         {
465                 if (!EC_POINT_get_affine_coordinates_GFp(group,
466                         point, X, NULL, ctx))
467                 {
468                         ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
469                         goto err;
470                 }
471         }
472 #ifndef OPENSSL_NO_EC2M
473         else /* NID_X9_62_characteristic_two_field */
474         {
475                 if (!EC_POINT_get_affine_coordinates_GF2m(group,
476                         point, X, NULL, ctx))
477                 {
478                         ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
479                         goto err;
480                 }
481         }
482 #endif  
483         if (!BN_nnmod(u1, X, order, ctx))
484         {
485                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
486                 goto err;
487         }
488         /*  if the signature is correct u1 is equal to sig->r */
489         ret = (BN_ucmp(u1, sig->r) == 0);
490 err:
491         BN_CTX_end(ctx);
492         BN_CTX_free(ctx);
493         if (point)
494                 EC_POINT_free(point);
495         return ret;
496 }
497
498 #ifdef OPENSSL_FIPSCANISTER
499 /* FIPS stanadlone version of ecdsa_check: just return FIPS method */
500 ECDSA_DATA *fips_ecdsa_check(EC_KEY *key)
501         {
502         static ECDSA_DATA rv = {
503                 0,0,0,
504                 &openssl_ecdsa_meth
505                 };
506         return &rv;
507         }
508 /* Standalone digest sign and verify */
509 int FIPS_ecdsa_verify_digest(EC_KEY *key,
510                         const unsigned char *dig, int dlen, ECDSA_SIG *s)
511         {
512         ECDSA_DATA *ecdsa = ecdsa_check(key);
513         if (ecdsa == NULL)
514                 return 0;
515         return ecdsa->meth->ecdsa_do_verify(dig, dlen, s, key);
516         }
517 ECDSA_SIG * FIPS_ecdsa_sign_digest(EC_KEY *key,
518                                         const unsigned char *dig, int dlen)
519         {
520         ECDSA_DATA *ecdsa = ecdsa_check(key);
521         if (ecdsa == NULL)
522                 return NULL;
523         return ecdsa->meth->ecdsa_do_sign(dig, dlen, NULL, NULL, key);
524         }
525 #endif