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