Add ECDSA functionality to fips module. Initial very incomplete version
[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         const int max = BN_num_bits(p) + 1;
368         int *arr=NULL;
369         bn_check_top(a);
370         bn_check_top(p);
371         if ((arr = (int *)OPENSSL_malloc(sizeof(int) * max)) == NULL) goto err;
372         ret = BN_GF2m_poly2arr(p, arr, max);
373         if (!ret || ret > max)
374                 {
375                 BNerr(BN_F_BN_GF2M_MOD,BN_R_INVALID_LENGTH);
376                 goto err;
377                 }
378         ret = BN_GF2m_mod_arr(r, a, arr);
379         bn_check_top(r);
380 err:
381         if (arr) OPENSSL_free(arr);
382         return ret;
383         }
384
385
386 /* Compute the product of two polynomials a and b, reduce modulo p, and store
387  * the result in r.  r could be a or b; a could be b.
388  */
389 int     BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const int p[], BN_CTX *ctx)
390         {
391         int zlen, i, j, k, ret = 0;
392         BIGNUM *s;
393         BN_ULONG x1, x0, y1, y0, zz[4];
394
395         bn_check_top(a);
396         bn_check_top(b);
397
398         if (a == b)
399                 {
400                 return BN_GF2m_mod_sqr_arr(r, a, p, ctx);
401                 }
402
403         BN_CTX_start(ctx);
404         if ((s = BN_CTX_get(ctx)) == NULL) goto err;
405         
406         zlen = a->top + b->top + 4;
407         if (!bn_wexpand(s, zlen)) goto err;
408         s->top = zlen;
409
410         for (i = 0; i < zlen; i++) s->d[i] = 0;
411
412         for (j = 0; j < b->top; j += 2)
413                 {
414                 y0 = b->d[j];
415                 y1 = ((j+1) == b->top) ? 0 : b->d[j+1];
416                 for (i = 0; i < a->top; i += 2)
417                         {
418                         x0 = a->d[i];
419                         x1 = ((i+1) == a->top) ? 0 : a->d[i+1];
420                         bn_GF2m_mul_2x2(zz, x1, x0, y1, y0);
421                         for (k = 0; k < 4; k++) s->d[i+j+k] ^= zz[k];
422                         }
423                 }
424
425         bn_correct_top(s);
426         if (BN_GF2m_mod_arr(r, s, p))
427                 ret = 1;
428         bn_check_top(r);
429
430 err:
431         BN_CTX_end(ctx);
432         return ret;
433         }
434
435 /* Compute the product of two polynomials a and b, reduce modulo p, and store
436  * the result in r.  r could be a or b; a could equal b.
437  *
438  * This function calls down to the BN_GF2m_mod_mul_arr implementation; this wrapper
439  * function is only provided for convenience; for best performance, use the 
440  * BN_GF2m_mod_mul_arr function.
441  */
442 int     BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx)
443         {
444         int ret = 0;
445         const int max = BN_num_bits(p) + 1;
446         int *arr=NULL;
447         bn_check_top(a);
448         bn_check_top(b);
449         bn_check_top(p);
450         if ((arr = (int *)OPENSSL_malloc(sizeof(int) * max)) == NULL) goto err;
451         ret = BN_GF2m_poly2arr(p, arr, max);
452         if (!ret || ret > max)
453                 {
454                 BNerr(BN_F_BN_GF2M_MOD_MUL,BN_R_INVALID_LENGTH);
455                 goto err;
456                 }
457         ret = BN_GF2m_mod_mul_arr(r, a, b, arr, ctx);
458         bn_check_top(r);
459 err:
460         if (arr) OPENSSL_free(arr);
461         return ret;
462         }
463
464
465 /* Square a, reduce the result mod p, and store it in a.  r could be a. */
466 int     BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[], BN_CTX *ctx)
467         {
468         int i, ret = 0;
469         BIGNUM *s;
470
471         bn_check_top(a);
472         BN_CTX_start(ctx);
473         if ((s = BN_CTX_get(ctx)) == NULL) return 0;
474         if (!bn_wexpand(s, 2 * a->top)) goto err;
475
476         for (i = a->top - 1; i >= 0; i--)
477                 {
478                 s->d[2*i+1] = SQR1(a->d[i]);
479                 s->d[2*i  ] = SQR0(a->d[i]);
480                 }
481
482         s->top = 2 * a->top;
483         bn_correct_top(s);
484         if (!BN_GF2m_mod_arr(r, s, p)) goto err;
485         bn_check_top(r);
486         ret = 1;
487 err:
488         BN_CTX_end(ctx);
489         return ret;
490         }
491
492 /* Square a, reduce the result mod p, and store it in a.  r could be a.
493  *
494  * This function calls down to the BN_GF2m_mod_sqr_arr implementation; this wrapper
495  * function is only provided for convenience; for best performance, use the 
496  * BN_GF2m_mod_sqr_arr function.
497  */
498 int     BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
499         {
500         int ret = 0;
501         const int max = BN_num_bits(p) + 1;
502         int *arr=NULL;
503
504         bn_check_top(a);
505         bn_check_top(p);
506         if ((arr = (int *)OPENSSL_malloc(sizeof(int) * max)) == NULL) goto err;
507         ret = BN_GF2m_poly2arr(p, arr, max);
508         if (!ret || ret > max)
509                 {
510                 BNerr(BN_F_BN_GF2M_MOD_SQR,BN_R_INVALID_LENGTH);
511                 goto err;
512                 }
513         ret = BN_GF2m_mod_sqr_arr(r, a, arr, ctx);
514         bn_check_top(r);
515 err:
516         if (arr) OPENSSL_free(arr);
517         return ret;
518         }
519
520
521 /* Invert a, reduce modulo p, and store the result in r. r could be a. 
522  * Uses Modified Almost Inverse Algorithm (Algorithm 10) from
523  *     Hankerson, D., Hernandez, J.L., and Menezes, A.  "Software Implementation
524  *     of Elliptic Curve Cryptography Over Binary Fields".
525  */
526 int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
527         {
528         BIGNUM *b, *c, *u, *v, *tmp;
529         int ret = 0;
530
531         bn_check_top(a);
532         bn_check_top(p);
533
534         BN_CTX_start(ctx);
535         
536         b = BN_CTX_get(ctx);
537         c = BN_CTX_get(ctx);
538         u = BN_CTX_get(ctx);
539         v = BN_CTX_get(ctx);
540         if (v == NULL) goto err;
541
542         if (!BN_one(b)) goto err;
543         if (!BN_GF2m_mod(u, a, p)) goto err;
544         if (!BN_copy(v, p)) goto err;
545
546         if (BN_is_zero(u)) goto err;
547
548         while (1)
549                 {
550                 while (!BN_is_odd(u))
551                         {
552                         if (!BN_rshift1(u, u)) goto err;
553                         if (BN_is_odd(b))
554                                 {
555                                 if (!BN_GF2m_add(b, b, p)) goto err;
556                                 }
557                         if (!BN_rshift1(b, b)) goto err;
558                         }
559
560                 if (BN_abs_is_word(u, 1)) break;
561
562                 if (BN_num_bits(u) < BN_num_bits(v))
563                         {
564                         tmp = u; u = v; v = tmp;
565                         tmp = b; b = c; c = tmp;
566                         }
567                 
568                 if (!BN_GF2m_add(u, u, v)) goto err;
569                 if (!BN_GF2m_add(b, b, c)) goto err;
570                 }
571
572
573         if (!BN_copy(r, b)) goto err;
574         bn_check_top(r);
575         ret = 1;
576
577 err:
578         BN_CTX_end(ctx);
579         return ret;
580         }
581
582 /* Invert xx, reduce modulo p, and store the result in r. r could be xx. 
583  *
584  * This function calls down to the BN_GF2m_mod_inv implementation; this wrapper
585  * function is only provided for convenience; for best performance, use the 
586  * BN_GF2m_mod_inv function.
587  */
588 int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *xx, const int p[], BN_CTX *ctx)
589         {
590         BIGNUM *field;
591         int ret = 0;
592
593         bn_check_top(xx);
594         BN_CTX_start(ctx);
595         if ((field = BN_CTX_get(ctx)) == NULL) goto err;
596         if (!BN_GF2m_arr2poly(p, field)) goto err;
597         
598         ret = BN_GF2m_mod_inv(r, xx, field, ctx);
599         bn_check_top(r);
600
601 err:
602         BN_CTX_end(ctx);
603         return ret;
604         }
605
606
607 #ifndef OPENSSL_SUN_GF2M_DIV
608 /* Divide y by x, reduce modulo p, and store the result in r. r could be x 
609  * or y, x could equal y.
610  */
611 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *y, const BIGNUM *x, const BIGNUM *p, BN_CTX *ctx)
612         {
613         BIGNUM *xinv = NULL;
614         int ret = 0;
615
616         bn_check_top(y);
617         bn_check_top(x);
618         bn_check_top(p);
619
620         BN_CTX_start(ctx);
621         xinv = BN_CTX_get(ctx);
622         if (xinv == NULL) goto err;
623         
624         if (!BN_GF2m_mod_inv(xinv, x, p, ctx)) goto err;
625         if (!BN_GF2m_mod_mul(r, y, xinv, p, ctx)) goto err;
626         bn_check_top(r);
627         ret = 1;
628
629 err:
630         BN_CTX_end(ctx);
631         return ret;
632         }
633 #else
634 /* Divide y by x, reduce modulo p, and store the result in r. r could be x 
635  * or y, x could equal y.
636  * Uses algorithm Modular_Division_GF(2^m) from 
637  *     Chang-Shantz, S.  "From Euclid's GCD to Montgomery Multiplication to 
638  *     the Great Divide".
639  */
640 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *y, const BIGNUM *x, const BIGNUM *p, BN_CTX *ctx)
641         {
642         BIGNUM *a, *b, *u, *v;
643         int ret = 0;
644
645         bn_check_top(y);
646         bn_check_top(x);
647         bn_check_top(p);
648
649         BN_CTX_start(ctx);
650         
651         a = BN_CTX_get(ctx);
652         b = BN_CTX_get(ctx);
653         u = BN_CTX_get(ctx);
654         v = BN_CTX_get(ctx);
655         if (v == NULL) goto err;
656
657         /* reduce x and y mod p */
658         if (!BN_GF2m_mod(u, y, p)) goto err;
659         if (!BN_GF2m_mod(a, x, p)) goto err;
660         if (!BN_copy(b, p)) goto err;
661         
662         while (!BN_is_odd(a))
663                 {
664                 if (!BN_rshift1(a, a)) goto err;
665                 if (BN_is_odd(u)) if (!BN_GF2m_add(u, u, p)) goto err;
666                 if (!BN_rshift1(u, u)) goto err;
667                 }
668
669         do
670                 {
671                 if (BN_GF2m_cmp(b, a) > 0)
672                         {
673                         if (!BN_GF2m_add(b, b, a)) goto err;
674                         if (!BN_GF2m_add(v, v, u)) goto err;
675                         do
676                                 {
677                                 if (!BN_rshift1(b, b)) goto err;
678                                 if (BN_is_odd(v)) if (!BN_GF2m_add(v, v, p)) goto err;
679                                 if (!BN_rshift1(v, v)) goto err;
680                                 } while (!BN_is_odd(b));
681                         }
682                 else if (BN_abs_is_word(a, 1))
683                         break;
684                 else
685                         {
686                         if (!BN_GF2m_add(a, a, b)) goto err;
687                         if (!BN_GF2m_add(u, u, v)) goto err;
688                         do
689                                 {
690                                 if (!BN_rshift1(a, a)) goto err;
691                                 if (BN_is_odd(u)) if (!BN_GF2m_add(u, u, p)) goto err;
692                                 if (!BN_rshift1(u, u)) goto err;
693                                 } while (!BN_is_odd(a));
694                         }
695                 } while (1);
696
697         if (!BN_copy(r, u)) goto err;
698         bn_check_top(r);
699         ret = 1;
700
701 err:
702         BN_CTX_end(ctx);
703         return ret;
704         }
705 #endif
706
707 /* Divide yy by xx, reduce modulo p, and store the result in r. r could be xx 
708  * or yy, xx could equal yy.
709  *
710  * This function calls down to the BN_GF2m_mod_div implementation; this wrapper
711  * function is only provided for convenience; for best performance, use the 
712  * BN_GF2m_mod_div function.
713  */
714 int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *yy, const BIGNUM *xx, const int p[], BN_CTX *ctx)
715         {
716         BIGNUM *field;
717         int ret = 0;
718
719         bn_check_top(yy);
720         bn_check_top(xx);
721
722         BN_CTX_start(ctx);
723         if ((field = BN_CTX_get(ctx)) == NULL) goto err;
724         if (!BN_GF2m_arr2poly(p, field)) goto err;
725         
726         ret = BN_GF2m_mod_div(r, yy, xx, field, ctx);
727         bn_check_top(r);
728
729 err:
730         BN_CTX_end(ctx);
731         return ret;
732         }
733
734
735 /* Compute the bth power of a, reduce modulo p, and store
736  * the result in r.  r could be a.
737  * Uses simple square-and-multiply algorithm A.5.1 from IEEE P1363.
738  */
739 int     BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const int p[], BN_CTX *ctx)
740         {
741         int ret = 0, i, n;
742         BIGNUM *u;
743
744         bn_check_top(a);
745         bn_check_top(b);
746
747         if (BN_is_zero(b))
748                 return(BN_one(r));
749
750         if (BN_abs_is_word(b, 1))
751                 return (BN_copy(r, a) != NULL);
752
753         BN_CTX_start(ctx);
754         if ((u = BN_CTX_get(ctx)) == NULL) goto err;
755         
756         if (!BN_GF2m_mod_arr(u, a, p)) goto err;
757         
758         n = BN_num_bits(b) - 1;
759         for (i = n - 1; i >= 0; i--)
760                 {
761                 if (!BN_GF2m_mod_sqr_arr(u, u, p, ctx)) goto err;
762                 if (BN_is_bit_set(b, i))
763                         {
764                         if (!BN_GF2m_mod_mul_arr(u, u, a, p, ctx)) goto err;
765                         }
766                 }
767         if (!BN_copy(r, u)) goto err;
768         bn_check_top(r);
769         ret = 1;
770 err:
771         BN_CTX_end(ctx);
772         return ret;
773         }
774
775 /* Compute the bth power of a, reduce modulo p, and store
776  * the result in r.  r could be a.
777  *
778  * This function calls down to the BN_GF2m_mod_exp_arr implementation; this wrapper
779  * function is only provided for convenience; for best performance, use the 
780  * BN_GF2m_mod_exp_arr function.
781  */
782 int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx)
783         {
784         int ret = 0;
785         const int max = BN_num_bits(p) + 1;
786         int *arr=NULL;
787         bn_check_top(a);
788         bn_check_top(b);
789         bn_check_top(p);
790         if ((arr = (int *)OPENSSL_malloc(sizeof(int) * max)) == NULL) goto err;
791         ret = BN_GF2m_poly2arr(p, arr, max);
792         if (!ret || ret > max)
793                 {
794                 BNerr(BN_F_BN_GF2M_MOD_EXP,BN_R_INVALID_LENGTH);
795                 goto err;
796                 }
797         ret = BN_GF2m_mod_exp_arr(r, a, b, arr, ctx);
798         bn_check_top(r);
799 err:
800         if (arr) OPENSSL_free(arr);
801         return ret;
802         }
803
804 /* Compute the square root of a, reduce modulo p, and store
805  * the result in r.  r could be a.
806  * Uses exponentiation as in algorithm A.4.1 from IEEE P1363.
807  */
808 int     BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a, const int p[], BN_CTX *ctx)
809         {
810         int ret = 0;
811         BIGNUM *u;
812
813         bn_check_top(a);
814
815         if (!p[0])
816                 {
817                 /* reduction mod 1 => return 0 */
818                 BN_zero(r);
819                 return 1;
820                 }
821
822         BN_CTX_start(ctx);
823         if ((u = BN_CTX_get(ctx)) == NULL) goto err;
824         
825         if (!BN_set_bit(u, p[0] - 1)) goto err;
826         ret = BN_GF2m_mod_exp_arr(r, a, u, p, ctx);
827         bn_check_top(r);
828
829 err:
830         BN_CTX_end(ctx);
831         return ret;
832         }
833
834 /* Compute the square root of a, reduce modulo p, and store
835  * the result in r.  r could be a.
836  *
837  * This function calls down to the BN_GF2m_mod_sqrt_arr implementation; this wrapper
838  * function is only provided for convenience; for best performance, use the 
839  * BN_GF2m_mod_sqrt_arr function.
840  */
841 int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
842         {
843         int ret = 0;
844         const int max = BN_num_bits(p) + 1;
845         int *arr=NULL;
846         bn_check_top(a);
847         bn_check_top(p);
848         if ((arr = (int *)OPENSSL_malloc(sizeof(int) * max)) == NULL) goto err;
849         ret = BN_GF2m_poly2arr(p, arr, max);
850         if (!ret || ret > max)
851                 {
852                 BNerr(BN_F_BN_GF2M_MOD_SQRT,BN_R_INVALID_LENGTH);
853                 goto err;
854                 }
855         ret = BN_GF2m_mod_sqrt_arr(r, a, arr, ctx);
856         bn_check_top(r);
857 err:
858         if (arr) OPENSSL_free(arr);
859         return ret;
860         }
861
862 /* Find r such that r^2 + r = a mod p.  r could be a. If no r exists returns 0.
863  * Uses algorithms A.4.7 and A.4.6 from IEEE P1363.
864  */
865 int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a_, const int p[], BN_CTX *ctx)
866         {
867         int ret = 0, count = 0, j;
868         BIGNUM *a, *z, *rho, *w, *w2, *tmp;
869
870         bn_check_top(a_);
871
872         if (!p[0])
873                 {
874                 /* reduction mod 1 => return 0 */
875                 BN_zero(r);
876                 return 1;
877                 }
878
879         BN_CTX_start(ctx);
880         a = BN_CTX_get(ctx);
881         z = BN_CTX_get(ctx);
882         w = BN_CTX_get(ctx);
883         if (w == NULL) goto err;
884
885         if (!BN_GF2m_mod_arr(a, a_, p)) goto err;
886         
887         if (BN_is_zero(a))
888                 {
889                 BN_zero(r);
890                 ret = 1;
891                 goto err;
892                 }
893
894         if (p[0] & 0x1) /* m is odd */
895                 {
896                 /* compute half-trace of a */
897                 if (!BN_copy(z, a)) goto err;
898                 for (j = 1; j <= (p[0] - 1) / 2; j++)
899                         {
900                         if (!BN_GF2m_mod_sqr_arr(z, z, p, ctx)) goto err;
901                         if (!BN_GF2m_mod_sqr_arr(z, z, p, ctx)) goto err;
902                         if (!BN_GF2m_add(z, z, a)) goto err;
903                         }
904                 
905                 }
906         else /* m is even */
907                 {
908                 rho = BN_CTX_get(ctx);
909                 w2 = BN_CTX_get(ctx);
910                 tmp = BN_CTX_get(ctx);
911                 if (tmp == NULL) goto err;
912                 do
913                         {
914                         if (!BN_rand(rho, p[0], 0, 0)) goto err;
915                         if (!BN_GF2m_mod_arr(rho, rho, p)) goto err;
916                         BN_zero(z);
917                         if (!BN_copy(w, rho)) goto err;
918                         for (j = 1; j <= p[0] - 1; j++)
919                                 {
920                                 if (!BN_GF2m_mod_sqr_arr(z, z, p, ctx)) goto err;
921                                 if (!BN_GF2m_mod_sqr_arr(w2, w, p, ctx)) goto err;
922                                 if (!BN_GF2m_mod_mul_arr(tmp, w2, a, p, ctx)) goto err;
923                                 if (!BN_GF2m_add(z, z, tmp)) goto err;
924                                 if (!BN_GF2m_add(w, w2, rho)) goto err;
925                                 }
926                         count++;
927                         } while (BN_is_zero(w) && (count < MAX_ITERATIONS));
928                 if (BN_is_zero(w))
929                         {
930                         BNerr(BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR,BN_R_TOO_MANY_ITERATIONS);
931                         goto err;
932                         }
933                 }
934         
935         if (!BN_GF2m_mod_sqr_arr(w, z, p, ctx)) goto err;
936         if (!BN_GF2m_add(w, z, w)) goto err;
937         if (BN_GF2m_cmp(w, a))
938                 {
939                 BNerr(BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR, BN_R_NO_SOLUTION);
940                 goto err;
941                 }
942
943         if (!BN_copy(r, z)) goto err;
944         bn_check_top(r);
945
946         ret = 1;
947
948 err:
949         BN_CTX_end(ctx);
950         return ret;
951         }
952
953 /* Find r such that r^2 + r = a mod p.  r could be a. If no r exists returns 0.
954  *
955  * This function calls down to the BN_GF2m_mod_solve_quad_arr implementation; this wrapper
956  * function is only provided for convenience; for best performance, use the 
957  * BN_GF2m_mod_solve_quad_arr function.
958  */
959 int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
960         {
961         int ret = 0;
962         const int max = BN_num_bits(p) + 1;
963         int *arr=NULL;
964         bn_check_top(a);
965         bn_check_top(p);
966         if ((arr = (int *)OPENSSL_malloc(sizeof(int) *
967                                                 max)) == NULL) goto err;
968         ret = BN_GF2m_poly2arr(p, arr, max);
969         if (!ret || ret > max)
970                 {
971                 BNerr(BN_F_BN_GF2M_MOD_SOLVE_QUAD,BN_R_INVALID_LENGTH);
972                 goto err;
973                 }
974         ret = BN_GF2m_mod_solve_quad_arr(r, a, arr, ctx);
975         bn_check_top(r);
976 err:
977         if (arr) OPENSSL_free(arr);
978         return ret;
979         }
980
981 /* Convert the bit-string representation of a polynomial
982  * ( \sum_{i=0}^n a_i * x^i) into an array of integers corresponding 
983  * to the bits with non-zero coefficient.  Array is terminated with -1.
984  * Up to max elements of the array will be filled.  Return value is total
985  * number of array elements that would be filled if array was large enough.
986  */
987 int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max)
988         {
989         int i, j, k = 0;
990         BN_ULONG mask;
991
992         if (BN_is_zero(a))
993                 return 0;
994
995         for (i = a->top - 1; i >= 0; i--)
996                 {
997                 if (!a->d[i])
998                         /* skip word if a->d[i] == 0 */
999                         continue;
1000                 mask = BN_TBIT;
1001                 for (j = BN_BITS2 - 1; j >= 0; j--)
1002                         {
1003                         if (a->d[i] & mask) 
1004                                 {
1005                                 if (k < max) p[k] = BN_BITS2 * i + j;
1006                                 k++;
1007                                 }
1008                         mask >>= 1;
1009                         }
1010                 }
1011
1012         if (k < max) {
1013                 p[k] = -1;
1014                 k++;
1015         }
1016
1017         return k;
1018         }
1019
1020 /* Convert the coefficient array representation of a polynomial to a 
1021  * bit-string.  The array must be terminated by -1.
1022  */
1023 int BN_GF2m_arr2poly(const int p[], BIGNUM *a)
1024         {
1025         int i;
1026
1027         bn_check_top(a);
1028         BN_zero(a);
1029         for (i = 0; p[i] != -1; i++)
1030                 {
1031                 if (BN_set_bit(a, p[i]) == 0)
1032                         return 0;
1033                 }
1034         bn_check_top(a);
1035
1036         return 1;
1037         }
1038
1039 #endif