]> git.ipfire.org Git - thirdparty/openssl.git/blob - include/openssl/bn.h
Remove /* foo.c */ comments
[thirdparty/openssl.git] / include / openssl / bn.h
1 /* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
56 */
57 /* ====================================================================
58 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
59 *
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
62 * are met:
63 *
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
66 *
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76 *
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
81 *
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
85 *
86 * 6. Redistributions of any form whatsoever must retain the following
87 * acknowledgment:
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90 *
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
104 *
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com).
108 *
109 */
110 /* ====================================================================
111 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
112 *
113 * Portions of the attached software ("Contribution") are developed by
114 * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
115 *
116 * The Contribution is licensed pursuant to the Eric Young open source
117 * license provided above.
118 *
119 * The binary polynomial arithmetic software is originally written by
120 * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
121 *
122 */
123
124 #ifndef HEADER_BN_H
125 # define HEADER_BN_H
126
127 # include <openssl/e_os2.h>
128 # ifndef OPENSSL_NO_STDIO
129 # include <stdio.h> /* FILE */
130 # endif
131 # include <openssl/opensslconf.h>
132 # include <openssl/ossl_typ.h>
133 # include <openssl/crypto.h>
134
135 #ifdef __cplusplus
136 extern "C" {
137 #endif
138
139 /*
140 * These preprocessor symbols control various aspects of the bignum headers
141 * and library code. They're not defined by any "normal" configuration, as
142 * they are intended for development and testing purposes. NB: defining all
143 * three can be useful for debugging application code as well as openssl
144 * itself. BN_DEBUG - turn on various debugging alterations to the bignum
145 * code BN_DEBUG_RAND - uses random poisoning of unused words to trip up
146 * mismanagement of bignum internals. You must also define BN_DEBUG.
147 */
148 /* #define BN_DEBUG */
149 /* #define BN_DEBUG_RAND */
150
151 # ifndef OPENSSL_SMALL_FOOTPRINT
152 # define BN_MUL_COMBA
153 # define BN_SQR_COMBA
154 # define BN_RECURSION
155 # endif
156
157 /*
158 * This next option uses the C libraries (2 word)/(1 word) function. If it is
159 * not defined, I use my C version (which is slower). The reason for this
160 * flag is that when the particular C compiler library routine is used, and
161 * the library is linked with a different compiler, the library is missing.
162 * This mostly happens when the library is built with gcc and then linked
163 * using normal cc. This would be a common occurrence because gcc normally
164 * produces code that is 2 times faster than system compilers for the big
165 * number stuff. For machines with only one compiler (or shared libraries),
166 * this should be on. Again this in only really a problem on machines using
167 * "long long's", are 32bit, and are not using my assembler code.
168 */
169 # if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || \
170 defined(OPENSSL_SYS_WIN32) || defined(linux)
171 # ifndef BN_DIV2W
172 # define BN_DIV2W
173 # endif
174 # endif
175
176 /*
177 * assuming long is 64bit - this is the DEC Alpha unsigned long long is only
178 * 64 bits :-(, don't define BN_LLONG for the DEC Alpha
179 */
180 # ifdef SIXTY_FOUR_BIT_LONG
181 # define BN_ULLONG unsigned long long
182 # define BN_ULONG unsigned long
183 # define BN_LONG long
184 # define BN_BITS 128
185 # define BN_BYTES 8
186 # define BN_BITS2 64
187 # define BN_BITS4 32
188 # define BN_MASK (0xffffffffffffffffffffffffffffffffLL)
189 # define BN_MASK2 (0xffffffffffffffffL)
190 # define BN_MASK2l (0xffffffffL)
191 # define BN_MASK2h (0xffffffff00000000L)
192 # define BN_MASK2h1 (0xffffffff80000000L)
193 # define BN_TBIT (0x8000000000000000L)
194 # define BN_DEC_CONV (10000000000000000000UL)
195 # define BN_DEC_FMT1 "%lu"
196 # define BN_DEC_FMT2 "%019lu"
197 # define BN_DEC_NUM 19
198 # define BN_HEX_FMT1 "%lX"
199 # define BN_HEX_FMT2 "%016lX"
200 # endif
201
202 /*
203 * This is where the long long data type is 64 bits, but long is 32. For
204 * machines where there are 64bit registers, this is the mode to use. IRIX,
205 * on R4000 and above should use this mode, along with the relevant assembler
206 * code :-). Do NOT define BN_LLONG.
207 */
208 # ifdef SIXTY_FOUR_BIT
209 # undef BN_LLONG
210 # undef BN_ULLONG
211 # define BN_ULONG unsigned long long
212 # define BN_LONG long long
213 # define BN_BITS 128
214 # define BN_BYTES 8
215 # define BN_BITS2 64
216 # define BN_BITS4 32
217 # define BN_MASK2 (0xffffffffffffffffLL)
218 # define BN_MASK2l (0xffffffffL)
219 # define BN_MASK2h (0xffffffff00000000LL)
220 # define BN_MASK2h1 (0xffffffff80000000LL)
221 # define BN_TBIT (0x8000000000000000LL)
222 # define BN_DEC_CONV (10000000000000000000ULL)
223 # define BN_DEC_FMT1 "%llu"
224 # define BN_DEC_FMT2 "%019llu"
225 # define BN_DEC_NUM 19
226 # define BN_HEX_FMT1 "%llX"
227 # define BN_HEX_FMT2 "%016llX"
228 # endif
229
230 # ifdef THIRTY_TWO_BIT
231 # ifdef BN_LLONG
232 # if defined(_WIN32) && !defined(__GNUC__)
233 # define BN_ULLONG unsigned __int64
234 # define BN_MASK (0xffffffffffffffffI64)
235 # else
236 # define BN_ULLONG unsigned long long
237 # define BN_MASK (0xffffffffffffffffLL)
238 # endif
239 # endif
240 # define BN_ULONG unsigned int
241 # define BN_LONG int
242 # define BN_BITS 64
243 # define BN_BYTES 4
244 # define BN_BITS2 32
245 # define BN_BITS4 16
246 # define BN_MASK2 (0xffffffffL)
247 # define BN_MASK2l (0xffff)
248 # define BN_MASK2h1 (0xffff8000L)
249 # define BN_MASK2h (0xffff0000L)
250 # define BN_TBIT (0x80000000L)
251 # define BN_DEC_CONV (1000000000L)
252 # define BN_DEC_FMT1 "%u"
253 # define BN_DEC_FMT2 "%09u"
254 # define BN_DEC_NUM 9
255 # define BN_HEX_FMT1 "%X"
256 # define BN_HEX_FMT2 "%08X"
257 # endif
258
259 # define BN_DEFAULT_BITS 1280
260
261 # define BN_FLG_MALLOCED 0x01
262 # define BN_FLG_STATIC_DATA 0x02
263
264 /*
265 * avoid leaking exponent information through timing,
266 * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime,
267 * BN_div() will call BN_div_no_branch,
268 * BN_mod_inverse() will call BN_mod_inverse_no_branch.
269 */
270 # define BN_FLG_CONSTTIME 0x04
271 # define BN_FLG_SECURE 0x08
272
273 # if OPENSSL_API_COMPAT < 0x00908000L
274 /* deprecated name for the flag */
275 # define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME
276 # define BN_FLG_FREE 0x8000 /* used for debuging */
277 # endif
278
279 void BN_set_flags(BIGNUM *b, int n);
280 int BN_get_flags(const BIGNUM *b, int n);
281
282 /*
283 * get a clone of a BIGNUM with changed flags, for *temporary* use only (the
284 * two BIGNUMs cannot be used in parallel!). Also only for *read only* use. The
285 * value |dest| should be a newly allocated BIGNUM obtained via BN_new() that
286 * has not been otherwise initialised or used.
287 */
288 void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags);
289
290 /* Wrapper function to make using BN_GENCB easier, */
291 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
292
293 BN_GENCB *BN_GENCB_new(void);
294 void BN_GENCB_free(BN_GENCB *cb);
295
296 /* Populate a BN_GENCB structure with an "old"-style callback */
297 void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
298 void *cb_arg);
299
300 /* Populate a BN_GENCB structure with a "new"-style callback */
301 void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
302 void *cb_arg);
303
304 void *BN_GENCB_get_arg(BN_GENCB *cb);
305
306 # define BN_prime_checks 0 /* default: select number of iterations based
307 * on the size of the number */
308
309 /*
310 * number of Miller-Rabin iterations for an error rate of less than 2^-80 for
311 * random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook of
312 * Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
313 * original paper: Damgaard, Landrock, Pomerance: Average case error
314 * estimates for the strong probable prime test. -- Math. Comp. 61 (1993)
315 * 177-194)
316 */
317 # define BN_prime_checks_for_size(b) ((b) >= 1300 ? 2 : \
318 (b) >= 850 ? 3 : \
319 (b) >= 650 ? 4 : \
320 (b) >= 550 ? 5 : \
321 (b) >= 450 ? 6 : \
322 (b) >= 400 ? 7 : \
323 (b) >= 350 ? 8 : \
324 (b) >= 300 ? 9 : \
325 (b) >= 250 ? 12 : \
326 (b) >= 200 ? 15 : \
327 (b) >= 150 ? 18 : \
328 /* b >= 100 */ 27)
329
330 # define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
331
332 int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w);
333 int BN_is_zero(const BIGNUM *a);
334 int BN_is_one(const BIGNUM *a);
335 int BN_is_word(const BIGNUM *a, const BN_ULONG w);
336 int BN_is_odd(const BIGNUM *a);
337
338 # define BN_one(a) (BN_set_word((a),1))
339
340 void BN_zero_ex(BIGNUM *a);
341
342 # if OPENSSL_API_COMPAT >= 0x00908000L
343 # define BN_zero(a) BN_zero_ex(a)
344 # else
345 # define BN_zero(a) (BN_set_word((a),0))
346 # endif
347
348 const BIGNUM *BN_value_one(void);
349 char *BN_options(void);
350 BN_CTX *BN_CTX_new(void);
351 BN_CTX *BN_CTX_secure_new(void);
352 void BN_CTX_free(BN_CTX *c);
353 void BN_CTX_start(BN_CTX *ctx);
354 BIGNUM *BN_CTX_get(BN_CTX *ctx);
355 void BN_CTX_end(BN_CTX *ctx);
356 int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
357 int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
358 int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
359 int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
360 int BN_num_bits(const BIGNUM *a);
361 int BN_num_bits_word(BN_ULONG l);
362 int BN_security_bits(int L, int N);
363 BIGNUM *BN_new(void);
364 BIGNUM *BN_secure_new(void);
365 void BN_clear_free(BIGNUM *a);
366 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
367 void BN_swap(BIGNUM *a, BIGNUM *b);
368 BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
369 int BN_bn2bin(const BIGNUM *a, unsigned char *to);
370 BIGNUM *BN_mpi2bn(const unsigned char *s, int len, BIGNUM *ret);
371 int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
372 int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
373 int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
374 int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
375 int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
376 int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
377 int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
378 /** BN_set_negative sets sign of a BIGNUM
379 * \param b pointer to the BIGNUM object
380 * \param n 0 if the BIGNUM b should be positive and a value != 0 otherwise
381 */
382 void BN_set_negative(BIGNUM *b, int n);
383 /** BN_is_negative returns 1 if the BIGNUM is negative
384 * \param a pointer to the BIGNUM object
385 * \return 1 if a < 0 and 0 otherwise
386 */
387 int BN_is_negative(const BIGNUM *b);
388
389 int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
390 BN_CTX *ctx);
391 # define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
392 int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
393 int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
394 BN_CTX *ctx);
395 int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
396 const BIGNUM *m);
397 int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
398 BN_CTX *ctx);
399 int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
400 const BIGNUM *m);
401 int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
402 BN_CTX *ctx);
403 int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
404 int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
405 int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
406 int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m,
407 BN_CTX *ctx);
408 int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
409
410 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
411 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
412 int BN_mul_word(BIGNUM *a, BN_ULONG w);
413 int BN_add_word(BIGNUM *a, BN_ULONG w);
414 int BN_sub_word(BIGNUM *a, BN_ULONG w);
415 int BN_set_word(BIGNUM *a, BN_ULONG w);
416 BN_ULONG BN_get_word(const BIGNUM *a);
417
418 int BN_cmp(const BIGNUM *a, const BIGNUM *b);
419 void BN_free(BIGNUM *a);
420 int BN_is_bit_set(const BIGNUM *a, int n);
421 int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
422 int BN_lshift1(BIGNUM *r, const BIGNUM *a);
423 int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
424
425 int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
426 const BIGNUM *m, BN_CTX *ctx);
427 int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
428 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
429 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
430 const BIGNUM *m, BN_CTX *ctx,
431 BN_MONT_CTX *in_mont);
432 int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
433 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
434 int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
435 const BIGNUM *a2, const BIGNUM *p2, const BIGNUM *m,
436 BN_CTX *ctx, BN_MONT_CTX *m_ctx);
437 int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
438 const BIGNUM *m, BN_CTX *ctx);
439
440 int BN_mask_bits(BIGNUM *a, int n);
441 # ifndef OPENSSL_NO_STDIO
442 int BN_print_fp(FILE *fp, const BIGNUM *a);
443 # endif
444 # ifdef HEADER_BIO_H
445 int BN_print(BIO *fp, const BIGNUM *a);
446 # else
447 int BN_print(void *fp, const BIGNUM *a);
448 # endif
449 int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
450 int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
451 int BN_rshift1(BIGNUM *r, const BIGNUM *a);
452 void BN_clear(BIGNUM *a);
453 BIGNUM *BN_dup(const BIGNUM *a);
454 int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
455 int BN_set_bit(BIGNUM *a, int n);
456 int BN_clear_bit(BIGNUM *a, int n);
457 char *BN_bn2hex(const BIGNUM *a);
458 char *BN_bn2dec(const BIGNUM *a);
459 int BN_hex2bn(BIGNUM **a, const char *str);
460 int BN_dec2bn(BIGNUM **a, const char *str);
461 int BN_asc2bn(BIGNUM **a, const char *str);
462 int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
463 int BN_kronecker(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); /* returns
464 * -2 for
465 * error */
466 BIGNUM *BN_mod_inverse(BIGNUM *ret,
467 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
468 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
469 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
470
471 void BN_consttime_swap(BN_ULONG swap, BIGNUM *a, BIGNUM *b, int nwords);
472
473 /* Deprecated versions */
474 DEPRECATEDIN_0_9_8(BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,
475 const BIGNUM *add,
476 const BIGNUM *rem,
477 void (*callback) (int, int,
478 void *),
479 void *cb_arg))
480 DEPRECATEDIN_0_9_8(int
481 BN_is_prime(const BIGNUM *p, int nchecks,
482 void (*callback) (int, int, void *),
483 BN_CTX *ctx, void *cb_arg))
484 DEPRECATEDIN_0_9_8(int
485 BN_is_prime_fasttest(const BIGNUM *p, int nchecks,
486 void (*callback) (int, int, void *),
487 BN_CTX *ctx, void *cb_arg,
488 int do_trial_division))
489
490 /* Newer versions */
491 int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add,
492 const BIGNUM *rem, BN_GENCB *cb);
493 int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb);
494 int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx,
495 int do_trial_division, BN_GENCB *cb);
496
497 int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx);
498
499 int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
500 const BIGNUM *Xp, const BIGNUM *Xp1,
501 const BIGNUM *Xp2, const BIGNUM *e, BN_CTX *ctx,
502 BN_GENCB *cb);
503 int BN_X931_generate_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2, BIGNUM *Xp1,
504 BIGNUM *Xp2, const BIGNUM *Xp, const BIGNUM *e,
505 BN_CTX *ctx, BN_GENCB *cb);
506
507 BN_MONT_CTX *BN_MONT_CTX_new(void);
508 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
509 BN_MONT_CTX *mont, BN_CTX *ctx);
510 int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
511 BN_CTX *ctx);
512 int BN_from_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
513 BN_CTX *ctx);
514 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
515 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx);
516 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
517 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock,
518 const BIGNUM *mod, BN_CTX *ctx);
519
520 /* BN_BLINDING flags */
521 # define BN_BLINDING_NO_UPDATE 0x00000001
522 # define BN_BLINDING_NO_RECREATE 0x00000002
523
524 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
525 void BN_BLINDING_free(BN_BLINDING *b);
526 int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx);
527 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
528 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
529 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
530 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
531 BN_CTX *);
532 DEPRECATEDIN_1_0_0(unsigned long
533 BN_BLINDING_get_thread_id(const BN_BLINDING *))
534 DEPRECATEDIN_1_0_0(void
535 BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long))
536 CRYPTO_THREADID *BN_BLINDING_thread_id(BN_BLINDING *);
537 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
538 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
539 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
540 const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
541 int (*bn_mod_exp) (BIGNUM *r,
542 const BIGNUM *a,
543 const BIGNUM *p,
544 const BIGNUM *m,
545 BN_CTX *ctx,
546 BN_MONT_CTX *m_ctx),
547 BN_MONT_CTX *m_ctx);
548
549 DEPRECATEDIN_0_9_8(void BN_set_params(int mul, int high, int low, int mont))
550 DEPRECATEDIN_0_9_8(int BN_get_params(int which)) /* 0, mul, 1 high, 2 low, 3
551 * mont */
552
553 BN_RECP_CTX *BN_RECP_CTX_new(void);
554 void BN_RECP_CTX_free(BN_RECP_CTX *recp);
555 int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *rdiv, BN_CTX *ctx);
556 int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
557 BN_RECP_CTX *recp, BN_CTX *ctx);
558 int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
559 const BIGNUM *m, BN_CTX *ctx);
560 int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
561 BN_RECP_CTX *recp, BN_CTX *ctx);
562
563 # ifndef OPENSSL_NO_EC2M
564
565 /*
566 * Functions for arithmetic over binary polynomials represented by BIGNUMs.
567 * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
568 * ignored. Note that input arguments are not const so that their bit arrays
569 * can be expanded to the appropriate size if needed.
570 */
571
572 /*
573 * r = a + b
574 */
575 int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
576 # define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
577 /*
578 * r=a mod p
579 */
580 int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p);
581 /* r = (a * b) mod p */
582 int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
583 const BIGNUM *p, BN_CTX *ctx);
584 /* r = (a * a) mod p */
585 int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
586 /* r = (1 / b) mod p */
587 int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx);
588 /* r = (a / b) mod p */
589 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
590 const BIGNUM *p, BN_CTX *ctx);
591 /* r = (a ^ b) mod p */
592 int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
593 const BIGNUM *p, BN_CTX *ctx);
594 /* r = sqrt(a) mod p */
595 int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
596 BN_CTX *ctx);
597 /* r^2 + r = a mod p */
598 int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
599 BN_CTX *ctx);
600 # define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
601 /*-
602 * Some functions allow for representation of the irreducible polynomials
603 * as an unsigned int[], say p. The irreducible f(t) is then of the form:
604 * t^p[0] + t^p[1] + ... + t^p[k]
605 * where m = p[0] > p[1] > ... > p[k] = 0.
606 */
607 /* r = a mod p */
608 int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]);
609 /* r = (a * b) mod p */
610 int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
611 const int p[], BN_CTX *ctx);
612 /* r = (a * a) mod p */
613 int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[],
614 BN_CTX *ctx);
615 /* r = (1 / b) mod p */
616 int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[],
617 BN_CTX *ctx);
618 /* r = (a / b) mod p */
619 int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
620 const int p[], BN_CTX *ctx);
621 /* r = (a ^ b) mod p */
622 int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
623 const int p[], BN_CTX *ctx);
624 /* r = sqrt(a) mod p */
625 int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
626 const int p[], BN_CTX *ctx);
627 /* r^2 + r = a mod p */
628 int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
629 const int p[], BN_CTX *ctx);
630 int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max);
631 int BN_GF2m_arr2poly(const int p[], BIGNUM *a);
632
633 # endif
634
635 /*
636 * faster mod functions for the 'NIST primes' 0 <= a < p^2
637 */
638 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
639 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
640 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
641 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
642 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
643
644 const BIGNUM *BN_get0_nist_prime_192(void);
645 const BIGNUM *BN_get0_nist_prime_224(void);
646 const BIGNUM *BN_get0_nist_prime_256(void);
647 const BIGNUM *BN_get0_nist_prime_384(void);
648 const BIGNUM *BN_get0_nist_prime_521(void);
649
650 int (*BN_nist_mod_func(const BIGNUM *p)) (BIGNUM *r, const BIGNUM *a,
651 const BIGNUM *field, BN_CTX *ctx);
652
653 int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range,
654 const BIGNUM *priv, const unsigned char *message,
655 size_t message_len, BN_CTX *ctx);
656
657 /* Primes from RFC 2409 */
658 BIGNUM *get_rfc2409_prime_768(BIGNUM *bn);
659 BIGNUM *get_rfc2409_prime_1024(BIGNUM *bn);
660
661 /* Primes from RFC 3526 */
662 BIGNUM *get_rfc3526_prime_1536(BIGNUM *bn);
663 BIGNUM *get_rfc3526_prime_2048(BIGNUM *bn);
664 BIGNUM *get_rfc3526_prime_3072(BIGNUM *bn);
665 BIGNUM *get_rfc3526_prime_4096(BIGNUM *bn);
666 BIGNUM *get_rfc3526_prime_6144(BIGNUM *bn);
667 BIGNUM *get_rfc3526_prime_8192(BIGNUM *bn);
668
669 int BN_bntest_rand(BIGNUM *rnd, int bits, int top, int bottom);
670
671 /* BEGIN ERROR CODES */
672 /*
673 * The following lines are auto generated by the script mkerr.pl. Any changes
674 * made after this point may be overwritten when the script is next run.
675 */
676 void ERR_load_BN_strings(void);
677
678 /* Error codes for the BN functions. */
679
680 /* Function codes. */
681 # define BN_F_BNRAND 127
682 # define BN_F_BN_BLINDING_CONVERT_EX 100
683 # define BN_F_BN_BLINDING_CREATE_PARAM 128
684 # define BN_F_BN_BLINDING_INVERT_EX 101
685 # define BN_F_BN_BLINDING_NEW 102
686 # define BN_F_BN_BLINDING_UPDATE 103
687 # define BN_F_BN_BN2DEC 104
688 # define BN_F_BN_BN2HEX 105
689 # define BN_F_BN_COMPUTE_WNAF 142
690 # define BN_F_BN_CTX_GET 116
691 # define BN_F_BN_CTX_NEW 106
692 # define BN_F_BN_CTX_START 129
693 # define BN_F_BN_DIV 107
694 # define BN_F_BN_DIV_NO_BRANCH 138
695 # define BN_F_BN_DIV_RECP 130
696 # define BN_F_BN_EXP 123
697 # define BN_F_BN_EXPAND2 108
698 # define BN_F_BN_EXPAND_INTERNAL 120
699 # define BN_F_BN_GENCB_NEW 143
700 # define BN_F_BN_GENERATE_DSA_NONCE 140
701 # define BN_F_BN_GENERATE_PRIME_EX 141
702 # define BN_F_BN_GF2M_MOD 131
703 # define BN_F_BN_GF2M_MOD_EXP 132
704 # define BN_F_BN_GF2M_MOD_MUL 133
705 # define BN_F_BN_GF2M_MOD_SOLVE_QUAD 134
706 # define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR 135
707 # define BN_F_BN_GF2M_MOD_SQR 136
708 # define BN_F_BN_GF2M_MOD_SQRT 137
709 # define BN_F_BN_LSHIFT 145
710 # define BN_F_BN_MOD_EXP2_MONT 118
711 # define BN_F_BN_MOD_EXP_MONT 109
712 # define BN_F_BN_MOD_EXP_MONT_CONSTTIME 124
713 # define BN_F_BN_MOD_EXP_MONT_WORD 117
714 # define BN_F_BN_MOD_EXP_RECP 125
715 # define BN_F_BN_MOD_EXP_SIMPLE 126
716 # define BN_F_BN_MOD_INVERSE 110
717 # define BN_F_BN_MOD_INVERSE_NO_BRANCH 139
718 # define BN_F_BN_MOD_LSHIFT_QUICK 119
719 # define BN_F_BN_MOD_MUL_RECIPROCAL 111
720 # define BN_F_BN_MOD_SQRT 121
721 # define BN_F_BN_MPI2BN 112
722 # define BN_F_BN_NEW 113
723 # define BN_F_BN_RAND 114
724 # define BN_F_BN_RAND_RANGE 122
725 # define BN_F_BN_RSHIFT 146
726 # define BN_F_BN_SET_WORDS 144
727 # define BN_F_BN_USUB 115
728
729 /* Reason codes. */
730 # define BN_R_ARG2_LT_ARG3 100
731 # define BN_R_BAD_RECIPROCAL 101
732 # define BN_R_BIGNUM_TOO_LONG 114
733 # define BN_R_BITS_TOO_SMALL 118
734 # define BN_R_CALLED_WITH_EVEN_MODULUS 102
735 # define BN_R_DIV_BY_ZERO 103
736 # define BN_R_ENCODING_ERROR 104
737 # define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA 105
738 # define BN_R_INPUT_NOT_REDUCED 110
739 # define BN_R_INVALID_LENGTH 106
740 # define BN_R_INVALID_RANGE 115
741 # define BN_R_INVALID_SHIFT 119
742 # define BN_R_NOT_A_SQUARE 111
743 # define BN_R_NOT_INITIALIZED 107
744 # define BN_R_NO_INVERSE 108
745 # define BN_R_NO_SOLUTION 116
746 # define BN_R_PRIVATE_KEY_TOO_LARGE 117
747 # define BN_R_P_IS_NOT_PRIME 112
748 # define BN_R_TOO_MANY_ITERATIONS 113
749 # define BN_R_TOO_MANY_TEMPORARY_VARIABLES 109
750
751 #ifdef __cplusplus
752 }
753 #endif
754 #endif