RSA: add simple getters for commonly used struct members
[openssl.git] / include / openssl / bn.h
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4  *
5  * Licensed under the OpenSSL license (the "License").  You may not use
6  * this file except in compliance with the License.  You can obtain a copy
7  * in the file LICENSE in the source distribution or at
8  * https://www.openssl.org/source/license.html
9  */
10
11 #ifndef HEADER_BN_H
12 # define HEADER_BN_H
13
14 # include <openssl/e_os2.h>
15 # ifndef OPENSSL_NO_STDIO
16 #  include <stdio.h>
17 # endif
18 # include <openssl/opensslconf.h>
19 # include <openssl/ossl_typ.h>
20 # include <openssl/crypto.h>
21 # include <openssl/bnerr.h>
22
23 #ifdef  __cplusplus
24 extern "C" {
25 #endif
26
27 /*
28  * 64-bit processor with LP64 ABI
29  */
30 # ifdef SIXTY_FOUR_BIT_LONG
31 #  define BN_ULONG        unsigned long
32 #  define BN_BYTES        8
33 # endif
34
35 /*
36  * 64-bit processor other than LP64 ABI
37  */
38 # ifdef SIXTY_FOUR_BIT
39 #  define BN_ULONG        unsigned long long
40 #  define BN_BYTES        8
41 # endif
42
43 # ifdef THIRTY_TWO_BIT
44 #  define BN_ULONG        unsigned int
45 #  define BN_BYTES        4
46 # endif
47
48 # define BN_BITS2       (BN_BYTES * 8)
49 # define BN_BITS        (BN_BITS2 * 2)
50 # define BN_TBIT        ((BN_ULONG)1 << (BN_BITS2 - 1))
51
52 # define BN_FLG_MALLOCED         0x01
53 # define BN_FLG_STATIC_DATA      0x02
54
55 /*
56  * avoid leaking exponent information through timing,
57  * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime,
58  * BN_div() will call BN_div_no_branch,
59  * BN_mod_inverse() will call BN_mod_inverse_no_branch.
60  */
61 # define BN_FLG_CONSTTIME        0x04
62 # define BN_FLG_SECURE           0x08
63
64 # if OPENSSL_API_COMPAT < 0x00908000L
65 /* deprecated name for the flag */
66 #  define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME
67 #  define BN_FLG_FREE            0x8000 /* used for debugging */
68 # endif
69
70 void BN_set_flags(BIGNUM *b, int n);
71 int BN_get_flags(const BIGNUM *b, int n);
72
73 /* Values for |top| in BN_rand() */
74 #define BN_RAND_TOP_ANY    -1
75 #define BN_RAND_TOP_ONE     0
76 #define BN_RAND_TOP_TWO     1
77
78 /* Values for |bottom| in BN_rand() */
79 #define BN_RAND_BOTTOM_ANY  0
80 #define BN_RAND_BOTTOM_ODD  1
81
82 /*
83  * get a clone of a BIGNUM with changed flags, for *temporary* use only (the
84  * two BIGNUMs cannot be used in parallel!). Also only for *read only* use. The
85  * value |dest| should be a newly allocated BIGNUM obtained via BN_new() that
86  * has not been otherwise initialised or used.
87  */
88 void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags);
89
90 /* Wrapper function to make using BN_GENCB easier */
91 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
92
93 BN_GENCB *BN_GENCB_new(void);
94 void BN_GENCB_free(BN_GENCB *cb);
95
96 /* Populate a BN_GENCB structure with an "old"-style callback */
97 void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
98                       void *cb_arg);
99
100 /* Populate a BN_GENCB structure with a "new"-style callback */
101 void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
102                   void *cb_arg);
103
104 void *BN_GENCB_get_arg(BN_GENCB *cb);
105
106 # define BN_prime_checks 0      /* default: select number of iterations based
107                                  * on the size of the number */
108
109 /*
110  * number of Miller-Rabin iterations for an error rate of less than 2^-80 for
111  * random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook of
112  * Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
113  * original paper: Damgaard, Landrock, Pomerance: Average case error
114  * estimates for the strong probable prime test. -- Math. Comp. 61 (1993)
115  * 177-194)
116  */
117 # define BN_prime_checks_for_size(b) ((b) >= 1300 ?  2 : \
118                                 (b) >=  850 ?  3 : \
119                                 (b) >=  650 ?  4 : \
120                                 (b) >=  550 ?  5 : \
121                                 (b) >=  450 ?  6 : \
122                                 (b) >=  400 ?  7 : \
123                                 (b) >=  350 ?  8 : \
124                                 (b) >=  300 ?  9 : \
125                                 (b) >=  250 ? 12 : \
126                                 (b) >=  200 ? 15 : \
127                                 (b) >=  150 ? 18 : \
128                                 /* b >= 100 */ 27)
129
130 # define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
131
132 int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w);
133 int BN_is_zero(const BIGNUM *a);
134 int BN_is_one(const BIGNUM *a);
135 int BN_is_word(const BIGNUM *a, const BN_ULONG w);
136 int BN_is_odd(const BIGNUM *a);
137
138 # define BN_one(a)       (BN_set_word((a),1))
139
140 void BN_zero_ex(BIGNUM *a);
141
142 # if OPENSSL_API_COMPAT >= 0x00908000L
143 #  define BN_zero(a)      BN_zero_ex(a)
144 # else
145 #  define BN_zero(a)      (BN_set_word((a),0))
146 # endif
147
148 const BIGNUM *BN_value_one(void);
149 char *BN_options(void);
150 BN_CTX *BN_CTX_new(void);
151 BN_CTX *BN_CTX_secure_new(void);
152 void BN_CTX_free(BN_CTX *c);
153 void BN_CTX_start(BN_CTX *ctx);
154 BIGNUM *BN_CTX_get(BN_CTX *ctx);
155 void BN_CTX_end(BN_CTX *ctx);
156 int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
157 int BN_priv_rand(BIGNUM *rnd, int bits, int top, int bottom);
158 int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
159 int BN_priv_rand_range(BIGNUM *rnd, const BIGNUM *range);
160 int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
161 int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
162 int BN_num_bits(const BIGNUM *a);
163 int BN_num_bits_word(BN_ULONG l);
164 int BN_security_bits(int L, int N);
165 BIGNUM *BN_new(void);
166 BIGNUM *BN_secure_new(void);
167 void BN_clear_free(BIGNUM *a);
168 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
169 void BN_swap(BIGNUM *a, BIGNUM *b);
170 BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
171 int BN_bn2bin(const BIGNUM *a, unsigned char *to);
172 int BN_bn2binpad(const BIGNUM *a, unsigned char *to, int tolen);
173 BIGNUM *BN_lebin2bn(const unsigned char *s, int len, BIGNUM *ret);
174 int BN_bn2lebinpad(const BIGNUM *a, unsigned char *to, int tolen);
175 BIGNUM *BN_mpi2bn(const unsigned char *s, int len, BIGNUM *ret);
176 int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
177 int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
178 int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
179 int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
180 int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
181 int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
182 int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
183 /** BN_set_negative sets sign of a BIGNUM
184  * \param  b  pointer to the BIGNUM object
185  * \param  n  0 if the BIGNUM b should be positive and a value != 0 otherwise
186  */
187 void BN_set_negative(BIGNUM *b, int n);
188 /** BN_is_negative returns 1 if the BIGNUM is negative
189  * \param  b  pointer to the BIGNUM object
190  * \return 1 if a < 0 and 0 otherwise
191  */
192 int BN_is_negative(const BIGNUM *b);
193
194 int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
195            BN_CTX *ctx);
196 # define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
197 int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
198 int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
199                BN_CTX *ctx);
200 int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
201                      const BIGNUM *m);
202 int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
203                BN_CTX *ctx);
204 int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
205                      const BIGNUM *m);
206 int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
207                BN_CTX *ctx);
208 int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
209 int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
210 int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
211 int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m,
212                   BN_CTX *ctx);
213 int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
214
215 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
216 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
217 int BN_mul_word(BIGNUM *a, BN_ULONG w);
218 int BN_add_word(BIGNUM *a, BN_ULONG w);
219 int BN_sub_word(BIGNUM *a, BN_ULONG w);
220 int BN_set_word(BIGNUM *a, BN_ULONG w);
221 BN_ULONG BN_get_word(const BIGNUM *a);
222
223 int BN_cmp(const BIGNUM *a, const BIGNUM *b);
224 void BN_free(BIGNUM *a);
225 int BN_is_bit_set(const BIGNUM *a, int n);
226 int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
227 int BN_lshift1(BIGNUM *r, const BIGNUM *a);
228 int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
229
230 int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
231                const BIGNUM *m, BN_CTX *ctx);
232 int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
233                     const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
234 int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
235                               const BIGNUM *m, BN_CTX *ctx,
236                               BN_MONT_CTX *in_mont);
237 int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
238                          const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
239 int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
240                      const BIGNUM *a2, const BIGNUM *p2, const BIGNUM *m,
241                      BN_CTX *ctx, BN_MONT_CTX *m_ctx);
242 int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
243                       const BIGNUM *m, BN_CTX *ctx);
244
245 int BN_mask_bits(BIGNUM *a, int n);
246 # ifndef OPENSSL_NO_STDIO
247 int BN_print_fp(FILE *fp, const BIGNUM *a);
248 # endif
249 int BN_print(BIO *bio, const BIGNUM *a);
250 int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
251 int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
252 int BN_rshift1(BIGNUM *r, const BIGNUM *a);
253 void BN_clear(BIGNUM *a);
254 BIGNUM *BN_dup(const BIGNUM *a);
255 int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
256 int BN_set_bit(BIGNUM *a, int n);
257 int BN_clear_bit(BIGNUM *a, int n);
258 char *BN_bn2hex(const BIGNUM *a);
259 char *BN_bn2dec(const BIGNUM *a);
260 int BN_hex2bn(BIGNUM **a, const char *str);
261 int BN_dec2bn(BIGNUM **a, const char *str);
262 int BN_asc2bn(BIGNUM **a, const char *str);
263 int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
264 int BN_kronecker(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); /* returns
265                                                                   * -2 for
266                                                                   * error */
267 BIGNUM *BN_mod_inverse(BIGNUM *ret,
268                        const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
269 BIGNUM *BN_mod_sqrt(BIGNUM *ret,
270                     const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
271
272 void BN_consttime_swap(BN_ULONG swap, BIGNUM *a, BIGNUM *b, int nwords);
273
274 /* Deprecated versions */
275 DEPRECATEDIN_0_9_8(BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,
276                                              const BIGNUM *add,
277                                              const BIGNUM *rem,
278                                              void (*callback) (int, int,
279                                                                void *),
280                                              void *cb_arg))
281 DEPRECATEDIN_0_9_8(int
282                    BN_is_prime(const BIGNUM *p, int nchecks,
283                                void (*callback) (int, int, void *),
284                                BN_CTX *ctx, void *cb_arg))
285 DEPRECATEDIN_0_9_8(int
286                    BN_is_prime_fasttest(const BIGNUM *p, int nchecks,
287                                         void (*callback) (int, int, void *),
288                                         BN_CTX *ctx, void *cb_arg,
289                                         int do_trial_division))
290
291 /* Newer versions */
292 int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add,
293                          const BIGNUM *rem, BN_GENCB *cb);
294 int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb);
295 int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx,
296                             int do_trial_division, BN_GENCB *cb);
297
298 int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx);
299
300 int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
301                             const BIGNUM *Xp, const BIGNUM *Xp1,
302                             const BIGNUM *Xp2, const BIGNUM *e, BN_CTX *ctx,
303                             BN_GENCB *cb);
304 int BN_X931_generate_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2, BIGNUM *Xp1,
305                               BIGNUM *Xp2, const BIGNUM *Xp, const BIGNUM *e,
306                               BN_CTX *ctx, BN_GENCB *cb);
307
308 BN_MONT_CTX *BN_MONT_CTX_new(void);
309 int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
310                           BN_MONT_CTX *mont, BN_CTX *ctx);
311 int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
312                      BN_CTX *ctx);
313 int BN_from_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
314                        BN_CTX *ctx);
315 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
316 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx);
317 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
318 BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, CRYPTO_RWLOCK *lock,
319                                     const BIGNUM *mod, BN_CTX *ctx);
320
321 /* BN_BLINDING flags */
322 # define BN_BLINDING_NO_UPDATE   0x00000001
323 # define BN_BLINDING_NO_RECREATE 0x00000002
324
325 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
326 void BN_BLINDING_free(BN_BLINDING *b);
327 int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx);
328 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
329 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
330 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
331 int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
332                           BN_CTX *);
333
334 int BN_BLINDING_is_current_thread(BN_BLINDING *b);
335 void BN_BLINDING_set_current_thread(BN_BLINDING *b);
336 int BN_BLINDING_lock(BN_BLINDING *b);
337 int BN_BLINDING_unlock(BN_BLINDING *b);
338
339 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
340 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
341 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
342                                       const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
343                                       int (*bn_mod_exp) (BIGNUM *r,
344                                                          const BIGNUM *a,
345                                                          const BIGNUM *p,
346                                                          const BIGNUM *m,
347                                                          BN_CTX *ctx,
348                                                          BN_MONT_CTX *m_ctx),
349                                       BN_MONT_CTX *m_ctx);
350
351 DEPRECATEDIN_0_9_8(void BN_set_params(int mul, int high, int low, int mont))
352 DEPRECATEDIN_0_9_8(int BN_get_params(int which)) /* 0, mul, 1 high, 2 low, 3
353                                                   * mont */
354
355 BN_RECP_CTX *BN_RECP_CTX_new(void);
356 void BN_RECP_CTX_free(BN_RECP_CTX *recp);
357 int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *rdiv, BN_CTX *ctx);
358 int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
359                           BN_RECP_CTX *recp, BN_CTX *ctx);
360 int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
361                     const BIGNUM *m, BN_CTX *ctx);
362 int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
363                 BN_RECP_CTX *recp, BN_CTX *ctx);
364
365 # ifndef OPENSSL_NO_EC2M
366
367 /*
368  * Functions for arithmetic over binary polynomials represented by BIGNUMs.
369  * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
370  * ignored. Note that input arguments are not const so that their bit arrays
371  * can be expanded to the appropriate size if needed.
372  */
373
374 /*
375  * r = a + b
376  */
377 int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
378 #  define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
379 /*
380  * r=a mod p
381  */
382 int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p);
383 /* r = (a * b) mod p */
384 int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
385                     const BIGNUM *p, BN_CTX *ctx);
386 /* r = (a * a) mod p */
387 int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
388 /* r = (1 / b) mod p */
389 int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx);
390 /* r = (a / b) mod p */
391 int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
392                     const BIGNUM *p, BN_CTX *ctx);
393 /* r = (a ^ b) mod p */
394 int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
395                     const BIGNUM *p, BN_CTX *ctx);
396 /* r = sqrt(a) mod p */
397 int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
398                      BN_CTX *ctx);
399 /* r^2 + r = a mod p */
400 int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
401                            BN_CTX *ctx);
402 #  define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
403 /*-
404  * Some functions allow for representation of the irreducible polynomials
405  * as an unsigned int[], say p.  The irreducible f(t) is then of the form:
406  *     t^p[0] + t^p[1] + ... + t^p[k]
407  * where m = p[0] > p[1] > ... > p[k] = 0.
408  */
409 /* r = a mod p */
410 int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]);
411 /* r = (a * b) mod p */
412 int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
413                         const int p[], BN_CTX *ctx);
414 /* r = (a * a) mod p */
415 int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[],
416                         BN_CTX *ctx);
417 /* r = (1 / b) mod p */
418 int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[],
419                         BN_CTX *ctx);
420 /* r = (a / b) mod p */
421 int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
422                         const int p[], BN_CTX *ctx);
423 /* r = (a ^ b) mod p */
424 int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
425                         const int p[], BN_CTX *ctx);
426 /* r = sqrt(a) mod p */
427 int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
428                          const int p[], BN_CTX *ctx);
429 /* r^2 + r = a mod p */
430 int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
431                                const int p[], BN_CTX *ctx);
432 int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max);
433 int BN_GF2m_arr2poly(const int p[], BIGNUM *a);
434
435 # endif
436
437 /*
438  * faster mod functions for the 'NIST primes' 0 <= a < p^2
439  */
440 int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
441 int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
442 int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
443 int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
444 int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
445
446 const BIGNUM *BN_get0_nist_prime_192(void);
447 const BIGNUM *BN_get0_nist_prime_224(void);
448 const BIGNUM *BN_get0_nist_prime_256(void);
449 const BIGNUM *BN_get0_nist_prime_384(void);
450 const BIGNUM *BN_get0_nist_prime_521(void);
451
452 int (*BN_nist_mod_func(const BIGNUM *p)) (BIGNUM *r, const BIGNUM *a,
453                                           const BIGNUM *field, BN_CTX *ctx);
454
455 int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range,
456                           const BIGNUM *priv, const unsigned char *message,
457                           size_t message_len, BN_CTX *ctx);
458
459 /* Primes from RFC 2409 */
460 BIGNUM *BN_get_rfc2409_prime_768(BIGNUM *bn);
461 BIGNUM *BN_get_rfc2409_prime_1024(BIGNUM *bn);
462
463 /* Primes from RFC 3526 */
464 BIGNUM *BN_get_rfc3526_prime_1536(BIGNUM *bn);
465 BIGNUM *BN_get_rfc3526_prime_2048(BIGNUM *bn);
466 BIGNUM *BN_get_rfc3526_prime_3072(BIGNUM *bn);
467 BIGNUM *BN_get_rfc3526_prime_4096(BIGNUM *bn);
468 BIGNUM *BN_get_rfc3526_prime_6144(BIGNUM *bn);
469 BIGNUM *BN_get_rfc3526_prime_8192(BIGNUM *bn);
470
471 # if OPENSSL_API_COMPAT < 0x10100000L
472 #  define get_rfc2409_prime_768 BN_get_rfc2409_prime_768
473 #  define get_rfc2409_prime_1024 BN_get_rfc2409_prime_1024
474 #  define get_rfc3526_prime_1536 BN_get_rfc3526_prime_1536
475 #  define get_rfc3526_prime_2048 BN_get_rfc3526_prime_2048
476 #  define get_rfc3526_prime_3072 BN_get_rfc3526_prime_3072
477 #  define get_rfc3526_prime_4096 BN_get_rfc3526_prime_4096
478 #  define get_rfc3526_prime_6144 BN_get_rfc3526_prime_6144
479 #  define get_rfc3526_prime_8192 BN_get_rfc3526_prime_8192
480 # endif
481
482 int BN_bntest_rand(BIGNUM *rnd, int bits, int top, int bottom);
483
484
485 # ifdef  __cplusplus
486 }
487 # endif
488 #endif