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 #include <assert.h>
  92 #include <limits.h>
  93 #include <stdio.h>
  94 #include "cryptlib.h"
  95 #include "bn_lcl.h"
  96
  97 /* Maximum number of iterations before BN_GF2m_mod_solve_quad_arr should fail. */
  98 #define MAX_ITERATIONS 50
  99
 100 static const BN_ULONG SQR_tb[16] =
 101   {     0,     1,     4,     5,    16,    17,    20,    21,
 102        64,    65,    68,    69,    80,    81,    84,    85 };
 103 /* Platform-specific macros to accelerate squaring. */
 104 #if defined(SIXTY_FOUR_BIT) || defined(SIXTY_FOUR_BIT_LONG)
 105 #define SQR1(w) \
 106     SQR_tb[(w) >> 60 & 0xF] << 56 | SQR_tb[(w) >> 56 & 0xF] << 48 | \
 107     SQR_tb[(w) >> 52 & 0xF] << 40 | SQR_tb[(w) >> 48 & 0xF] << 32 | \
 108     SQR_tb[(w) >> 44 & 0xF] << 24 | SQR_tb[(w) >> 40 & 0xF] << 16 | \
 109     SQR_tb[(w) >> 36 & 0xF] <<  8 | SQR_tb[(w) >> 32 & 0xF]
 110 #define SQR0(w) \
 111     SQR_tb[(w) >> 28 & 0xF] << 56 | SQR_tb[(w) >> 24 & 0xF] << 48 | \
 112     SQR_tb[(w) >> 20 & 0xF] << 40 | SQR_tb[(w) >> 16 & 0xF] << 32 | \
 113     SQR_tb[(w) >> 12 & 0xF] << 24 | SQR_tb[(w) >>  8 & 0xF] << 16 | \
 114     SQR_tb[(w) >>  4 & 0xF] <<  8 | SQR_tb[(w)       & 0xF]
 115 #endif
 116 #ifdef THIRTY_TWO_BIT
 117 #define SQR1(w) \
 118     SQR_tb[(w) >> 28 & 0xF] << 24 | SQR_tb[(w) >> 24 & 0xF] << 16 | \
 119     SQR_tb[(w) >> 20 & 0xF] <<  8 | SQR_tb[(w) >> 16 & 0xF]
 120 #define SQR0(w) \
 121     SQR_tb[(w) >> 12 & 0xF] << 24 | SQR_tb[(w) >>  8 & 0xF] << 16 | \
 122     SQR_tb[(w) >>  4 & 0xF] <<  8 | SQR_tb[(w)       & 0xF]
 123 #endif
 124 #ifdef SIXTEEN_BIT
 125 #define SQR1(w) \
 126     SQR_tb[(w) >> 12 & 0xF] <<  8 | SQR_tb[(w) >>  8 & 0xF]
 127 #define SQR0(w) \
 128     SQR_tb[(w) >>  4 & 0xF] <<  8 | SQR_tb[(w)       & 0xF]
 129 #endif
 130 #ifdef EIGHT_BIT
 131 #define SQR1(w) \
 132     SQR_tb[(w) >>  4 & 0xF]
 133 #define SQR0(w) \
 134     SQR_tb[(w)       & 15]
 135 #endif
 136
 137 /* Product of two polynomials a, b each with degree < BN_BITS2 - 1,
 138  * result is a polynomial r with degree < 2 * BN_BITS - 1
 139  * The caller MUST ensure that the variables have the right amount
 140  * of space allocated.
 141  */
 142 #ifdef EIGHT_BIT
 143 static void bn_GF2m_mul_1x1(BN_ULONG *r1, BN_ULONG *r0, const BN_ULONG a, const BN_ULONG b)
 144         {
 145         register BN_ULONG h, l, s;
 146         BN_ULONG tab[4], top1b = a >> 7;
 147         register BN_ULONG a1, a2;
 148
 149         a1 = a & (0x7F); a2 = a1 << 1;
 150
 151         tab[0] = 0; tab[1] = a1; tab[2] = a2; tab[3] = a1^a2;
 152
 153         s = tab[b      & 0x3]; l  = s;
 154         s = tab[b >> 2 & 0x3]; l ^= s << 2; h  = s >> 6;
 155         s = tab[b >> 4 & 0x3]; l ^= s << 4; h ^= s >> 4;
 156         s = tab[b >> 6      ]; l ^= s << 6; h ^= s >> 2;
 157
 158         /* compensate for the top bit of a */
 159
 160         if (top1b & 01) { l ^= b << 7; h ^= b >> 1; }
 161
 162         *r1 = h; *r0 = l;
 163         }
 164 #endif
 165 #ifdef SIXTEEN_BIT
 166 static void bn_GF2m_mul_1x1(BN_ULONG *r1, BN_ULONG *r0, const BN_ULONG a, const BN_ULONG b)
 167         {
 168         register BN_ULONG h, l, s;
 169         BN_ULONG tab[4], top1b = a >> 15;
 170         register BN_ULONG a1, a2;
 171
 172         a1 = a & (0x7FFF); a2 = a1 << 1;
 173
 174         tab[0] = 0; tab[1] = a1; tab[2] = a2; tab[3] = a1^a2;
 175
 176         s = tab[b      & 0x3]; l  = s;
 177         s = tab[b >> 2 & 0x3]; l ^= s <<  2; h  = s >> 14;
 178         s = tab[b >> 4 & 0x3]; l ^= s <<  4; h ^= s >> 12;
 179         s = tab[b >> 6 & 0x3]; l ^= s <<  6; h ^= s >> 10;
 180         s = tab[b >> 8 & 0x3]; l ^= s <<  8; h ^= s >>  8;
 181         s = tab[b >>10 & 0x3]; l ^= s << 10; h ^= s >>  6;
 182         s = tab[b >>12 & 0x3]; l ^= s << 12; h ^= s >>  4;
 183         s = tab[b >>14      ]; l ^= s << 14; h ^= s >>  2;
 184
 185         /* compensate for the top bit of a */
 186
 187         if (top1b & 01) { l ^= b << 15; h ^= b >> 1; }
 188
 189         *r1 = h; *r0 = l;
 190         }
 191 #endif
 192 #ifdef THIRTY_TWO_BIT
 193 static void bn_GF2m_mul_1x1(BN_ULONG *r1, BN_ULONG *r0, const BN_ULONG a, const BN_ULONG b)
 194         {
 195         register BN_ULONG h, l, s;
 196         BN_ULONG tab[8], top2b = a >> 30;
 197         register BN_ULONG a1, a2, a4;
 198
 199         a1 = a & (0x3FFFFFFF); a2 = a1 << 1; a4 = a2 << 1;
 200
 201         tab[0] =  0; tab[1] = a1;    tab[2] = a2;    tab[3] = a1^a2;
 202         tab[4] = a4; tab[5] = a1^a4; tab[6] = a2^a4; tab[7] = a1^a2^a4;
 203
 204         s = tab[b       & 0x7]; l  = s;
 205         s = tab[b >>  3 & 0x7]; l ^= s <<  3; h  = s >> 29;
 206         s = tab[b >>  6 & 0x7]; l ^= s <<  6; h ^= s >> 26;
 207         s = tab[b >>  9 & 0x7]; l ^= s <<  9; h ^= s >> 23;
 208         s = tab[b >> 12 & 0x7]; l ^= s << 12; h ^= s >> 20;
 209         s = tab[b >> 15 & 0x7]; l ^= s << 15; h ^= s >> 17;
 210         s = tab[b >> 18 & 0x7]; l ^= s << 18; h ^= s >> 14;
 211         s = tab[b >> 21 & 0x7]; l ^= s << 21; h ^= s >> 11;
 212         s = tab[b >> 24 & 0x7]; l ^= s << 24; h ^= s >>  8;
 213         s = tab[b >> 27 & 0x7]; l ^= s << 27; h ^= s >>  5;
 214         s = tab[b >> 30      ]; l ^= s << 30; h ^= s >>  2;
 215
 216         /* compensate for the top two bits of a */
 217
 218         if (top2b & 01) { l ^= b << 30; h ^= b >> 2; }
 219         if (top2b & 02) { l ^= b << 31; h ^= b >> 1; }
 220
 221         *r1 = h; *r0 = l;
 222         }
 223 #endif
 224 #if defined(SIXTY_FOUR_BIT) || defined(SIXTY_FOUR_BIT_LONG)
 225 static void bn_GF2m_mul_1x1(BN_ULONG *r1, BN_ULONG *r0, const BN_ULONG a, const BN_ULONG b)
 226         {
 227         register BN_ULONG h, l, s;
 228         BN_ULONG tab[16], top3b = a >> 61;
 229         register BN_ULONG a1, a2, a4, a8;
 230
 231         a1 = a & (0x1FFFFFFFFFFFFFFF); a2 = a1 << 1; a4 = a2 << 1; a8 = a4 << 1;
 232
 233         tab[ 0] = 0;     tab[ 1] = a1;       tab[ 2] = a2;       tab[ 3] = a1^a2;
 234         tab[ 4] = a4;    tab[ 5] = a1^a4;    tab[ 6] = a2^a4;    tab[ 7] = a1^a2^a4;
 235         tab[ 8] = a8;    tab[ 9] = a1^a8;    tab[10] = a2^a8;    tab[11] = a1^a2^a8;
 236         tab[12] = a4^a8; tab[13] = a1^a4^a8; tab[14] = a2^a4^a8; tab[15] = a1^a2^a4^a8;
 237
 238         s = tab[b       & 0xF]; l  = s;
 239         s = tab[b >>  4 & 0xF]; l ^= s <<  4; h  = s >> 60;
 240         s = tab[b >>  8 & 0xF]; l ^= s <<  8; h ^= s >> 56;
 241         s = tab[b >> 12 & 0xF]; l ^= s << 12; h ^= s >> 52;
 242         s = tab[b >> 16 & 0xF]; l ^= s << 16; h ^= s >> 48;
 243         s = tab[b >> 20 & 0xF]; l ^= s << 20; h ^= s >> 44;
 244         s = tab[b >> 24 & 0xF]; l ^= s << 24; h ^= s >> 40;
 245         s = tab[b >> 28 & 0xF]; l ^= s << 28; h ^= s >> 36;
 246         s = tab[b >> 32 & 0xF]; l ^= s << 32; h ^= s >> 32;
 247         s = tab[b >> 36 & 0xF]; l ^= s << 36; h ^= s >> 28;
 248         s = tab[b >> 40 & 0xF]; l ^= s << 40; h ^= s >> 24;
 249         s = tab[b >> 44 & 0xF]; l ^= s << 44; h ^= s >> 20;
 250         s = tab[b >> 48 & 0xF]; l ^= s << 48; h ^= s >> 16;
 251         s = tab[b >> 52 & 0xF]; l ^= s << 52; h ^= s >> 12;
 252         s = tab[b >> 56 & 0xF]; l ^= s << 56; h ^= s >>  8;
 253         s = tab[b >> 60      ]; l ^= s << 60; h ^= s >>  4;
 254
 255         /* compensate for the top three bits of a */
 256
 257         if (top3b & 01) { l ^= b << 61; h ^= b >> 3; }
 258         if (top3b & 02) { l ^= b << 62; h ^= b >> 2; }
 259         if (top3b & 04) { l ^= b << 63; h ^= b >> 1; }
 260
 261         *r1 = h; *r0 = l;
 262         }
 263 #endif
 264
 265 /* Product of two polynomials a, b each with degree < 2 * BN_BITS2 - 1,
 266  * result is a polynomial r with degree < 4 * BN_BITS2 - 1
 267  * The caller MUST ensure that the variables have the right amount
 268  * of space allocated.
 269  */
 270 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)
 271         {
 272         BN_ULONG m1, m0;
 273         /* r[3] = h1, r[2] = h0; r[1] = l1; r[0] = l0 */
 274         bn_GF2m_mul_1x1(r+3, r+2, a1, b1);
 275         bn_GF2m_mul_1x1(r+1, r, a0, b0);
 276         bn_GF2m_mul_1x1(&m1, &m0, a0 ^ a1, b0 ^ b1);
 277         /* Correction on m1 ^= l1 ^ h1; m0 ^= l0 ^ h0; */
 278         r[2] ^= m1 ^ r[1] ^ r[3];  /* h0 ^= m1 ^ l1 ^ h1; */
 279         r[1] = r[3] ^ r[2] ^ r[0] ^ m1 ^ m0;  /* l1 ^= l0 ^ h0 ^ m0; */
 280         }
 281
 282
 283 /* Add polynomials a and b and store result in r; r could be a or b, a and b
 284  * could be equal; r is the bitwise XOR of a and b.
 285  */
 286 int     BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b)
 287         {
 288         int i;
 289         const BIGNUM *at, *bt;
 290
 291         bn_check_top(a);
 292         bn_check_top(b);
 293
 294         if (a->top < b->top) { at = b; bt = a; }
 295         else { at = a; bt = b; }
 296
 297         bn_wexpand(r, at->top);
 298
 299         for (i = 0; i < bt->top; i++)
 300                 {
 301                 r->d[i] = at->d[i] ^ bt->d[i];
 302                 }
 303         for (; i < at->top; i++)
 304                 {
 305                 r->d[i] = at->d[i];
 306                 }
 307
 308         r->top = at->top;
 309         bn_correct_top(r);
 310
 311         return 1;
 312         }
 313
 314
 315 /* Some functions allow for representation of the irreducible polynomials
 316  * as an int[], say p.  The irreducible f(t) is then of the form:
 317  *     t^p[0] + t^p[1] + ... + t^p[k]
 318  * where m = p[0] > p[1] > ... > p[k] = 0.
 319  */
 320
 321
 322 /* Performs modular reduction of a and store result in r.  r could be a. */
 323 int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[])
 324         {
 325         int j, k;
 326         int n, dN, d0, d1;
 327         BN_ULONG zz, *z;
 328
 329         bn_check_top(a);
 330
 331         if (!p[0])
 332                 /* reduction mod 1 => return 0 */
 333                 return BN_zero(r);
 334
 335         /* Since the algorithm does reduction in the r value, if a != r, copy
 336          * the contents of a into r so we can do reduction in r.
 337          */
 338         if (a != r)
 339                 {
 340                 if (!bn_wexpand(r, a->top)) return 0;
 341                 for (j = 0; j < a->top; j++)
 342                         {
 343                         r->d[j] = a->d[j];
 344                         }
 345                 r->top = a->top;
 346                 }
 347         z = r->d;
 348
 349         /* start reduction */
 350         dN = p[0] / BN_BITS2;
 351         for (j = r->top - 1; j > dN;)
 352                 {
 353                 zz = z[j];
 354                 if (z[j] == 0) { j--; continue; }
 355                 z[j] = 0;
 356
 357                 for (k = 1; p[k] != 0; k++)
 358                         {
 359                         /* reducing component t^p[k] */
 360                         n = p[0] - p[k];
 361                         d0 = n % BN_BITS2;  d1 = BN_BITS2 - d0;
 362                         n /= BN_BITS2;
 363                         z[j-n] ^= (zz>>d0);
 364                         if (d0) z[j-n-1] ^= (zz<<d1);
 365                         }
 366
 367                 /* reducing component t^0 */
 368                 n = dN;
 369                 d0 = p[0] % BN_BITS2;
 370                 d1 = BN_BITS2 - d0;
 371                 z[j-n] ^= (zz >> d0);
 372                 if (d0) z[j-n-1] ^= (zz << d1);
 373                 }
 374
 375         /* final round of reduction */
 376         while (j == dN)
 377                 {
 378
 379                 d0 = p[0] % BN_BITS2;
 380                 zz = z[dN] >> d0;
 381                 if (zz == 0) break;
 382                 d1 = BN_BITS2 - d0;
 383
 384                 if (d0) z[dN] = (z[dN] << d1) >> d1; /* clear up the top d1 bits */
 385                 z[0] ^= zz; /* reduction t^0 component */
 386
 387                 for (k = 1; p[k] != 0; k++)
 388                         {
 389                         BN_ULONG tmp_ulong;
 390
 391                         /* reducing component t^p[k]*/
 392                         n = p[k] / BN_BITS2;
 393                         d0 = p[k] % BN_BITS2;
 394                         d1 = BN_BITS2 - d0;
 395                         z[n] ^= (zz << d0);
 396                         tmp_ulong = zz >> d1;
 397                         if (d0 && tmp_ulong)
 398                                 z[n+1] ^= tmp_ulong;
 399                         }
 400
 401
 402                 }
 403
 404         bn_correct_top(r);
 405         return 1;
 406         }
 407
 408 /* Performs modular reduction of a by p and store result in r.  r could be a.
 409  *
 410  * This function calls down to the BN_GF2m_mod_arr implementation; this wrapper
 411  * function is only provided for convenience; for best performance, use the
 412  * BN_GF2m_mod_arr function.
 413  */
 414 int     BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p)
 415         {
 416         int ret = 0;
 417         const int max = BN_num_bits(p);
 418         unsigned int *arr=NULL;
 419         bn_check_top(a);
 420         bn_check_top(p);
 421         if ((arr = (unsigned int *)OPENSSL_malloc(sizeof(unsigned int) * max)) == NULL) goto err;
 422         ret = BN_GF2m_poly2arr(p, arr, max);
 423         if (!ret || ret > max)
 424                 {
 425                 BNerr(BN_F_BN_GF2M_MOD,BN_R_INVALID_LENGTH);
 426                 goto err;
 427                 }
 428         ret = BN_GF2m_mod_arr(r, a, arr);
 429         bn_check_top(r);
 430 err:
 431         if (arr) OPENSSL_free(arr);
 432         return ret;
 433         }
 434
 435
 436 /* Compute the product of two polynomials a and b, reduce modulo p, and store
 437  * the result in r.  r could be a or b; a could be b.
 438  */
 439 int     BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const unsigned int p[], BN_CTX *ctx)
 440         {
 441         int zlen, i, j, k, ret = 0;
 442         BIGNUM *s;
 443         BN_ULONG x1, x0, y1, y0, zz[4];
 444
 445         bn_check_top(a);
 446         bn_check_top(b);
 447
 448         if (a == b)
 449                 {
 450                 return BN_GF2m_mod_sqr_arr(r, a, p, ctx);
 451                 }
 452
 453         BN_CTX_start(ctx);
 454         if ((s = BN_CTX_get(ctx)) == NULL) goto err;
 455
 456         zlen = a->top + b->top + 4;
 457         if (!bn_wexpand(s, zlen)) goto err;
 458         s->top = zlen;
 459
 460         for (i = 0; i < zlen; i++) s->d[i] = 0;
 461
 462         for (j = 0; j < b->top; j += 2)
 463                 {
 464                 y0 = b->d[j];
 465                 y1 = ((j+1) == b->top) ? 0 : b->d[j+1];
 466                 for (i = 0; i < a->top; i += 2)
 467                         {
 468                         x0 = a->d[i];
 469                         x1 = ((i+1) == a->top) ? 0 : a->d[i+1];
 470                         bn_GF2m_mul_2x2(zz, x1, x0, y1, y0);
 471                         for (k = 0; k < 4; k++) s->d[i+j+k] ^= zz[k];
 472                         }
 473                 }
 474
 475         bn_correct_top(s);
 476         if (BN_GF2m_mod_arr(r, s, p))
 477                 ret = 1;
 478         bn_check_top(r);
 479
 480 err:
 481         BN_CTX_end(ctx);
 482         return ret;
 483         }
 484
 485 /* Compute the product of two polynomials a and b, reduce modulo p, and store
 486  * the result in r.  r could be a or b; a could equal b.
 487  *
 488  * This function calls down to the BN_GF2m_mod_mul_arr implementation; this wrapper
 489  * function is only provided for convenience; for best performance, use the
 490  * BN_GF2m_mod_mul_arr function.
 491  */
 492 int     BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx)
 493         {
 494         int ret = 0;
 495         const int max = BN_num_bits(p);
 496         unsigned int *arr=NULL;
 497         bn_check_top(a);
 498         bn_check_top(b);
 499         bn_check_top(p);
 500         if ((arr = (unsigned int *)OPENSSL_malloc(sizeof(unsigned int) * max)) == NULL) goto err;
 501         ret = BN_GF2m_poly2arr(p, arr, max);
 502         if (!ret || ret > max)
 503                 {
 504                 BNerr(BN_F_BN_GF2M_MOD_MUL,BN_R_INVALID_LENGTH);
 505                 goto err;
 506                 }
 507         ret = BN_GF2m_mod_mul_arr(r, a, b, arr, ctx);
 508         bn_check_top(r);
 509 err:
 510         if (arr) OPENSSL_free(arr);
 511         return ret;
 512         }
 513
 514
 515 /* Square a, reduce the result mod p, and store it in a.  r could be a. */
 516 int     BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[], BN_CTX *ctx)
 517         {
 518         int i, ret = 0;
 519         BIGNUM *s;
 520
 521         bn_check_top(a);
 522         BN_CTX_start(ctx);
 523         if ((s = BN_CTX_get(ctx)) == NULL) return 0;
 524         if (!bn_wexpand(s, 2 * a->top)) goto err;
 525
 526         for (i = a->top - 1; i >= 0; i--)
 527                 {
 528                 s->d[2*i+1] = SQR1(a->d[i]);
 529                 s->d[2*i  ] = SQR0(a->d[i]);
 530                 }
 531
 532         s->top = 2 * a->top;
 533         bn_correct_top(s);
 534         if (!BN_GF2m_mod_arr(r, s, p)) goto err;
 535         bn_check_top(r);
 536         ret = 1;
 537 err:
 538         BN_CTX_end(ctx);
 539         return ret;
 540         }
 541
 542 /* Square a, reduce the result mod p, and store it in a.  r could be a.
 543  *
 544  * This function calls down to the BN_GF2m_mod_sqr_arr implementation; this wrapper
 545  * function is only provided for convenience; for best performance, use the
 546  * BN_GF2m_mod_sqr_arr function.
 547  */
 548 int     BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
 549         {
 550         int ret = 0;
 551         const int max = BN_num_bits(p);
 552         unsigned int *arr=NULL;
 553
 554         bn_check_top(a);
 555         bn_check_top(p);
 556         if ((arr = (unsigned int *)OPENSSL_malloc(sizeof(unsigned int) * max)) == NULL) goto err;
 557         ret = BN_GF2m_poly2arr(p, arr, max);
 558         if (!ret || ret > max)
 559                 {
 560                 BNerr(BN_F_BN_GF2M_MOD_SQR,BN_R_INVALID_LENGTH);
 561                 goto err;
 562                 }
 563         ret = BN_GF2m_mod_sqr_arr(r, a, arr, ctx);
 564         bn_check_top(r);
 565 err:
 566         if (arr) OPENSSL_free(arr);
 567         return ret;
 568         }
 569
 570
 571 /* Invert a, reduce modulo p, and store the result in r. r could be a.
 572  * Uses Modified Almost Inverse Algorithm (Algorithm 10) from
 573  *     Hankerson, D., Hernandez, J.L., and Menezes, A.  "Software Implementation
 574  *     of Elliptic Curve Cryptography Over Binary Fields".
 575  */
 576 int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
 577         {
 578         BIGNUM *b, *c, *u, *v, *tmp;
 579         int ret = 0;
 580
 581         bn_check_top(a);
 582         bn_check_top(p);
 583
 584         BN_CTX_start(ctx);
 585
 586         b = BN_CTX_get(ctx);
 587         c = BN_CTX_get(ctx);
 588         u = BN_CTX_get(ctx);
 589         v = BN_CTX_get(ctx);
 590         if (v == NULL) goto err;
 591
 592         if (!BN_one(b)) goto err;
 593         if (!BN_zero(c)) goto err;
 594         if (!BN_GF2m_mod(u, a, p)) goto err;
 595         if (!BN_copy(v, p)) goto err;
 596
 597         if (BN_is_zero(u)) goto err;
 598
 599         while (1)
 600                 {
 601                 while (!BN_is_odd(u))
 602                         {
 603                         if (!BN_rshift1(u, u)) goto err;
 604                         if (BN_is_odd(b))
 605                                 {
 606                                 if (!BN_GF2m_add(b, b, p)) goto err;
 607                                 }
 608                         if (!BN_rshift1(b, b)) goto err;
 609                         }
 610
 611                 if (BN_abs_is_word(u, 1)) break;
 612
 613                 if (BN_num_bits(u) < BN_num_bits(v))
 614                         {
 615                         tmp = u; u = v; v = tmp;
 616                         tmp = b; b = c; c = tmp;
 617                         }
 618
 619                 if (!BN_GF2m_add(u, u, v)) goto err;
 620                 if (!BN_GF2m_add(b, b, c)) goto err;
 621                 }
 622
 623
 624         if (!BN_copy(r, b)) goto err;
 625         bn_check_top(r);
 626         ret = 1;
 627
 628 err:
 629         BN_CTX_end(ctx);
 630         return ret;
 631         }
 632
 633 /* Invert xx, reduce modulo p, and store the result in r. r could be xx.
 634  *
 635  * This function calls down to the BN_GF2m_mod_inv implementation; this wrapper
 636  * function is only provided for convenience; for best performance, use the
 637  * BN_GF2m_mod_inv function.
 638  */
 639 int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *xx, const unsigned int p[], BN_CTX *ctx)
 640         {
 641         BIGNUM *field;
 642         int ret = 0;
 643
 644         bn_check_top(xx);
 645         BN_CTX_start(ctx);
 646         if ((field = BN_CTX_get(ctx)) == NULL) goto err;
 647         if (!BN_GF2m_arr2poly(p, field)) goto err;
 648
 649         ret = BN_GF2m_mod_inv(r, xx, field, ctx);
 650         bn_check_top(r);
 651
 652 err:
 653         BN_CTX_end(ctx);
 654         return ret;
 655         }
 656
 657
 658 #ifndef OPENSSL_SUN_GF2M_DIV
 659 /* Divide y by x, reduce modulo p, and store the result in r. r could be x
 660  * or y, x could equal y.
 661  */
 662 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *y, const BIGNUM *x, const BIGNUM *p, BN_CTX *ctx)
 663         {
 664         BIGNUM *xinv = NULL;
 665         int ret = 0;
 666
 667         bn_check_top(y);
 668         bn_check_top(x);
 669         bn_check_top(p);
 670
 671         BN_CTX_start(ctx);
 672         xinv = BN_CTX_get(ctx);
 673         if (xinv == NULL) goto err;
 674
 675         if (!BN_GF2m_mod_inv(xinv, x, p, ctx)) goto err;
 676         if (!BN_GF2m_mod_mul(r, y, xinv, p, ctx)) goto err;
 677         bn_check_top(r);
 678         ret = 1;
 679
 680 err:
 681         BN_CTX_end(ctx);
 682         return ret;
 683         }
 684 #else
 685 /* Divide y by x, reduce modulo p, and store the result in r. r could be x
 686  * or y, x could equal y.
 687  * Uses algorithm Modular_Division_GF(2^m) from
 688  *     Chang-Shantz, S.  "From Euclid's GCD to Montgomery Multiplication to
 689  *     the Great Divide".
 690  */
 691 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *y, const BIGNUM *x, const BIGNUM *p, BN_CTX *ctx)
 692         {
 693         BIGNUM *a, *b, *u, *v;
 694         int ret = 0;
 695
 696         bn_check_top(y);
 697         bn_check_top(x);
 698         bn_check_top(p);
 699
 700         BN_CTX_start(ctx);
 701
 702         a = BN_CTX_get(ctx);
 703         b = BN_CTX_get(ctx);
 704         u = BN_CTX_get(ctx);
 705         v = BN_CTX_get(ctx);
 706         if (v == NULL) goto err;
 707
 708         /* reduce x and y mod p */
 709         if (!BN_GF2m_mod(u, y, p)) goto err;
 710         if (!BN_GF2m_mod(a, x, p)) goto err;
 711         if (!BN_copy(b, p)) goto err;
 712         if (!BN_zero(v)) goto err;
 713
 714         while (!BN_is_odd(a))
 715                 {
 716                 if (!BN_rshift1(a, a)) goto err;
 717                 if (BN_is_odd(u)) if (!BN_GF2m_add(u, u, p)) goto err;
 718                 if (!BN_rshift1(u, u)) goto err;
 719                 }
 720
 721         do
 722                 {
 723                 if (BN_GF2m_cmp(b, a) > 0)
 724                         {
 725                         if (!BN_GF2m_add(b, b, a)) goto err;
 726                         if (!BN_GF2m_add(v, v, u)) goto err;
 727                         do
 728                                 {
 729                                 if (!BN_rshift1(b, b)) goto err;
 730                                 if (BN_is_odd(v)) if (!BN_GF2m_add(v, v, p)) goto err;
 731                                 if (!BN_rshift1(v, v)) goto err;
 732                                 } while (!BN_is_odd(b));
 733                         }
 734                 else if (BN_abs_is_word(a, 1))
 735                         break;
 736                 else
 737                         {
 738                         if (!BN_GF2m_add(a, a, b)) goto err;
 739                         if (!BN_GF2m_add(u, u, v)) goto err;
 740                         do
 741                                 {
 742                                 if (!BN_rshift1(a, a)) goto err;
 743                                 if (BN_is_odd(u)) if (!BN_GF2m_add(u, u, p)) goto err;
 744                                 if (!BN_rshift1(u, u)) goto err;
 745                                 } while (!BN_is_odd(a));
 746                         }
 747                 } while (1);
 748
 749         if (!BN_copy(r, u)) goto err;
 750         bn_check_top(r);
 751         ret = 1;
 752
 753 err:
 754         BN_CTX_end(ctx);
 755         return ret;
 756         }
 757 #endif
 758
 759 /* Divide yy by xx, reduce modulo p, and store the result in r. r could be xx
 760  * or yy, xx could equal yy.
 761  *
 762  * This function calls down to the BN_GF2m_mod_div implementation; this wrapper
 763  * function is only provided for convenience; for best performance, use the
 764  * BN_GF2m_mod_div function.
 765  */
 766 int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *yy, const BIGNUM *xx, const unsigned int p[], BN_CTX *ctx)
 767         {
 768         BIGNUM *field;
 769         int ret = 0;
 770
 771         bn_check_top(yy);
 772         bn_check_top(xx);
 773
 774         BN_CTX_start(ctx);
 775         if ((field = BN_CTX_get(ctx)) == NULL) goto err;
 776         if (!BN_GF2m_arr2poly(p, field)) goto err;
 777
 778         ret = BN_GF2m_mod_div(r, yy, xx, field, ctx);
 779         bn_check_top(r);
 780
 781 err:
 782         BN_CTX_end(ctx);
 783         return ret;
 784         }
 785
 786
 787 /* Compute the bth power of a, reduce modulo p, and store
 788  * the result in r.  r could be a.
 789  * Uses simple square-and-multiply algorithm A.5.1 from IEEE P1363.
 790  */
 791 int     BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const unsigned int p[], BN_CTX *ctx)
 792         {
 793         int ret = 0, i, n;
 794         BIGNUM *u;
 795
 796         bn_check_top(a);
 797         bn_check_top(b);
 798
 799         if (BN_is_zero(b))
 800                 return(BN_one(r));
 801
 802         if (BN_abs_is_word(b, 1))
 803                 return (BN_copy(r, a) != NULL);
 804
 805         BN_CTX_start(ctx);
 806         if ((u = BN_CTX_get(ctx)) == NULL) goto err;
 807
 808         if (!BN_GF2m_mod_arr(u, a, p)) goto err;
 809
 810         n = BN_num_bits(b) - 1;
 811         for (i = n - 1; i >= 0; i--)
 812                 {
 813                 if (!BN_GF2m_mod_sqr_arr(u, u, p, ctx)) goto err;
 814                 if (BN_is_bit_set(b, i))
 815                         {
 816                         if (!BN_GF2m_mod_mul_arr(u, u, a, p, ctx)) goto err;
 817                         }
 818                 }
 819         if (!BN_copy(r, u)) goto err;
 820         bn_check_top(r);
 821         ret = 1;
 822 err:
 823         BN_CTX_end(ctx);
 824         return ret;
 825         }
 826
 827 /* Compute the bth power of a, reduce modulo p, and store
 828  * the result in r.  r could be a.
 829  *
 830  * This function calls down to the BN_GF2m_mod_exp_arr implementation; this wrapper
 831  * function is only provided for convenience; for best performance, use the
 832  * BN_GF2m_mod_exp_arr function.
 833  */
 834 int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx)
 835         {
 836         int ret = 0;
 837         const int max = BN_num_bits(p);
 838         unsigned int *arr=NULL;
 839         bn_check_top(a);
 840         bn_check_top(b);
 841         bn_check_top(p);
 842         if ((arr = (unsigned int *)OPENSSL_malloc(sizeof(unsigned int) * max)) == NULL) goto err;
 843         ret = BN_GF2m_poly2arr(p, arr, max);
 844         if (!ret || ret > max)
 845                 {
 846                 BNerr(BN_F_BN_GF2M_MOD_EXP,BN_R_INVALID_LENGTH);
 847                 goto err;
 848                 }
 849         ret = BN_GF2m_mod_exp_arr(r, a, b, arr, ctx);
 850         bn_check_top(r);
 851 err:
 852         if (arr) OPENSSL_free(arr);
 853         return ret;
 854         }
 855
 856 /* Compute the square root of a, reduce modulo p, and store
 857  * the result in r.  r could be a.
 858  * Uses exponentiation as in algorithm A.4.1 from IEEE P1363.
 859  */
 860 int     BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[], BN_CTX *ctx)
 861         {
 862         int ret = 0;
 863         BIGNUM *u;
 864
 865         bn_check_top(a);
 866
 867         if (!p[0])
 868                 /* reduction mod 1 => return 0 */
 869                 return BN_zero(r);
 870
 871         BN_CTX_start(ctx);
 872         if ((u = BN_CTX_get(ctx)) == NULL) goto err;
 873
 874         if (!BN_zero(u)) goto err;
 875         if (!BN_set_bit(u, p[0] - 1)) goto err;
 876         ret = BN_GF2m_mod_exp_arr(r, a, u, p, ctx);
 877         bn_check_top(r);
 878
 879 err:
 880         BN_CTX_end(ctx);
 881         return ret;
 882         }
 883
 884 /* Compute the square root of a, reduce modulo p, and store
 885  * the result in r.  r could be a.
 886  *
 887  * This function calls down to the BN_GF2m_mod_sqrt_arr implementation; this wrapper
 888  * function is only provided for convenience; for best performance, use the
 889  * BN_GF2m_mod_sqrt_arr function.
 890  */
 891 int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
 892         {
 893         int ret = 0;
 894         const int max = BN_num_bits(p);
 895         unsigned int *arr=NULL;
 896         bn_check_top(a);
 897         bn_check_top(p);
 898         if ((arr = (unsigned int *)OPENSSL_malloc(sizeof(unsigned int) * max)) == NULL) goto err;
 899         ret = BN_GF2m_poly2arr(p, arr, max);
 900         if (!ret || ret > max)
 901                 {
 902                 BNerr(BN_F_BN_GF2M_MOD_EXP,BN_R_INVALID_LENGTH);
 903                 goto err;
 904                 }
 905         ret = BN_GF2m_mod_sqrt_arr(r, a, arr, ctx);
 906         bn_check_top(r);
 907 err:
 908         if (arr) OPENSSL_free(arr);
 909         return ret;
 910         }
 911
 912 /* Find r such that r^2 + r = a mod p.  r could be a. If no r exists returns 0.
 913  * Uses algorithms A.4.7 and A.4.6 from IEEE P1363.
 914  */
 915 int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a_, const unsigned int p[], BN_CTX *ctx)
 916         {
 917         int ret = 0, count = 0;
 918         unsigned int j;
 919         BIGNUM *a, *z, *rho, *w, *w2, *tmp;
 920
 921         bn_check_top(a_);
 922
 923         if (!p[0])
 924                 /* reduction mod 1 => return 0 */
 925                 return BN_zero(r);
 926
 927         BN_CTX_start(ctx);
 928         a = BN_CTX_get(ctx);
 929         z = BN_CTX_get(ctx);
 930         w = BN_CTX_get(ctx);
 931         if (w == NULL) goto err;
 932
 933         if (!BN_GF2m_mod_arr(a, a_, p)) goto err;
 934
 935         if (BN_is_zero(a))
 936                 {
 937                 ret = BN_zero(r);
 938                 goto err;
 939                 }
 940
 941         if (p[0] & 0x1) /* m is odd */
 942                 {
 943                 /* compute half-trace of a */
 944                 if (!BN_copy(z, a)) goto err;
 945                 for (j = 1; j <= (p[0] - 1) / 2; j++)
 946                         {
 947                         if (!BN_GF2m_mod_sqr_arr(z, z, p, ctx)) goto err;
 948                         if (!BN_GF2m_mod_sqr_arr(z, z, p, ctx)) goto err;
 949                         if (!BN_GF2m_add(z, z, a)) goto err;
 950                         }
 951
 952                 }
 953         else /* m is even */
 954                 {
 955                 rho = BN_CTX_get(ctx);
 956                 w2 = BN_CTX_get(ctx);
 957                 tmp = BN_CTX_get(ctx);
 958                 if (tmp == NULL) goto err;
 959                 do
 960                         {
 961                         if (!BN_rand(rho, p[0], 0, 0)) goto err;
 962                         if (!BN_GF2m_mod_arr(rho, rho, p)) goto err;
 963                         if (!BN_zero(z)) goto err;
 964                         if (!BN_copy(w, rho)) goto err;
 965                         for (j = 1; j <= p[0] - 1; j++)
 966                                 {
 967                                 if (!BN_GF2m_mod_sqr_arr(z, z, p, ctx)) goto err;
 968                                 if (!BN_GF2m_mod_sqr_arr(w2, w, p, ctx)) goto err;
 969                                 if (!BN_GF2m_mod_mul_arr(tmp, w2, a, p, ctx)) goto err;
 970                                 if (!BN_GF2m_add(z, z, tmp)) goto err;
 971                                 if (!BN_GF2m_add(w, w2, rho)) goto err;
 972                                 }
 973                         count++;
 974                         } while (BN_is_zero(w) && (count < MAX_ITERATIONS));
 975                 if (BN_is_zero(w))
 976                         {
 977                         BNerr(BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR,BN_R_TOO_MANY_ITERATIONS);
 978                         goto err;
 979                         }
 980                 }
 981
 982         if (!BN_GF2m_mod_sqr_arr(w, z, p, ctx)) goto err;
 983         if (!BN_GF2m_add(w, z, w)) goto err;
 984         if (BN_GF2m_cmp(w, a)) goto err;
 985
 986         if (!BN_copy(r, z)) goto err;
 987         bn_check_top(r);
 988
 989         ret = 1;
 990
 991 err:
 992         BN_CTX_end(ctx);
 993         return ret;
 994         }
 995
 996 /* Find r such that r^2 + r = a mod p.  r could be a. If no r exists returns 0.
 997  *
 998  * This function calls down to the BN_GF2m_mod_solve_quad_arr implementation; this wrapper
 999  * function is only provided for convenience; for best performance, use the
1000  * BN_GF2m_mod_solve_quad_arr function.
1001  */
1002 int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx)
1003         {
1004         int ret = 0;
1005         const int max = BN_num_bits(p);
1006         unsigned int *arr=NULL;
1007         bn_check_top(a);
1008         bn_check_top(p);
1009         if ((arr = (unsigned int *)OPENSSL_malloc(sizeof(unsigned int) *
1010                                                 max)) == NULL) goto err;
1011         ret = BN_GF2m_poly2arr(p, arr, max);
1012         if (!ret || ret > max)
1013                 {
1014                 BNerr(BN_F_BN_GF2M_MOD_SOLVE_QUAD,BN_R_INVALID_LENGTH);
1015                 goto err;
1016                 }
1017         ret = BN_GF2m_mod_solve_quad_arr(r, a, arr, ctx);
1018         bn_check_top(r);
1019 err:
1020         if (arr) OPENSSL_free(arr);
1021         return ret;
1022         }
1023
1024 /* Convert the bit-string representation of a polynomial
1025  * ( \sum_{i=0}^n a_i * x^i , where a_0 is *not* zero) into an array
1026  * of integers corresponding to the bits with non-zero coefficient.
1027  * Up to max elements of the array will be filled.  Return value is total
1028  * number of coefficients that would be extracted if array was large enough.
1029  */
1030 int BN_GF2m_poly2arr(const BIGNUM *a, unsigned int p[], int max)
1031         {
1032         int i, j, k = 0;
1033         BN_ULONG mask;
1034
1035         if (BN_is_zero(a) || !BN_is_bit_set(a, 0))
1036                 /* a_0 == 0 => return error (the unsigned int array
1037                  * must be terminated by 0)
1038                  */
1039                 return 0;
1040
1041         for (i = a->top - 1; i >= 0; i--)
1042                 {
1043                 if (!a->d[i])
1044                         /* skip word if a->d[i] == 0 */
1045                         continue;
1046                 mask = BN_TBIT;
1047                 for (j = BN_BITS2 - 1; j >= 0; j--)
1048                         {
1049                         if (a->d[i] & mask)
1050                                 {
1051                                 if (k < max) p[k] = BN_BITS2 * i + j;
1052                                 k++;
1053                                 }
1054                         mask >>= 1;
1055                         }
1056                 }
1057
1058         return k;
1059         }
1060
1061 /* Convert the coefficient array representation of a polynomial to a
1062  * bit-string.  The array must be terminated by 0.
1063  */
1064 int BN_GF2m_arr2poly(const unsigned int p[], BIGNUM *a)
1065         {
1066         int i;
1067
1068         bn_check_top(a);
1069         BN_zero(a);
1070         for (i = 0; p[i] != 0; i++)
1071                 {
1072                 BN_set_bit(a, p[i]);
1073                 }
1074         BN_set_bit(a, 0);
1075         bn_check_top(a);
1076
1077         return 1;
1078         }
1079