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