cd03dae77e45194554c489be3f74270092f401e1
[openssl.git] / crypto / bn / bn.h
1 /* crypto/bn/bn.h */
2 /* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 /* ====================================================================
59  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60  *
61  * Portions of the attached software ("Contribution") are developed by 
62  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
63  *
64  * The Contribution is licensed pursuant to the Eric Young open source
65  * license provided above.
66  *
67  * The binary polynomial arithmetic software is originally written by 
68  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
69  *
70  */
71
72 #ifndef HEADER_BN_H
73 #define HEADER_BN_H
74
75 #include <openssl/e_os2.h>
76 #ifndef OPENSSL_NO_FP_API
77 #include <stdio.h> /* FILE */
78 #endif
79 #include <openssl/ossl_typ.h>
80
81 #ifdef  __cplusplus
82 extern "C" {
83 #endif
84
85 /* These preprocessor symbols control various aspects of the bignum headers and
86  * library code. They're not defined by any "normal" configuration, as they are
87  * intended for development and testing purposes. NB: defining all three can be
88  * useful for debugging application code as well as openssl itself.
89  *
90  * BN_DEBUG - turn on various debugging alterations to the bignum code
91  * BN_DEBUG_RAND - uses random poisoning of unused words to trip up
92  * mismanagement of bignum internals. You must also define BN_DEBUG.
93  */
94 /* #define BN_DEBUG */
95 /* #define BN_DEBUG_RAND */
96
97 #ifdef OPENSSL_SYS_VMS
98 #undef BN_LLONG /* experimental, so far... */
99 #endif
100
101 #define BN_MUL_COMBA
102 #define BN_SQR_COMBA
103 #define BN_RECURSION
104
105 /* This next option uses the C libraries (2 word)/(1 word) function.
106  * If it is not defined, I use my C version (which is slower).
107  * The reason for this flag is that when the particular C compiler
108  * library routine is used, and the library is linked with a different
109  * compiler, the library is missing.  This mostly happens when the
110  * library is built with gcc and then linked using normal cc.  This would
111  * be a common occurrence because gcc normally produces code that is
112  * 2 times faster than system compilers for the big number stuff.
113  * For machines with only one compiler (or shared libraries), this should
114  * be on.  Again this in only really a problem on machines
115  * using "long long's", are 32bit, and are not using my assembler code. */
116 #if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || \
117     defined(OPENSSL_SYS_WIN32) || defined(linux)
118 # ifndef BN_DIV2W
119 #  define BN_DIV2W
120 # endif
121 #endif
122
123 /* assuming long is 64bit - this is the DEC Alpha
124  * unsigned long long is only 64 bits :-(, don't define
125  * BN_LLONG for the DEC Alpha */
126 #ifdef SIXTY_FOUR_BIT_LONG
127 #define BN_ULLONG       unsigned long long
128 #define BN_ULONG        unsigned long
129 #define BN_LONG         long
130 #define BN_BITS         128
131 #define BN_BYTES        8
132 #define BN_BITS2        64
133 #define BN_BITS4        32
134 #define BN_MASK         (0xffffffffffffffffffffffffffffffffLL)
135 #define BN_MASK2        (0xffffffffffffffffL)
136 #define BN_MASK2l       (0xffffffffL)
137 #define BN_MASK2h       (0xffffffff00000000L)
138 #define BN_MASK2h1      (0xffffffff80000000L)
139 #define BN_TBIT         (0x8000000000000000L)
140 #define BN_DEC_CONV     (10000000000000000000UL)
141 #define BN_DEC_FMT1     "%lu"
142 #define BN_DEC_FMT2     "%019lu"
143 #define BN_DEC_NUM      19
144 #endif
145
146 /* This is where the long long data type is 64 bits, but long is 32.
147  * For machines where there are 64bit registers, this is the mode to use.
148  * IRIX, on R4000 and above should use this mode, along with the relevant
149  * assembler code :-).  Do NOT define BN_LLONG.
150  */
151 #ifdef SIXTY_FOUR_BIT
152 #undef BN_LLONG
153 #undef BN_ULLONG
154 #define BN_ULONG        unsigned long long
155 #define BN_LONG         long long
156 #define BN_BITS         128
157 #define BN_BYTES        8
158 #define BN_BITS2        64
159 #define BN_BITS4        32
160 #define BN_MASK2        (0xffffffffffffffffLL)
161 #define BN_MASK2l       (0xffffffffL)
162 #define BN_MASK2h       (0xffffffff00000000LL)
163 #define BN_MASK2h1      (0xffffffff80000000LL)
164 #define BN_TBIT         (0x8000000000000000LL)
165 #define BN_DEC_CONV     (10000000000000000000ULL)
166 #define BN_DEC_FMT1     "%llu"
167 #define BN_DEC_FMT2     "%019llu"
168 #define BN_DEC_NUM      19
169 #endif
170
171 #ifdef THIRTY_TWO_BIT
172 #if defined(OPENSSL_SYS_WIN32) && !defined(__GNUC__)
173 #define BN_ULLONG       unsigned _int64
174 #else
175 #define BN_ULLONG       unsigned long long
176 #endif
177 #define BN_ULONG        unsigned long
178 #define BN_LONG         long
179 #define BN_BITS         64
180 #define BN_BYTES        4
181 #define BN_BITS2        32
182 #define BN_BITS4        16
183 #ifdef OPENSSL_SYS_WIN32
184 /* VC++ doesn't like the LL suffix */
185 #define BN_MASK         (0xffffffffffffffffL)
186 #else
187 #define BN_MASK         (0xffffffffffffffffLL)
188 #endif
189 #define BN_MASK2        (0xffffffffL)
190 #define BN_MASK2l       (0xffff)
191 #define BN_MASK2h1      (0xffff8000L)
192 #define BN_MASK2h       (0xffff0000L)
193 #define BN_TBIT         (0x80000000L)
194 #define BN_DEC_CONV     (1000000000L)
195 #define BN_DEC_FMT1     "%lu"
196 #define BN_DEC_FMT2     "%09lu"
197 #define BN_DEC_NUM      9
198 #endif
199
200 #ifdef SIXTEEN_BIT
201 #ifndef BN_DIV2W
202 #define BN_DIV2W
203 #endif
204 #define BN_ULLONG       unsigned long
205 #define BN_ULONG        unsigned short
206 #define BN_LONG         short
207 #define BN_BITS         32
208 #define BN_BYTES        2
209 #define BN_BITS2        16
210 #define BN_BITS4        8
211 #define BN_MASK         (0xffffffff)
212 #define BN_MASK2        (0xffff)
213 #define BN_MASK2l       (0xff)
214 #define BN_MASK2h1      (0xff80)
215 #define BN_MASK2h       (0xff00)
216 #define BN_TBIT         (0x8000)
217 #define BN_DEC_CONV     (100000)
218 #define BN_DEC_FMT1     "%u"
219 #define BN_DEC_FMT2     "%05u"
220 #define BN_DEC_NUM      5
221 #endif
222
223 #ifdef EIGHT_BIT
224 #ifndef BN_DIV2W
225 #define BN_DIV2W
226 #endif
227 #define BN_ULLONG       unsigned short
228 #define BN_ULONG        unsigned char
229 #define BN_LONG         char
230 #define BN_BITS         16
231 #define BN_BYTES        1
232 #define BN_BITS2        8
233 #define BN_BITS4        4
234 #define BN_MASK         (0xffff)
235 #define BN_MASK2        (0xff)
236 #define BN_MASK2l       (0xf)
237 #define BN_MASK2h1      (0xf8)
238 #define BN_MASK2h       (0xf0)
239 #define BN_TBIT         (0x80)
240 #define BN_DEC_CONV     (100)
241 #define BN_DEC_FMT1     "%u"
242 #define BN_DEC_FMT2     "%02u"
243 #define BN_DEC_NUM      2
244 #endif
245
246 #define BN_DEFAULT_BITS 1280
247
248 #define BN_FLG_MALLOCED         0x01
249 #define BN_FLG_STATIC_DATA      0x02
250 #ifndef OPENSSL_NO_DEPRECATED
251 #define BN_FLG_FREE             0x8000  /* used for debuging */
252 #endif
253 #define BN_set_flags(b,n)       ((b)->flags|=(n))
254 #define BN_get_flags(b,n)       ((b)->flags&(n))
255
256 /* Already declared in ossl_typ.h */
257 #if 0
258 typedef struct bignum_st BIGNUM;
259 /* Used for temp variables (declaration hidden in bn_lcl.h) */
260 typedef struct bignum_ctx BN_CTX;
261 typedef struct bn_blinding_st BN_BLINDING;
262 typedef struct bn_mont_ctx_st BN_MONT_CTX;
263 typedef struct bn_recp_ctx_st BN_RECP_CTX;
264 typedef struct bn_gencb_st BN_GENCB;
265 #endif
266
267 struct bignum_st
268         {
269         BN_ULONG *d;    /* Pointer to an array of 'BN_BITS2' bit chunks. */
270         int top;        /* Index of last used d +1. */
271         /* The next are internal book keeping for bn_expand. */
272         int dmax;       /* Size of the d array. */
273         int neg;        /* one if the number is negative */
274         int flags;
275         };
276
277 /* Used for montgomery multiplication */
278 struct bn_mont_ctx_st
279         {
280         int ri;        /* number of bits in R */
281         BIGNUM RR;     /* used to convert to montgomery form */
282         BIGNUM N;      /* The modulus */
283         BIGNUM Ni;     /* R*(1/R mod N) - N*Ni = 1
284                         * (Ni is only stored for bignum algorithm) */
285         BN_ULONG n0;   /* least significant word of Ni */
286         int flags;
287         };
288
289 /* Used for reciprocal division/mod functions
290  * It cannot be shared between threads
291  */
292 struct bn_recp_ctx_st
293         {
294         BIGNUM N;       /* the divisor */
295         BIGNUM Nr;      /* the reciprocal */
296         int num_bits;
297         int shift;
298         int flags;
299         };
300
301 /* Used for slow "generation" functions. */
302 struct bn_gencb_st
303         {
304         unsigned int ver;       /* To handle binary (in)compatibility */
305         void *arg;              /* callback-specific data */
306         union
307                 {
308                 /* if(ver==1) - handles old style callbacks */
309                 void (*cb_1)(int, int, void *);
310                 /* if(ver==2) - new callback style */
311                 int (*cb_2)(int, int, BN_GENCB *);
312                 } cb;
313         };
314 /* Wrapper function to make using BN_GENCB easier,  */
315 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
316 /* Macro to populate a BN_GENCB structure with an "old"-style callback */
317 #define BN_GENCB_set_old(gencb, callback, cb_arg) { \
318                 BN_GENCB *tmp_gencb = (gencb); \
319                 tmp_gencb->ver = 1; \
320                 tmp_gencb->arg = (cb_arg); \
321                 tmp_gencb->cb.cb_1 = (callback); }
322 /* Macro to populate a BN_GENCB structure with a "new"-style callback */
323 #define BN_GENCB_set(gencb, callback, cb_arg) { \
324                 BN_GENCB *tmp_gencb = (gencb); \
325                 tmp_gencb->ver = 2; \
326                 tmp_gencb->arg = (cb_arg); \
327                 tmp_gencb->cb.cb_2 = (callback); }
328
329 #define BN_prime_checks 0 /* default: select number of iterations
330                              based on the size of the number */
331
332 /* number of Miller-Rabin iterations for an error rate  of less than 2^-80
333  * for random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook
334  * of Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
335  * original paper: Damgaard, Landrock, Pomerance: Average case error estimates
336  * for the strong probable prime test. -- Math. Comp. 61 (1993) 177-194) */
337 #define BN_prime_checks_for_size(b) ((b) >= 1300 ?  2 : \
338                                 (b) >=  850 ?  3 : \
339                                 (b) >=  650 ?  4 : \
340                                 (b) >=  550 ?  5 : \
341                                 (b) >=  450 ?  6 : \
342                                 (b) >=  400 ?  7 : \
343                                 (b) >=  350 ?  8 : \
344                                 (b) >=  300 ?  9 : \
345                                 (b) >=  250 ? 12 : \
346                                 (b) >=  200 ? 15 : \
347                                 (b) >=  150 ? 18 : \
348                                 /* b >= 100 */ 27)
349
350 #define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
351
352 /* Note that BN_abs_is_word didn't work reliably for w == 0 until 0.9.8 */
353 #define BN_abs_is_word(a,w) ((((a)->top == 1) && ((a)->d[0] == (BN_ULONG)(w))) || \
354                                 (((w) == 0) && ((a)->top == 0)))
355 #define BN_is_zero(a)       ((a)->top == 0)
356 #define BN_is_one(a)        (BN_abs_is_word((a),1) && !(a)->neg)
357 #define BN_is_word(a,w)     (BN_abs_is_word((a),(w)) && (!(w) || !(a)->neg))
358 #define BN_is_odd(a)        (((a)->top > 0) && ((a)->d[0] & 1))
359
360 #define BN_one(a)       (BN_set_word((a),1))
361 #define BN_zero_ex(a) \
362         do { \
363                 BIGNUM *_tmp_bn = (a); \
364                 _tmp_bn->top = 0; \
365                 _tmp_bn->neg = 0; \
366         } while(0)
367 #ifdef OPENSSL_NO_DEPRECATED
368 #define BN_zero(a)      BN_zero_ex(a)
369 #else
370 #define BN_zero(a)      (BN_set_word((a),0))
371 #endif
372
373 const BIGNUM *BN_value_one(void);
374 char *  BN_options(void);
375 BN_CTX *BN_CTX_new(void);
376 #ifndef OPENSSL_NO_DEPRECATED
377 void    BN_CTX_init(BN_CTX *c);
378 #endif
379 void    BN_CTX_free(BN_CTX *c);
380 void    BN_CTX_start(BN_CTX *ctx);
381 BIGNUM *BN_CTX_get(BN_CTX *ctx);
382 void    BN_CTX_end(BN_CTX *ctx);
383 int     BN_rand(BIGNUM *rnd, int bits, int top,int bottom);
384 int     BN_pseudo_rand(BIGNUM *rnd, int bits, int top,int bottom);
385 int     BN_rand_range(BIGNUM *rnd, BIGNUM *range);
386 int     BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range);
387 int     BN_num_bits(const BIGNUM *a);
388 int     BN_num_bits_word(BN_ULONG);
389 BIGNUM *BN_new(void);
390 void    BN_init(BIGNUM *);
391 void    BN_clear_free(BIGNUM *a);
392 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
393 void    BN_swap(BIGNUM *a, BIGNUM *b);
394 BIGNUM *BN_bin2bn(const unsigned char *s,int len,BIGNUM *ret);
395 int     BN_bn2bin(const BIGNUM *a, unsigned char *to);
396 BIGNUM *BN_mpi2bn(const unsigned char *s,int len,BIGNUM *ret);
397 int     BN_bn2mpi(const BIGNUM *a, unsigned char *to);
398 int     BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
399 int     BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
400 int     BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
401 int     BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
402 int     BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
403 int     BN_sqr(BIGNUM *r, const BIGNUM *a,BN_CTX *ctx);
404 /* BN_set_negative(): sets sign of a bignum */
405 void    BN_set_negative(BIGNUM *b, int n);
406 /* BN_get_negative():  returns 1 if the bignum is < 0 and 0 otherwise */
407 #define BN_is_negative(a) ((a)->neg != 0)
408
409 int     BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
410         BN_CTX *ctx);
411 #define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
412 int     BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
413 int     BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx);
414 int     BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m);
415 int     BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx);
416 int     BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m);
417 int     BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
418         const BIGNUM *m, BN_CTX *ctx);
419 int     BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
420 int     BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
421 int     BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
422 int     BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m, BN_CTX *ctx);
423 int     BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
424
425 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
426 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
427 int     BN_mul_word(BIGNUM *a, BN_ULONG w);
428 int     BN_add_word(BIGNUM *a, BN_ULONG w);
429 int     BN_sub_word(BIGNUM *a, BN_ULONG w);
430 int     BN_set_word(BIGNUM *a, BN_ULONG w);
431 BN_ULONG BN_get_word(const BIGNUM *a);
432
433 int     BN_cmp(const BIGNUM *a, const BIGNUM *b);
434 void    BN_free(BIGNUM *a);
435 int     BN_is_bit_set(const BIGNUM *a, int n);
436 int     BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
437 int     BN_lshift1(BIGNUM *r, const BIGNUM *a);
438 int     BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,BN_CTX *ctx);
439
440 int     BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
441         const BIGNUM *m,BN_CTX *ctx);
442 int     BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
443         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
444 int     BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
445         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
446 int     BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
447         const BIGNUM *a2, const BIGNUM *p2,const BIGNUM *m,
448         BN_CTX *ctx,BN_MONT_CTX *m_ctx);
449 int     BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
450         const BIGNUM *m,BN_CTX *ctx);
451
452 int     BN_mask_bits(BIGNUM *a,int n);
453 #ifndef OPENSSL_NO_FP_API
454 int     BN_print_fp(FILE *fp, const BIGNUM *a);
455 #endif
456 #ifdef HEADER_BIO_H
457 int     BN_print(BIO *fp, const BIGNUM *a);
458 #else
459 int     BN_print(void *fp, const BIGNUM *a);
460 #endif
461 int     BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
462 int     BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
463 int     BN_rshift1(BIGNUM *r, const BIGNUM *a);
464 void    BN_clear(BIGNUM *a);
465 BIGNUM *BN_dup(const BIGNUM *a);
466 int     BN_ucmp(const BIGNUM *a, const BIGNUM *b);
467 int     BN_set_bit(BIGNUM *a, int n);
468 int     BN_clear_bit(BIGNUM *a, int n);
469 char *  BN_bn2hex(const BIGNUM *a);
470 char *  BN_bn2dec(const BIGNUM *a);
471 int     BN_hex2bn(BIGNUM **a, const char *str);
472 int     BN_dec2bn(BIGNUM **a, const char *str);
473 int     BN_gcd(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx);
474 int     BN_kronecker(const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); /* returns -2 for error */
475 BIGNUM *BN_mod_inverse(BIGNUM *ret,
476         const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);
477 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
478         const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);
479
480 /* Deprecated versions */
481 #ifndef OPENSSL_NO_DEPRECATED
482 BIGNUM *BN_generate_prime(BIGNUM *ret,int bits,int safe,
483         const BIGNUM *add, const BIGNUM *rem,
484         void (*callback)(int,int,void *),void *cb_arg);
485 int     BN_is_prime(const BIGNUM *p,int nchecks,
486         void (*callback)(int,int,void *),
487         BN_CTX *ctx,void *cb_arg);
488 int     BN_is_prime_fasttest(const BIGNUM *p,int nchecks,
489         void (*callback)(int,int,void *),BN_CTX *ctx,void *cb_arg,
490         int do_trial_division);
491 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
492
493 /* Newer versions */
494 int     BN_generate_prime_ex(BIGNUM *ret,int bits,int safe, const BIGNUM *add,
495                 const BIGNUM *rem, BN_GENCB *cb);
496 int     BN_is_prime_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, BN_GENCB *cb);
497 int     BN_is_prime_fasttest_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx,
498                 int do_trial_division, BN_GENCB *cb);
499
500 BN_MONT_CTX *BN_MONT_CTX_new(void );
501 void BN_MONT_CTX_init(BN_MONT_CTX *ctx);
502 int BN_mod_mul_montgomery(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,
503         BN_MONT_CTX *mont, BN_CTX *ctx);
504 #define BN_to_montgomery(r,a,mont,ctx)  BN_mod_mul_montgomery(\
505         (r),(a),&((mont)->RR),(mont),(ctx))
506 int BN_from_montgomery(BIGNUM *r,const BIGNUM *a,
507         BN_MONT_CTX *mont, BN_CTX *ctx);
508 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
509 int BN_MONT_CTX_set(BN_MONT_CTX *mont,const BIGNUM *mod,BN_CTX *ctx);
510 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,BN_MONT_CTX *from);
511 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
512                                         const BIGNUM *mod, BN_CTX *ctx);
513
514 /* BN_BLINDING flags */
515 #define BN_BLINDING_NO_UPDATE   0x00000001
516 #define BN_BLINDING_NO_RECREATE 0x00000002
517
518 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
519 void BN_BLINDING_free(BN_BLINDING *b);
520 int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
521 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
522 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
523 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
524 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b, BN_CTX *);
525 unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *);
526 void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long);
527 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
528 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
529 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
530         const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
531         int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
532                           const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
533         BN_MONT_CTX *m_ctx);
534
535 #ifndef OPENSSL_NO_DEPRECATED
536 void BN_set_params(int mul,int high,int low,int mont);
537 int BN_get_params(int which); /* 0, mul, 1 high, 2 low, 3 mont */
538 #endif
539
540 void    BN_RECP_CTX_init(BN_RECP_CTX *recp);
541 BN_RECP_CTX *BN_RECP_CTX_new(void);
542 void    BN_RECP_CTX_free(BN_RECP_CTX *recp);
543 int     BN_RECP_CTX_set(BN_RECP_CTX *recp,const BIGNUM *rdiv,BN_CTX *ctx);
544 int     BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
545         BN_RECP_CTX *recp,BN_CTX *ctx);
546 int     BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
547         const BIGNUM *m, BN_CTX *ctx);
548 int     BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
549         BN_RECP_CTX *recp, BN_CTX *ctx);
550
551 /* Functions for arithmetic over binary polynomials represented by BIGNUMs. 
552  *
553  * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
554  * ignored.
555  *
556  * Note that input arguments are not const so that their bit arrays can
557  * be expanded to the appropriate size if needed.
558  */
559
560 int     BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); /*r = a + b*/
561 #define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
562 int     BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p); /*r=a mod p*/
563 int     BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
564         const BIGNUM *p, BN_CTX *ctx); /* r = (a * b) mod p */
565 int     BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
566         BN_CTX *ctx); /* r = (a * a) mod p */
567 int     BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p,
568         BN_CTX *ctx); /* r = (1 / b) mod p */
569 int     BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
570         const BIGNUM *p, BN_CTX *ctx); /* r = (a / b) mod p */
571 int     BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
572         const BIGNUM *p, BN_CTX *ctx); /* r = (a ^ b) mod p */
573 int     BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
574         BN_CTX *ctx); /* r = sqrt(a) mod p */
575 int     BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
576         BN_CTX *ctx); /* r^2 + r = a mod p */
577 #define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
578 /* Some functions allow for representation of the irreducible polynomials
579  * as an unsigned int[], say p.  The irreducible f(t) is then of the form:
580  *     t^p[0] + t^p[1] + ... + t^p[k]
581  * where m = p[0] > p[1] > ... > p[k] = 0.
582  */
583 int     BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[]);
584         /* r = a mod p */
585 int     BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
586         const unsigned int p[], BN_CTX *ctx); /* r = (a * b) mod p */
587 int     BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[],
588         BN_CTX *ctx); /* r = (a * a) mod p */
589 int     BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const unsigned int p[],
590         BN_CTX *ctx); /* r = (1 / b) mod p */
591 int     BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
592         const unsigned int p[], BN_CTX *ctx); /* r = (a / b) mod p */
593 int     BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
594         const unsigned int p[], BN_CTX *ctx); /* r = (a ^ b) mod p */
595 int     BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
596         const unsigned int p[], BN_CTX *ctx); /* r = sqrt(a) mod p */
597 int     BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
598         const unsigned int p[], BN_CTX *ctx); /* r^2 + r = a mod p */
599 int     BN_GF2m_poly2arr(const BIGNUM *a, unsigned int p[], int max);
600 int     BN_GF2m_arr2poly(const unsigned int p[], BIGNUM *a);
601
602 /* faster mod functions for the 'NIST primes' 
603  * 0 <= a < p^2 */
604 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
605 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
606 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
607 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
608 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
609
610 const BIGNUM *BN_get0_nist_prime_192(void);
611 const BIGNUM *BN_get0_nist_prime_224(void);
612 const BIGNUM *BN_get0_nist_prime_256(void);
613 const BIGNUM *BN_get0_nist_prime_384(void);
614 const BIGNUM *BN_get0_nist_prime_521(void);
615
616 /* library internal functions */
617
618 #define bn_expand(a,bits) ((((((bits+BN_BITS2-1))/BN_BITS2)) <= (a)->dmax)?\
619         (a):bn_expand2((a),(bits+BN_BITS2-1)/BN_BITS2))
620 #define bn_wexpand(a,words) (((words) <= (a)->dmax)?(a):bn_expand2((a),(words)))
621 BIGNUM *bn_expand2(BIGNUM *a, int words);
622 #ifndef OPENSSL_NO_DEPRECATED
623 BIGNUM *bn_dup_expand(const BIGNUM *a, int words); /* unused */
624 #endif
625
626 /* Bignum consistency macros
627  * There is one "API" macro, bn_fix_top(), for stripping leading zeroes from
628  * bignum data after direct manipulations on the data. There is also an
629  * "internal" macro, bn_check_top(), for verifying that there are no leading
630  * zeroes. Unfortunately, some auditing is required due to the fact that
631  * bn_fix_top() has become an overabused duct-tape because bignum data is
632  * occasionally passed around in an inconsistent state. So the following
633  * changes have been made to sort this out;
634  * - bn_fix_top()s implementation has been moved to bn_correct_top()
635  * - if BN_DEBUG isn't defined, bn_fix_top() maps to bn_correct_top(), and
636  *   bn_check_top() is as before.
637  * - if BN_DEBUG *is* defined;
638  *   - bn_check_top() tries to pollute unused words even if the bignum 'top' is
639  *     consistent. (ed: only if BN_DEBUG_RAND is defined)
640  *   - bn_fix_top() maps to bn_check_top() rather than "fixing" anything.
641  * The idea is to have debug builds flag up inconsistent bignums when they
642  * occur. If that occurs in a bn_fix_top(), we examine the code in question; if
643  * the use of bn_fix_top() was appropriate (ie. it follows directly after code
644  * that manipulates the bignum) it is converted to bn_correct_top(), and if it
645  * was not appropriate, we convert it permanently to bn_check_top() and track
646  * down the cause of the bug. Eventually, no internal code should be using the
647  * bn_fix_top() macro. External applications and libraries should try this with
648  * their own code too, both in terms of building against the openssl headers
649  * with BN_DEBUG defined *and* linking with a version of OpenSSL built with it
650  * defined. This not only improves external code, it provides more test
651  * coverage for openssl's own code.
652  */
653
654 #ifdef BN_DEBUG
655
656 /* We only need assert() when debugging */
657 #include <assert.h>
658
659 #ifdef BN_DEBUG_RAND
660 /* To avoid "make update" cvs wars due to BN_DEBUG, use some tricks */
661 #ifndef RAND_pseudo_bytes
662 int RAND_pseudo_bytes(unsigned char *buf,int num);
663 #define BN_DEBUG_TRIX
664 #endif
665 #define bn_pollute(a) \
666         do { \
667                 const BIGNUM *_bnum1 = (a); \
668                 if(_bnum1->top < _bnum1->dmax) { \
669                         unsigned char _tmp_char; \
670                         /* We cast away const without the compiler knowing, any \
671                          * *genuinely* constant variables that aren't mutable \
672                          * wouldn't be constructed with top!=dmax. */ \
673                         BN_ULONG *_not_const; \
674                         memcpy(&_not_const, &_bnum1->d, sizeof(BN_ULONG*)); \
675                         RAND_pseudo_bytes(&_tmp_char, 1); \
676                         memset((unsigned char *)(_not_const + _bnum1->top), _tmp_char, \
677                                 (_bnum1->dmax - _bnum1->top) * sizeof(BN_ULONG)); \
678                 } \
679         } while(0)
680 #ifdef BN_DEBUG_TRIX
681 #undef RAND_pseudo_bytes
682 #endif
683 #else
684 #define bn_pollute(a)
685 #endif
686 #define bn_check_top(a) \
687         do { \
688                 const BIGNUM *_bnum2 = (a); \
689                 assert((_bnum2->top == 0) || \
690                                 (_bnum2->d[_bnum2->top - 1] != 0)); \
691                 bn_pollute(_bnum2); \
692         } while(0)
693
694 #define bn_fix_top(a)           bn_check_top(a)
695
696 #else /* !BN_DEBUG */
697
698 #define bn_pollute(a)
699 #define bn_check_top(a)
700 #define bn_fix_top(a)           bn_correct_top(a)
701
702 #endif
703
704 #define bn_correct_top(a) \
705         { \
706         BN_ULONG *ftl; \
707         if ((a)->top > 0) \
708                 { \
709                 for (ftl= &((a)->d[(a)->top-1]); (a)->top > 0; (a)->top--) \
710                 if (*(ftl--)) break; \
711                 } \
712         bn_pollute(a); \
713         }
714
715 BN_ULONG bn_mul_add_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
716 BN_ULONG bn_mul_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
717 void     bn_sqr_words(BN_ULONG *rp, const BN_ULONG *ap, int num);
718 BN_ULONG bn_div_words(BN_ULONG h, BN_ULONG l, BN_ULONG d);
719 BN_ULONG bn_add_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
720 BN_ULONG bn_sub_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
721
722 int BN_bntest_rand(BIGNUM *rnd, int bits, int top,int bottom);
723
724 /* BEGIN ERROR CODES */
725 /* The following lines are auto generated by the script mkerr.pl. Any changes
726  * made after this point may be overwritten when the script is next run.
727  */
728 void ERR_load_BN_strings(void);
729
730 /* Error codes for the BN functions. */
731
732 /* Function codes. */
733 #define BN_F_BNRAND                                      114
734 #define BN_F_BN_BLINDING_CONVERT                         100
735 #define BN_F_BN_BLINDING_CREATE_PARAM                    133
736 #define BN_F_BN_BLINDING_INVERT                          101
737 #define BN_F_BN_BLINDING_NEW                             102
738 #define BN_F_BN_BLINDING_UPDATE                          103
739 #define BN_F_BN_BN2DEC                                   104
740 #define BN_F_BN_BN2HEX                                   105
741 #define BN_F_BN_CTX_GET                                  116
742 #define BN_F_BN_CTX_NEW                                  106
743 #define BN_F_BN_CTX_START                                130
744 #define BN_F_BN_DIV                                      107
745 #define BN_F_BN_DIV_RECP                                 131
746 #define BN_F_BN_EXPAND2                                  108
747 #define BN_F_BN_EXPAND_INTERNAL                          120
748 #define BN_F_BN_GF2M_MOD                                 126
749 #define BN_F_BN_GF2M_MOD_DIV                             123
750 #define BN_F_BN_GF2M_MOD_EXP                             127
751 #define BN_F_BN_GF2M_MOD_MUL                             124
752 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD                      128
753 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR                  129
754 #define BN_F_BN_GF2M_MOD_SQR                             125
755 #define BN_F_BN_GF2M_MOD_SQRT                            132
756 #define BN_F_BN_MOD_EXP2_MONT                            118
757 #define BN_F_BN_MOD_EXP_MONT                             109
758 #define BN_F_BN_MOD_EXP_MONT_WORD                        117
759 #define BN_F_BN_MOD_INVERSE                              110
760 #define BN_F_BN_MOD_LSHIFT_QUICK                         119
761 #define BN_F_BN_MOD_MUL_RECIPROCAL                       111
762 #define BN_F_BN_MOD_SQRT                                 121
763 #define BN_F_BN_MPI2BN                                   112
764 #define BN_F_BN_NEW                                      113
765 #define BN_F_BN_RAND_RANGE                               122
766 #define BN_F_BN_USUB                                     115
767
768 /* Reason codes. */
769 #define BN_R_ARG2_LT_ARG3                                100
770 #define BN_R_BAD_RECIPROCAL                              101
771 #define BN_R_BIGNUM_TOO_LONG                             114
772 #define BN_R_CALLED_WITH_EVEN_MODULUS                    102
773 #define BN_R_DIV_BY_ZERO                                 103
774 #define BN_R_ENCODING_ERROR                              104
775 #define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA                105
776 #define BN_R_INPUT_NOT_REDUCED                           110
777 #define BN_R_INVALID_LENGTH                              106
778 #define BN_R_INVALID_RANGE                               115
779 #define BN_R_NOT_A_SQUARE                                111
780 #define BN_R_NOT_IMPLEMENTED                             116
781 #define BN_R_NOT_INITIALIZED                             107
782 #define BN_R_NO_INVERSE                                  108
783 #define BN_R_NO_SOLUTION                                 117
784 #define BN_R_P_IS_NOT_PRIME                              112
785 #define BN_R_TOO_MANY_ITERATIONS                         113
786 #define BN_R_TOO_MANY_TEMPORARY_VARIABLES                109
787
788 #ifdef  __cplusplus
789 }
790 #endif
791 #endif