]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/bn.h
Fix spelling of error code
[thirdparty/openssl.git] / include / openssl / bn.h
CommitLineData
21dcbebc
RS
1/*
2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
48fc582f 3 *
21dcbebc
RS
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
48fc582f 8 */
21dcbebc 9
1dc920c8
BM
10/* ====================================================================
11 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12 *
0f113f3e 13 * Portions of the attached software ("Contribution") are developed by
1dc920c8
BM
14 * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
15 *
16 * The Contribution is licensed pursuant to the Eric Young open source
17 * license provided above.
18 *
0f113f3e 19 * The binary polynomial arithmetic software is originally written by
1dc920c8
BM
20 * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
21 *
22 */
d02b48c6 23
d02b48c6 24#ifndef HEADER_BN_H
0f113f3e 25# define HEADER_BN_H
d02b48c6 26
0f113f3e
MC
27# include <openssl/e_os2.h>
28# ifndef OPENSSL_NO_STDIO
3c27208f 29# include <stdio.h>
0f113f3e 30# endif
98186eb4 31# include <openssl/opensslconf.h>
0f113f3e
MC
32# include <openssl/ossl_typ.h>
33# include <openssl/crypto.h>
8e10f2b3 34
d02b48c6
RE
35#ifdef __cplusplus
36extern "C" {
37#endif
38
0f113f3e 39/*
94af0cd7 40 * 64-bit processor with LP64 ABI
0f113f3e
MC
41 */
42# ifdef SIXTY_FOUR_BIT_LONG
0f113f3e 43# define BN_ULONG unsigned long
0f113f3e 44# define BN_BYTES 8
0f113f3e 45# endif
d02b48c6 46
0f113f3e 47/*
94af0cd7 48 * 64-bit processor other than LP64 ABI
dfeab068 49 */
0f113f3e 50# ifdef SIXTY_FOUR_BIT
0f113f3e 51# define BN_ULONG unsigned long long
0f113f3e 52# define BN_BYTES 8
0f113f3e 53# endif
d02b48c6 54
0f113f3e 55# ifdef THIRTY_TWO_BIT
0f113f3e 56# define BN_ULONG unsigned int
0f113f3e 57# define BN_BYTES 4
82e8cb40 58# endif
d02b48c6 59
94af0cd7
RS
60# define BN_BITS2 (BN_BYTES * 8)
61# define BN_BITS (BN_BITS2 * 2)
62# define BN_TBIT ((BN_ULONG)1 << (BN_BITS2 - 1))
d02b48c6 63
0f113f3e
MC
64# define BN_FLG_MALLOCED 0x01
65# define BN_FLG_STATIC_DATA 0x02
dbd87ffc
MC
66
67/*
68 * avoid leaking exponent information through timing,
69 * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime,
70 * BN_div() will call BN_div_no_branch,
71 * BN_mod_inverse() will call BN_mod_inverse_no_branch.
72 */
0f113f3e 73# define BN_FLG_CONSTTIME 0x04
74924dcb 74# define BN_FLG_SECURE 0x08
bd31fb21 75
98186eb4 76# if OPENSSL_API_COMPAT < 0x00908000L
dbd87ffc 77/* deprecated name for the flag */
0f113f3e 78# define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME
60250017 79# define BN_FLG_FREE 0x8000 /* used for debugging */
0f113f3e 80# endif
85bcf27c
MC
81
82void BN_set_flags(BIGNUM *b, int n);
83int BN_get_flags(const BIGNUM *b, int n);
dfeab068 84
0f113f3e
MC
85/*
86 * get a clone of a BIGNUM with changed flags, for *temporary* use only (the
e113c9c5
MC
87 * two BIGNUMs cannot be used in parallel!). Also only for *read only* use. The
88 * value |dest| should be a newly allocated BIGNUM obtained via BN_new() that
89 * has not been otherwise initialised or used.
0f113f3e 90 */
e113c9c5 91void BN_with_flags(BIGNUM *dest, const BIGNUM *b, int flags);
85bcf27c 92
02e112a8 93/* Wrapper function to make using BN_GENCB easier */
e9224c71 94int BN_GENCB_call(BN_GENCB *cb, int a, int b);
85bcf27c
MC
95
96BN_GENCB *BN_GENCB_new(void);
97void BN_GENCB_free(BN_GENCB *cb);
98
99/* Populate a BN_GENCB structure with an "old"-style callback */
0f113f3e
MC
100void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback) (int, int, void *),
101 void *cb_arg);
85bcf27c
MC
102
103/* Populate a BN_GENCB structure with a "new"-style callback */
0f113f3e
MC
104void BN_GENCB_set(BN_GENCB *gencb, int (*callback) (int, int, BN_GENCB *),
105 void *cb_arg);
85bcf27c
MC
106
107void *BN_GENCB_get_arg(BN_GENCB *cb);
e9224c71 108
0f113f3e
MC
109# define BN_prime_checks 0 /* default: select number of iterations based
110 * on the size of the number */
d02b48c6 111
0f113f3e
MC
112/*
113 * number of Miller-Rabin iterations for an error rate of less than 2^-80 for
114 * random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook of
115 * Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996];
116 * original paper: Damgaard, Landrock, Pomerance: Average case error
117 * estimates for the strong probable prime test. -- Math. Comp. 61 (1993)
118 * 177-194)
119 */
120# define BN_prime_checks_for_size(b) ((b) >= 1300 ? 2 : \
38e33cef
UM
121 (b) >= 850 ? 3 : \
122 (b) >= 650 ? 4 : \
123 (b) >= 550 ? 5 : \
124 (b) >= 450 ? 6 : \
125 (b) >= 400 ? 7 : \
126 (b) >= 350 ? 8 : \
127 (b) >= 300 ? 9 : \
128 (b) >= 250 ? 12 : \
129 (b) >= 200 ? 15 : \
130 (b) >= 150 ? 18 : \
131 /* b >= 100 */ 27)
132
0f113f3e 133# define BN_num_bytes(a) ((BN_num_bits(a)+7)/8)
85bcf27c
MC
134
135int BN_abs_is_word(const BIGNUM *a, const BN_ULONG w);
136int BN_is_zero(const BIGNUM *a);
137int BN_is_one(const BIGNUM *a);
138int BN_is_word(const BIGNUM *a, const BN_ULONG w);
139int BN_is_odd(const BIGNUM *a);
140
0f113f3e 141# define BN_one(a) (BN_set_word((a),1))
85bcf27c
MC
142
143void BN_zero_ex(BIGNUM *a);
144
98186eb4 145# if OPENSSL_API_COMPAT >= 0x00908000L
0f113f3e
MC
146# define BN_zero(a) BN_zero_ex(a)
147# else
148# define BN_zero(a) (BN_set_word((a),0))
149# endif
d02b48c6 150
98499135 151const BIGNUM *BN_value_one(void);
0f113f3e 152char *BN_options(void);
d02b48c6 153BN_CTX *BN_CTX_new(void);
74924dcb 154BN_CTX *BN_CTX_secure_new(void);
0f113f3e
MC
155void BN_CTX_free(BN_CTX *c);
156void BN_CTX_start(BN_CTX *ctx);
9b141126 157BIGNUM *BN_CTX_get(BN_CTX *ctx);
0f113f3e
MC
158void BN_CTX_end(BN_CTX *ctx);
159int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
160int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
161int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
162int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
163int BN_num_bits(const BIGNUM *a);
164int BN_num_bits_word(BN_ULONG l);
165int BN_security_bits(int L, int N);
d02b48c6 166BIGNUM *BN_new(void);
74924dcb 167BIGNUM *BN_secure_new(void);
0f113f3e 168void BN_clear_free(BIGNUM *a);
84c15db5 169BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
0f113f3e
MC
170void BN_swap(BIGNUM *a, BIGNUM *b);
171BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
172int BN_bn2bin(const BIGNUM *a, unsigned char *to);
85a4807f
DSH
173int BN_bn2binpad(const BIGNUM *a, unsigned char *to, int tolen);
174BIGNUM *BN_lebin2bn(const unsigned char *s, int len, BIGNUM *ret);
175int BN_bn2lebinpad(const BIGNUM *a, unsigned char *to, int tolen);
0f113f3e
MC
176BIGNUM *BN_mpi2bn(const unsigned char *s, int len, BIGNUM *ret);
177int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
178int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
179int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
180int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
181int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
182int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
183int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
3798cb81
NL
184/** BN_set_negative sets sign of a BIGNUM
185 * \param b pointer to the BIGNUM object
0f113f3e 186 * \param n 0 if the BIGNUM b should be positive and a value != 0 otherwise
3798cb81 187 */
0f113f3e 188void BN_set_negative(BIGNUM *b, int n);
3798cb81
NL
189/** BN_is_negative returns 1 if the BIGNUM is negative
190 * \param a pointer to the BIGNUM object
191 * \return 1 if a < 0 and 0 otherwise
192 */
0f113f3e
MC
193int BN_is_negative(const BIGNUM *b);
194
195int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d,
196 BN_CTX *ctx);
197# define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx))
198int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx);
199int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
200 BN_CTX *ctx);
201int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
202 const BIGNUM *m);
203int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
204 BN_CTX *ctx);
205int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
206 const BIGNUM *m);
207int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m,
208 BN_CTX *ctx);
209int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
210int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
211int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m);
212int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m,
213 BN_CTX *ctx);
214int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m);
5acaa495 215
7999c65c 216BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
dfeab068 217BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
0f113f3e
MC
218int BN_mul_word(BIGNUM *a, BN_ULONG w);
219int BN_add_word(BIGNUM *a, BN_ULONG w);
220int BN_sub_word(BIGNUM *a, BN_ULONG w);
221int BN_set_word(BIGNUM *a, BN_ULONG w);
020fc820 222BN_ULONG BN_get_word(const BIGNUM *a);
5acaa495 223
0f113f3e
MC
224int BN_cmp(const BIGNUM *a, const BIGNUM *b);
225void BN_free(BIGNUM *a);
226int BN_is_bit_set(const BIGNUM *a, int n);
227int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
228int BN_lshift1(BIGNUM *r, const BIGNUM *a);
229int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
230
231int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
232 const BIGNUM *m, BN_CTX *ctx);
233int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
234 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
46a64376 235int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p,
0f113f3e
MC
236 const BIGNUM *m, BN_CTX *ctx,
237 BN_MONT_CTX *in_mont);
238int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
239 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
240int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1,
241 const BIGNUM *a2, const BIGNUM *p2, const BIGNUM *m,
242 BN_CTX *ctx, BN_MONT_CTX *m_ctx);
243int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
244 const BIGNUM *m, BN_CTX *ctx);
245
246int BN_mask_bits(BIGNUM *a, int n);
247# ifndef OPENSSL_NO_STDIO
248int BN_print_fp(FILE *fp, const BIGNUM *a);
249# endif
94af0cd7 250int BN_print(BIO *bio, const BIGNUM *a);
0f113f3e
MC
251int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx);
252int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
253int BN_rshift1(BIGNUM *r, const BIGNUM *a);
254void BN_clear(BIGNUM *a);
84c15db5 255BIGNUM *BN_dup(const BIGNUM *a);
0f113f3e
MC
256int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
257int BN_set_bit(BIGNUM *a, int n);
258int BN_clear_bit(BIGNUM *a, int n);
259char *BN_bn2hex(const BIGNUM *a);
260char *BN_bn2dec(const BIGNUM *a);
261int BN_hex2bn(BIGNUM **a, const char *str);
262int BN_dec2bn(BIGNUM **a, const char *str);
263int BN_asc2bn(BIGNUM **a, const char *str);
264int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
265int BN_kronecker(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); /* returns
266 * -2 for
267 * error */
020fc820 268BIGNUM *BN_mod_inverse(BIGNUM *ret,
0f113f3e 269 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
cd2eebfd 270BIGNUM *BN_mod_sqrt(BIGNUM *ret,
0f113f3e 271 const BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
e9224c71 272
0f113f3e 273void BN_consttime_swap(BN_ULONG swap, BIGNUM *a, BIGNUM *b, int nwords);
f9b6c0ba 274
e9224c71 275/* Deprecated versions */
98186eb4 276DEPRECATEDIN_0_9_8(BIGNUM *BN_generate_prime(BIGNUM *ret, int bits, int safe,
0f113f3e
MC
277 const BIGNUM *add,
278 const BIGNUM *rem,
279 void (*callback) (int, int,
280 void *),
98186eb4
VD
281 void *cb_arg))
282DEPRECATEDIN_0_9_8(int
0f113f3e
MC
283 BN_is_prime(const BIGNUM *p, int nchecks,
284 void (*callback) (int, int, void *),
98186eb4
VD
285 BN_CTX *ctx, void *cb_arg))
286DEPRECATEDIN_0_9_8(int
0f113f3e
MC
287 BN_is_prime_fasttest(const BIGNUM *p, int nchecks,
288 void (*callback) (int, int, void *),
289 BN_CTX *ctx, void *cb_arg,
98186eb4 290 int do_trial_division))
e9224c71
GT
291
292/* Newer versions */
0f113f3e
MC
293int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe, const BIGNUM *add,
294 const BIGNUM *rem, BN_GENCB *cb);
295int BN_is_prime_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx, BN_GENCB *cb);
296int BN_is_prime_fasttest_ex(const BIGNUM *p, int nchecks, BN_CTX *ctx,
297 int do_trial_division, BN_GENCB *cb);
d02b48c6 298
7b1a0451
DSH
299int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx);
300
301int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2,
0f113f3e
MC
302 const BIGNUM *Xp, const BIGNUM *Xp1,
303 const BIGNUM *Xp2, const BIGNUM *e, BN_CTX *ctx,
304 BN_GENCB *cb);
305int BN_X931_generate_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2, BIGNUM *Xp1,
306 BIGNUM *Xp2, const BIGNUM *Xp, const BIGNUM *e,
307 BN_CTX *ctx, BN_GENCB *cb);
308
309BN_MONT_CTX *BN_MONT_CTX_new(void);
310int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
311 BN_MONT_CTX *mont, BN_CTX *ctx);
312int BN_to_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
313 BN_CTX *ctx);
314int BN_from_montgomery(BIGNUM *r, const BIGNUM *a, BN_MONT_CTX *mont,
315 BN_CTX *ctx);
d02b48c6 316void BN_MONT_CTX_free(BN_MONT_CTX *mont);
0f113f3e
MC
317int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod, BN_CTX *ctx);
318BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
d188a536 319BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, CRYPTO_RWLOCK *lock,
0f113f3e 320 const BIGNUM *mod, BN_CTX *ctx);
d02b48c6 321
800e400d 322/* BN_BLINDING flags */
0f113f3e
MC
323# define BN_BLINDING_NO_UPDATE 0x00000001
324# define BN_BLINDING_NO_RECREATE 0x00000002
800e400d
NL
325
326BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod);
58964a49 327void BN_BLINDING_free(BN_BLINDING *b);
0f113f3e 328int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx);
800e400d 329int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
58964a49 330int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
800e400d 331int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *);
0f113f3e
MC
332int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
333 BN_CTX *);
0b1a07c8
AG
334
335int BN_BLINDING_is_current_thread(BN_BLINDING *b);
336void BN_BLINDING_set_current_thread(BN_BLINDING *b);
337int BN_BLINDING_lock(BN_BLINDING *b);
338int BN_BLINDING_unlock(BN_BLINDING *b);
339
800e400d
NL
340unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
341void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
342BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
0f113f3e
MC
343 const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
344 int (*bn_mod_exp) (BIGNUM *r,
345 const BIGNUM *a,
346 const BIGNUM *p,
347 const BIGNUM *m,
348 BN_CTX *ctx,
349 BN_MONT_CTX *m_ctx),
350 BN_MONT_CTX *m_ctx);
351
98186eb4
VD
352DEPRECATEDIN_0_9_8(void BN_set_params(int mul, int high, int low, int mont))
353DEPRECATEDIN_0_9_8(int BN_get_params(int which)) /* 0, mul, 1 high, 2 low, 3
354 * mont */
dfeab068 355
dfeab068 356BN_RECP_CTX *BN_RECP_CTX_new(void);
0f113f3e
MC
357void BN_RECP_CTX_free(BN_RECP_CTX *recp);
358int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *rdiv, BN_CTX *ctx);
359int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y,
360 BN_RECP_CTX *recp, BN_CTX *ctx);
361int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
362 const BIGNUM *m, BN_CTX *ctx);
363int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m,
364 BN_RECP_CTX *recp, BN_CTX *ctx);
365
366# ifndef OPENSSL_NO_EC2M
367
368/*
369 * Functions for arithmetic over binary polynomials represented by BIGNUMs.
b53e44e5 370 * The BIGNUM::neg property of BIGNUMs representing binary polynomials is
0f113f3e
MC
371 * ignored. Note that input arguments are not const so that their bit arrays
372 * can be expanded to the appropriate size if needed.
1dc920c8 373 */
b53e44e5 374
0f113f3e
MC
375/*
376 * r = a + b
377 */
378int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
379# define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b)
380/*
381 * r=a mod p
382 */
383int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p);
e636e2ac 384/* r = (a * b) mod p */
0f113f3e
MC
385int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
386 const BIGNUM *p, BN_CTX *ctx);
e636e2ac 387/* r = (a * a) mod p */
0f113f3e 388int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
e636e2ac 389/* r = (1 / b) mod p */
0f113f3e 390int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, BN_CTX *ctx);
e636e2ac 391/* r = (a / b) mod p */
0f113f3e
MC
392int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
393 const BIGNUM *p, BN_CTX *ctx);
e636e2ac 394/* r = (a ^ b) mod p */
0f113f3e
MC
395int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
396 const BIGNUM *p, BN_CTX *ctx);
e636e2ac 397/* r = sqrt(a) mod p */
0f113f3e
MC
398int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
399 BN_CTX *ctx);
e636e2ac 400/* r^2 + r = a mod p */
0f113f3e
MC
401int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
402 BN_CTX *ctx);
403# define BN_GF2m_cmp(a, b) BN_ucmp((a), (b))
c80fd6b2
MC
404/*-
405 * Some functions allow for representation of the irreducible polynomials
1dc920c8
BM
406 * as an unsigned int[], say p. The irreducible f(t) is then of the form:
407 * t^p[0] + t^p[1] + ... + t^p[k]
408 * where m = p[0] > p[1] > ... > p[k] = 0.
409 */
e636e2ac 410/* r = a mod p */
0f113f3e 411int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]);
e636e2ac 412/* r = (a * b) mod p */
0f113f3e
MC
413int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
414 const int p[], BN_CTX *ctx);
e636e2ac 415/* r = (a * a) mod p */
0f113f3e
MC
416int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[],
417 BN_CTX *ctx);
e636e2ac 418/* r = (1 / b) mod p */
0f113f3e
MC
419int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[],
420 BN_CTX *ctx);
e636e2ac 421/* r = (a / b) mod p */
0f113f3e
MC
422int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
423 const int p[], BN_CTX *ctx);
e636e2ac 424/* r = (a ^ b) mod p */
0f113f3e
MC
425int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
426 const int p[], BN_CTX *ctx);
e636e2ac 427/* r = sqrt(a) mod p */
0f113f3e
MC
428int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a,
429 const int p[], BN_CTX *ctx);
e636e2ac 430/* r^2 + r = a mod p */
0f113f3e
MC
431int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a,
432 const int p[], BN_CTX *ctx);
433int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max);
434int BN_GF2m_arr2poly(const int p[], BIGNUM *a);
1dc920c8 435
0f113f3e 436# endif
c9a90645 437
0f113f3e
MC
438/*
439 * faster mod functions for the 'NIST primes' 0 <= a < p^2
440 */
5c6bf031
BM
441int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
442int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
443int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
444int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
445int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx);
446
447const BIGNUM *BN_get0_nist_prime_192(void);
448const BIGNUM *BN_get0_nist_prime_224(void);
449const BIGNUM *BN_get0_nist_prime_256(void);
450const BIGNUM *BN_get0_nist_prime_384(void);
451const BIGNUM *BN_get0_nist_prime_521(void);
452
0f113f3e
MC
453int (*BN_nist_mod_func(const BIGNUM *p)) (BIGNUM *r, const BIGNUM *a,
454 const BIGNUM *field, BN_CTX *ctx);
8a99cb29 455
0f113f3e
MC
456int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range,
457 const BIGNUM *priv, const unsigned char *message,
458 size_t message_len, BN_CTX *ctx);
775c63fc 459
bf3d6c0c 460/* Primes from RFC 2409 */
9021a5df
RS
461BIGNUM *BN_get_rfc2409_prime_768(BIGNUM *bn);
462BIGNUM *BN_get_rfc2409_prime_1024(BIGNUM *bn);
bf3d6c0c
BL
463
464/* Primes from RFC 3526 */
9021a5df
RS
465BIGNUM *BN_get_rfc3526_prime_1536(BIGNUM *bn);
466BIGNUM *BN_get_rfc3526_prime_2048(BIGNUM *bn);
467BIGNUM *BN_get_rfc3526_prime_3072(BIGNUM *bn);
468BIGNUM *BN_get_rfc3526_prime_4096(BIGNUM *bn);
469BIGNUM *BN_get_rfc3526_prime_6144(BIGNUM *bn);
470BIGNUM *BN_get_rfc3526_prime_8192(BIGNUM *bn);
471
1aca3618 472# if OPENSSL_API_COMPAT < 0x10100000L
9021a5df
RS
473# define get_rfc2409_prime_768 BN_get_rfc2409_prime_768
474# define get_rfc2409_prime_1024 BN_get_rfc2409_prime_1024
475# define get_rfc3526_prime_1536 BN_get_rfc3526_prime_1536
476# define get_rfc3526_prime_2048 BN_get_rfc3526_prime_2048
477# define get_rfc3526_prime_3072 BN_get_rfc3526_prime_3072
478# define get_rfc3526_prime_4096 BN_get_rfc3526_prime_4096
479# define get_rfc3526_prime_6144 BN_get_rfc3526_prime_6144
480# define get_rfc3526_prime_8192 BN_get_rfc3526_prime_8192
481# endif
bf3d6c0c 482
0f113f3e 483int BN_bntest_rand(BIGNUM *rnd, int bits, int top, int bottom);
85bcf27c 484
d02b48c6 485/* BEGIN ERROR CODES */
0f113f3e
MC
486/*
487 * The following lines are auto generated by the script mkerr.pl. Any changes
6d311938
DSH
488 * made after this point may be overwritten when the script is next run.
489 */
0cd0a820 490
69588edb 491int ERR_load_BN_strings(void);
6d311938 492
d02b48c6
RE
493/* Error codes for the BN functions. */
494
495/* Function codes. */
0f113f3e
MC
496# define BN_F_BNRAND 127
497# define BN_F_BN_BLINDING_CONVERT_EX 100
498# define BN_F_BN_BLINDING_CREATE_PARAM 128
499# define BN_F_BN_BLINDING_INVERT_EX 101
500# define BN_F_BN_BLINDING_NEW 102
501# define BN_F_BN_BLINDING_UPDATE 103
502# define BN_F_BN_BN2DEC 104
503# define BN_F_BN_BN2HEX 105
504# define BN_F_BN_COMPUTE_WNAF 142
505# define BN_F_BN_CTX_GET 116
506# define BN_F_BN_CTX_NEW 106
507# define BN_F_BN_CTX_START 129
508# define BN_F_BN_DIV 107
0f113f3e
MC
509# define BN_F_BN_DIV_RECP 130
510# define BN_F_BN_EXP 123
0f113f3e
MC
511# define BN_F_BN_EXPAND_INTERNAL 120
512# define BN_F_BN_GENCB_NEW 143
513# define BN_F_BN_GENERATE_DSA_NONCE 140
514# define BN_F_BN_GENERATE_PRIME_EX 141
515# define BN_F_BN_GF2M_MOD 131
516# define BN_F_BN_GF2M_MOD_EXP 132
517# define BN_F_BN_GF2M_MOD_MUL 133
518# define BN_F_BN_GF2M_MOD_SOLVE_QUAD 134
519# define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR 135
520# define BN_F_BN_GF2M_MOD_SQR 136
521# define BN_F_BN_GF2M_MOD_SQRT 137
7cc18d81 522# define BN_F_BN_LSHIFT 145
0f113f3e
MC
523# define BN_F_BN_MOD_EXP2_MONT 118
524# define BN_F_BN_MOD_EXP_MONT 109
525# define BN_F_BN_MOD_EXP_MONT_CONSTTIME 124
526# define BN_F_BN_MOD_EXP_MONT_WORD 117
527# define BN_F_BN_MOD_EXP_RECP 125
528# define BN_F_BN_MOD_EXP_SIMPLE 126
529# define BN_F_BN_MOD_INVERSE 110
530# define BN_F_BN_MOD_INVERSE_NO_BRANCH 139
531# define BN_F_BN_MOD_LSHIFT_QUICK 119
0f113f3e
MC
532# define BN_F_BN_MOD_SQRT 121
533# define BN_F_BN_MPI2BN 112
534# define BN_F_BN_NEW 113
535# define BN_F_BN_RAND 114
536# define BN_F_BN_RAND_RANGE 122
7cc18d81 537# define BN_F_BN_RSHIFT 146
e22d2199 538# define BN_F_BN_SET_WORDS 144
0f113f3e 539# define BN_F_BN_USUB 115
d02b48c6
RE
540
541/* Reason codes. */
0f113f3e
MC
542# define BN_R_ARG2_LT_ARG3 100
543# define BN_R_BAD_RECIPROCAL 101
544# define BN_R_BIGNUM_TOO_LONG 114
545# define BN_R_BITS_TOO_SMALL 118
546# define BN_R_CALLED_WITH_EVEN_MODULUS 102
547# define BN_R_DIV_BY_ZERO 103
548# define BN_R_ENCODING_ERROR 104
549# define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA 105
550# define BN_R_INPUT_NOT_REDUCED 110
551# define BN_R_INVALID_LENGTH 106
552# define BN_R_INVALID_RANGE 115
7cc18d81 553# define BN_R_INVALID_SHIFT 119
0f113f3e
MC
554# define BN_R_NOT_A_SQUARE 111
555# define BN_R_NOT_INITIALIZED 107
556# define BN_R_NO_INVERSE 108
557# define BN_R_NO_SOLUTION 116
558# define BN_R_PRIVATE_KEY_TOO_LARGE 117
559# define BN_R_P_IS_NOT_PRIME 112
560# define BN_R_TOO_MANY_ITERATIONS 113
561# define BN_R_TOO_MANY_TEMPORARY_VARIABLES 109
6d311938 562
0cd0a820 563# ifdef __cplusplus
d02b48c6 564}
0cd0a820 565# endif
d02b48c6 566#endif