This is a first-cut at improving the callback mechanisms used in
[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
80 #ifdef  __cplusplus
81 extern "C" {
82 #endif
83
84 #ifdef OPENSSL_SYS_VMS
85 #undef BN_LLONG /* experimental, so far... */
86 #endif
87
88 #define BN_MUL_COMBA
89 #define BN_SQR_COMBA
90 #define BN_RECURSION
91
92 /* This next option uses the C libraries (2 word)/(1 word) function.
93  * If it is not defined, I use my C version (which is slower).
94  * The reason for this flag is that when the particular C compiler
95  * library routine is used, and the library is linked with a different
96  * compiler, the library is missing.  This mostly happens when the
97  * library is built with gcc and then linked using normal cc.  This would
98  * be a common occurrence because gcc normally produces code that is
99  * 2 times faster than system compilers for the big number stuff.
100  * For machines with only one compiler (or shared libraries), this should
101  * be on.  Again this in only really a problem on machines
102  * using "long long's", are 32bit, and are not using my assembler code. */
103 #if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || \
104     defined(OPENSSL_SYS_WIN32) || defined(linux)
105 # ifndef BN_DIV2W
106 #  define BN_DIV2W
107 # endif
108 #endif
109
110 /* assuming long is 64bit - this is the DEC Alpha
111  * unsigned long long is only 64 bits :-(, don't define
112  * BN_LLONG for the DEC Alpha */
113 #ifdef SIXTY_FOUR_BIT_LONG
114 #define BN_ULLONG       unsigned long long
115 #define BN_ULONG        unsigned long
116 #define BN_LONG         long
117 #define BN_BITS         128
118 #define BN_BYTES        8
119 #define BN_BITS2        64
120 #define BN_BITS4        32
121 #define BN_MASK         (0xffffffffffffffffffffffffffffffffLL)
122 #define BN_MASK2        (0xffffffffffffffffL)
123 #define BN_MASK2l       (0xffffffffL)
124 #define BN_MASK2h       (0xffffffff00000000L)
125 #define BN_MASK2h1      (0xffffffff80000000L)
126 #define BN_TBIT         (0x8000000000000000L)
127 #define BN_DEC_CONV     (10000000000000000000UL)
128 #define BN_DEC_FMT1     "%lu"
129 #define BN_DEC_FMT2     "%019lu"
130 #define BN_DEC_NUM      19
131 #endif
132
133 /* This is where the long long data type is 64 bits, but long is 32.
134  * For machines where there are 64bit registers, this is the mode to use.
135  * IRIX, on R4000 and above should use this mode, along with the relevant
136  * assembler code :-).  Do NOT define BN_LLONG.
137  */
138 #ifdef SIXTY_FOUR_BIT
139 #undef BN_LLONG
140 #undef BN_ULLONG
141 #define BN_ULONG        unsigned long long
142 #define BN_LONG         long long
143 #define BN_BITS         128
144 #define BN_BYTES        8
145 #define BN_BITS2        64
146 #define BN_BITS4        32
147 #define BN_MASK2        (0xffffffffffffffffLL)
148 #define BN_MASK2l       (0xffffffffL)
149 #define BN_MASK2h       (0xffffffff00000000LL)
150 #define BN_MASK2h1      (0xffffffff80000000LL)
151 #define BN_TBIT         (0x8000000000000000LL)
152 #define BN_DEC_CONV     (10000000000000000000ULL)
153 #define BN_DEC_FMT1     "%llu"
154 #define BN_DEC_FMT2     "%019llu"
155 #define BN_DEC_NUM      19
156 #endif
157
158 #ifdef THIRTY_TWO_BIT
159 #if defined(OPENSSL_SYS_WIN32) && !defined(__GNUC__)
160 #define BN_ULLONG       unsigned _int64
161 #else
162 #define BN_ULLONG       unsigned long long
163 #endif
164 #define BN_ULONG        unsigned long
165 #define BN_LONG         long
166 #define BN_BITS         64
167 #define BN_BYTES        4
168 #define BN_BITS2        32
169 #define BN_BITS4        16
170 #ifdef OPENSSL_SYS_WIN32
171 /* VC++ doesn't like the LL suffix */
172 #define BN_MASK         (0xffffffffffffffffL)
173 #else
174 #define BN_MASK         (0xffffffffffffffffLL)
175 #endif
176 #define BN_MASK2        (0xffffffffL)
177 #define BN_MASK2l       (0xffff)
178 #define BN_MASK2h1      (0xffff8000L)
179 #define BN_MASK2h       (0xffff0000L)
180 #define BN_TBIT         (0x80000000L)
181 #define BN_DEC_CONV     (1000000000L)
182 #define BN_DEC_FMT1     "%lu"
183 #define BN_DEC_FMT2     "%09lu"
184 #define BN_DEC_NUM      9
185 #endif
186
187 #ifdef SIXTEEN_BIT
188 #ifndef BN_DIV2W
189 #define BN_DIV2W
190 #endif
191 #define BN_ULLONG       unsigned long
192 #define BN_ULONG        unsigned short
193 #define BN_LONG         short
194 #define BN_BITS         32
195 #define BN_BYTES        2
196 #define BN_BITS2        16
197 #define BN_BITS4        8
198 #define BN_MASK         (0xffffffff)
199 #define BN_MASK2        (0xffff)
200 #define BN_MASK2l       (0xff)
201 #define BN_MASK2h1      (0xff80)
202 #define BN_MASK2h       (0xff00)
203 #define BN_TBIT         (0x8000)
204 #define BN_DEC_CONV     (100000)
205 #define BN_DEC_FMT1     "%u"
206 #define BN_DEC_FMT2     "%05u"
207 #define BN_DEC_NUM      5
208 #endif
209
210 #ifdef EIGHT_BIT
211 #ifndef BN_DIV2W
212 #define BN_DIV2W
213 #endif
214 #define BN_ULLONG       unsigned short
215 #define BN_ULONG        unsigned char
216 #define BN_LONG         char
217 #define BN_BITS         16
218 #define BN_BYTES        1
219 #define BN_BITS2        8
220 #define BN_BITS4        4
221 #define BN_MASK         (0xffff)
222 #define BN_MASK2        (0xff)
223 #define BN_MASK2l       (0xf)
224 #define BN_MASK2h1      (0xf8)
225 #define BN_MASK2h       (0xf0)
226 #define BN_TBIT         (0x80)
227 #define BN_DEC_CONV     (100)
228 #define BN_DEC_FMT1     "%u"
229 #define BN_DEC_FMT2     "%02u"
230 #define BN_DEC_NUM      2
231 #endif
232
233 #define BN_DEFAULT_BITS 1280
234
235 #ifdef BIGNUM
236 #undef BIGNUM
237 #endif
238
239 #define BN_FLG_MALLOCED         0x01
240 #define BN_FLG_STATIC_DATA      0x02
241 #define BN_FLG_FREE             0x8000  /* used for debuging */
242 #define BN_set_flags(b,n)       ((b)->flags|=(n))
243 #define BN_get_flags(b,n)       ((b)->flags&(n))
244
245 typedef struct bignum_st
246         {
247         BN_ULONG *d;    /* Pointer to an array of 'BN_BITS2' bit chunks. */
248         int top;        /* Index of last used d +1. */
249         /* The next are internal book keeping for bn_expand. */
250         int dmax;       /* Size of the d array. */
251         int neg;        /* one if the number is negative */
252         int flags;
253         } BIGNUM;
254
255 /* Used for temp variables (declaration hidden in bn_lcl.h) */
256 typedef struct bignum_ctx BN_CTX;
257
258 typedef struct bn_blinding_st
259         {
260         int init;
261         BIGNUM *A;
262         BIGNUM *Ai;
263         BIGNUM *mod; /* just a reference */
264         } BN_BLINDING;
265
266 /* Used for montgomery multiplication */
267 typedef struct bn_mont_ctx_st
268         {
269         int ri;        /* number of bits in R */
270         BIGNUM RR;     /* used to convert to montgomery form */
271         BIGNUM N;      /* The modulus */
272         BIGNUM Ni;     /* R*(1/R mod N) - N*Ni = 1
273                         * (Ni is only stored for bignum algorithm) */
274         BN_ULONG n0;   /* least significant word of Ni */
275         int flags;
276         } BN_MONT_CTX;
277
278 /* Used for reciprocal division/mod functions
279  * It cannot be shared between threads
280  */
281 typedef struct bn_recp_ctx_st
282         {
283         BIGNUM N;       /* the divisor */
284         BIGNUM Nr;      /* the reciprocal */
285         int num_bits;
286         int shift;
287         int flags;
288         } BN_RECP_CTX;
289
290 /* Used for slow "generation" functions. */
291 typedef struct bn_gencb_st BN_GENCB;
292 struct bn_gencb_st
293         {
294         unsigned int ver;       /* To handle binary (in)compatibility */
295         void *arg;              /* callback-specific data */
296         union
297                 {
298                 /* if(ver==1) - handles old style callbacks */
299                 void (*cb_1)(int, int, void *);
300                 /* if(ver==2) - new callback style */
301                 int (*cb_2)(int, int, BN_GENCB *);
302                 };
303         };
304 /* Wrapper function to make using BN_GENCB easier,  */
305 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
306
307 #define BN_prime_checks 0 /* default: select number of iterations
308                              based on the size of the number */
309
310 /* number of Miller-Rabin iterations for an error rate  of less than 2^-80
311  * for random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook
312  * of Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
313  * original paper: Damgaard, Landrock, Pomerance: Average case error estimates
314  * for the strong probable prime test. -- Math. Comp. 61 (1993) 177-194) */
315 #define BN_prime_checks_for_size(b) ((b) >= 1300 ?  2 : \
316                                 (b) >=  850 ?  3 : \
317                                 (b) >=  650 ?  4 : \
318                                 (b) >=  550 ?  5 : \
319                                 (b) >=  450 ?  6 : \
320                                 (b) >=  400 ?  7 : \
321                                 (b) >=  350 ?  8 : \
322                                 (b) >=  300 ?  9 : \
323                                 (b) >=  250 ? 12 : \
324                                 (b) >=  200 ? 15 : \
325                                 (b) >=  150 ? 18 : \
326                                 /* b >= 100 */ 27)
327
328 #define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
329
330 /* Note that BN_abs_is_word does not work reliably for w == 0 */
331 #define BN_abs_is_word(a,w) (((a)->top == 1) && ((a)->d[0] == (BN_ULONG)(w)))
332 #define BN_is_zero(a)       (((a)->top == 0) || BN_abs_is_word(a,0))
333 #define BN_is_one(a)        (BN_abs_is_word((a),1) && !(a)->neg)
334 #define BN_is_word(a,w)     ((w) ? BN_abs_is_word((a),(w)) && !(a)->neg : \
335                                    BN_is_zero((a)))
336 #define BN_is_odd(a)        (((a)->top > 0) && ((a)->d[0] & 1))
337
338 #define BN_one(a)       (BN_set_word((a),1))
339 #define BN_zero(a)      (BN_set_word((a),0))
340 /* BN_set_sign(BIGNUM *, int) sets the sign of a BIGNUM
341  * (0 for a non-negative value, 1 for negative) */
342 #define BN_set_sign(a,b) ((a)->neg = (b))
343 /* BN_get_sign(BIGNUM *) returns the sign of the BIGNUM */
344 #define BN_get_sign(a)   ((a)->neg)
345
346 /*#define BN_ascii2bn(a)        BN_hex2bn(a) */
347 /*#define BN_bn2ascii(a)        BN_bn2hex(a) */
348
349 const BIGNUM *BN_value_one(void);
350 char *  BN_options(void);
351 BN_CTX *BN_CTX_new(void);
352 void    BN_CTX_init(BN_CTX *c);
353 void    BN_CTX_free(BN_CTX *c);
354 void    BN_CTX_start(BN_CTX *ctx);
355 BIGNUM *BN_CTX_get(BN_CTX *ctx);
356 void    BN_CTX_end(BN_CTX *ctx);
357 int     BN_rand(BIGNUM *rnd, int bits, int top,int bottom);
358 int     BN_pseudo_rand(BIGNUM *rnd, int bits, int top,int bottom);
359 int     BN_rand_range(BIGNUM *rnd, BIGNUM *range);
360 int     BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range);
361 int     BN_num_bits(const BIGNUM *a);
362 int     BN_num_bits_word(BN_ULONG);
363 BIGNUM *BN_new(void);
364 void    BN_init(BIGNUM *);
365 void    BN_clear_free(BIGNUM *a);
366 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
367 /* BN_ncopy(): like BN_copy() but copies at most the first n BN_ULONGs */
368 BIGNUM *BN_ncopy(BIGNUM *a, const BIGNUM *b, size_t n);
369 void    BN_swap(BIGNUM *a, BIGNUM *b);
370 BIGNUM *BN_bin2bn(const unsigned char *s,int len,BIGNUM *ret);
371 int     BN_bn2bin(const BIGNUM *a, unsigned char *to);
372 BIGNUM *BN_mpi2bn(const unsigned char *s,int len,BIGNUM *ret);
373 int     BN_bn2mpi(const BIGNUM *a, unsigned char *to);
374 int     BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
375 int     BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
376 int     BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
377 int     BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
378 int     BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
379 int     BN_sqr(BIGNUM *r, const BIGNUM *a,BN_CTX *ctx);
380
381 int     BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
382         BN_CTX *ctx);
383 #define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
384 int     BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
385 int     BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx);
386 int     BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m);
387 int     BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx);
388 int     BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m);
389 int     BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
390         const BIGNUM *m, BN_CTX *ctx);
391 int     BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
392 int     BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
393 int     BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
394 int     BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m, BN_CTX *ctx);
395 int     BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
396
397 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
398 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
399 int     BN_mul_word(BIGNUM *a, BN_ULONG w);
400 int     BN_add_word(BIGNUM *a, BN_ULONG w);
401 int     BN_sub_word(BIGNUM *a, BN_ULONG w);
402 int     BN_set_word(BIGNUM *a, BN_ULONG w);
403 BN_ULONG BN_get_word(const BIGNUM *a);
404
405 int     BN_cmp(const BIGNUM *a, const BIGNUM *b);
406 void    BN_free(BIGNUM *a);
407 int     BN_is_bit_set(const BIGNUM *a, int n);
408 int     BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
409 int     BN_lshift1(BIGNUM *r, const BIGNUM *a);
410 int     BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,BN_CTX *ctx);
411
412 int     BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
413         const BIGNUM *m,BN_CTX *ctx);
414 int     BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
415         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
416 int     BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
417         const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
418 int     BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
419         const BIGNUM *a2, const BIGNUM *p2,const BIGNUM *m,
420         BN_CTX *ctx,BN_MONT_CTX *m_ctx);
421 int     BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
422         const BIGNUM *m,BN_CTX *ctx);
423
424 int     BN_mask_bits(BIGNUM *a,int n);
425 #ifndef OPENSSL_NO_FP_API
426 int     BN_print_fp(FILE *fp, const BIGNUM *a);
427 #endif
428 #ifdef HEADER_BIO_H
429 int     BN_print(BIO *fp, const BIGNUM *a);
430 #else
431 int     BN_print(void *fp, const BIGNUM *a);
432 #endif
433 int     BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
434 int     BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
435 int     BN_rshift1(BIGNUM *r, const BIGNUM *a);
436 void    BN_clear(BIGNUM *a);
437 BIGNUM *BN_dup(const BIGNUM *a);
438 int     BN_ucmp(const BIGNUM *a, const BIGNUM *b);
439 int     BN_set_bit(BIGNUM *a, int n);
440 int     BN_clear_bit(BIGNUM *a, int n);
441 char *  BN_bn2hex(const BIGNUM *a);
442 char *  BN_bn2dec(const BIGNUM *a);
443 int     BN_hex2bn(BIGNUM **a, const char *str);
444 int     BN_dec2bn(BIGNUM **a, const char *str);
445 int     BN_gcd(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx);
446 int     BN_kronecker(const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); /* returns -2 for error */
447 BIGNUM *BN_mod_inverse(BIGNUM *ret,
448         const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);
449 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
450         const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx);
451
452 /* Deprecated versions */
453 #ifndef OPENSSL_NO_DEPRECATED
454 BIGNUM *BN_generate_prime(BIGNUM *ret,int bits,int safe,
455         const BIGNUM *add, const BIGNUM *rem,
456         void (*callback)(int,int,void *),void *cb_arg);
457 int     BN_is_prime(const BIGNUM *p,int nchecks,
458         void (*callback)(int,int,void *),
459         BN_CTX *ctx,void *cb_arg);
460 int     BN_is_prime_fasttest(const BIGNUM *p,int nchecks,
461         void (*callback)(int,int,void *),BN_CTX *ctx,void *cb_arg,
462         int do_trial_division);
463 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
464
465 /* Newer versions */
466 int     BN_generate_prime_ex(BIGNUM *ret,int bits,int safe, const BIGNUM *add,
467                 const BIGNUM *rem, BN_GENCB *cb);
468 int     BN_is_prime_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, BN_GENCB *cb);
469 int     BN_is_prime_fasttest_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx,
470                 int do_trial_division, BN_GENCB *cb);
471
472 BN_MONT_CTX *BN_MONT_CTX_new(void );
473 void BN_MONT_CTX_init(BN_MONT_CTX *ctx);
474 int BN_mod_mul_montgomery(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,
475         BN_MONT_CTX *mont, BN_CTX *ctx);
476 #define BN_to_montgomery(r,a,mont,ctx)  BN_mod_mul_montgomery(\
477         (r),(a),&((mont)->RR),(mont),(ctx))
478 int BN_from_montgomery(BIGNUM *r,const BIGNUM *a,
479         BN_MONT_CTX *mont, BN_CTX *ctx);
480 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
481 int BN_MONT_CTX_set(BN_MONT_CTX *mont,const BIGNUM *mod,BN_CTX *ctx);
482 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,BN_MONT_CTX *from);
483
484 BN_BLINDING *BN_BLINDING_new(BIGNUM *A,BIGNUM *Ai,BIGNUM *mod);
485 void BN_BLINDING_free(BN_BLINDING *b);
486 int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
487 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *r, BN_CTX *ctx);
488 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
489
490 void BN_set_params(int mul,int high,int low,int mont);
491 int BN_get_params(int which); /* 0, mul, 1 high, 2 low, 3 mont */
492
493 void    BN_RECP_CTX_init(BN_RECP_CTX *recp);
494 BN_RECP_CTX *BN_RECP_CTX_new(void);
495 void    BN_RECP_CTX_free(BN_RECP_CTX *recp);
496 int     BN_RECP_CTX_set(BN_RECP_CTX *recp,const BIGNUM *rdiv,BN_CTX *ctx);
497 int     BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
498         BN_RECP_CTX *recp,BN_CTX *ctx);
499 int     BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
500         const BIGNUM *m, BN_CTX *ctx);
501 int     BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
502         BN_RECP_CTX *recp, BN_CTX *ctx);
503
504 /* Functions for arithmetic over binary polynomials represented by BIGNUMs. 
505  *
506  * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
507  * ignored.
508  *
509  * Note that input arguments are not const so that their bit arrays can
510  * be expanded to the appropriate size if needed.
511  */
512
513 int     BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); /*r = a + b*/
514 #define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
515 int     BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p); /*r=a mod p*/
516 int     BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
517         const BIGNUM *p, BN_CTX *ctx); /* r = (a * b) mod p */
518 int     BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
519         BN_CTX *ctx); /* r = (a * a) mod p */
520 int     BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p,
521         BN_CTX *ctx); /* r = (1 / b) mod p */
522 int     BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
523         const BIGNUM *p, BN_CTX *ctx); /* r = (a / b) mod p */
524 int     BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
525         const BIGNUM *p, BN_CTX *ctx); /* r = (a ^ b) mod p */
526 int     BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
527         BN_CTX *ctx); /* r = sqrt(a) mod p */
528 int     BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
529         BN_CTX *ctx); /* r^2 + r = a mod p */
530 #define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
531 /* Some functions allow for representation of the irreducible polynomials
532  * as an unsigned int[], say p.  The irreducible f(t) is then of the form:
533  *     t^p[0] + t^p[1] + ... + t^p[k]
534  * where m = p[0] > p[1] > ... > p[k] = 0.
535  */
536 int     BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[]);
537         /* r = a mod p */
538 int     BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
539         const unsigned int p[], BN_CTX *ctx); /* r = (a * b) mod p */
540 int     BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const unsigned int p[],
541         BN_CTX *ctx); /* r = (a * a) mod p */
542 int     BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const unsigned int p[],
543         BN_CTX *ctx); /* r = (1 / b) mod p */
544 int     BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
545         const unsigned int p[], BN_CTX *ctx); /* r = (a / b) mod p */
546 int     BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
547         const unsigned int p[], BN_CTX *ctx); /* r = (a ^ b) mod p */
548 int     BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
549         const unsigned int p[], BN_CTX *ctx); /* r = sqrt(a) mod p */
550 int     BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
551         const unsigned int p[], BN_CTX *ctx); /* r^2 + r = a mod p */
552 int     BN_GF2m_poly2arr(const BIGNUM *a, unsigned int p[], int max);
553 int     BN_GF2m_arr2poly(const unsigned int p[], BIGNUM *a);
554
555 /* faster mod functions for the 'NIST primes' 
556  * 0 <= a < p^2 */
557 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
558 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
559 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
560 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
561 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
562
563 const BIGNUM *BN_get0_nist_prime_192(void);
564 const BIGNUM *BN_get0_nist_prime_224(void);
565 const BIGNUM *BN_get0_nist_prime_256(void);
566 const BIGNUM *BN_get0_nist_prime_384(void);
567 const BIGNUM *BN_get0_nist_prime_521(void);
568
569 /* library internal functions */
570
571 #define bn_expand(a,bits) ((((((bits+BN_BITS2-1))/BN_BITS2)) <= (a)->dmax)?\
572         (a):bn_expand2((a),(bits)/BN_BITS2+1))
573 #define bn_wexpand(a,words) (((words) <= (a)->dmax)?(a):bn_expand2((a),(words)))
574 BIGNUM *bn_expand2(BIGNUM *a, int words);
575 BIGNUM *bn_dup_expand(const BIGNUM *a, int words);
576
577 #define bn_fix_top(a) \
578         { \
579         BN_ULONG *ftl; \
580         if ((a)->top > 0) \
581                 { \
582                 for (ftl= &((a)->d[(a)->top-1]); (a)->top > 0; (a)->top--) \
583                 if (*(ftl--)) break; \
584                 } \
585         }
586
587 BN_ULONG bn_mul_add_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
588 BN_ULONG bn_mul_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w);
589 void     bn_sqr_words(BN_ULONG *rp, const BN_ULONG *ap, int num);
590 BN_ULONG bn_div_words(BN_ULONG h, BN_ULONG l, BN_ULONG d);
591 BN_ULONG bn_add_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
592 BN_ULONG bn_sub_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num);
593
594 #ifdef BN_DEBUG
595 void bn_dump1(FILE *o, const char *a, const BN_ULONG *b,int n);
596 # define bn_print(a) {fprintf(stderr, #a "="); BN_print_fp(stderr,a); \
597    fprintf(stderr,"\n");}
598 # define bn_dump(a,n) bn_dump1(stderr,#a,a,n);
599 #else
600 # define bn_print(a)
601 # define bn_dump(a,b)
602 #endif
603
604 int BN_bntest_rand(BIGNUM *rnd, int bits, int top,int bottom);
605
606 /* BEGIN ERROR CODES */
607 /* The following lines are auto generated by the script mkerr.pl. Any changes
608  * made after this point may be overwritten when the script is next run.
609  */
610 void ERR_load_BN_strings(void);
611
612 /* Error codes for the BN functions. */
613
614 /* Function codes. */
615 #define BN_F_BN_BLINDING_CONVERT                         100
616 #define BN_F_BN_BLINDING_INVERT                          101
617 #define BN_F_BN_BLINDING_NEW                             102
618 #define BN_F_BN_BLINDING_UPDATE                          103
619 #define BN_F_BN_BN2DEC                                   104
620 #define BN_F_BN_BN2HEX                                   105
621 #define BN_F_BN_CTX_GET                                  116
622 #define BN_F_BN_CTX_NEW                                  106
623 #define BN_F_BN_DIV                                      107
624 #define BN_F_BN_EXPAND2                                  108
625 #define BN_F_BN_EXPAND_INTERNAL                          120
626 #define BN_F_BN_GF2M_MOD                                 126
627 #define BN_F_BN_GF2M_MOD_DIV                             123
628 #define BN_F_BN_GF2M_MOD_EXP                             127
629 #define BN_F_BN_GF2M_MOD_MUL                             124
630 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD                      128
631 #define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR                  129
632 #define BN_F_BN_GF2M_MOD_SQR                             125
633 #define BN_F_BN_MOD_EXP2_MONT                            118
634 #define BN_F_BN_MOD_EXP_MONT                             109
635 #define BN_F_BN_MOD_EXP_MONT_WORD                        117
636 #define BN_F_BN_MOD_INVERSE                              110
637 #define BN_F_BN_MOD_LSHIFT_QUICK                         119
638 #define BN_F_BN_MOD_MUL_RECIPROCAL                       111
639 #define BN_F_BN_MOD_SQRT                                 121
640 #define BN_F_BN_MPI2BN                                   112
641 #define BN_F_BN_NEW                                      113
642 #define BN_F_BN_RAND                                     114
643 #define BN_F_BN_RAND_RANGE                               122
644 #define BN_F_BN_USUB                                     115
645
646 /* Reason codes. */
647 #define BN_R_ARG2_LT_ARG3                                100
648 #define BN_R_BAD_RECIPROCAL                              101
649 #define BN_R_BIGNUM_TOO_LONG                             114
650 #define BN_R_CALLED_WITH_EVEN_MODULUS                    102
651 #define BN_R_DIV_BY_ZERO                                 103
652 #define BN_R_ENCODING_ERROR                              104
653 #define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA                105
654 #define BN_R_INPUT_NOT_REDUCED                           110
655 #define BN_R_INVALID_LENGTH                              106
656 #define BN_R_INVALID_RANGE                               115
657 #define BN_R_NOT_A_SQUARE                                111
658 #define BN_R_NOT_IMPLEMENTED                             116
659 #define BN_R_NOT_INITIALIZED                             107
660 #define BN_R_NO_INVERSE                                  108
661 #define BN_R_P_IS_NOT_PRIME                              112
662 #define BN_R_TOO_MANY_ITERATIONS                         113
663 #define BN_R_TOO_MANY_TEMPORARY_VARIABLES                109
664
665 #ifdef  __cplusplus
666 }
667 #endif
668 #endif