59127d350d1301e4c57d7d721fa8e4366978641a
[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                 /* compute r the x-coordinate of generator * k */
148                 if (!EC_POINT_mul(group, tmp_point, k, NULL, NULL, ctx))
149                 {
150                         ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_EC_LIB);
151                         goto err;
152                 }
153                 if (EC_METHOD_get_field_type(EC_GROUP_method_of(group)) == NID_X9_62_prime_field)
154                 {
155                         if (!EC_POINT_get_affine_coordinates_GFp(group,
156                                 tmp_point, X, NULL, ctx))
157                         {
158                                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP,ERR_R_EC_LIB);
159                                 goto err;
160                         }
161                 }
162 #ifndef OPENSSL_NO_EC2M
163                 else /* NID_X9_62_characteristic_two_field */
164                 {
165                         if (!EC_POINT_get_affine_coordinates_GF2m(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 #endif
173                 if (!BN_nnmod(r, X, order, ctx))
174                 {
175                         ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_BN_LIB);
176                         goto err;
177                 }
178         }
179         while (BN_is_zero(r));
180
181         /* compute the inverse of k */
182         if (!BN_mod_inverse(k, k, order, ctx))
183         {
184                 ECDSAerr(ECDSA_F_ECDSA_SIGN_SETUP, ERR_R_BN_LIB);
185                 goto err;       
186         }
187         /* clear old values if necessary */
188         if (*rp != NULL)
189                 BN_clear_free(*rp);
190         if (*kinvp != NULL) 
191                 BN_clear_free(*kinvp);
192         /* save the pre-computed values  */
193         *rp    = r;
194         *kinvp = k;
195         ret = 1;
196 err:
197         if (!ret)
198         {
199                 if (k != NULL) BN_clear_free(k);
200                 if (r != NULL) BN_clear_free(r);
201         }
202         if (ctx_in == NULL) 
203                 BN_CTX_free(ctx);
204         if (order != NULL)
205                 BN_free(order);
206         if (tmp_point != NULL) 
207                 EC_POINT_free(tmp_point);
208         if (X)
209                 BN_clear_free(X);
210         return(ret);
211 }
212
213
214 static ECDSA_SIG *ecdsa_do_sign(const unsigned char *dgst, int dgst_len, 
215                 const BIGNUM *in_kinv, const BIGNUM *in_r, EC_KEY *eckey)
216 {
217         int     ok = 0, i;
218         BIGNUM *kinv=NULL, *s, *m=NULL,*tmp=NULL,*order=NULL;
219         const BIGNUM *ckinv;
220         BN_CTX     *ctx = NULL;
221         const EC_GROUP   *group;
222         ECDSA_SIG  *ret;
223         ECDSA_DATA *ecdsa;
224         const BIGNUM *priv_key;
225
226         ecdsa    = ecdsa_check(eckey);
227         group    = EC_KEY_get0_group(eckey);
228         priv_key = EC_KEY_get0_private_key(eckey);
229         
230         if (group == NULL || priv_key == NULL || ecdsa == NULL)
231         {
232                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_PASSED_NULL_PARAMETER);
233                 return NULL;
234         }
235
236         ret = ECDSA_SIG_new();
237         if (!ret)
238         {
239                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_MALLOC_FAILURE);
240                 return NULL;
241         }
242         s = ret->s;
243
244         if ((ctx = BN_CTX_new()) == NULL || (order = BN_new()) == NULL ||
245                 (tmp = BN_new()) == NULL || (m = BN_new()) == NULL)
246         {
247                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_MALLOC_FAILURE);
248                 goto err;
249         }
250
251         if (!EC_GROUP_get_order(group, order, ctx))
252         {
253                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_EC_LIB);
254                 goto err;
255         }
256         i = BN_num_bits(order);
257         /* Need to truncate digest if it is too long: first truncate whole
258          * bytes.
259          */
260         if (8 * dgst_len > i)
261                 dgst_len = (i + 7)/8;
262         if (!BN_bin2bn(dgst, dgst_len, m))
263         {
264                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
265                 goto err;
266         }
267         /* If still too long truncate remaining bits with a shift */
268         if ((8 * dgst_len > i) && !BN_rshift(m, m, 8 - (i & 0x7)))
269         {
270                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
271                 goto err;
272         }
273         do
274         {
275                 if (in_kinv == NULL || in_r == NULL)
276                 {
277                         if (!ECDSA_sign_setup(eckey, ctx, &kinv, &ret->r))
278                         {
279                                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN,ERR_R_ECDSA_LIB);
280                                 goto err;
281                         }
282                         ckinv = kinv;
283                 }
284                 else
285                 {
286                         ckinv  = in_kinv;
287                         if (BN_copy(ret->r, in_r) == NULL)
288                         {
289                                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_MALLOC_FAILURE);
290                                 goto err;
291                         }
292                 }
293
294                 if (!BN_mod_mul(tmp, priv_key, ret->r, order, ctx))
295                 {
296                         ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
297                         goto err;
298                 }
299                 if (!BN_mod_add_quick(s, tmp, m, order))
300                 {
301                         ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
302                         goto err;
303                 }
304                 if (!BN_mod_mul(s, s, ckinv, order, ctx))
305                 {
306                         ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ERR_R_BN_LIB);
307                         goto err;
308                 }
309                 if (BN_is_zero(s))
310                 {
311                         /* if kinv and r have been supplied by the caller
312                          * don't to generate new kinv and r values */
313                         if (in_kinv != NULL && in_r != NULL)
314                         {
315                                 ECDSAerr(ECDSA_F_ECDSA_DO_SIGN, ECDSA_R_NEED_NEW_SETUP_VALUES);
316                                 goto err;
317                         }
318                 }
319                 else
320                         /* s != 0 => we have a valid signature */
321                         break;
322         }
323         while (1);
324
325         ok = 1;
326 err:
327         if (!ok)
328         {
329                 ECDSA_SIG_free(ret);
330                 ret = NULL;
331         }
332         if (ctx)
333                 BN_CTX_free(ctx);
334         if (m)
335                 BN_clear_free(m);
336         if (tmp)
337                 BN_clear_free(tmp);
338         if (order)
339                 BN_free(order);
340         if (kinv)
341                 BN_clear_free(kinv);
342         return ret;
343 }
344
345 static int ecdsa_do_verify(const unsigned char *dgst, int dgst_len,
346                 const ECDSA_SIG *sig, EC_KEY *eckey)
347 {
348         int ret = -1, i;
349         BN_CTX   *ctx;
350         BIGNUM   *order, *u1, *u2, *m, *X;
351         EC_POINT *point = NULL;
352         const EC_GROUP *group;
353         const EC_POINT *pub_key;
354
355         /* check input values */
356         if (eckey == NULL || (group = EC_KEY_get0_group(eckey)) == NULL ||
357             (pub_key = EC_KEY_get0_public_key(eckey)) == NULL || sig == NULL)
358         {
359                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ECDSA_R_MISSING_PARAMETERS);
360                 return -1;
361         }
362
363         ctx = BN_CTX_new();
364         if (!ctx)
365         {
366                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_MALLOC_FAILURE);
367                 return -1;
368         }
369         BN_CTX_start(ctx);
370         order = BN_CTX_get(ctx);        
371         u1    = BN_CTX_get(ctx);
372         u2    = BN_CTX_get(ctx);
373         m     = BN_CTX_get(ctx);
374         X     = BN_CTX_get(ctx);
375         if (!X)
376         {
377                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
378                 goto err;
379         }
380         
381         if (!EC_GROUP_get_order(group, order, ctx))
382         {
383                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
384                 goto err;
385         }
386
387         if (BN_is_zero(sig->r)          || BN_is_negative(sig->r) || 
388             BN_ucmp(sig->r, order) >= 0 || BN_is_zero(sig->s)  ||
389             BN_is_negative(sig->s)      || BN_ucmp(sig->s, order) >= 0)
390         {
391                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ECDSA_R_BAD_SIGNATURE);
392                 ret = 0;        /* signature is invalid */
393                 goto err;
394         }
395         /* calculate tmp1 = inv(S) mod order */
396         if (!BN_mod_inverse(u2, sig->s, order, ctx))
397         {
398                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
399                 goto err;
400         }
401         /* digest -> m */
402         i = BN_num_bits(order);
403         /* Need to truncate digest if it is too long: first truncate whole
404          * bytes.
405          */
406         if (8 * dgst_len > i)
407                 dgst_len = (i + 7)/8;
408         if (!BN_bin2bn(dgst, dgst_len, m))
409         {
410                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
411                 goto err;
412         }
413         /* If still too long truncate remaining bits with a shift */
414         if ((8 * dgst_len > i) && !BN_rshift(m, m, 8 - (i & 0x7)))
415         {
416                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
417                 goto err;
418         }
419         /* u1 = m * tmp mod order */
420         if (!BN_mod_mul(u1, m, u2, order, ctx))
421         {
422                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
423                 goto err;
424         }
425         /* u2 = r * w mod q */
426         if (!BN_mod_mul(u2, sig->r, u2, order, ctx))
427         {
428                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
429                 goto err;
430         }
431
432         if ((point = EC_POINT_new(group)) == NULL)
433         {
434                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_MALLOC_FAILURE);
435                 goto err;
436         }
437         if (!EC_POINT_mul(group, point, u1, pub_key, u2, ctx))
438         {
439                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
440                 goto err;
441         }
442         if (EC_METHOD_get_field_type(EC_GROUP_method_of(group)) == NID_X9_62_prime_field)
443         {
444                 if (!EC_POINT_get_affine_coordinates_GFp(group,
445                         point, X, NULL, ctx))
446                 {
447                         ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
448                         goto err;
449                 }
450         }
451 #ifndef OPENSSL_NO_EC2M
452         else /* NID_X9_62_characteristic_two_field */
453         {
454                 if (!EC_POINT_get_affine_coordinates_GF2m(group,
455                         point, X, NULL, ctx))
456                 {
457                         ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_EC_LIB);
458                         goto err;
459                 }
460         }
461 #endif  
462         if (!BN_nnmod(u1, X, order, ctx))
463         {
464                 ECDSAerr(ECDSA_F_ECDSA_DO_VERIFY, ERR_R_BN_LIB);
465                 goto err;
466         }
467         /*  if the signature is correct u1 is equal to sig->r */
468         ret = (BN_ucmp(u1, sig->r) == 0);
469 err:
470         BN_CTX_end(ctx);
471         BN_CTX_free(ctx);
472         if (point)
473                 EC_POINT_free(point);
474         return ret;
475 }