crypto/bn/bn_blind.c

   1 /* ====================================================================
   2  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in
  13  *    the documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  * 3. All advertising materials mentioning features or use of this
  17  *    software must display the following acknowledgment:
  18  *    "This product includes software developed by the OpenSSL Project
  19  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  20  *
  21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  22  *    endorse or promote products derived from this software without
  23  *    prior written permission. For written permission, please contact
  24  *    openssl-core@openssl.org.
  25  *
  26  * 5. Products derived from this software may not be called "OpenSSL"
  27  *    nor may "OpenSSL" appear in their names without prior written
  28  *    permission of the OpenSSL Project.
  29  *
  30  * 6. Redistributions of any form whatsoever must retain the following
  31  *    acknowledgment:
  32  *    "This product includes software developed by the OpenSSL Project
  33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  46  * OF THE POSSIBILITY OF SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This product includes cryptographic software written by Eric Young
  50  * (eay@cryptsoft.com).  This product includes software written by Tim
  51  * Hudson (tjh@cryptsoft.com).
  52  *
  53  */
  54 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  55  * All rights reserved.
  56  *
  57  * This package is an SSL implementation written
  58  * by Eric Young (eay@cryptsoft.com).
  59  * The implementation was written so as to conform with Netscapes SSL.
  60  *
  61  * This library is free for commercial and non-commercial use as long as
  62  * the following conditions are aheared to.  The following conditions
  63  * apply to all code found in this distribution, be it the RC4, RSA,
  64  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  65  * included with this distribution is covered by the same copyright terms
  66  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  67  *
  68  * Copyright remains Eric Young's, and as such any Copyright notices in
  69  * the code are not to be removed.
  70  * If this package is used in a product, Eric Young should be given attribution
  71  * as the author of the parts of the library used.
  72  * This can be in the form of a textual message at program startup or
  73  * in documentation (online or textual) provided with the package.
  74  *
  75  * Redistribution and use in source and binary forms, with or without
  76  * modification, are permitted provided that the following conditions
  77  * are met:
  78  * 1. Redistributions of source code must retain the copyright
  79  *    notice, this list of conditions and the following disclaimer.
  80  * 2. Redistributions in binary form must reproduce the above copyright
  81  *    notice, this list of conditions and the following disclaimer in the
  82  *    documentation and/or other materials provided with the distribution.
  83  * 3. All advertising materials mentioning features or use of this software
  84  *    must display the following acknowledgement:
  85  *    "This product includes cryptographic software written by
  86  *     Eric Young (eay@cryptsoft.com)"
  87  *    The word 'cryptographic' can be left out if the rouines from the library
  88  *    being used are not cryptographic related :-).
  89  * 4. If you include any Windows specific code (or a derivative thereof) from
  90  *    the apps directory (application code) you must include an acknowledgement:
  91  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  92  *
  93  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  94  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  95  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  96  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  97  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  98  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  99  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 101  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 102  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 103  * SUCH DAMAGE.
 104  *
 105  * The licence and distribution terms for any publically available version or
 106  * derivative of this code cannot be changed.  i.e. this code cannot simply be
 107  * copied and put under another distribution licence
 108  * [including the GNU Public Licence.]
 109  */
 110
 111 #include <openssl/opensslconf.h>
 112 #include "internal/cryptlib.h"
 113 #include "bn_lcl.h"
 114
 115 #define BN_BLINDING_COUNTER     32
 116
 117 struct bn_blinding_st {
 118     BIGNUM *A;
 119     BIGNUM *Ai;
 120     BIGNUM *e;
 121     BIGNUM *mod;                /* just a reference */
 122     CRYPTO_THREAD_ID tid;
 123     int counter;
 124     unsigned long flags;
 125     BN_MONT_CTX *m_ctx;
 126     int (*bn_mod_exp) (BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 127                        const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 128     CRYPTO_RWLOCK *lock;
 129 };
 130
 131 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod)
 132 {
 133     BN_BLINDING *ret = NULL;
 134
 135     bn_check_top(mod);
 136
 137     if ((ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
 138         BNerr(BN_F_BN_BLINDING_NEW, ERR_R_MALLOC_FAILURE);
 139         return NULL;
 140     }
 141
 142     ret->lock = CRYPTO_THREAD_lock_new();
 143     if (ret->lock == NULL) {
 144         BNerr(BN_F_BN_BLINDING_NEW, ERR_R_MALLOC_FAILURE);
 145         OPENSSL_free(ret);
 146         return NULL;
 147     }
 148
 149     BN_BLINDING_set_current_thread(ret);
 150
 151     if (A != NULL) {
 152         if ((ret->A = BN_dup(A)) == NULL)
 153             goto err;
 154     }
 155
 156     if (Ai != NULL) {
 157         if ((ret->Ai = BN_dup(Ai)) == NULL)
 158             goto err;
 159     }
 160
 161     /* save a copy of mod in the BN_BLINDING structure */
 162     if ((ret->mod = BN_dup(mod)) == NULL)
 163         goto err;
 164
 165     if (BN_get_flags(mod, BN_FLG_CONSTTIME) != 0)
 166         BN_set_flags(ret->mod, BN_FLG_CONSTTIME);
 167
 168     /*
 169      * Set the counter to the special value -1 to indicate that this is
 170      * never-used fresh blinding that does not need updating before first
 171      * use.
 172      */
 173     ret->counter = -1;
 174
 175     return ret;
 176
 177  err:
 178     BN_BLINDING_free(ret);
 179     return NULL;
 180 }
 181
 182 void BN_BLINDING_free(BN_BLINDING *r)
 183 {
 184     if (r == NULL)
 185         return;
 186
 187     BN_free(r->A);
 188     BN_free(r->Ai);
 189     BN_free(r->e);
 190     BN_free(r->mod);
 191     CRYPTO_THREAD_lock_free(r->lock);
 192     OPENSSL_free(r);
 193 }
 194
 195 int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx)
 196 {
 197     int ret = 0;
 198
 199     if ((b->A == NULL) || (b->Ai == NULL)) {
 200         BNerr(BN_F_BN_BLINDING_UPDATE, BN_R_NOT_INITIALIZED);
 201         goto err;
 202     }
 203
 204     if (b->counter == -1)
 205         b->counter = 0;
 206
 207     if (++b->counter == BN_BLINDING_COUNTER && b->e != NULL &&
 208         !(b->flags & BN_BLINDING_NO_RECREATE)) {
 209         /* re-create blinding parameters */
 210         if (!BN_BLINDING_create_param(b, NULL, NULL, ctx, NULL, NULL))
 211             goto err;
 212     } else if (!(b->flags & BN_BLINDING_NO_UPDATE)) {
 213         if (!BN_mod_mul(b->A, b->A, b->A, b->mod, ctx))
 214             goto err;
 215         if (!BN_mod_mul(b->Ai, b->Ai, b->Ai, b->mod, ctx))
 216             goto err;
 217     }
 218
 219     ret = 1;
 220  err:
 221     if (b->counter == BN_BLINDING_COUNTER)
 222         b->counter = 0;
 223     return (ret);
 224 }
 225
 226 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx)
 227 {
 228     return BN_BLINDING_convert_ex(n, NULL, b, ctx);
 229 }
 230
 231 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *ctx)
 232 {
 233     int ret = 1;
 234
 235     bn_check_top(n);
 236
 237     if ((b->A == NULL) || (b->Ai == NULL)) {
 238         BNerr(BN_F_BN_BLINDING_CONVERT_EX, BN_R_NOT_INITIALIZED);
 239         return (0);
 240     }
 241
 242     if (b->counter == -1)
 243         /* Fresh blinding, doesn't need updating. */
 244         b->counter = 0;
 245     else if (!BN_BLINDING_update(b, ctx))
 246         return (0);
 247
 248     if (r != NULL) {
 249         if (!BN_copy(r, b->Ai))
 250             ret = 0;
 251     }
 252
 253     if (!BN_mod_mul(n, n, b->A, b->mod, ctx))
 254         ret = 0;
 255
 256     return ret;
 257 }
 258
 259 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx)
 260 {
 261     return BN_BLINDING_invert_ex(n, NULL, b, ctx);
 262 }
 263
 264 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
 265                           BN_CTX *ctx)
 266 {
 267     int ret;
 268
 269     bn_check_top(n);
 270
 271     if (r != NULL)
 272         ret = BN_mod_mul(n, n, r, b->mod, ctx);
 273     else {
 274         if (b->Ai == NULL) {
 275             BNerr(BN_F_BN_BLINDING_INVERT_EX, BN_R_NOT_INITIALIZED);
 276             return (0);
 277         }
 278         ret = BN_mod_mul(n, n, b->Ai, b->mod, ctx);
 279     }
 280
 281     bn_check_top(n);
 282     return (ret);
 283 }
 284
 285 int BN_BLINDING_is_current_thread(BN_BLINDING *b)
 286 {
 287     return CRYPTO_THREAD_compare_id(CRYPTO_THREAD_get_current_id(), b->tid);
 288 }
 289
 290 void BN_BLINDING_set_current_thread(BN_BLINDING *b)
 291 {
 292     b->tid = CRYPTO_THREAD_get_current_id();
 293 }
 294
 295 int BN_BLINDING_lock(BN_BLINDING *b)
 296 {
 297     return CRYPTO_THREAD_write_lock(b->lock);
 298 }
 299
 300 int BN_BLINDING_unlock(BN_BLINDING *b)
 301 {
 302     return CRYPTO_THREAD_unlock(b->lock);
 303 }
 304
 305 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *b)
 306 {
 307     return b->flags;
 308 }
 309
 310 void BN_BLINDING_set_flags(BN_BLINDING *b, unsigned long flags)
 311 {
 312     b->flags = flags;
 313 }
 314
 315 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
 316                                       const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
 317                                       int (*bn_mod_exp) (BIGNUM *r,
 318                                                          const BIGNUM *a,
 319                                                          const BIGNUM *p,
 320                                                          const BIGNUM *m,
 321                                                          BN_CTX *ctx,
 322                                                          BN_MONT_CTX *m_ctx),
 323                                       BN_MONT_CTX *m_ctx)
 324 {
 325     int retry_counter = 32;
 326     BN_BLINDING *ret = NULL;
 327
 328     if (b == NULL)
 329         ret = BN_BLINDING_new(NULL, NULL, m);
 330     else
 331         ret = b;
 332
 333     if (ret == NULL)
 334         goto err;
 335
 336     if (ret->A == NULL && (ret->A = BN_new()) == NULL)
 337         goto err;
 338     if (ret->Ai == NULL && (ret->Ai = BN_new()) == NULL)
 339         goto err;
 340
 341     if (e != NULL) {
 342         BN_free(ret->e);
 343         ret->e = BN_dup(e);
 344     }
 345     if (ret->e == NULL)
 346         goto err;
 347
 348     if (bn_mod_exp != NULL)
 349         ret->bn_mod_exp = bn_mod_exp;
 350     if (m_ctx != NULL)
 351         ret->m_ctx = m_ctx;
 352
 353     do {
 354         int rv;
 355         if (!BN_rand_range(ret->A, ret->mod))
 356             goto err;
 357         if (!int_bn_mod_inverse(ret->Ai, ret->A, ret->mod, ctx, &rv)) {
 358             /*
 359              * this should almost never happen for good RSA keys
 360              */
 361             if (rv) {
 362                 if (retry_counter-- == 0) {
 363                     BNerr(BN_F_BN_BLINDING_CREATE_PARAM,
 364                           BN_R_TOO_MANY_ITERATIONS);
 365                     goto err;
 366                 }
 367             } else
 368                 goto err;
 369         } else
 370             break;
 371     } while (1);
 372
 373     if (ret->bn_mod_exp != NULL && ret->m_ctx != NULL) {
 374         if (!ret->bn_mod_exp
 375             (ret->A, ret->A, ret->e, ret->mod, ctx, ret->m_ctx))
 376             goto err;
 377     } else {
 378         if (!BN_mod_exp(ret->A, ret->A, ret->e, ret->mod, ctx))
 379             goto err;
 380     }
 381
 382     return ret;
 383  err:
 384     if (b == NULL) {
 385         BN_BLINDING_free(ret);
 386         ret = NULL;
 387     }
 388
 389     return ret;
 390 }