crypto/bn/bn_ctx.c

   1 /*
   2  * Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <openssl/trace.h>
  11 #include "internal/cryptlib.h"
  12 #include "bn_lcl.h"
  13
  14 /*-
  15  * TODO list
  16  *
  17  * 1. Check a bunch of "(words+1)" type hacks in various bignum functions and
  18  * check they can be safely removed.
  19  *  - Check +1 and other ugliness in BN_from_montgomery()
  20  *
  21  * 2. Consider allowing a BN_new_ex() that, at least, lets you specify an
  22  * appropriate 'block' size that will be honoured by bn_expand_internal() to
  23  * prevent piddly little reallocations. OTOH, profiling bignum expansions in
  24  * BN_CTX doesn't show this to be a big issue.
  25  */
  26
  27 /* How many bignums are in each "pool item"; */
  28 #define BN_CTX_POOL_SIZE        16
  29 /* The stack frame info is resizing, set a first-time expansion size; */
  30 #define BN_CTX_START_FRAMES     32
  31
  32 /***********/
  33 /* BN_POOL */
  34 /***********/
  35
  36 /* A bundle of bignums that can be linked with other bundles */
  37 typedef struct bignum_pool_item {
  38     /* The bignum values */
  39     BIGNUM vals[BN_CTX_POOL_SIZE];
  40     /* Linked-list admin */
  41     struct bignum_pool_item *prev, *next;
  42 } BN_POOL_ITEM;
  43 /* A linked-list of bignums grouped in bundles */
  44 typedef struct bignum_pool {
  45     /* Linked-list admin */
  46     BN_POOL_ITEM *head, *current, *tail;
  47     /* Stack depth and allocation size */
  48     unsigned used, size;
  49 } BN_POOL;
  50 static void BN_POOL_init(BN_POOL *);
  51 static void BN_POOL_finish(BN_POOL *);
  52 static BIGNUM *BN_POOL_get(BN_POOL *, int);
  53 static void BN_POOL_release(BN_POOL *, unsigned int);
  54
  55 /************/
  56 /* BN_STACK */
  57 /************/
  58
  59 /* A wrapper to manage the "stack frames" */
  60 typedef struct bignum_ctx_stack {
  61     /* Array of indexes into the bignum stack */
  62     unsigned int *indexes;
  63     /* Number of stack frames, and the size of the allocated array */
  64     unsigned int depth, size;
  65 } BN_STACK;
  66 static void BN_STACK_init(BN_STACK *);
  67 static void BN_STACK_finish(BN_STACK *);
  68 static int BN_STACK_push(BN_STACK *, unsigned int);
  69 static unsigned int BN_STACK_pop(BN_STACK *);
  70
  71 /**********/
  72 /* BN_CTX */
  73 /**********/
  74
  75 /* The opaque BN_CTX type */
  76 struct bignum_ctx {
  77     /* The bignum bundles */
  78     BN_POOL pool;
  79     /* The "stack frames", if you will */
  80     BN_STACK stack;
  81     /* The number of bignums currently assigned */
  82     unsigned int used;
  83     /* Depth of stack overflow */
  84     int err_stack;
  85     /* Block "gets" until an "end" (compatibility behaviour) */
  86     int too_many;
  87     /* Flags. */
  88     int flags;
  89 };
  90
  91 /* Debugging functionality */
  92 static void ctxdbg(BIO *channel, const char *text, BN_CTX *ctx)
  93 {
  94     unsigned int bnidx = 0, fpidx = 0;
  95     BN_POOL_ITEM *item = ctx->pool.head;
  96     BN_STACK *stack = &ctx->stack;
  97
  98     BIO_printf(channel, "%s\n", text);
  99     BIO_printf(channel, "  (%16p): ", (void*)ctx);
 100     while (bnidx < ctx->used) {
 101         BIO_printf(channel, "%03x ",
 102                    item->vals[bnidx++ % BN_CTX_POOL_SIZE].dmax);
 103         if (!(bnidx % BN_CTX_POOL_SIZE))
 104             item = item->next;
 105     }
 106     BIO_printf(channel, "\n");
 107     bnidx = 0;
 108     BIO_printf(channel, "   %16s : ", "");
 109     while (fpidx < stack->depth) {
 110         while (bnidx++ < stack->indexes[fpidx])
 111             BIO_printf(channel, "    ");
 112         BIO_printf(channel, "^^^ ");
 113         bnidx++;
 114         fpidx++;
 115     }
 116     BIO_printf(channel, "\n");
 117 }
 118
 119 #define CTXDBG(str, ctx)            \
 120     OSSL_TRACE_BEGIN(BN_CTX) {      \
 121         ctxdbg(trc_out, str, ctx);  \
 122     } OSSL_TRACE_END(BN_CTX)
 123
 124
 125 BN_CTX *BN_CTX_new(void)
 126 {
 127     BN_CTX *ret;
 128
 129     if ((ret = OPENSSL_zalloc(sizeof(*ret))) == NULL) {
 130         BNerr(BN_F_BN_CTX_NEW, ERR_R_MALLOC_FAILURE);
 131         return NULL;
 132     }
 133     /* Initialise the structure */
 134     BN_POOL_init(&ret->pool);
 135     BN_STACK_init(&ret->stack);
 136     return ret;
 137 }
 138
 139 BN_CTX *BN_CTX_secure_new(void)
 140 {
 141     BN_CTX *ret = BN_CTX_new();
 142
 143     if (ret != NULL)
 144         ret->flags = BN_FLG_SECURE;
 145     return ret;
 146 }
 147
 148 void BN_CTX_free(BN_CTX *ctx)
 149 {
 150     if (ctx == NULL)
 151         return;
 152     OSSL_TRACE_BEGIN(BN_CTX) {
 153         BN_POOL_ITEM *pool = ctx->pool.head;
 154         BIO_printf(trc_out,
 155                    "BN_CTX_free(): stack-size=%d, pool-bignums=%d\n",
 156                    ctx->stack.size, ctx->pool.size);
 157         BIO_printf(trc_out, "  dmaxs: ");
 158         while (pool) {
 159             unsigned loop = 0;
 160             while (loop < BN_CTX_POOL_SIZE)
 161                 BIO_printf(trc_out, "%02x ", pool->vals[loop++].dmax);
 162             pool = pool->next;
 163         }
 164         BIO_printf(trc_out, "\n");
 165     } OSSL_TRACE_END(BN_CTX);
 166     BN_STACK_finish(&ctx->stack);
 167     BN_POOL_finish(&ctx->pool);
 168     OPENSSL_free(ctx);
 169 }
 170
 171 void BN_CTX_start(BN_CTX *ctx)
 172 {
 173     CTXDBG("ENTER BN_CTX_start()", ctx);
 174     /* If we're already overflowing ... */
 175     if (ctx->err_stack || ctx->too_many)
 176         ctx->err_stack++;
 177     /* (Try to) get a new frame pointer */
 178     else if (!BN_STACK_push(&ctx->stack, ctx->used)) {
 179         BNerr(BN_F_BN_CTX_START, BN_R_TOO_MANY_TEMPORARY_VARIABLES);
 180         ctx->err_stack++;
 181     }
 182     CTXDBG("LEAVE BN_CTX_start()", ctx);
 183 }
 184
 185 void BN_CTX_end(BN_CTX *ctx)
 186 {
 187     CTXDBG("ENTER BN_CTX_end()", ctx);
 188     if (ctx->err_stack)
 189         ctx->err_stack--;
 190     else {
 191         unsigned int fp = BN_STACK_pop(&ctx->stack);
 192         /* Does this stack frame have anything to release? */
 193         if (fp < ctx->used)
 194             BN_POOL_release(&ctx->pool, ctx->used - fp);
 195         ctx->used = fp;
 196         /* Unjam "too_many" in case "get" had failed */
 197         ctx->too_many = 0;
 198     }
 199     CTXDBG("LEAVE BN_CTX_end()", ctx);
 200 }
 201
 202 BIGNUM *BN_CTX_get(BN_CTX *ctx)
 203 {
 204     BIGNUM *ret;
 205
 206     CTXDBG("ENTER BN_CTX_get()", ctx);
 207     if (ctx->err_stack || ctx->too_many)
 208         return NULL;
 209     if ((ret = BN_POOL_get(&ctx->pool, ctx->flags)) == NULL) {
 210         /*
 211          * Setting too_many prevents repeated "get" attempts from cluttering
 212          * the error stack.
 213          */
 214         ctx->too_many = 1;
 215         BNerr(BN_F_BN_CTX_GET, BN_R_TOO_MANY_TEMPORARY_VARIABLES);
 216         return NULL;
 217     }
 218     /* OK, make sure the returned bignum is "zero" */
 219     BN_zero(ret);
 220     /* clear BN_FLG_CONSTTIME if leaked from previous frames */
 221     ret->flags &= (~BN_FLG_CONSTTIME);
 222     ctx->used++;
 223     CTXDBG("LEAVE BN_CTX_get()", ctx);
 224     return ret;
 225 }
 226
 227 /************/
 228 /* BN_STACK */
 229 /************/
 230
 231 static void BN_STACK_init(BN_STACK *st)
 232 {
 233     st->indexes = NULL;
 234     st->depth = st->size = 0;
 235 }
 236
 237 static void BN_STACK_finish(BN_STACK *st)
 238 {
 239     OPENSSL_free(st->indexes);
 240     st->indexes = NULL;
 241 }
 242
 243
 244 static int BN_STACK_push(BN_STACK *st, unsigned int idx)
 245 {
 246     if (st->depth == st->size) {
 247         /* Need to expand */
 248         unsigned int newsize =
 249             st->size ? (st->size * 3 / 2) : BN_CTX_START_FRAMES;
 250         unsigned int *newitems;
 251
 252         if ((newitems = OPENSSL_malloc(sizeof(*newitems) * newsize)) == NULL) {
 253             BNerr(BN_F_BN_STACK_PUSH, ERR_R_MALLOC_FAILURE);
 254             return 0;
 255         }
 256         if (st->depth)
 257             memcpy(newitems, st->indexes, sizeof(*newitems) * st->depth);
 258         OPENSSL_free(st->indexes);
 259         st->indexes = newitems;
 260         st->size = newsize;
 261     }
 262     st->indexes[(st->depth)++] = idx;
 263     return 1;
 264 }
 265
 266 static unsigned int BN_STACK_pop(BN_STACK *st)
 267 {
 268     return st->indexes[--(st->depth)];
 269 }
 270
 271 /***********/
 272 /* BN_POOL */
 273 /***********/
 274
 275 static void BN_POOL_init(BN_POOL *p)
 276 {
 277     p->head = p->current = p->tail = NULL;
 278     p->used = p->size = 0;
 279 }
 280
 281 static void BN_POOL_finish(BN_POOL *p)
 282 {
 283     unsigned int loop;
 284     BIGNUM *bn;
 285
 286     while (p->head) {
 287         for (loop = 0, bn = p->head->vals; loop++ < BN_CTX_POOL_SIZE; bn++)
 288             if (bn->d)
 289                 BN_clear_free(bn);
 290         p->current = p->head->next;
 291         OPENSSL_free(p->head);
 292         p->head = p->current;
 293     }
 294 }
 295
 296
 297 static BIGNUM *BN_POOL_get(BN_POOL *p, int flag)
 298 {
 299     BIGNUM *bn;
 300     unsigned int loop;
 301
 302     /* Full; allocate a new pool item and link it in. */
 303     if (p->used == p->size) {
 304         BN_POOL_ITEM *item;
 305
 306         if ((item = OPENSSL_malloc(sizeof(*item))) == NULL) {
 307             BNerr(BN_F_BN_POOL_GET, ERR_R_MALLOC_FAILURE);
 308             return NULL;
 309         }
 310         for (loop = 0, bn = item->vals; loop++ < BN_CTX_POOL_SIZE; bn++) {
 311             bn_init(bn);
 312             if ((flag & BN_FLG_SECURE) != 0)
 313                 BN_set_flags(bn, BN_FLG_SECURE);
 314         }
 315         item->prev = p->tail;
 316         item->next = NULL;
 317
 318         if (p->head == NULL)
 319             p->head = p->current = p->tail = item;
 320         else {
 321             p->tail->next = item;
 322             p->tail = item;
 323             p->current = item;
 324         }
 325         p->size += BN_CTX_POOL_SIZE;
 326         p->used++;
 327         /* Return the first bignum from the new pool */
 328         return item->vals;
 329     }
 330
 331     if (!p->used)
 332         p->current = p->head;
 333     else if ((p->used % BN_CTX_POOL_SIZE) == 0)
 334         p->current = p->current->next;
 335     return p->current->vals + ((p->used++) % BN_CTX_POOL_SIZE);
 336 }
 337
 338 static void BN_POOL_release(BN_POOL *p, unsigned int num)
 339 {
 340     unsigned int offset = (p->used - 1) % BN_CTX_POOL_SIZE;
 341
 342     p->used -= num;
 343     while (num--) {
 344         bn_check_top(p->current->vals + offset);
 345         if (offset == 0) {
 346             offset = BN_CTX_POOL_SIZE - 1;
 347             p->current = p->current->prev;
 348         } else
 349             offset--;
 350     }
 351 }