]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/bn.h
OpenSSL 1.1.1 is now in pre release
[thirdparty/openssl.git] / include / openssl / bn.h
CommitLineData
21dcbebc
RS
1/*
2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
aa8f3d76 3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
48fc582f 4 *
21dcbebc
RS
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
48fc582f 9 */
21dcbebc 10
d02b48c6 11#ifndef HEADER_BN_H
0f113f3e 12# define HEADER_BN_H
d02b48c6 13
0f113f3e
MC
14# include <openssl/e_os2.h>
15# ifndef OPENSSL_NO_STDIO
3c27208f 16# include <stdio.h>
0f113f3e 17# endif
98186eb4 18# include <openssl/opensslconf.h>
0f113f3e
MC
19# include <openssl/ossl_typ.h>
20# include <openssl/crypto.h>
52df25cf 21# include <openssl/bnerr.h>
8e10f2b3 22
d02b48c6
RE
23#ifdef __cplusplus
24extern "C" {
25#endif
26
0f113f3e 27/*
94af0cd7 28 * 64-bit processor with LP64 ABI
0f113f3e
MC
29 */
30# ifdef SIXTY_FOUR_BIT_LONG
0f113f3e 31# define BN_ULONG unsigned long
0f113f3e 32# define BN_BYTES 8
0f113f3e 33# endif
d02b48c6 34
0f113f3e 35/*
94af0cd7 36 * 64-bit processor other than LP64 ABI
dfeab068 37 */
0f113f3e 38# ifdef SIXTY_FOUR_BIT
0f113f3e 39# define BN_ULONG unsigned long long
0f113f3e 40# define BN_BYTES 8
0f113f3e 41# endif
d02b48c6 42
0f113f3e 43# ifdef THIRTY_TWO_BIT
0f113f3e 44# define BN_ULONG unsigned int
0f113f3e 45# define BN_BYTES 4
82e8cb40 46# endif
d02b48c6 47
94af0cd7
RS
48# define BN_BITS2 (BN_BYTES * 8)
49# define BN_BITS (BN_BITS2 * 2)
50# define BN_TBIT ((BN_ULONG)1 << (BN_BITS2 - 1))
d02b48c6 51
0f113f3e
MC
52# define BN_FLG_MALLOCED 0x01
53# define BN_FLG_STATIC_DATA 0x02
dbd87ffc
MC
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 */
0f113f3e 61# define BN_FLG_CONSTTIME 0x04
74924dcb 62# define BN_FLG_SECURE 0x08
bd31fb21 63
98186eb4 64# if OPENSSL_API_COMPAT < 0x00908000L
dbd87ffc 65/* deprecated name for the flag */
0f113f3e 66# define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME
60250017 67# define BN_FLG_FREE 0x8000 /* used for debugging */
0f113f3e 68# endif
85bcf27c
MC
69
70void BN_set_flags(BIGNUM *b, int n);
71int BN_get_flags(const BIGNUM *b, int n);
dfeab068 72
f67cbb74
RS
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
0f113f3e
MC
82/*
83 * get a clone of a BIGNUM with changed flags, for *temporary* use only (the
e113c9c5
MC
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.
0f113f3e 87 */
e113c9c5 88void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags);
85bcf27c 89
02e112a8 90/* Wrapper function to make using BN_GENCB easier */
e9224c71 91int BN_GENCB_call(BN_GENCB *cb, int a, int b);
85bcf27c
MC
92
93BN_GENCB *BN_GENCB_new(void);
94void BN_GENCB_free(BN_GENCB *cb);
95
96/* Populate a BN_GENCB structure with an "old"-style callback */
0f113f3e
MC
97void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
98 void *cb_arg);
85bcf27c
MC
99
100/* Populate a BN_GENCB structure with a "new"-style callback */
0f113f3e
MC
101void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
102 void *cb_arg);
85bcf27c
MC
103
104void *BN_GENCB_get_arg(BN_GENCB *cb);
e9224c71 105
0f113f3e
MC
106# define BN_prime_checks 0 /* default: select number of iterations based
107 * on the size of the number */
d02b48c6 108
0f113f3e
MC
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 : \
38e33cef
UM
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
0f113f3e 130# define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
85bcf27c
MC
131
132int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w);
133int BN_is_zero(const BIGNUM *a);
134int BN_is_one(const BIGNUM *a);
135int BN_is_word(const BIGNUM *a, const BN_ULONG w);
136int BN_is_odd(const BIGNUM *a);
137
0f113f3e 138# define BN_one(a) (BN_set_word((a),1))
85bcf27c
MC
139
140void BN_zero_ex(BIGNUM *a);
141
98186eb4 142# if OPENSSL_API_COMPAT >= 0x00908000L
0f113f3e
MC
143# define BN_zero(a) BN_zero_ex(a)
144# else
145# define BN_zero(a) (BN_set_word((a),0))
146# endif
d02b48c6 147
98499135 148const BIGNUM *BN_value_one(void);
0f113f3e 149char *BN_options(void);
d02b48c6 150BN_CTX *BN_CTX_new(void);
74924dcb 151BN_CTX *BN_CTX_secure_new(void);
0f113f3e
MC
152void BN_CTX_free(BN_CTX *c);
153void BN_CTX_start(BN_CTX *ctx);
9b141126 154BIGNUM *BN_CTX_get(BN_CTX *ctx);
0f113f3e
MC
155void BN_CTX_end(BN_CTX *ctx);
156int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
ddc6a5c8 157int BN_priv_rand(BIGNUM *rnd, int bits, int top, int bottom);
0f113f3e 158int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
ddc6a5c8 159int BN_priv_rand_range(BIGNUM *rnd, const BIGNUM *range);
5ecff87d 160int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
0f113f3e
MC
161int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
162int BN_num_bits(const BIGNUM *a);
163int BN_num_bits_word(BN_ULONG l);
164int BN_security_bits(int L, int N);
d02b48c6 165BIGNUM *BN_new(void);
74924dcb 166BIGNUM *BN_secure_new(void);
0f113f3e 167void BN_clear_free(BIGNUM *a);
84c15db5 168BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
0f113f3e
MC
169void BN_swap(BIGNUM *a, BIGNUM *b);
170BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
171int BN_bn2bin(const BIGNUM *a, unsigned char *to);
85a4807f
DSH
172int BN_bn2binpad(const BIGNUM *a, unsigned char *to, int tolen);
173BIGNUM *BN_lebin2bn(const unsigned char *s, int len, BIGNUM *ret);
174int BN_bn2lebinpad(const BIGNUM *a, unsigned char *to, int tolen);
0f113f3e
MC
175BIGNUM *BN_mpi2bn(const unsigned char *s, int len, BIGNUM *ret);
176int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
177int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
178int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
179int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
180int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
181int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
182int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
3798cb81
NL
183/** BN_set_negative sets sign of a BIGNUM
184 * \param b pointer to the BIGNUM object
0f113f3e 185 * \param n 0 if the BIGNUM b should be positive and a value != 0 otherwise
3798cb81 186 */
0f113f3e 187void BN_set_negative(BIGNUM *b, int n);
3798cb81 188/** BN_is_negative returns 1 if the BIGNUM is negative
28c0a61b 189 * \param b pointer to the BIGNUM object
3798cb81
NL
190 * \return 1 if a < 0 and 0 otherwise
191 */
0f113f3e
MC
192int BN_is_negative(const BIGNUM *b);
193
194int 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))
197int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
198int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
199 BN_CTX *ctx);
200int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
201 const BIGNUM *m);
202int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
203 BN_CTX *ctx);
204int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
205 const BIGNUM *m);
206int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
207 BN_CTX *ctx);
208int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
209int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
210int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
211int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m,
212 BN_CTX *ctx);
213int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
5acaa495 214
7999c65c 215BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
dfeab068 216BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
0f113f3e
MC
217int BN_mul_word(BIGNUM *a, BN_ULONG w);
218int BN_add_word(BIGNUM *a, BN_ULONG w);
219int BN_sub_word(BIGNUM *a, BN_ULONG w);
220int BN_set_word(BIGNUM *a, BN_ULONG w);
020fc820 221BN_ULONG BN_get_word(const BIGNUM *a);
5acaa495 222
0f113f3e
MC
223int BN_cmp(const BIGNUM *a, const BIGNUM *b);
224void BN_free(BIGNUM *a);
225int BN_is_bit_set(const BIGNUM *a, int n);
226int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
227int BN_lshift1(BIGNUM *r, const BIGNUM *a);
228int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
229
230int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
231 const BIGNUM *m, BN_CTX *ctx);
232int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
233 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
46a64376 234int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
0f113f3e
MC
235 const BIGNUM *m, BN_CTX *ctx,
236 BN_MONT_CTX *in_mont);
237int 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);
239int 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);
242int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
243 const BIGNUM *m, BN_CTX *ctx);
244
245int BN_mask_bits(BIGNUM *a, int n);
246# ifndef OPENSSL_NO_STDIO
247int BN_print_fp(FILE *fp, const BIGNUM *a);
248# endif
94af0cd7 249int BN_print(BIO *bio, const BIGNUM *a);
0f113f3e
MC
250int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
251int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
252int BN_rshift1(BIGNUM *r, const BIGNUM *a);
253void BN_clear(BIGNUM *a);
84c15db5 254BIGNUM *BN_dup(const BIGNUM *a);
0f113f3e
MC
255int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
256int BN_set_bit(BIGNUM *a, int n);
257int BN_clear_bit(BIGNUM *a, int n);
258char *BN_bn2hex(const BIGNUM *a);
259char *BN_bn2dec(const BIGNUM *a);
260int BN_hex2bn(BIGNUM **a, const char *str);
261int BN_dec2bn(BIGNUM **a, const char *str);
262int BN_asc2bn(BIGNUM **a, const char *str);
263int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
264int BN_kronecker(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); /* returns
265 * -2 for
266 * error */
020fc820 267BIGNUM *BN_mod_inverse(BIGNUM *ret,
0f113f3e 268 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
cd2eebfd 269BIGNUM *BN_mod_sqrt(BIGNUM *ret,
0f113f3e 270 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
e9224c71 271
0f113f3e 272void BN_consttime_swap(BN_ULONG swap, BIGNUM *a, BIGNUM *b, int nwords);
f9b6c0ba 273
e9224c71 274/* Deprecated versions */
98186eb4 275DEPRECATEDIN_0_9_8(BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,
0f113f3e
MC
276 const BIGNUM *add,
277 const BIGNUM *rem,
278 void (*callback) (int, int,
279 void *),
98186eb4
VD
280 void *cb_arg))
281DEPRECATEDIN_0_9_8(int
0f113f3e
MC
282 BN_is_prime(const BIGNUM *p, int nchecks,
283 void (*callback) (int, int, void *),
98186eb4
VD
284 BN_CTX *ctx, void *cb_arg))
285DEPRECATEDIN_0_9_8(int
0f113f3e
MC
286 BN_is_prime_fasttest(const BIGNUM *p, int nchecks,
287 void (*callback) (int, int, void *),
288 BN_CTX *ctx, void *cb_arg,
98186eb4 289 int do_trial_division))
e9224c71
GT
290
291/* Newer versions */
0f113f3e
MC
292int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add,
293 const BIGNUM *rem, BN_GENCB *cb);
294int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb);
295int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx,
296 int do_trial_division, BN_GENCB *cb);
d02b48c6 297
7b1a0451
DSH
298int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx);
299
300int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
0f113f3e
MC
301 const BIGNUM *Xp, const BIGNUM *Xp1,
302 const BIGNUM *Xp2, const BIGNUM *e, BN_CTX *ctx,
303 BN_GENCB *cb);
304int 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
308BN_MONT_CTX *BN_MONT_CTX_new(void);
309int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
310 BN_MONT_CTX *mont, BN_CTX *ctx);
311int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
312 BN_CTX *ctx);
313int BN_from_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
314 BN_CTX *ctx);
d02b48c6 315void BN_MONT_CTX_free(BN_MONT_CTX *mont);
0f113f3e
MC
316int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx);
317BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
d188a536 318BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, CRYPTO_RWLOCK *lock,
0f113f3e 319 const BIGNUM *mod, BN_CTX *ctx);
d02b48c6 320
800e400d 321/* BN_BLINDING flags */
0f113f3e
MC
322# define BN_BLINDING_NO_UPDATE 0x00000001
323# define BN_BLINDING_NO_RECREATE 0x00000002
800e400d
NL
324
325BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
58964a49 326void BN_BLINDING_free(BN_BLINDING *b);
0f113f3e 327int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx);
800e400d 328int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
58964a49 329int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
800e400d 330int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
0f113f3e
MC
331int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
332 BN_CTX *);
0b1a07c8
AG
333
334int BN_BLINDING_is_current_thread(BN_BLINDING *b);
335void BN_BLINDING_set_current_thread(BN_BLINDING *b);
336int BN_BLINDING_lock(BN_BLINDING *b);
337int BN_BLINDING_unlock(BN_BLINDING *b);
338
800e400d
NL
339unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
340void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
341BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
0f113f3e
MC
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
98186eb4
VD
351DEPRECATEDIN_0_9_8(void BN_set_params(int mul, int high, int low, int mont))
352DEPRECATEDIN_0_9_8(int BN_get_params(int which)) /* 0, mul, 1 high, 2 low, 3
353 * mont */
dfeab068 354
dfeab068 355BN_RECP_CTX *BN_RECP_CTX_new(void);
0f113f3e
MC
356void BN_RECP_CTX_free(BN_RECP_CTX *recp);
357int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *rdiv, BN_CTX *ctx);
358int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
359 BN_RECP_CTX *recp, BN_CTX *ctx);
360int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
361 const BIGNUM *m, BN_CTX *ctx);
362int 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.
b53e44e5 369 * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
0f113f3e
MC
370 * ignored. Note that input arguments are not const so that their bit arrays
371 * can be expanded to the appropriate size if needed.
1dc920c8 372 */
b53e44e5 373
0f113f3e
MC
374/*
375 * r = a + b
376 */
377int 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 */
382int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p);
e636e2ac 383/* r = (a * b) mod p */
0f113f3e
MC
384int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
385 const BIGNUM *p, BN_CTX *ctx);
e636e2ac 386/* r = (a * a) mod p */
0f113f3e 387int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
e636e2ac 388/* r = (1 / b) mod p */
0f113f3e 389int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx);
e636e2ac 390/* r = (a / b) mod p */
0f113f3e
MC
391int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
392 const BIGNUM *p, BN_CTX *ctx);
e636e2ac 393/* r = (a ^ b) mod p */
0f113f3e
MC
394int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
395 const BIGNUM *p, BN_CTX *ctx);
e636e2ac 396/* r = sqrt(a) mod p */
0f113f3e
MC
397int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
398 BN_CTX *ctx);
e636e2ac 399/* r^2 + r = a mod p */
0f113f3e
MC
400int 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))
c80fd6b2
MC
403/*-
404 * Some functions allow for representation of the irreducible polynomials
1dc920c8
BM
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 */
e636e2ac 409/* r = a mod p */
0f113f3e 410int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]);
e636e2ac 411/* r = (a * b) mod p */
0f113f3e
MC
412int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
413 const int p[], BN_CTX *ctx);
e636e2ac 414/* r = (a * a) mod p */
0f113f3e
MC
415int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[],
416 BN_CTX *ctx);
e636e2ac 417/* r = (1 / b) mod p */
0f113f3e
MC
418int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[],
419 BN_CTX *ctx);
e636e2ac 420/* r = (a / b) mod p */
0f113f3e
MC
421int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
422 const int p[], BN_CTX *ctx);
e636e2ac 423/* r = (a ^ b) mod p */
0f113f3e
MC
424int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
425 const int p[], BN_CTX *ctx);
e636e2ac 426/* r = sqrt(a) mod p */
0f113f3e
MC
427int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
428 const int p[], BN_CTX *ctx);
e636e2ac 429/* r^2 + r = a mod p */
0f113f3e
MC
430int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
431 const int p[], BN_CTX *ctx);
432int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max);
433int BN_GF2m_arr2poly(const int p[], BIGNUM *a);
1dc920c8 434
0f113f3e 435# endif
c9a90645 436
0f113f3e
MC
437/*
438 * faster mod functions for the 'NIST primes' 0 <= a < p^2
439 */
5c6bf031
BM
440int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
441int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
442int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
443int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
444int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
445
446const BIGNUM *BN_get0_nist_prime_192(void);
447const BIGNUM *BN_get0_nist_prime_224(void);
448const BIGNUM *BN_get0_nist_prime_256(void);
449const BIGNUM *BN_get0_nist_prime_384(void);
450const BIGNUM *BN_get0_nist_prime_521(void);
451
0f113f3e
MC
452int (*BN_nist_mod_func(const BIGNUM *p)) (BIGNUM *r, const BIGNUM *a,
453 const BIGNUM *field, BN_CTX *ctx);
8a99cb29 454
0f113f3e
MC
455int 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);
775c63fc 458
bf3d6c0c 459/* Primes from RFC 2409 */
9021a5df
RS
460BIGNUM *BN_get_rfc2409_prime_768(BIGNUM *bn);
461BIGNUM *BN_get_rfc2409_prime_1024(BIGNUM *bn);
bf3d6c0c
BL
462
463/* Primes from RFC 3526 */
9021a5df
RS
464BIGNUM *BN_get_rfc3526_prime_1536(BIGNUM *bn);
465BIGNUM *BN_get_rfc3526_prime_2048(BIGNUM *bn);
466BIGNUM *BN_get_rfc3526_prime_3072(BIGNUM *bn);
467BIGNUM *BN_get_rfc3526_prime_4096(BIGNUM *bn);
468BIGNUM *BN_get_rfc3526_prime_6144(BIGNUM *bn);
469BIGNUM *BN_get_rfc3526_prime_8192(BIGNUM *bn);
470
1aca3618 471# if OPENSSL_API_COMPAT < 0x10100000L
9021a5df
RS
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
bf3d6c0c 481
0f113f3e 482int BN_bntest_rand(BIGNUM *rnd, int bits, int top, int bottom);
85bcf27c 483
6d311938 484
0cd0a820 485# ifdef __cplusplus
d02b48c6 486}
0cd0a820 487# endif
d02b48c6 488#endif