More changes coming out of the bignum auditing. BN_CTX_get() should ideally
[openssl.git] / crypto / bn / bn_ctx.c
1 /* crypto/bn/bn_ctx.c */
2 /* Written by Ulf Moeller for the OpenSSL project. */
3 /* ====================================================================
4  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer. 
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  *
18  * 3. All advertising materials mentioning features or use of this
19  *    software must display the following acknowledgment:
20  *    "This product includes software developed by the OpenSSL Project
21  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
22  *
23  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
24  *    endorse or promote products derived from this software without
25  *    prior written permission. For written permission, please contact
26  *    openssl-core@openssl.org.
27  *
28  * 5. Products derived from this software may not be called "OpenSSL"
29  *    nor may "OpenSSL" appear in their names without prior written
30  *    permission of the OpenSSL Project.
31  *
32  * 6. Redistributions of any form whatsoever must retain the following
33  *    acknowledgment:
34  *    "This product includes software developed by the OpenSSL Project
35  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
36  *
37  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
38  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
39  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
40  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
43  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
45  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
46  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
47  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
48  * OF THE POSSIBILITY OF SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This product includes cryptographic software written by Eric Young
52  * (eay@cryptsoft.com).  This product includes software written by Tim
53  * Hudson (tjh@cryptsoft.com).
54  *
55  */
56
57 #if !defined(BN_CTX_DEBUG) && !defined(BN_DEBUG)
58 #ifndef NDEBUG
59 #define NDEBUG
60 #endif
61 #endif
62
63 #include <stdio.h>
64 #include <assert.h>
65
66 #include "cryptlib.h"
67 #include "bn_lcl.h"
68
69 /* BN_CTX structure details */
70 #define BN_CTX_NUM      32
71 #define BN_CTX_NUM_POS  12
72 struct bignum_ctx
73         {
74         int tos;
75         BIGNUM bn[BN_CTX_NUM];
76         int flags;
77         int depth;
78         int pos[BN_CTX_NUM_POS];
79         int too_many;
80         };
81
82 #ifndef OPENSSL_NO_DEPRECATED
83 void BN_CTX_init(BN_CTX *ctx)
84 #else
85 static void BN_CTX_init(BN_CTX *ctx)
86 #endif
87         {
88 #if 0 /* explicit version */
89         int i;
90         ctx->tos = 0;
91         ctx->flags = 0;
92         ctx->depth = 0;
93         ctx->too_many = 0;
94         for (i = 0; i < BN_CTX_NUM; i++)
95                 BN_init(&(ctx->bn[i]));
96 #else
97         memset(ctx, 0, sizeof *ctx);
98 #endif
99         }
100
101 BN_CTX *BN_CTX_new(void)
102         {
103         BN_CTX *ret;
104
105         ret=(BN_CTX *)OPENSSL_malloc(sizeof(BN_CTX));
106         if (ret == NULL)
107                 {
108                 BNerr(BN_F_BN_CTX_NEW,ERR_R_MALLOC_FAILURE);
109                 return(NULL);
110                 }
111
112         BN_CTX_init(ret);
113         ret->flags=BN_FLG_MALLOCED;
114         return(ret);
115         }
116
117 void BN_CTX_free(BN_CTX *ctx)
118         {
119         int i;
120
121         if (ctx == NULL) return;
122         assert(ctx->depth == 0);
123
124         for (i=0; i < BN_CTX_NUM; i++) {
125                 bn_check_top(&(ctx->bn[i]));
126                 if (ctx->bn[i].d)
127                         BN_clear_free(&(ctx->bn[i]));
128         }
129         if (ctx->flags & BN_FLG_MALLOCED)
130                 OPENSSL_free(ctx);
131         }
132
133 void BN_CTX_start(BN_CTX *ctx)
134         {
135         if (ctx->depth < BN_CTX_NUM_POS)
136                 ctx->pos[ctx->depth] = ctx->tos;
137         ctx->depth++;
138         }
139
140
141 BIGNUM *BN_CTX_get(BN_CTX *ctx)
142         {
143         /* Note: If BN_CTX_get is ever changed to allocate BIGNUMs dynamically,
144          * make sure that if BN_CTX_get fails once it will return NULL again
145          * until BN_CTX_end is called.  (This is so that callers have to check
146          * only the last return value.)
147          */
148         if (ctx->depth > BN_CTX_NUM_POS || ctx->tos >= BN_CTX_NUM)
149                 {
150                 if (!ctx->too_many)
151                         {
152                         BNerr(BN_F_BN_CTX_GET,BN_R_TOO_MANY_TEMPORARY_VARIABLES);
153                         /* disable error code until BN_CTX_end is called: */
154                         ctx->too_many = 1;
155                         }
156                 return NULL;
157                 }
158         /* always return a 'zeroed' bignum */
159         ctx->bn[ctx->tos].top = 0;
160         return (&(ctx->bn[ctx->tos++]));
161         }
162
163 void BN_CTX_end(BN_CTX *ctx)
164         {
165         if (ctx == NULL) return;
166         assert(ctx->depth > 0);
167         if (ctx->depth == 0)
168                 /* should never happen, but we can tolerate it if not in
169                  * debug mode (could be a 'goto err' in the calling function
170                  * before BN_CTX_start was reached) */
171                 BN_CTX_start(ctx);
172
173         ctx->too_many = 0;
174         ctx->depth--;
175         if (ctx->depth < BN_CTX_NUM_POS)
176 #ifndef BN_DEBUG
177                 ctx->tos = ctx->pos[ctx->depth];
178 #else
179                 while(ctx->tos > ctx->pos[ctx->depth])
180                         bn_check_top(&ctx->bn[--(ctx->tos)]);
181 #endif
182         }