bn_gf2m.c: optimized BN_GF2m_mod_inv delivers sometimes 2x of ECDSA sign.
[openssl.git] / crypto / bn / bn_gf2m.c
1 /* crypto/bn/bn_gf2m.c */
2 /* ====================================================================
3  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
4  *
5  * The Elliptic Curve Public-Key Crypto Library (ECC Code) included
6  * herein is developed by SUN MICROSYSTEMS, INC., and is contributed
7  * to the OpenSSL project.
8  *
9  * The ECC Code is licensed pursuant to the OpenSSL open source
10  * license provided below.
11  *
12  * In addition, Sun covenants to all licensees who provide a reciprocal
13  * covenant with respect to their own patents if any, not to sue under
14  * current and future patent claims necessarily infringed by the making,
15  * using, practicing, selling, offering for sale and/or otherwise
16  * disposing of the ECC Code as delivered hereunder (or portions thereof),
17  * provided that such covenant shall not apply:
18  *  1) for code that a licensee deletes from the ECC Code;
19  *  2) separates from the ECC Code; or
20  *  3) for infringements caused by:
21  *       i) the modification of the ECC Code or
22  *      ii) the combination of the ECC Code with other software or
23  *          devices where such combination causes the infringement.
24  *
25  * The software is originally written by Sheueling Chang Shantz and
26  * Douglas Stebila of Sun Microsystems Laboratories.
27  *
28  */
29
30 /* NOTE: This file is licensed pursuant to the OpenSSL license below
31  * and may be modified; but after modifications, the above covenant
32  * may no longer apply!  In such cases, the corresponding paragraph
33  * ["In addition, Sun covenants ... causes the infringement."] and
34  * this note can be edited out; but please keep the Sun copyright
35  * notice and attribution. */
36
37 /* ====================================================================
38  * Copyright (c) 1998-2002 The OpenSSL Project.  All rights reserved.
39  *
40  * Redistribution and use in source and binary forms, with or without
41  * modification, are permitted provided that the following conditions
42  * are met:
43  *
44  * 1. Redistributions of source code must retain the above copyright
45  *    notice, this list of conditions and the following disclaimer. 
46  *
47  * 2. Redistributions in binary form must reproduce the above copyright
48  *    notice, this list of conditions and the following disclaimer in
49  *    the documentation and/or other materials provided with the
50  *    distribution.
51  *
52  * 3. All advertising materials mentioning features or use of this
53  *    software must display the following acknowledgment:
54  *    "This product includes software developed by the OpenSSL Project
55  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
56  *
57  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
58  *    endorse or promote products derived from this software without
59  *    prior written permission. For written permission, please contact
60  *    openssl-core@openssl.org.
61  *
62  * 5. Products derived from this software may not be called "OpenSSL"
63  *    nor may "OpenSSL" appear in their names without prior written
64  *    permission of the OpenSSL Project.
65  *
66  * 6. Redistributions of any form whatsoever must retain the following
67  *    acknowledgment:
68  *    "This product includes software developed by the OpenSSL Project
69  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
70  *
71  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
72  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
73  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
74  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
75  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
76  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
77  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
78  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
79  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
80  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
81  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
82  * OF THE POSSIBILITY OF SUCH DAMAGE.
83  * ====================================================================
84  *
85  * This product includes cryptographic software written by Eric Young
86  * (eay@cryptsoft.com).  This product includes software written by Tim
87  * Hudson (tjh@cryptsoft.com).
88  *
89  */
90
91 #define OPENSSL_FIPSAPI
92
93 #include <assert.h>
94 #include <limits.h>
95 #include <stdio.h>
96 #include "cryptlib.h"
97 #include "bn_lcl.h"
98
99 #ifndef OPENSSL_NO_EC2M
100
101 /* Maximum number of iterations before BN_GF2m_mod_solve_quad_arr should fail. */
102 #define MAX_ITERATIONS 50
103
104 static const BN_ULONG SQR_tb[16] =
105   {     0,     1,     4,     5,    16,    17,    20,    21,
106        64,    65,    68,    69,    80,    81,    84,    85 };
107 /* Platform-specific macros to accelerate squaring. */
108 #if defined(SIXTY_FOUR_BIT) || defined(SIXTY_FOUR_BIT_LONG)
109 #define SQR1(w) \
110     SQR_tb[(w) >> 60 & 0xF] << 56 | SQR_tb[(w) >> 56 & 0xF] << 48 | \
111     SQR_tb[(w) >> 52 & 0xF] << 40 | SQR_tb[(w) >> 48 & 0xF] << 32 | \
112     SQR_tb[(w) >> 44 & 0xF] << 24 | SQR_tb[(w) >> 40 & 0xF] << 16 | \
113     SQR_tb[(w) >> 36 & 0xF] <<  8 | SQR_tb[(w) >> 32 & 0xF]
114 #define SQR0(w) \
115     SQR_tb[(w) >> 28 & 0xF] << 56 | SQR_tb[(w) >> 24 & 0xF] << 48 | \
116     SQR_tb[(w) >> 20 & 0xF] << 40 | SQR_tb[(w) >> 16 & 0xF] << 32 | \
117     SQR_tb[(w) >> 12 & 0xF] << 24 | SQR_tb[(w) >>  8 & 0xF] << 16 | \
118     SQR_tb[(w) >>  4 & 0xF] <<  8 | SQR_tb[(w)       & 0xF]
119 #endif
120 #ifdef THIRTY_TWO_BIT
121 #define SQR1(w) \
122     SQR_tb[(w) >> 28 & 0xF] << 24 | SQR_tb[(w) >> 24 & 0xF] << 16 | \
123     SQR_tb[(w) >> 20 & 0xF] <<  8 | SQR_tb[(w) >> 16 & 0xF]
124 #define SQR0(w) \
125     SQR_tb[(w) >> 12 & 0xF] << 24 | SQR_tb[(w) >>  8 & 0xF] << 16 | \
126     SQR_tb[(w) >>  4 & 0xF] <<  8 | SQR_tb[(w)       & 0xF]
127 #endif
128
129 /* Product of two polynomials a, b each with degree < BN_BITS2 - 1,
130  * result is a polynomial r with degree < 2 * BN_BITS - 1
131  * The caller MUST ensure that the variables have the right amount
132  * of space allocated.
133  */
134 #ifdef THIRTY_TWO_BIT
135 static void bn_GF2m_mul_1x1(BN_ULONG *r1, BN_ULONG *r0, const BN_ULONG a, const BN_ULONG b)
136         {
137         register BN_ULONG h, l, s;
138         BN_ULONG tab[8], top2b = a >> 30; 
139         register BN_ULONG a1, a2, a4;
140
141         a1 = a & (0x3FFFFFFF); a2 = a1 << 1; a4 = a2 << 1;
142
143         tab[0] =  0; tab[1] = a1;    tab[2] = a2;    tab[3] = a1^a2;
144         tab[4] = a4; tab[5] = a1^a4; tab[6] = a2^a4; tab[7] = a1^a2^a4;
145
146         s = tab[b       & 0x7]; l  = s;
147         s = tab[b >>  3 & 0x7]; l ^= s <<  3; h  = s >> 29;
148         s = tab[b >>  6 & 0x7]; l ^= s <<  6; h ^= s >> 26;
149         s = tab[b >>  9 & 0x7]; l ^= s <<  9; h ^= s >> 23;
150         s = tab[b >> 12 & 0x7]; l ^= s << 12; h ^= s >> 20;
151         s = tab[b >> 15 & 0x7]; l ^= s << 15; h ^= s >> 17;
152         s = tab[b >> 18 & 0x7]; l ^= s << 18; h ^= s >> 14;
153         s = tab[b >> 21 & 0x7]; l ^= s << 21; h ^= s >> 11;
154         s = tab[b >> 24 & 0x7]; l ^= s << 24; h ^= s >>  8;
155         s = tab[b >> 27 & 0x7]; l ^= s << 27; h ^= s >>  5;
156         s = tab[b >> 30      ]; l ^= s << 30; h ^= s >>  2;
157
158         /* compensate for the top two bits of a */
159
160         if (top2b & 01) { l ^= b << 30; h ^= b >> 2; } 
161         if (top2b & 02) { l ^= b << 31; h ^= b >> 1; } 
162
163         *r1 = h; *r0 = l;
164         } 
165 #endif
166 #if defined(SIXTY_FOUR_BIT) || defined(SIXTY_FOUR_BIT_LONG)
167 static void bn_GF2m_mul_1x1(BN_ULONG *r1, BN_ULONG *r0, const BN_ULONG a, const BN_ULONG b)
168         {
169         register BN_ULONG h, l, s;
170         BN_ULONG tab[16], top3b = a >> 61;
171         register BN_ULONG a1, a2, a4, a8;
172
173         a1 = a & (0x1FFFFFFFFFFFFFFFULL); a2 = a1 << 1; a4 = a2 << 1; a8 = a4 << 1;
174
175         tab[ 0] = 0;     tab[ 1] = a1;       tab[ 2] = a2;       tab[ 3] = a1^a2;
176         tab[ 4] = a4;    tab[ 5] = a1^a4;    tab[ 6] = a2^a4;    tab[ 7] = a1^a2^a4;
177         tab[ 8] = a8;    tab[ 9] = a1^a8;    tab[10] = a2^a8;    tab[11] = a1^a2^a8;
178         tab[12] = a4^a8; tab[13] = a1^a4^a8; tab[14] = a2^a4^a8; tab[15] = a1^a2^a4^a8;
179
180         s = tab[b       & 0xF]; l  = s;
181         s = tab[b >>  4 & 0xF]; l ^= s <<  4; h  = s >> 60;
182         s = tab[b >>  8 & 0xF]; l ^= s <<  8; h ^= s >> 56;
183         s = tab[b >> 12 & 0xF]; l ^= s << 12; h ^= s >> 52;
184         s = tab[b >> 16 & 0xF]; l ^= s << 16; h ^= s >> 48;
185         s = tab[b >> 20 & 0xF]; l ^= s << 20; h ^= s >> 44;
186         s = tab[b >> 24 & 0xF]; l ^= s << 24; h ^= s >> 40;
187         s = tab[b >> 28 & 0xF]; l ^= s << 28; h ^= s >> 36;
188         s = tab[b >> 32 & 0xF]; l ^= s << 32; h ^= s >> 32;
189         s = tab[b >> 36 & 0xF]; l ^= s << 36; h ^= s >> 28;
190         s = tab[b >> 40 & 0xF]; l ^= s << 40; h ^= s >> 24;
191         s = tab[b >> 44 & 0xF]; l ^= s << 44; h ^= s >> 20;
192         s = tab[b >> 48 & 0xF]; l ^= s << 48; h ^= s >> 16;
193         s = tab[b >> 52 & 0xF]; l ^= s << 52; h ^= s >> 12;
194         s = tab[b >> 56 & 0xF]; l ^= s << 56; h ^= s >>  8;
195         s = tab[b >> 60      ]; l ^= s << 60; h ^= s >>  4;
196
197         /* compensate for the top three bits of a */
198
199         if (top3b & 01) { l ^= b << 61; h ^= b >> 3; } 
200         if (top3b & 02) { l ^= b << 62; h ^= b >> 2; } 
201         if (top3b & 04) { l ^= b << 63; h ^= b >> 1; } 
202
203         *r1 = h; *r0 = l;
204         } 
205 #endif
206
207 /* Product of two polynomials a, b each with degree < 2 * BN_BITS2 - 1,
208  * result is a polynomial r with degree < 4 * BN_BITS2 - 1
209  * The caller MUST ensure that the variables have the right amount
210  * of space allocated.
211  */
212 static void bn_GF2m_mul_2x2(BN_ULONG *r, const BN_ULONG a1, const BN_ULONG a0, const BN_ULONG b1, const BN_ULONG b0)
213         {
214         BN_ULONG m1, m0;
215         /* r[3] = h1, r[2] = h0; r[1] = l1; r[0] = l0 */
216         bn_GF2m_mul_1x1(r+3, r+2, a1, b1);
217         bn_GF2m_mul_1x1(r+1, r, a0, b0);
218         bn_GF2m_mul_1x1(&m1, &m0, a0 ^ a1, b0 ^ b1);
219         /* Correction on m1 ^= l1 ^ h1; m0 ^= l0 ^ h0; */
220         r[2] ^= m1 ^ r[1] ^ r[3];  /* h0 ^= m1 ^ l1 ^ h1; */
221         r[1] = r[3] ^ r[2] ^ r[0] ^ m1 ^ m0;  /* l1 ^= l0 ^ h0 ^ m0; */
222         }
223
224
225 /* Add polynomials a and b and store result in r; r could be a or b, a and b 
226  * could be equal; r is the bitwise XOR of a and b.
227  */
228 int     BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b)
229         {
230         int i;
231         const BIGNUM *at, *bt;
232
233         bn_check_top(a);
234         bn_check_top(b);
235
236         if (a->top < b->top) { at = b; bt = a; }
237         else { at = a; bt = b; }
238
239         if(bn_wexpand(r, at->top) == NULL)
240                 return 0;
241
242         for (i = 0; i < bt->top; i++)
243                 {
244                 r->d[i] = at->d[i] ^ bt->d[i];
245                 }
246         for (; i < at->top; i++)
247                 {
248                 r->d[i] = at->d[i];
249                 }
250         
251         r->top = at->top;
252         bn_correct_top(r);
253         
254         return 1;
255         }
256
257
258 /* Some functions allow for representation of the irreducible polynomials
259  * as an int[], say p.  The irreducible f(t) is then of the form:
260  *     t^p[0] + t^p[1] + ... + t^p[k]
261  * where m = p[0] > p[1] > ... > p[k] = 0.
262  */
263
264
265 /* Performs modular reduction of a and store result in r.  r could be a. */
266 int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[])
267         {
268         int j, k;
269         int n, dN, d0, d1;
270         BN_ULONG zz, *z;
271
272         bn_check_top(a);
273
274         if (!p[0])
275                 {
276                 /* reduction mod 1 => return 0 */
277                 BN_zero(r);
278                 return 1;
279                 }
280
281         /* Since the algorithm does reduction in the r value, if a != r, copy
282          * the contents of a into r so we can do reduction in r. 
283          */
284         if (a != r)
285                 {
286                 if (!bn_wexpand(r, a->top)) return 0;
287                 for (j = 0; j < a->top; j++)
288                         {
289                         r->d[j] = a->d[j];
290                         }
291                 r->top = a->top;
292                 }
293         z = r->d;
294
295         /* start reduction */
296         dN = p[0] / BN_BITS2;  
297         for (j = r->top - 1; j > dN;)
298                 {
299                 zz = z[j];
300                 if (z[j] == 0) { j--; continue; }
301                 z[j] = 0;
302
303                 for (k = 1; p[k] != 0; k++)
304                         {
305                         /* reducing component t^p[k] */
306                         n = p[0] - p[k];
307                         d0 = n % BN_BITS2;  d1 = BN_BITS2 - d0;
308                         n /= BN_BITS2; 
309                         z[j-n] ^= (zz>>d0);
310                         if (d0) z[j-n-1] ^= (zz<<d1);
311                         }
312
313                 /* reducing component t^0 */
314                 n = dN;  
315                 d0 = p[0] % BN_BITS2;
316                 d1 = BN_BITS2 - d0;
317                 z[j-n] ^= (zz >> d0);
318                 if (d0) z[j-n-1] ^= (zz << d1);
319                 }
320
321         /* final round of reduction */
322         while (j == dN)
323                 {
324
325                 d0 = p[0] % BN_BITS2;
326                 zz = z[dN] >> d0;
327                 if (zz == 0) break;
328                 d1 = BN_BITS2 - d0;
329                 
330                 /* clear up the top d1 bits */
331                 if (d0)
332                         z[dN] = (z[dN] << d1) >> d1;
333                 else
334                         z[dN] = 0;
335                 z[0] ^= zz; /* reduction t^0 component */
336
337                 for (k = 1; p[k] != 0; k++)
338                         {
339                         BN_ULONG tmp_ulong;
340
341                         /* reducing component t^p[k]*/
342                         n = p[k] / BN_BITS2;   
343                         d0 = p[k] % BN_BITS2;
344                         d1 = BN_BITS2 - d0;
345                         z[n] ^= (zz << d0);
346                         tmp_ulong = zz >> d1;
347                         if (d0 && tmp_ulong)
348                                 z[n+1] ^= tmp_ulong;
349                         }
350
351                 
352                 }
353
354         bn_correct_top(r);
355         return 1;
356         }
357
358 /* Performs modular reduction of a by p and store result in r.  r could be a.
359  *
360  * This function calls down to the BN_GF2m_mod_arr implementation; this wrapper
361  * function is only provided for convenience; for best performance, use the 
362  * BN_GF2m_mod_arr function.
363  */
364 int     BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p)
365         {
366         int ret = 0;
367         int arr[6];
368         bn_check_top(a);
369         bn_check_top(p);
370         ret = BN_GF2m_poly2arr(p, arr, sizeof(arr)/sizeof(arr[0]));
371         if (!ret || ret > sizeof(arr)/sizeof(arr[0]))
372                 {
373                 BNerr(BN_F_BN_GF2M_MOD,BN_R_INVALID_LENGTH);
374                 return 0;
375                 }
376         ret = BN_GF2m_mod_arr(r, a, arr);
377         bn_check_top(r);
378         return ret;
379         }
380
381
382 /* Compute the product of two polynomials a and b, reduce modulo p, and store
383  * the result in r.  r could be a or b; a could be b.
384  */
385 int     BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const int p[], BN_CTX *ctx)
386         {
387         int zlen, i, j, k, ret = 0;
388         BIGNUM *s;
389         BN_ULONG x1, x0, y1, y0, zz[4];
390
391         bn_check_top(a);
392         bn_check_top(b);
393
394         if (a == b)
395                 {
396                 return BN_GF2m_mod_sqr_arr(r, a, p, ctx);
397                 }
398
399         BN_CTX_start(ctx);
400         if ((s = BN_CTX_get(ctx)) == NULL) goto err;
401         
402         zlen = a->top + b->top + 4;
403         if (!bn_wexpand(s, zlen)) goto err;
404         s->top = zlen;
405
406         for (i = 0; i < zlen; i++) s->d[i] = 0;
407
408         for (j = 0; j < b->top; j += 2)
409                 {
410                 y0 = b->d[j];
411                 y1 = ((j+1) == b->top) ? 0 : b->d[j+1];
412                 for (i = 0; i < a->top; i += 2)
413                         {
414                         x0 = a->d[i];
415                         x1 = ((i+1) == a->top) ? 0 : a->d[i+1];
416                         bn_GF2m_mul_2x2(zz, x1, x0, y1, y0);
417                         for (k = 0; k < 4; k++) s->d[i+j+k] ^= zz[k];
418                         }
419                 }
420
421         bn_correct_top(s);
422         if (BN_GF2m_mod_arr(r, s, p))
423                 ret = 1;
424         bn_check_top(r);
425
426 err:
427         BN_CTX_end(ctx);
428         return ret;
429         }
430
431 /* Compute the product of two polynomials a and b, reduce modulo p, and store
432  * the result in r.  r could be a or b; a could equal b.
433  *
434  * This function calls down to the BN_GF2m_mod_mul_arr implementation; this wrapper
435  * function is only provided for convenience; for best performance, use the 
436  * BN_GF2m_mod_mul_arr function.
437  */
438 int     BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx)
439         {
440         int ret = 0;
441         const int max = BN_num_bits(p) + 1;
442         int *arr=NULL;
443         bn_check_top(a);
444         bn_check_top(b);
445         bn_check_top(p);
446         if ((arr = (int *)OPENSSL_malloc(sizeof(int) * max)) == NULL) goto err;
447         ret = BN_GF2m_poly2arr(p, arr, max);
448         if (!ret || ret > max)
449                 {
450                 BNerr(BN_F_BN_GF2M_MOD_MUL,BN_R_INVALID_LENGTH);
451                 goto err;
452                 }
453         ret = BN_GF2m_mod_mul_arr(r, a, b, arr, ctx);
454         bn_check_top(r);
455 err:
456         if (arr) OPENSSL_free(arr);
457         return ret;
458         }
459
460
461 /* Square a, reduce the result mod p, and store it in a.  r could be a. */
462 int     BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[], BN_CTX *ctx)
463         {
464         int i, ret = 0;
465         BIGNUM *s;
466
467         bn_check_top(a);
468         BN_CTX_start(ctx);
469         if ((s = BN_CTX_get(ctx)) == NULL) return 0;
470         if (!bn_wexpand(s, 2 * a->top)) goto err;
471
472         for (i = a->top - 1; i >= 0; i--)
473                 {
474                 s->d[2*i+1] = SQR1(a->d[i]);
475                 s->d[2*i  ] = SQR0(a->d[i]);
476                 }
477
478         s->top = 2 * a->top;
479         bn_correct_top(s);
480         if (!BN_GF2m_mod_arr(r, s, p)) goto err;
481         bn_check_top(r);
482         ret = 1;
483 err:
484         BN_CTX_end(ctx);
485         return ret;
486         }
487
488 /* Square a, reduce the result mod p, and store it in a.  r could be a.
489  *
490  * This function calls down to the BN_GF2m_mod_sqr_arr implementation; this wrapper
491  * function is only provided for convenience; for best performance, use the 
492  * BN_GF2m_mod_sqr_arr function.
493  */
494 int     BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
495         {
496         int ret = 0;
497         const int max = BN_num_bits(p) + 1;
498         int *arr=NULL;
499
500         bn_check_top(a);
501         bn_check_top(p);
502         if ((arr = (int *)OPENSSL_malloc(sizeof(int) * max)) == NULL) goto err;
503         ret = BN_GF2m_poly2arr(p, arr, max);
504         if (!ret || ret > max)
505                 {
506                 BNerr(BN_F_BN_GF2M_MOD_SQR,BN_R_INVALID_LENGTH);
507                 goto err;
508                 }
509         ret = BN_GF2m_mod_sqr_arr(r, a, arr, ctx);
510         bn_check_top(r);
511 err:
512         if (arr) OPENSSL_free(arr);
513         return ret;
514         }
515
516
517 /* Invert a, reduce modulo p, and store the result in r. r could be a. 
518  * Uses Modified Almost Inverse Algorithm (Algorithm 10) from
519  *     Hankerson, D., Hernandez, J.L., and Menezes, A.  "Software Implementation
520  *     of Elliptic Curve Cryptography Over Binary Fields".
521  */
522 int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
523         {
524         BIGNUM *b, *c, *u, *v, *tmp;
525         int ret = 0;
526
527         bn_check_top(a);
528         bn_check_top(p);
529
530         BN_CTX_start(ctx);
531         
532         if ((b = BN_CTX_get(ctx))==NULL) goto err;
533         if ((c = BN_CTX_get(ctx))==NULL) goto err;
534         if ((u = BN_CTX_get(ctx))==NULL) goto err;
535         if ((v = BN_CTX_get(ctx))==NULL) goto err;
536
537         if (!BN_GF2m_mod(u, a, p)) goto err;
538         if (BN_is_zero(u)) goto err;
539
540         if (!BN_copy(v, p)) goto err;
541 #if 0
542         if (!BN_one(b)) goto err;
543
544         while (1)
545                 {
546                 while (!BN_is_odd(u))
547                         {
548                         if (!BN_rshift1(u, u)) goto err;
549                         if (BN_is_odd(b))
550                                 {
551                                 if (!BN_GF2m_add(b, b, p)) goto err;
552                                 }
553                         if (!BN_rshift1(b, b)) goto err;
554                         }
555
556                 if (BN_abs_is_word(u, 1)) break;
557
558                 if (BN_num_bits(u) < BN_num_bits(v))
559                         {
560                         tmp = u; u = v; v = tmp;
561                         tmp = b; b = c; c = tmp;
562                         }
563                 
564                 if (!BN_GF2m_add(u, u, v)) goto err;
565                 if (!BN_GF2m_add(b, b, c)) goto err;
566                 }
567 #else
568         {
569         int i,  ubits = BN_num_bits(u),
570                 vbits = BN_num_bits(v), /* v is copy of p */
571                 top = p->top;
572         BN_ULONG *udp,*bdp,*vdp,*cdp;
573
574         bn_wexpand(u,top);      udp = u->d;
575                                 for (i=u->top;i<top;i++) udp[i] = 0;
576                                 u->top = top;
577         bn_wexpand(b,top);      bdp = b->d;
578                                 bdp[0] = 1;
579                                 for (i=1;i<top;i++) bdp[i] = 0;
580                                 b->top = top;
581         bn_wexpand(c,top);      cdp = c->d;
582                                 for (i=0;i<top;i++) cdp[i] = 0;
583                                 c->top = top;
584         vdp = v->d;     /* It pays off to "cache" *->d pointers, because
585                          * it allows optimizer to be more aggressive.
586                          * But we don't have to "cache" p->d, because *p
587                          * is declared 'const'... */
588         while (1)
589                 {
590                 while (ubits && !(udp[0]&1))
591                         {
592                         BN_ULONG u0,u1,b0,b1,mask;
593
594                         u0   = udp[0];
595                         b0   = bdp[0];
596                         mask = (BN_ULONG)0-(b0&1);
597                         b0  ^= p->d[0]&mask;
598                         for (i=0;i<top-1;i++)
599                                 {
600                                 u1 = udp[i+1];
601                                 udp[i] = ((u0>>1)|(u1<<(BN_BITS2-1)))&BN_MASK2;
602                                 u0 = u1;
603                                 b1 = bdp[i+1]^(p->d[i+1]&mask);
604                                 bdp[i] = ((b0>>1)|(b1<<(BN_BITS2-1)))&BN_MASK2;
605                                 b0 = b1;
606                                 }
607                         udp[i] = u0>>1;
608                         bdp[i] = b0>>1;
609                         ubits--;
610                         }
611
612                 if (ubits<=BN_BITS2 && udp[0]==1) break;
613
614                 if (ubits<vbits)
615                         {
616                         i = ubits; ubits = vbits; vbits = i;
617                         tmp = u; u = v; v = tmp;
618                         tmp = b; b = c; c = tmp;
619                         udp = vdp; vdp = v->d;
620                         bdp = cdp; cdp = c->d;
621                         }
622                 for(i=0;i<top;i++)
623                         {
624                         udp[i] ^= vdp[i];
625                         bdp[i] ^= cdp[i];
626                         }
627                 if (ubits==vbits)
628                         {
629                         bn_fix_top(u);
630                         ubits = BN_num_bits(u);
631                         }
632                 }
633         bn_fix_top(b);
634         }
635 #endif
636
637         if (!BN_copy(r, b)) goto err;
638         bn_check_top(r);
639         ret = 1;
640
641 err:
642         BN_CTX_end(ctx);
643         return ret;
644         }
645
646 /* Invert xx, reduce modulo p, and store the result in r. r could be xx. 
647  *
648  * This function calls down to the BN_GF2m_mod_inv implementation; this wrapper
649  * function is only provided for convenience; for best performance, use the 
650  * BN_GF2m_mod_inv function.
651  */
652 int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *xx, const int p[], BN_CTX *ctx)
653         {
654         BIGNUM *field;
655         int ret = 0;
656
657         bn_check_top(xx);
658         BN_CTX_start(ctx);
659         if ((field = BN_CTX_get(ctx)) == NULL) goto err;
660         if (!BN_GF2m_arr2poly(p, field)) goto err;
661         
662         ret = BN_GF2m_mod_inv(r, xx, field, ctx);
663         bn_check_top(r);
664
665 err:
666         BN_CTX_end(ctx);
667         return ret;
668         }
669
670
671 #ifndef OPENSSL_SUN_GF2M_DIV
672 /* Divide y by x, reduce modulo p, and store the result in r. r could be x 
673  * or y, x could equal y.
674  */
675 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *y, const BIGNUM *x, const BIGNUM *p, BN_CTX *ctx)
676         {
677         BIGNUM *xinv = NULL;
678         int ret = 0;
679
680         bn_check_top(y);
681         bn_check_top(x);
682         bn_check_top(p);
683
684         BN_CTX_start(ctx);
685         xinv = BN_CTX_get(ctx);
686         if (xinv == NULL) goto err;
687         
688         if (!BN_GF2m_mod_inv(xinv, x, p, ctx)) goto err;
689         if (!BN_GF2m_mod_mul(r, y, xinv, p, ctx)) goto err;
690         bn_check_top(r);
691         ret = 1;
692
693 err:
694         BN_CTX_end(ctx);
695         return ret;
696         }
697 #else
698 /* Divide y by x, reduce modulo p, and store the result in r. r could be x 
699  * or y, x could equal y.
700  * Uses algorithm Modular_Division_GF(2^m) from 
701  *     Chang-Shantz, S.  "From Euclid's GCD to Montgomery Multiplication to 
702  *     the Great Divide".
703  */
704 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *y, const BIGNUM *x, const BIGNUM *p, BN_CTX *ctx)
705         {
706         BIGNUM *a, *b, *u, *v;
707         int ret = 0;
708
709         bn_check_top(y);
710         bn_check_top(x);
711         bn_check_top(p);
712
713         BN_CTX_start(ctx);
714         
715         a = BN_CTX_get(ctx);
716         b = BN_CTX_get(ctx);
717         u = BN_CTX_get(ctx);
718         v = BN_CTX_get(ctx);
719         if (v == NULL) goto err;
720
721         /* reduce x and y mod p */
722         if (!BN_GF2m_mod(u, y, p)) goto err;
723         if (!BN_GF2m_mod(a, x, p)) goto err;
724         if (!BN_copy(b, p)) goto err;
725         
726         while (!BN_is_odd(a))
727                 {
728                 if (!BN_rshift1(a, a)) goto err;
729                 if (BN_is_odd(u)) if (!BN_GF2m_add(u, u, p)) goto err;
730                 if (!BN_rshift1(u, u)) goto err;
731                 }
732
733         do
734                 {
735                 if (BN_GF2m_cmp(b, a) > 0)
736                         {
737                         if (!BN_GF2m_add(b, b, a)) goto err;
738                         if (!BN_GF2m_add(v, v, u)) goto err;
739                         do
740                                 {
741                                 if (!BN_rshift1(b, b)) goto err;
742                                 if (BN_is_odd(v)) if (!BN_GF2m_add(v, v, p)) goto err;
743                                 if (!BN_rshift1(v, v)) goto err;
744                                 } while (!BN_is_odd(b));
745                         }
746                 else if (BN_abs_is_word(a, 1))
747                         break;
748                 else
749                         {
750                         if (!BN_GF2m_add(a, a, b)) goto err;
751                         if (!BN_GF2m_add(u, u, v)) goto err;
752                         do
753                                 {
754                                 if (!BN_rshift1(a, a)) goto err;
755                                 if (BN_is_odd(u)) if (!BN_GF2m_add(u, u, p)) goto err;
756                                 if (!BN_rshift1(u, u)) goto err;
757                                 } while (!BN_is_odd(a));
758                         }
759                 } while (1);
760
761         if (!BN_copy(r, u)) goto err;
762         bn_check_top(r);
763         ret = 1;
764
765 err:
766         BN_CTX_end(ctx);
767         return ret;
768         }
769 #endif
770
771 /* Divide yy by xx, reduce modulo p, and store the result in r. r could be xx 
772  * or yy, xx could equal yy.
773  *
774  * This function calls down to the BN_GF2m_mod_div implementation; this wrapper
775  * function is only provided for convenience; for best performance, use the 
776  * BN_GF2m_mod_div function.
777  */
778 int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *yy, const BIGNUM *xx, const int p[], BN_CTX *ctx)
779         {
780         BIGNUM *field;
781         int ret = 0;
782
783         bn_check_top(yy);
784         bn_check_top(xx);
785
786         BN_CTX_start(ctx);
787         if ((field = BN_CTX_get(ctx)) == NULL) goto err;
788         if (!BN_GF2m_arr2poly(p, field)) goto err;
789         
790         ret = BN_GF2m_mod_div(r, yy, xx, field, ctx);
791         bn_check_top(r);
792
793 err:
794         BN_CTX_end(ctx);
795         return ret;
796         }
797
798
799 /* Compute the bth power of a, reduce modulo p, and store
800  * the result in r.  r could be a.
801  * Uses simple square-and-multiply algorithm A.5.1 from IEEE P1363.
802  */
803 int     BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const int p[], BN_CTX *ctx)
804         {
805         int ret = 0, i, n;
806         BIGNUM *u;
807
808         bn_check_top(a);
809         bn_check_top(b);
810
811         if (BN_is_zero(b))
812                 return(BN_one(r));
813
814         if (BN_abs_is_word(b, 1))
815                 return (BN_copy(r, a) != NULL);
816
817         BN_CTX_start(ctx);
818         if ((u = BN_CTX_get(ctx)) == NULL) goto err;
819         
820         if (!BN_GF2m_mod_arr(u, a, p)) goto err;
821         
822         n = BN_num_bits(b) - 1;
823         for (i = n - 1; i >= 0; i--)
824                 {
825                 if (!BN_GF2m_mod_sqr_arr(u, u, p, ctx)) goto err;
826                 if (BN_is_bit_set(b, i))
827                         {
828                         if (!BN_GF2m_mod_mul_arr(u, u, a, p, ctx)) goto err;
829                         }
830                 }
831         if (!BN_copy(r, u)) goto err;
832         bn_check_top(r);
833         ret = 1;
834 err:
835         BN_CTX_end(ctx);
836         return ret;
837         }
838
839 /* Compute the bth power of a, reduce modulo p, and store
840  * the result in r.  r could be a.
841  *
842  * This function calls down to the BN_GF2m_mod_exp_arr implementation; this wrapper
843  * function is only provided for convenience; for best performance, use the 
844  * BN_GF2m_mod_exp_arr function.
845  */
846 int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx)
847         {
848         int ret = 0;
849         const int max = BN_num_bits(p) + 1;
850         int *arr=NULL;
851         bn_check_top(a);
852         bn_check_top(b);
853         bn_check_top(p);
854         if ((arr = (int *)OPENSSL_malloc(sizeof(int) * max)) == NULL) goto err;
855         ret = BN_GF2m_poly2arr(p, arr, max);
856         if (!ret || ret > max)
857                 {
858                 BNerr(BN_F_BN_GF2M_MOD_EXP,BN_R_INVALID_LENGTH);
859                 goto err;
860                 }
861         ret = BN_GF2m_mod_exp_arr(r, a, b, arr, ctx);
862         bn_check_top(r);
863 err:
864         if (arr) OPENSSL_free(arr);
865         return ret;
866         }
867
868 /* Compute the square root of a, reduce modulo p, and store
869  * the result in r.  r could be a.
870  * Uses exponentiation as in algorithm A.4.1 from IEEE P1363.
871  */
872 int     BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a, const int p[], BN_CTX *ctx)
873         {
874         int ret = 0;
875         BIGNUM *u;
876
877         bn_check_top(a);
878
879         if (!p[0])
880                 {
881                 /* reduction mod 1 => return 0 */
882                 BN_zero(r);
883                 return 1;
884                 }
885
886         BN_CTX_start(ctx);
887         if ((u = BN_CTX_get(ctx)) == NULL) goto err;
888         
889         if (!BN_set_bit(u, p[0] - 1)) goto err;
890         ret = BN_GF2m_mod_exp_arr(r, a, u, p, ctx);
891         bn_check_top(r);
892
893 err:
894         BN_CTX_end(ctx);
895         return ret;
896         }
897
898 /* Compute the square root of a, reduce modulo p, and store
899  * the result in r.  r could be a.
900  *
901  * This function calls down to the BN_GF2m_mod_sqrt_arr implementation; this wrapper
902  * function is only provided for convenience; for best performance, use the 
903  * BN_GF2m_mod_sqrt_arr function.
904  */
905 int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
906         {
907         int ret = 0;
908         const int max = BN_num_bits(p) + 1;
909         int *arr=NULL;
910         bn_check_top(a);
911         bn_check_top(p);
912         if ((arr = (int *)OPENSSL_malloc(sizeof(int) * max)) == NULL) goto err;
913         ret = BN_GF2m_poly2arr(p, arr, max);
914         if (!ret || ret > max)
915                 {
916                 BNerr(BN_F_BN_GF2M_MOD_SQRT,BN_R_INVALID_LENGTH);
917                 goto err;
918                 }
919         ret = BN_GF2m_mod_sqrt_arr(r, a, arr, ctx);
920         bn_check_top(r);
921 err:
922         if (arr) OPENSSL_free(arr);
923         return ret;
924         }
925
926 /* Find r such that r^2 + r = a mod p.  r could be a. If no r exists returns 0.
927  * Uses algorithms A.4.7 and A.4.6 from IEEE P1363.
928  */
929 int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a_, const int p[], BN_CTX *ctx)
930         {
931         int ret = 0, count = 0, j;
932         BIGNUM *a, *z, *rho, *w, *w2, *tmp;
933
934         bn_check_top(a_);
935
936         if (!p[0])
937                 {
938                 /* reduction mod 1 => return 0 */
939                 BN_zero(r);
940                 return 1;
941                 }
942
943         BN_CTX_start(ctx);
944         a = BN_CTX_get(ctx);
945         z = BN_CTX_get(ctx);
946         w = BN_CTX_get(ctx);
947         if (w == NULL) goto err;
948
949         if (!BN_GF2m_mod_arr(a, a_, p)) goto err;
950         
951         if (BN_is_zero(a))
952                 {
953                 BN_zero(r);
954                 ret = 1;
955                 goto err;
956                 }
957
958         if (p[0] & 0x1) /* m is odd */
959                 {
960                 /* compute half-trace of a */
961                 if (!BN_copy(z, a)) goto err;
962                 for (j = 1; j <= (p[0] - 1) / 2; j++)
963                         {
964                         if (!BN_GF2m_mod_sqr_arr(z, z, p, ctx)) goto err;
965                         if (!BN_GF2m_mod_sqr_arr(z, z, p, ctx)) goto err;
966                         if (!BN_GF2m_add(z, z, a)) goto err;
967                         }
968                 
969                 }
970         else /* m is even */
971                 {
972                 rho = BN_CTX_get(ctx);
973                 w2 = BN_CTX_get(ctx);
974                 tmp = BN_CTX_get(ctx);
975                 if (tmp == NULL) goto err;
976                 do
977                         {
978                         if (!BN_rand(rho, p[0], 0, 0)) goto err;
979                         if (!BN_GF2m_mod_arr(rho, rho, p)) goto err;
980                         BN_zero(z);
981                         if (!BN_copy(w, rho)) goto err;
982                         for (j = 1; j <= p[0] - 1; j++)
983                                 {
984                                 if (!BN_GF2m_mod_sqr_arr(z, z, p, ctx)) goto err;
985                                 if (!BN_GF2m_mod_sqr_arr(w2, w, p, ctx)) goto err;
986                                 if (!BN_GF2m_mod_mul_arr(tmp, w2, a, p, ctx)) goto err;
987                                 if (!BN_GF2m_add(z, z, tmp)) goto err;
988                                 if (!BN_GF2m_add(w, w2, rho)) goto err;
989                                 }
990                         count++;
991                         } while (BN_is_zero(w) && (count < MAX_ITERATIONS));
992                 if (BN_is_zero(w))
993                         {
994                         BNerr(BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR,BN_R_TOO_MANY_ITERATIONS);
995                         goto err;
996                         }
997                 }
998         
999         if (!BN_GF2m_mod_sqr_arr(w, z, p, ctx)) goto err;
1000         if (!BN_GF2m_add(w, z, w)) goto err;
1001         if (BN_GF2m_cmp(w, a))
1002                 {
1003                 BNerr(BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR, BN_R_NO_SOLUTION);
1004                 goto err;
1005                 }
1006
1007         if (!BN_copy(r, z)) goto err;
1008         bn_check_top(r);
1009
1010         ret = 1;
1011
1012 err:
1013         BN_CTX_end(ctx);
1014         return ret;
1015         }
1016
1017 /* Find r such that r^2 + r = a mod p.  r could be a. If no r exists returns 0.
1018  *
1019  * This function calls down to the BN_GF2m_mod_solve_quad_arr implementation; this wrapper
1020  * function is only provided for convenience; for best performance, use the 
1021  * BN_GF2m_mod_solve_quad_arr function.
1022  */
1023 int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
1024         {
1025         int ret = 0;
1026         const int max = BN_num_bits(p) + 1;
1027         int *arr=NULL;
1028         bn_check_top(a);
1029         bn_check_top(p);
1030         if ((arr = (int *)OPENSSL_malloc(sizeof(int) *
1031                                                 max)) == NULL) goto err;
1032         ret = BN_GF2m_poly2arr(p, arr, max);
1033         if (!ret || ret > max)
1034                 {
1035                 BNerr(BN_F_BN_GF2M_MOD_SOLVE_QUAD,BN_R_INVALID_LENGTH);
1036                 goto err;
1037                 }
1038         ret = BN_GF2m_mod_solve_quad_arr(r, a, arr, ctx);
1039         bn_check_top(r);
1040 err:
1041         if (arr) OPENSSL_free(arr);
1042         return ret;
1043         }
1044
1045 /* Convert the bit-string representation of a polynomial
1046  * ( \sum_{i=0}^n a_i * x^i) into an array of integers corresponding 
1047  * to the bits with non-zero coefficient.  Array is terminated with -1.
1048  * Up to max elements of the array will be filled.  Return value is total
1049  * number of array elements that would be filled if array was large enough.
1050  */
1051 int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max)
1052         {
1053         int i, j, k = 0;
1054         BN_ULONG mask;
1055
1056         if (BN_is_zero(a))
1057                 return 0;
1058
1059         for (i = a->top - 1; i >= 0; i--)
1060                 {
1061                 if (!a->d[i])
1062                         /* skip word if a->d[i] == 0 */
1063                         continue;
1064                 mask = BN_TBIT;
1065                 for (j = BN_BITS2 - 1; j >= 0; j--)
1066                         {
1067                         if (a->d[i] & mask) 
1068                                 {
1069                                 if (k < max) p[k] = BN_BITS2 * i + j;
1070                                 k++;
1071                                 }
1072                         mask >>= 1;
1073                         }
1074                 }
1075
1076         if (k < max) {
1077                 p[k] = -1;
1078                 k++;
1079         }
1080
1081         return k;
1082         }
1083
1084 /* Convert the coefficient array representation of a polynomial to a 
1085  * bit-string.  The array must be terminated by -1.
1086  */
1087 int BN_GF2m_arr2poly(const int p[], BIGNUM *a)
1088         {
1089         int i;
1090
1091         bn_check_top(a);
1092         BN_zero(a);
1093         for (i = 0; p[i] != -1; i++)
1094                 {
1095                 if (BN_set_bit(a, p[i]) == 0)
1096                         return 0;
1097                 }
1098         bn_check_top(a);
1099
1100         return 1;
1101         }
1102
1103 #endif