crypto/bn/bn_recp.c

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57
  58 #include "internal/cryptlib.h"
  59 #include "bn_lcl.h"
  60
  61 void BN_RECP_CTX_init(BN_RECP_CTX *recp)
  62 {
  63     bn_init(&(recp->N));
  64     bn_init(&(recp->Nr));
  65     recp->num_bits = 0;
  66     recp->flags = 0;
  67 }
  68
  69 BN_RECP_CTX *BN_RECP_CTX_new(void)
  70 {
  71     BN_RECP_CTX *ret;
  72
  73     if ((ret = OPENSSL_zalloc(sizeof(*ret))) == NULL)
  74         return (NULL);
  75
  76     BN_RECP_CTX_init(ret);
  77     ret->flags = BN_FLG_MALLOCED;
  78     return (ret);
  79 }
  80
  81 void BN_RECP_CTX_free(BN_RECP_CTX *recp)
  82 {
  83     if (recp == NULL)
  84         return;
  85
  86     BN_free(&(recp->N));
  87     BN_free(&(recp->Nr));
  88     if (recp->flags & BN_FLG_MALLOCED)
  89         OPENSSL_free(recp);
  90 }
  91
  92 int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *d, BN_CTX *ctx)
  93 {
  94     if (!BN_copy(&(recp->N), d))
  95         return 0;
  96     BN_zero(&(recp->Nr));
  97     recp->num_bits = BN_num_bits(d);
  98     recp->shift = 0;
  99     return (1);
 100 }
 101
 102 int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
 103                           BN_RECP_CTX *recp, BN_CTX *ctx)
 104 {
 105     int ret = 0;
 106     BIGNUM *a;
 107     const BIGNUM *ca;
 108
 109     BN_CTX_start(ctx);
 110     if ((a = BN_CTX_get(ctx)) == NULL)
 111         goto err;
 112     if (y != NULL) {
 113         if (x == y) {
 114             if (!BN_sqr(a, x, ctx))
 115                 goto err;
 116         } else {
 117             if (!BN_mul(a, x, y, ctx))
 118                 goto err;
 119         }
 120         ca = a;
 121     } else
 122         ca = x;                 /* Just do the mod */
 123
 124     ret = BN_div_recp(NULL, r, ca, recp, ctx);
 125  err:
 126     BN_CTX_end(ctx);
 127     bn_check_top(r);
 128     return (ret);
 129 }
 130
 131 int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
 132                 BN_RECP_CTX *recp, BN_CTX *ctx)
 133 {
 134     int i, j, ret = 0;
 135     BIGNUM *a, *b, *d, *r;
 136
 137     BN_CTX_start(ctx);
 138     a = BN_CTX_get(ctx);
 139     b = BN_CTX_get(ctx);
 140     if (dv != NULL)
 141         d = dv;
 142     else
 143         d = BN_CTX_get(ctx);
 144     if (rem != NULL)
 145         r = rem;
 146     else
 147         r = BN_CTX_get(ctx);
 148     if (a == NULL || b == NULL || d == NULL || r == NULL)
 149         goto err;
 150
 151     if (BN_ucmp(m, &(recp->N)) < 0) {
 152         BN_zero(d);
 153         if (!BN_copy(r, m)) {
 154             BN_CTX_end(ctx);
 155             return 0;
 156         }
 157         BN_CTX_end(ctx);
 158         return (1);
 159     }
 160
 161     /*
 162      * We want the remainder Given input of ABCDEF / ab we need multiply
 163      * ABCDEF by 3 digests of the reciprocal of ab
 164      */
 165
 166     /* i := max(BN_num_bits(m), 2*BN_num_bits(N)) */
 167     i = BN_num_bits(m);
 168     j = recp->num_bits << 1;
 169     if (j > i)
 170         i = j;
 171
 172     /* Nr := round(2^i / N) */
 173     if (i != recp->shift)
 174         recp->shift = BN_reciprocal(&(recp->Nr), &(recp->N), i, ctx);
 175     /* BN_reciprocal could have returned -1 for an error */
 176     if (recp->shift == -1)
 177         goto err;
 178
 179     /*-
 180      * d := |round(round(m / 2^BN_num_bits(N)) * recp->Nr / 2^(i - BN_num_bits(N)))|
 181      *    = |round(round(m / 2^BN_num_bits(N)) * round(2^i / N) / 2^(i - BN_num_bits(N)))|
 182      *   <= |(m / 2^BN_num_bits(N)) * (2^i / N) * (2^BN_num_bits(N) / 2^i)|
 183      *    = |m/N|
 184      */
 185     if (!BN_rshift(a, m, recp->num_bits))
 186         goto err;
 187     if (!BN_mul(b, a, &(recp->Nr), ctx))
 188         goto err;
 189     if (!BN_rshift(d, b, i - recp->num_bits))
 190         goto err;
 191     d->neg = 0;
 192
 193     if (!BN_mul(b, &(recp->N), d, ctx))
 194         goto err;
 195     if (!BN_usub(r, m, b))
 196         goto err;
 197     r->neg = 0;
 198
 199     j = 0;
 200     while (BN_ucmp(r, &(recp->N)) >= 0) {
 201         if (j++ > 2) {
 202             BNerr(BN_F_BN_DIV_RECP, BN_R_BAD_RECIPROCAL);
 203             goto err;
 204         }
 205         if (!BN_usub(r, r, &(recp->N)))
 206             goto err;
 207         if (!BN_add_word(d, 1))
 208             goto err;
 209     }
 210
 211     r->neg = BN_is_zero(r) ? 0 : m->neg;
 212     d->neg = m->neg ^ recp->N.neg;
 213     ret = 1;
 214  err:
 215     BN_CTX_end(ctx);
 216     bn_check_top(dv);
 217     bn_check_top(rem);
 218     return (ret);
 219 }
 220
 221 /*
 222  * len is the expected size of the result We actually calculate with an extra
 223  * word of precision, so we can do faster division if the remainder is not
 224  * required.
 225  */
 226 /* r := 2^len / m */
 227 int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx)
 228 {
 229     int ret = -1;
 230     BIGNUM *t;
 231
 232     BN_CTX_start(ctx);
 233     if ((t = BN_CTX_get(ctx)) == NULL)
 234         goto err;
 235
 236     if (!BN_set_bit(t, len))
 237         goto err;
 238
 239     if (!BN_div(r, NULL, t, m, ctx))
 240         goto err;
 241
 242     ret = len;
 243  err:
 244     bn_check_top(r);
 245     BN_CTX_end(ctx);
 246     return (ret);
 247 }