]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/bn.h
Add legacy include guards to public header files
[thirdparty/openssl.git] / include / openssl / bn.h
CommitLineData
21dcbebc 1/*
6738bf14 2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
aa8f3d76 3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
48fc582f 4 *
48f4ad77 5 * Licensed under the Apache License 2.0 (the "License"). You may not use
21dcbebc
RS
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
48fc582f 9 */
21dcbebc 10
ae4186b0
DMSP
11#ifndef OPENSSL_BN_H
12# define OPENSSL_BN_H
d86167ec
DMSP
13# pragma once
14
15# include <openssl/macros.h>
16# if !OPENSSL_API_3
17# define HEADER_BN_H
18# endif
d02b48c6 19
0f113f3e
MC
20# include <openssl/e_os2.h>
21# ifndef OPENSSL_NO_STDIO
3c27208f 22# include <stdio.h>
0f113f3e 23# endif
98186eb4 24# include <openssl/opensslconf.h>
50cd4768 25# include <openssl/types.h>
0f113f3e 26# include <openssl/crypto.h>
52df25cf 27# include <openssl/bnerr.h>
8e10f2b3 28
d02b48c6
RE
29#ifdef __cplusplus
30extern "C" {
31#endif
32
0f113f3e 33/*
94af0cd7 34 * 64-bit processor with LP64 ABI
0f113f3e
MC
35 */
36# ifdef SIXTY_FOUR_BIT_LONG
0f113f3e 37# define BN_ULONG unsigned long
0f113f3e 38# define BN_BYTES 8
0f113f3e 39# endif
d02b48c6 40
0f113f3e 41/*
94af0cd7 42 * 64-bit processor other than LP64 ABI
dfeab068 43 */
0f113f3e 44# ifdef SIXTY_FOUR_BIT
0f113f3e 45# define BN_ULONG unsigned long long
0f113f3e 46# define BN_BYTES 8
0f113f3e 47# endif
d02b48c6 48
0f113f3e 49# ifdef THIRTY_TWO_BIT
0f113f3e 50# define BN_ULONG unsigned int
0f113f3e 51# define BN_BYTES 4
82e8cb40 52# endif
d02b48c6 53
94af0cd7
RS
54# define BN_BITS2 (BN_BYTES * 8)
55# define BN_BITS (BN_BITS2 * 2)
56# define BN_TBIT ((BN_ULONG)1 << (BN_BITS2 - 1))
d02b48c6 57
0f113f3e
MC
58# define BN_FLG_MALLOCED 0x01
59# define BN_FLG_STATIC_DATA 0x02
dbd87ffc
MC
60
61/*
62 * avoid leaking exponent information through timing,
63 * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime,
64 * BN_div() will call BN_div_no_branch,
65 * BN_mod_inverse() will call BN_mod_inverse_no_branch.
66 */
0f113f3e 67# define BN_FLG_CONSTTIME 0x04
74924dcb 68# define BN_FLG_SECURE 0x08
bd31fb21 69
fcd2d5a6 70# if !OPENSSL_API_0_9_8
dbd87ffc 71/* deprecated name for the flag */
0f113f3e 72# define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME
60250017 73# define BN_FLG_FREE 0x8000 /* used for debugging */
0f113f3e 74# endif
85bcf27c
MC
75
76void BN_set_flags(BIGNUM *b, int n);
77int BN_get_flags(const BIGNUM *b, int n);
dfeab068 78
f67cbb74
RS
79/* Values for |top| in BN_rand() */
80#define BN_RAND_TOP_ANY -1
81#define BN_RAND_TOP_ONE 0
82#define BN_RAND_TOP_TWO 1
83
84/* Values for |bottom| in BN_rand() */
85#define BN_RAND_BOTTOM_ANY 0
86#define BN_RAND_BOTTOM_ODD 1
87
0f113f3e
MC
88/*
89 * get a clone of a BIGNUM with changed flags, for *temporary* use only (the
e113c9c5
MC
90 * two BIGNUMs cannot be used in parallel!). Also only for *read only* use. The
91 * value |dest| should be a newly allocated BIGNUM obtained via BN_new() that
92 * has not been otherwise initialised or used.
0f113f3e 93 */
e113c9c5 94void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags);
85bcf27c 95
02e112a8 96/* Wrapper function to make using BN_GENCB easier */
e9224c71 97int BN_GENCB_call(BN_GENCB *cb, int a, int b);
85bcf27c
MC
98
99BN_GENCB *BN_GENCB_new(void);
100void BN_GENCB_free(BN_GENCB *cb);
101
102/* Populate a BN_GENCB structure with an "old"-style callback */
0f113f3e
MC
103void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
104 void *cb_arg);
85bcf27c
MC
105
106/* Populate a BN_GENCB structure with a "new"-style callback */
0f113f3e
MC
107void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
108 void *cb_arg);
85bcf27c
MC
109
110void *BN_GENCB_get_arg(BN_GENCB *cb);
e9224c71 111
0f113f3e
MC
112# define BN_prime_checks 0 /* default: select number of iterations based
113 * on the size of the number */
d02b48c6 114
0f113f3e 115/*
feac7a1c
KR
116 * BN_prime_checks_for_size() returns the number of Miller-Rabin iterations
117 * that will be done for checking that a random number is probably prime. The
118 * error rate for accepting a composite number as prime depends on the size of
119 * the prime |b|. The error rates used are for calculating an RSA key with 2 primes,
120 * and so the level is what you would expect for a key of double the size of the
121 * prime.
122 *
123 * This table is generated using the algorithm of FIPS PUB 186-4
124 * Digital Signature Standard (DSS), section F.1, page 117.
125 * (https://dx.doi.org/10.6028/NIST.FIPS.186-4)
126 *
127 * The following magma script was used to generate the output:
128 * securitybits:=125;
129 * k:=1024;
130 * for t:=1 to 65 do
131 * for M:=3 to Floor(2*Sqrt(k-1)-1) do
132 * S:=0;
133 * // Sum over m
134 * for m:=3 to M do
135 * s:=0;
136 * // Sum over j
137 * for j:=2 to m do
138 * s+:=(RealField(32)!2)^-(j+(k-1)/j);
139 * end for;
140 * S+:=2^(m-(m-1)*t)*s;
141 * end for;
142 * A:=2^(k-2-M*t);
143 * B:=8*(Pi(RealField(32))^2-6)/3*2^(k-2)*S;
144 * pkt:=2.00743*Log(2)*k*2^-k*(A+B);
145 * seclevel:=Floor(-Log(2,pkt));
146 * if seclevel ge securitybits then
147 * printf "k: %5o, security: %o bits (t: %o, M: %o)\n",k,seclevel,t,M;
148 * break;
149 * end if;
150 * end for;
151 * if seclevel ge securitybits then break; end if;
152 * end for;
153 *
154 * It can be run online at:
155 * http://magma.maths.usyd.edu.au/calc
156 *
157 * And will output:
158 * k: 1024, security: 129 bits (t: 6, M: 23)
159 *
160 * k is the number of bits of the prime, securitybits is the level we want to
161 * reach.
162 *
163 * prime length | RSA key size | # MR tests | security level
164 * -------------+--------------|------------+---------------
165 * (b) >= 6394 | >= 12788 | 3 | 256 bit
166 * (b) >= 3747 | >= 7494 | 3 | 192 bit
167 * (b) >= 1345 | >= 2690 | 4 | 128 bit
168 * (b) >= 1080 | >= 2160 | 5 | 128 bit
169 * (b) >= 852 | >= 1704 | 5 | 112 bit
170 * (b) >= 476 | >= 952 | 5 | 80 bit
171 * (b) >= 400 | >= 800 | 6 | 80 bit
172 * (b) >= 347 | >= 694 | 7 | 80 bit
173 * (b) >= 308 | >= 616 | 8 | 80 bit
174 * (b) >= 55 | >= 110 | 27 | 64 bit
175 * (b) >= 6 | >= 12 | 34 | 64 bit
0f113f3e 176 */
feac7a1c
KR
177
178# define BN_prime_checks_for_size(b) ((b) >= 3747 ? 3 : \
179 (b) >= 1345 ? 4 : \
180 (b) >= 476 ? 5 : \
181 (b) >= 400 ? 6 : \
182 (b) >= 347 ? 7 : \
183 (b) >= 308 ? 8 : \
184 (b) >= 55 ? 27 : \
185 /* b >= 6 */ 34)
38e33cef 186
0f113f3e 187# define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
85bcf27c
MC
188
189int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w);
190int BN_is_zero(const BIGNUM *a);
191int BN_is_one(const BIGNUM *a);
192int BN_is_word(const BIGNUM *a, const BN_ULONG w);
193int BN_is_odd(const BIGNUM *a);
194
0f113f3e 195# define BN_one(a) (BN_set_word((a),1))
85bcf27c
MC
196
197void BN_zero_ex(BIGNUM *a);
198
fcd2d5a6 199# if OPENSSL_API_0_9_8
0f113f3e
MC
200# define BN_zero(a) BN_zero_ex(a)
201# else
202# define BN_zero(a) (BN_set_word((a),0))
203# endif
d02b48c6 204
98499135 205const BIGNUM *BN_value_one(void);
0f113f3e 206char *BN_options(void);
7bc081dd 207BN_CTX *BN_CTX_new_ex(OPENSSL_CTX *ctx);
d02b48c6 208BN_CTX *BN_CTX_new(void);
7bc081dd 209BN_CTX *BN_CTX_secure_new_ex(OPENSSL_CTX *ctx);
74924dcb 210BN_CTX *BN_CTX_secure_new(void);
0f113f3e
MC
211void BN_CTX_free(BN_CTX *c);
212void BN_CTX_start(BN_CTX *ctx);
9b141126 213BIGNUM *BN_CTX_get(BN_CTX *ctx);
0f113f3e 214void BN_CTX_end(BN_CTX *ctx);
ee1d4f3d 215int BN_rand_ex(BIGNUM *rnd, int bits, int top, int bottom, BN_CTX *ctx);
0f113f3e 216int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
ee1d4f3d 217int BN_priv_rand_ex(BIGNUM *rnd, int bits, int top, int bottom, BN_CTX *ctx);
ddc6a5c8 218int BN_priv_rand(BIGNUM *rnd, int bits, int top, int bottom);
ee1d4f3d 219int BN_rand_range_ex(BIGNUM *r, const BIGNUM *range, BN_CTX *ctx);
0f113f3e 220int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
ee1d4f3d 221int BN_priv_rand_range_ex(BIGNUM *r, const BIGNUM *range, BN_CTX *ctx);
ddc6a5c8 222int BN_priv_rand_range(BIGNUM *rnd, const BIGNUM *range);
5ecff87d 223int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
0f113f3e
MC
224int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
225int BN_num_bits(const BIGNUM *a);
226int BN_num_bits_word(BN_ULONG l);
227int BN_security_bits(int L, int N);
d02b48c6 228BIGNUM *BN_new(void);
74924dcb 229BIGNUM *BN_secure_new(void);
0f113f3e 230void BN_clear_free(BIGNUM *a);
84c15db5 231BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
0f113f3e
MC
232void BN_swap(BIGNUM *a, BIGNUM *b);
233BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
234int BN_bn2bin(const BIGNUM *a, unsigned char *to);
85a4807f
DSH
235int BN_bn2binpad(const BIGNUM *a, unsigned char *to, int tolen);
236BIGNUM *BN_lebin2bn(const unsigned char *s, int len, BIGNUM *ret);
237int BN_bn2lebinpad(const BIGNUM *a, unsigned char *to, int tolen);
fa4d419c
RL
238BIGNUM *BN_native2bn(const unsigned char *s, int len, BIGNUM *ret);
239int BN_bn2nativepad(const BIGNUM *a, unsigned char *to, int tolen);
0f113f3e
MC
240BIGNUM *BN_mpi2bn(const unsigned char *s, int len, BIGNUM *ret);
241int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
242int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
243int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
244int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
245int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
246int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
247int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
3798cb81
NL
248/** BN_set_negative sets sign of a BIGNUM
249 * \param b pointer to the BIGNUM object
0f113f3e 250 * \param n 0 if the BIGNUM b should be positive and a value != 0 otherwise
3798cb81 251 */
0f113f3e 252void BN_set_negative(BIGNUM *b, int n);
3798cb81 253/** BN_is_negative returns 1 if the BIGNUM is negative
28c0a61b 254 * \param b pointer to the BIGNUM object
3798cb81
NL
255 * \return 1 if a < 0 and 0 otherwise
256 */
0f113f3e
MC
257int BN_is_negative(const BIGNUM *b);
258
259int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
260 BN_CTX *ctx);
261# define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
262int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
263int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
264 BN_CTX *ctx);
265int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
266 const BIGNUM *m);
267int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
268 BN_CTX *ctx);
269int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
270 const BIGNUM *m);
271int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
272 BN_CTX *ctx);
273int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
274int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
275int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
276int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m,
277 BN_CTX *ctx);
278int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
5acaa495 279
7999c65c 280BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
dfeab068 281BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
0f113f3e
MC
282int BN_mul_word(BIGNUM *a, BN_ULONG w);
283int BN_add_word(BIGNUM *a, BN_ULONG w);
284int BN_sub_word(BIGNUM *a, BN_ULONG w);
285int BN_set_word(BIGNUM *a, BN_ULONG w);
020fc820 286BN_ULONG BN_get_word(const BIGNUM *a);
5acaa495 287
0f113f3e
MC
288int BN_cmp(const BIGNUM *a, const BIGNUM *b);
289void BN_free(BIGNUM *a);
290int BN_is_bit_set(const BIGNUM *a, int n);
291int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
292int BN_lshift1(BIGNUM *r, const BIGNUM *a);
293int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
294
295int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
296 const BIGNUM *m, BN_CTX *ctx);
297int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
298 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
46a64376 299int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
0f113f3e
MC
300 const BIGNUM *m, BN_CTX *ctx,
301 BN_MONT_CTX *in_mont);
302int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
303 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
304int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
305 const BIGNUM *a2, const BIGNUM *p2, const BIGNUM *m,
306 BN_CTX *ctx, BN_MONT_CTX *m_ctx);
307int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
308 const BIGNUM *m, BN_CTX *ctx);
309
310int BN_mask_bits(BIGNUM *a, int n);
311# ifndef OPENSSL_NO_STDIO
312int BN_print_fp(FILE *fp, const BIGNUM *a);
313# endif
94af0cd7 314int BN_print(BIO *bio, const BIGNUM *a);
0f113f3e
MC
315int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
316int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
317int BN_rshift1(BIGNUM *r, const BIGNUM *a);
318void BN_clear(BIGNUM *a);
84c15db5 319BIGNUM *BN_dup(const BIGNUM *a);
0f113f3e
MC
320int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
321int BN_set_bit(BIGNUM *a, int n);
322int BN_clear_bit(BIGNUM *a, int n);
323char *BN_bn2hex(const BIGNUM *a);
324char *BN_bn2dec(const BIGNUM *a);
325int BN_hex2bn(BIGNUM **a, const char *str);
326int BN_dec2bn(BIGNUM **a, const char *str);
327int BN_asc2bn(BIGNUM **a, const char *str);
328int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
329int BN_kronecker(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); /* returns
330 * -2 for
331 * error */
020fc820 332BIGNUM *BN_mod_inverse(BIGNUM *ret,
0f113f3e 333 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
cd2eebfd 334BIGNUM *BN_mod_sqrt(BIGNUM *ret,
0f113f3e 335 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
e9224c71 336
0f113f3e 337void BN_consttime_swap(BN_ULONG swap, BIGNUM *a, BIGNUM *b, int nwords);
f9b6c0ba 338
e9224c71 339/* Deprecated versions */
98186eb4 340DEPRECATEDIN_0_9_8(BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,
0f113f3e
MC
341 const BIGNUM *add,
342 const BIGNUM *rem,
343 void (*callback) (int, int,
344 void *),
98186eb4
VD
345 void *cb_arg))
346DEPRECATEDIN_0_9_8(int
0f113f3e
MC
347 BN_is_prime(const BIGNUM *p, int nchecks,
348 void (*callback) (int, int, void *),
98186eb4
VD
349 BN_CTX *ctx, void *cb_arg))
350DEPRECATEDIN_0_9_8(int
0f113f3e
MC
351 BN_is_prime_fasttest(const BIGNUM *p, int nchecks,
352 void (*callback) (int, int, void *),
353 BN_CTX *ctx, void *cb_arg,
98186eb4 354 int do_trial_division))
e9224c71
GT
355
356/* Newer versions */
2934be91
MC
357int BN_generate_prime_ex2(BIGNUM *ret, int bits, int safe,
358 const BIGNUM *add, const BIGNUM *rem, BN_GENCB *cb,
359 BN_CTX *ctx);
0f113f3e
MC
360int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add,
361 const BIGNUM *rem, BN_GENCB *cb);
362int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb);
363int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx,
364 int do_trial_division, BN_GENCB *cb);
d02b48c6 365
7b1a0451
DSH
366int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx);
367
368int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
0f113f3e
MC
369 const BIGNUM *Xp, const BIGNUM *Xp1,
370 const BIGNUM *Xp2, const BIGNUM *e, BN_CTX *ctx,
371 BN_GENCB *cb);
372int BN_X931_generate_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2, BIGNUM *Xp1,
373 BIGNUM *Xp2, const BIGNUM *Xp, const BIGNUM *e,
374 BN_CTX *ctx, BN_GENCB *cb);
375
376BN_MONT_CTX *BN_MONT_CTX_new(void);
377int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
378 BN_MONT_CTX *mont, BN_CTX *ctx);
379int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
380 BN_CTX *ctx);
381int BN_from_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
382 BN_CTX *ctx);
d02b48c6 383void BN_MONT_CTX_free(BN_MONT_CTX *mont);
0f113f3e
MC
384int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx);
385BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
d188a536 386BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, CRYPTO_RWLOCK *lock,
0f113f3e 387 const BIGNUM *mod, BN_CTX *ctx);
d02b48c6 388
800e400d 389/* BN_BLINDING flags */
0f113f3e
MC
390# define BN_BLINDING_NO_UPDATE 0x00000001
391# define BN_BLINDING_NO_RECREATE 0x00000002
800e400d
NL
392
393BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
58964a49 394void BN_BLINDING_free(BN_BLINDING *b);
0f113f3e 395int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx);
800e400d 396int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
58964a49 397int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
800e400d 398int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
0f113f3e
MC
399int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
400 BN_CTX *);
0b1a07c8
AG
401
402int BN_BLINDING_is_current_thread(BN_BLINDING *b);
403void BN_BLINDING_set_current_thread(BN_BLINDING *b);
404int BN_BLINDING_lock(BN_BLINDING *b);
405int BN_BLINDING_unlock(BN_BLINDING *b);
406
800e400d
NL
407unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
408void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
409BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
0f113f3e
MC
410 const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
411 int (*bn_mod_exp) (BIGNUM *r,
412 const BIGNUM *a,
413 const BIGNUM *p,
414 const BIGNUM *m,
415 BN_CTX *ctx,
416 BN_MONT_CTX *m_ctx),
417 BN_MONT_CTX *m_ctx);
418
98186eb4
VD
419DEPRECATEDIN_0_9_8(void BN_set_params(int mul, int high, int low, int mont))
420DEPRECATEDIN_0_9_8(int BN_get_params(int which)) /* 0, mul, 1 high, 2 low, 3
421 * mont */
dfeab068 422
dfeab068 423BN_RECP_CTX *BN_RECP_CTX_new(void);
0f113f3e
MC
424void BN_RECP_CTX_free(BN_RECP_CTX *recp);
425int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *rdiv, BN_CTX *ctx);
426int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
427 BN_RECP_CTX *recp, BN_CTX *ctx);
428int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
429 const BIGNUM *m, BN_CTX *ctx);
430int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
431 BN_RECP_CTX *recp, BN_CTX *ctx);
432
433# ifndef OPENSSL_NO_EC2M
434
435/*
436 * Functions for arithmetic over binary polynomials represented by BIGNUMs.
b53e44e5 437 * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
0f113f3e
MC
438 * ignored. Note that input arguments are not const so that their bit arrays
439 * can be expanded to the appropriate size if needed.
1dc920c8 440 */
b53e44e5 441
0f113f3e
MC
442/*
443 * r = a + b
444 */
445int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
446# define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
447/*
448 * r=a mod p
449 */
450int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p);
e636e2ac 451/* r = (a * b) mod p */
0f113f3e
MC
452int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
453 const BIGNUM *p, BN_CTX *ctx);
e636e2ac 454/* r = (a * a) mod p */
0f113f3e 455int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
e636e2ac 456/* r = (1 / b) mod p */
0f113f3e 457int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx);
e636e2ac 458/* r = (a / b) mod p */
0f113f3e
MC
459int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
460 const BIGNUM *p, BN_CTX *ctx);
e636e2ac 461/* r = (a ^ b) mod p */
0f113f3e
MC
462int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
463 const BIGNUM *p, BN_CTX *ctx);
e636e2ac 464/* r = sqrt(a) mod p */
0f113f3e
MC
465int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
466 BN_CTX *ctx);
e636e2ac 467/* r^2 + r = a mod p */
0f113f3e
MC
468int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
469 BN_CTX *ctx);
470# define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
c80fd6b2
MC
471/*-
472 * Some functions allow for representation of the irreducible polynomials
1dc920c8
BM
473 * as an unsigned int[], say p. The irreducible f(t) is then of the form:
474 * t^p[0] + t^p[1] + ... + t^p[k]
475 * where m = p[0] > p[1] > ... > p[k] = 0.
476 */
e636e2ac 477/* r = a mod p */
0f113f3e 478int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]);
e636e2ac 479/* r = (a * b) mod p */
0f113f3e
MC
480int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
481 const int p[], BN_CTX *ctx);
e636e2ac 482/* r = (a * a) mod p */
0f113f3e
MC
483int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[],
484 BN_CTX *ctx);
e636e2ac 485/* r = (1 / b) mod p */
0f113f3e
MC
486int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[],
487 BN_CTX *ctx);
e636e2ac 488/* r = (a / b) mod p */
0f113f3e
MC
489int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
490 const int p[], BN_CTX *ctx);
e636e2ac 491/* r = (a ^ b) mod p */
0f113f3e
MC
492int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
493 const int p[], BN_CTX *ctx);
e636e2ac 494/* r = sqrt(a) mod p */
0f113f3e
MC
495int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
496 const int p[], BN_CTX *ctx);
e636e2ac 497/* r^2 + r = a mod p */
0f113f3e
MC
498int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
499 const int p[], BN_CTX *ctx);
500int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max);
501int BN_GF2m_arr2poly(const int p[], BIGNUM *a);
1dc920c8 502
0f113f3e 503# endif
c9a90645 504
0f113f3e
MC
505/*
506 * faster mod functions for the 'NIST primes' 0 <= a < p^2
507 */
5c6bf031
BM
508int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
509int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
510int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
511int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
512int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
513
514const BIGNUM *BN_get0_nist_prime_192(void);
515const BIGNUM *BN_get0_nist_prime_224(void);
516const BIGNUM *BN_get0_nist_prime_256(void);
517const BIGNUM *BN_get0_nist_prime_384(void);
518const BIGNUM *BN_get0_nist_prime_521(void);
519
0f113f3e
MC
520int (*BN_nist_mod_func(const BIGNUM *p)) (BIGNUM *r, const BIGNUM *a,
521 const BIGNUM *field, BN_CTX *ctx);
8a99cb29 522
0f113f3e
MC
523int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range,
524 const BIGNUM *priv, const unsigned char *message,
525 size_t message_len, BN_CTX *ctx);
775c63fc 526
bf3d6c0c 527/* Primes from RFC 2409 */
9021a5df
RS
528BIGNUM *BN_get_rfc2409_prime_768(BIGNUM *bn);
529BIGNUM *BN_get_rfc2409_prime_1024(BIGNUM *bn);
bf3d6c0c
BL
530
531/* Primes from RFC 3526 */
9021a5df
RS
532BIGNUM *BN_get_rfc3526_prime_1536(BIGNUM *bn);
533BIGNUM *BN_get_rfc3526_prime_2048(BIGNUM *bn);
534BIGNUM *BN_get_rfc3526_prime_3072(BIGNUM *bn);
535BIGNUM *BN_get_rfc3526_prime_4096(BIGNUM *bn);
536BIGNUM *BN_get_rfc3526_prime_6144(BIGNUM *bn);
537BIGNUM *BN_get_rfc3526_prime_8192(BIGNUM *bn);
538
fcd2d5a6 539# if !OPENSSL_API_1_1_0
9021a5df
RS
540# define get_rfc2409_prime_768 BN_get_rfc2409_prime_768
541# define get_rfc2409_prime_1024 BN_get_rfc2409_prime_1024
542# define get_rfc3526_prime_1536 BN_get_rfc3526_prime_1536
543# define get_rfc3526_prime_2048 BN_get_rfc3526_prime_2048
544# define get_rfc3526_prime_3072 BN_get_rfc3526_prime_3072
545# define get_rfc3526_prime_4096 BN_get_rfc3526_prime_4096
546# define get_rfc3526_prime_6144 BN_get_rfc3526_prime_6144
547# define get_rfc3526_prime_8192 BN_get_rfc3526_prime_8192
548# endif
bf3d6c0c 549
0f113f3e 550int BN_bntest_rand(BIGNUM *rnd, int bits, int top, int bottom);
85bcf27c 551
6d311938 552
0cd0a820 553# ifdef __cplusplus
d02b48c6 554}
0cd0a820 555# endif
d02b48c6 556#endif