blob: 52333ac5a233b8f06dc2d430e17915d322608c86 [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* 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
121 * Laboratories. */
122
123#ifndef OPENSSL_HEADER_BN_H
124#define OPENSSL_HEADER_BN_H
125
126#include <openssl/base.h>
Adam Langley683d7bd2015-04-13 11:04:14 -0700127#include <openssl/thread.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700128
David Benjamin4512b792017-08-18 19:21:50 -0400129#include <inttypes.h> // for PRIu64 and friends
130#include <stdio.h> // for FILE*
Adam Langley95c29f32014-06-20 12:00:00 -0700131
132#if defined(__cplusplus)
133extern "C" {
134#endif
135
136
David Benjamin4512b792017-08-18 19:21:50 -0400137// BN provides support for working with arbitrary sized integers. For example,
138// although the largest integer supported by the compiler might be 64 bits, BN
139// will allow you to work with numbers until you run out of memory.
Adam Langley95c29f32014-06-20 12:00:00 -0700140
141
David Benjamin4512b792017-08-18 19:21:50 -0400142// BN_ULONG is the native word size when working with big integers.
143//
144// Note: on some platforms, inttypes.h does not define print format macros in
145// C++ unless |__STDC_FORMAT_MACROS| defined. As this is a public header, bn.h
146// does not define |__STDC_FORMAT_MACROS| itself. C++ source files which use the
147// FMT macros must define it externally.
Adam Langley95c29f32014-06-20 12:00:00 -0700148#if defined(OPENSSL_64_BIT)
149#define BN_ULONG uint64_t
150#define BN_BITS2 64
David Benjamin4a9313a2016-10-24 20:02:26 -0400151#define BN_DEC_FMT1 "%" PRIu64
152#define BN_DEC_FMT2 "%019" PRIu64
153#define BN_HEX_FMT1 "%" PRIx64
154#define BN_HEX_FMT2 "%016" PRIx64
Adam Langley95c29f32014-06-20 12:00:00 -0700155#elif defined(OPENSSL_32_BIT)
156#define BN_ULONG uint32_t
157#define BN_BITS2 32
David Benjamin4a9313a2016-10-24 20:02:26 -0400158#define BN_DEC_FMT1 "%" PRIu32
159#define BN_DEC_FMT2 "%09" PRIu32
160#define BN_HEX_FMT1 "%" PRIx32
161#define BN_HEX_FMT2 "%08" PRIx64
Adam Langley95c29f32014-06-20 12:00:00 -0700162#else
163#error "Must define either OPENSSL_32_BIT or OPENSSL_64_BIT"
164#endif
165
166
David Benjamin4512b792017-08-18 19:21:50 -0400167// Allocation and freeing.
Adam Langley95c29f32014-06-20 12:00:00 -0700168
David Benjamin4512b792017-08-18 19:21:50 -0400169// BN_new creates a new, allocated BIGNUM and initialises it.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700170OPENSSL_EXPORT BIGNUM *BN_new(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700171
David Benjamin4512b792017-08-18 19:21:50 -0400172// BN_init initialises a stack allocated |BIGNUM|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700173OPENSSL_EXPORT void BN_init(BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700174
David Benjamin4512b792017-08-18 19:21:50 -0400175// BN_free frees the data referenced by |bn| and, if |bn| was originally
176// allocated on the heap, frees |bn| also.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700177OPENSSL_EXPORT void BN_free(BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700178
David Benjamin4512b792017-08-18 19:21:50 -0400179// BN_clear_free erases and frees the data referenced by |bn| and, if |bn| was
180// originally allocated on the heap, frees |bn| also.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700181OPENSSL_EXPORT void BN_clear_free(BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700182
David Benjamin4512b792017-08-18 19:21:50 -0400183// BN_dup allocates a new BIGNUM and sets it equal to |src|. It returns the
184// allocated BIGNUM on success or NULL otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700185OPENSSL_EXPORT BIGNUM *BN_dup(const BIGNUM *src);
Adam Langley95c29f32014-06-20 12:00:00 -0700186
David Benjamin4512b792017-08-18 19:21:50 -0400187// BN_copy sets |dest| equal to |src| and returns |dest| or NULL on allocation
188// failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700189OPENSSL_EXPORT BIGNUM *BN_copy(BIGNUM *dest, const BIGNUM *src);
Adam Langley95c29f32014-06-20 12:00:00 -0700190
David Benjamin4512b792017-08-18 19:21:50 -0400191// BN_clear sets |bn| to zero and erases the old data.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700192OPENSSL_EXPORT void BN_clear(BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700193
David Benjamin4512b792017-08-18 19:21:50 -0400194// BN_value_one returns a static BIGNUM with value 1.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700195OPENSSL_EXPORT const BIGNUM *BN_value_one(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700196
Adam Langley95c29f32014-06-20 12:00:00 -0700197
David Benjamin4512b792017-08-18 19:21:50 -0400198// Basic functions.
Adam Langley95c29f32014-06-20 12:00:00 -0700199
David Benjamin4512b792017-08-18 19:21:50 -0400200// BN_num_bits returns the minimum number of bits needed to represent the
201// absolute value of |bn|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700202OPENSSL_EXPORT unsigned BN_num_bits(const BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700203
David Benjamin4512b792017-08-18 19:21:50 -0400204// BN_num_bytes returns the minimum number of bytes needed to represent the
205// absolute value of |bn|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700206OPENSSL_EXPORT unsigned BN_num_bytes(const BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700207
David Benjamin4512b792017-08-18 19:21:50 -0400208// BN_zero sets |bn| to zero.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700209OPENSSL_EXPORT void BN_zero(BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700210
David Benjamin4512b792017-08-18 19:21:50 -0400211// BN_one sets |bn| to one. It returns one on success or zero on allocation
212// failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700213OPENSSL_EXPORT int BN_one(BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700214
David Benjamin4512b792017-08-18 19:21:50 -0400215// BN_set_word sets |bn| to |value|. It returns one on success or zero on
216// allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700217OPENSSL_EXPORT int BN_set_word(BIGNUM *bn, BN_ULONG value);
Adam Langley95c29f32014-06-20 12:00:00 -0700218
David Benjamin4512b792017-08-18 19:21:50 -0400219// BN_set_u64 sets |bn| to |value|. It returns one on success or zero on
220// allocation failure.
David Benjamin40a63112016-08-23 20:53:12 -0700221OPENSSL_EXPORT int BN_set_u64(BIGNUM *bn, uint64_t value);
222
David Benjamin4512b792017-08-18 19:21:50 -0400223// BN_set_negative sets the sign of |bn|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700224OPENSSL_EXPORT void BN_set_negative(BIGNUM *bn, int sign);
Adam Langley95c29f32014-06-20 12:00:00 -0700225
David Benjamin4512b792017-08-18 19:21:50 -0400226// BN_is_negative returns one if |bn| is negative and zero otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700227OPENSSL_EXPORT int BN_is_negative(const BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700228
Adam Langley95c29f32014-06-20 12:00:00 -0700229
David Benjamin4512b792017-08-18 19:21:50 -0400230// Conversion functions.
Adam Langley95c29f32014-06-20 12:00:00 -0700231
David Benjamin4512b792017-08-18 19:21:50 -0400232// BN_bin2bn sets |*ret| to the value of |len| bytes from |in|, interpreted as
233// a big-endian number, and returns |ret|. If |ret| is NULL then a fresh
234// |BIGNUM| is allocated and returned. It returns NULL on allocation
235// failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700236OPENSSL_EXPORT BIGNUM *BN_bin2bn(const uint8_t *in, size_t len, BIGNUM *ret);
Adam Langley95c29f32014-06-20 12:00:00 -0700237
David Benjamin4512b792017-08-18 19:21:50 -0400238// BN_bn2bin serialises the absolute value of |in| to |out| as a big-endian
239// integer, which must have |BN_num_bytes| of space available. It returns the
240// number of bytes written.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700241OPENSSL_EXPORT size_t BN_bn2bin(const BIGNUM *in, uint8_t *out);
Adam Langley95c29f32014-06-20 12:00:00 -0700242
David Benjamin4512b792017-08-18 19:21:50 -0400243// BN_le2bn sets |*ret| to the value of |len| bytes from |in|, interpreted as
244// a little-endian number, and returns |ret|. If |ret| is NULL then a fresh
245// |BIGNUM| is allocated and returned. It returns NULL on allocation
246// failure.
Rob Sloan45573cc2016-12-07 20:53:22 -0800247OPENSSL_EXPORT BIGNUM *BN_le2bn(const uint8_t *in, size_t len, BIGNUM *ret);
248
David Benjamin4512b792017-08-18 19:21:50 -0400249// BN_bn2le_padded serialises the absolute value of |in| to |out| as a
250// little-endian integer, which must have |len| of space available, padding
251// out the remainder of out with zeros. If |len| is smaller than |BN_num_bytes|,
252// the function fails and returns 0. Otherwise, it returns 1.
Rob Sloan45573cc2016-12-07 20:53:22 -0800253OPENSSL_EXPORT int BN_bn2le_padded(uint8_t *out, size_t len, const BIGNUM *in);
254
David Benjamin4512b792017-08-18 19:21:50 -0400255// BN_bn2bin_padded serialises the absolute value of |in| to |out| as a
256// big-endian integer. The integer is padded with leading zeros up to size
257// |len|. If |len| is smaller than |BN_num_bytes|, the function fails and
258// returns 0. Otherwise, it returns 1.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700259OPENSSL_EXPORT int BN_bn2bin_padded(uint8_t *out, size_t len, const BIGNUM *in);
Adam Langley6887edb2014-06-20 12:00:00 -0700260
David Benjamin4512b792017-08-18 19:21:50 -0400261// BN_bn2cbb_padded behaves like |BN_bn2bin_padded| but writes to a |CBB|.
David Benjaminae0eaaa2015-12-17 02:01:25 -0500262OPENSSL_EXPORT int BN_bn2cbb_padded(CBB *out, size_t len, const BIGNUM *in);
263
David Benjamin4512b792017-08-18 19:21:50 -0400264// BN_bn2hex returns an allocated string that contains a NUL-terminated, hex
265// representation of |bn|. If |bn| is negative, the first char in the resulting
266// string will be '-'. Returns NULL on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700267OPENSSL_EXPORT char *BN_bn2hex(const BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700268
David Benjamin4512b792017-08-18 19:21:50 -0400269// BN_hex2bn parses the leading hex number from |in|, which may be proceeded by
270// a '-' to indicate a negative number and may contain trailing, non-hex data.
271// If |outp| is not NULL, it constructs a BIGNUM equal to the hex number and
272// stores it in |*outp|. If |*outp| is NULL then it allocates a new BIGNUM and
273// updates |*outp|. It returns the number of bytes of |in| processed or zero on
274// error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700275OPENSSL_EXPORT int BN_hex2bn(BIGNUM **outp, const char *in);
Adam Langley95c29f32014-06-20 12:00:00 -0700276
David Benjamin4512b792017-08-18 19:21:50 -0400277// BN_bn2dec returns an allocated string that contains a NUL-terminated,
278// decimal representation of |bn|. If |bn| is negative, the first char in the
279// resulting string will be '-'. Returns NULL on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700280OPENSSL_EXPORT char *BN_bn2dec(const BIGNUM *a);
Adam Langley95c29f32014-06-20 12:00:00 -0700281
David Benjamin4512b792017-08-18 19:21:50 -0400282// BN_dec2bn parses the leading decimal number from |in|, which may be
283// proceeded by a '-' to indicate a negative number and may contain trailing,
284// non-decimal data. If |outp| is not NULL, it constructs a BIGNUM equal to the
285// decimal number and stores it in |*outp|. If |*outp| is NULL then it
286// allocates a new BIGNUM and updates |*outp|. It returns the number of bytes
287// of |in| processed or zero on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700288OPENSSL_EXPORT int BN_dec2bn(BIGNUM **outp, const char *in);
Adam Langley95c29f32014-06-20 12:00:00 -0700289
David Benjamin4512b792017-08-18 19:21:50 -0400290// BN_asc2bn acts like |BN_dec2bn| or |BN_hex2bn| depending on whether |in|
291// begins with "0X" or "0x" (indicating hex) or not (indicating decimal). A
292// leading '-' is still permitted and comes before the optional 0X/0x. It
293// returns one on success or zero on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700294OPENSSL_EXPORT int BN_asc2bn(BIGNUM **outp, const char *in);
Adam Langley95c29f32014-06-20 12:00:00 -0700295
David Benjamin4512b792017-08-18 19:21:50 -0400296// BN_print writes a hex encoding of |a| to |bio|. It returns one on success
297// and zero on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700298OPENSSL_EXPORT int BN_print(BIO *bio, const BIGNUM *a);
Adam Langley95c29f32014-06-20 12:00:00 -0700299
David Benjamin4512b792017-08-18 19:21:50 -0400300// BN_print_fp acts like |BIO_print|, but wraps |fp| in a |BIO| first.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700301OPENSSL_EXPORT int BN_print_fp(FILE *fp, const BIGNUM *a);
Adam Langley95c29f32014-06-20 12:00:00 -0700302
David Benjamin4512b792017-08-18 19:21:50 -0400303// BN_get_word returns the absolute value of |bn| as a single word. If |bn| is
304// too large to be represented as a single word, the maximum possible value
305// will be returned.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700306OPENSSL_EXPORT BN_ULONG BN_get_word(const BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700307
David Benjamin4512b792017-08-18 19:21:50 -0400308// BN_get_u64 sets |*out| to the absolute value of |bn| as a |uint64_t| and
309// returns one. If |bn| is too large to be represented as a |uint64_t|, it
310// returns zero.
Rob Sloan2ee1edf2016-12-15 16:28:44 -0800311OPENSSL_EXPORT int BN_get_u64(const BIGNUM *bn, uint64_t *out);
312
Adam Langley95c29f32014-06-20 12:00:00 -0700313
David Benjamin4512b792017-08-18 19:21:50 -0400314// ASN.1 functions.
David Benjaminb9c579d2015-06-11 22:52:07 -0400315
David Benjamin4512b792017-08-18 19:21:50 -0400316// BN_parse_asn1_unsigned parses a non-negative DER INTEGER from |cbs| writes
317// the result to |ret|. It returns one on success and zero on failure.
David Benjaminacb24512015-12-22 15:02:01 -0500318OPENSSL_EXPORT int BN_parse_asn1_unsigned(CBS *cbs, BIGNUM *ret);
David Benjaminb9c579d2015-06-11 22:52:07 -0400319
David Benjamin4512b792017-08-18 19:21:50 -0400320// BN_parse_asn1_unsigned_buggy acts like |BN_parse_asn1_unsigned| but tolerates
321// some invalid encodings. Do not use this function.
David Benjaminacb24512015-12-22 15:02:01 -0500322OPENSSL_EXPORT int BN_parse_asn1_unsigned_buggy(CBS *cbs, BIGNUM *ret);
David Benjamin231cb822015-09-15 16:47:35 -0400323
David Benjamin4512b792017-08-18 19:21:50 -0400324// BN_marshal_asn1 marshals |bn| as a non-negative DER INTEGER and appends the
325// result to |cbb|. It returns one on success and zero on failure.
David Benjaminacb24512015-12-22 15:02:01 -0500326OPENSSL_EXPORT int BN_marshal_asn1(CBB *cbb, const BIGNUM *bn);
David Benjaminb9c579d2015-06-11 22:52:07 -0400327
328
David Benjamin4512b792017-08-18 19:21:50 -0400329// BIGNUM pools.
330//
331// Certain BIGNUM operations need to use many temporary variables and
332// allocating and freeing them can be quite slow. Thus such operations typically
333// take a |BN_CTX| parameter, which contains a pool of |BIGNUMs|. The |ctx|
334// argument to a public function may be NULL, in which case a local |BN_CTX|
335// will be created just for the lifetime of that call.
336//
337// A function must call |BN_CTX_start| first. Then, |BN_CTX_get| may be called
338// repeatedly to obtain temporary |BIGNUM|s. All |BN_CTX_get| calls must be made
339// before calling any other functions that use the |ctx| as an argument.
340//
341// Finally, |BN_CTX_end| must be called before returning from the function.
342// When |BN_CTX_end| is called, the |BIGNUM| pointers obtained from
343// |BN_CTX_get| become invalid.
Adam Langley95c29f32014-06-20 12:00:00 -0700344
David Benjamin4512b792017-08-18 19:21:50 -0400345// BN_CTX_new returns a new, empty BN_CTX or NULL on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700346OPENSSL_EXPORT BN_CTX *BN_CTX_new(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700347
David Benjamin4512b792017-08-18 19:21:50 -0400348// BN_CTX_free frees all BIGNUMs contained in |ctx| and then frees |ctx|
349// itself.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700350OPENSSL_EXPORT void BN_CTX_free(BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700351
David Benjamin4512b792017-08-18 19:21:50 -0400352// BN_CTX_start "pushes" a new entry onto the |ctx| stack and allows future
353// calls to |BN_CTX_get|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700354OPENSSL_EXPORT void BN_CTX_start(BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700355
David Benjamin4512b792017-08-18 19:21:50 -0400356// BN_CTX_get returns a new |BIGNUM|, or NULL on allocation failure. Once
357// |BN_CTX_get| has returned NULL, all future calls will also return NULL until
358// |BN_CTX_end| is called.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700359OPENSSL_EXPORT BIGNUM *BN_CTX_get(BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700360
David Benjamin4512b792017-08-18 19:21:50 -0400361// BN_CTX_end invalidates all |BIGNUM|s returned from |BN_CTX_get| since the
362// matching |BN_CTX_start| call.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700363OPENSSL_EXPORT void BN_CTX_end(BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700364
365
David Benjamin4512b792017-08-18 19:21:50 -0400366// Simple arithmetic
Adam Langley95c29f32014-06-20 12:00:00 -0700367
David Benjamin4512b792017-08-18 19:21:50 -0400368// BN_add sets |r| = |a| + |b|, where |r| may be the same pointer as either |a|
369// or |b|. It returns one on success and zero on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700370OPENSSL_EXPORT int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700371
David Benjamin4512b792017-08-18 19:21:50 -0400372// BN_uadd sets |r| = |a| + |b|, where |a| and |b| are non-negative and |r| may
373// be the same pointer as either |a| or |b|. It returns one on success and zero
374// on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700375OPENSSL_EXPORT int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700376
David Benjamin4512b792017-08-18 19:21:50 -0400377// BN_add_word adds |w| to |a|. It returns one on success and zero otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700378OPENSSL_EXPORT int BN_add_word(BIGNUM *a, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700379
David Benjamin4512b792017-08-18 19:21:50 -0400380// BN_sub sets |r| = |a| - |b|, where |r| may be the same pointer as either |a|
381// or |b|. It returns one on success and zero on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700382OPENSSL_EXPORT int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700383
David Benjamin4512b792017-08-18 19:21:50 -0400384// BN_usub sets |r| = |a| - |b|, where |a| and |b| are non-negative integers,
385// |b| < |a| and |r| may be the same pointer as either |a| or |b|. It returns
386// one on success and zero on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700387OPENSSL_EXPORT int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700388
David Benjamin4512b792017-08-18 19:21:50 -0400389// BN_sub_word subtracts |w| from |a|. It returns one on success and zero on
390// allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700391OPENSSL_EXPORT int BN_sub_word(BIGNUM *a, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700392
David Benjamin4512b792017-08-18 19:21:50 -0400393// BN_mul sets |r| = |a| * |b|, where |r| may be the same pointer as |a| or
394// |b|. Returns one on success and zero otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700395OPENSSL_EXPORT int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
396 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700397
David Benjamin4512b792017-08-18 19:21:50 -0400398// BN_mul_word sets |bn| = |bn| * |w|. It returns one on success or zero on
399// allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700400OPENSSL_EXPORT int BN_mul_word(BIGNUM *bn, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700401
David Benjamin4512b792017-08-18 19:21:50 -0400402// BN_sqr sets |r| = |a|^2 (i.e. squares), where |r| may be the same pointer as
403// |a|. Returns one on success and zero otherwise. This is more efficient than
404// BN_mul(r, a, a, ctx).
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700405OPENSSL_EXPORT int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700406
David Benjamin4512b792017-08-18 19:21:50 -0400407// BN_div divides |numerator| by |divisor| and places the result in |quotient|
408// and the remainder in |rem|. Either of |quotient| or |rem| may be NULL, in
409// which case the respective value is not returned. The result is rounded
410// towards zero; thus if |numerator| is negative, the remainder will be zero or
411// negative. It returns one on success or zero on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700412OPENSSL_EXPORT int BN_div(BIGNUM *quotient, BIGNUM *rem,
413 const BIGNUM *numerator, const BIGNUM *divisor,
414 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700415
David Benjamin4512b792017-08-18 19:21:50 -0400416// BN_div_word sets |numerator| = |numerator|/|divisor| and returns the
417// remainder or (BN_ULONG)-1 on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700418OPENSSL_EXPORT BN_ULONG BN_div_word(BIGNUM *numerator, BN_ULONG divisor);
Adam Langley95c29f32014-06-20 12:00:00 -0700419
David Benjamin4512b792017-08-18 19:21:50 -0400420// BN_sqrt sets |*out_sqrt| (which may be the same |BIGNUM| as |in|) to the
421// square root of |in|, using |ctx|. It returns one on success or zero on
422// error. Negative numbers and non-square numbers will result in an error with
423// appropriate errors on the error queue.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700424OPENSSL_EXPORT int BN_sqrt(BIGNUM *out_sqrt, const BIGNUM *in, BN_CTX *ctx);
Adam Langley409766d2014-06-20 12:00:00 -0700425
Adam Langley95c29f32014-06-20 12:00:00 -0700426
David Benjamin4512b792017-08-18 19:21:50 -0400427// Comparison functions
Adam Langley95c29f32014-06-20 12:00:00 -0700428
David Benjamin4512b792017-08-18 19:21:50 -0400429// BN_cmp returns a value less than, equal to or greater than zero if |a| is
430// less than, equal to or greater than |b|, respectively.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700431OPENSSL_EXPORT int BN_cmp(const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700432
David Benjamin4512b792017-08-18 19:21:50 -0400433// BN_cmp_word is like |BN_cmp| except it takes its second argument as a
434// |BN_ULONG| instead of a |BIGNUM|.
David Benjaminccd511e2016-07-29 12:11:34 -0400435OPENSSL_EXPORT int BN_cmp_word(const BIGNUM *a, BN_ULONG b);
Brian Smith4edca0b2016-07-25 10:36:58 -1000436
David Benjamin4512b792017-08-18 19:21:50 -0400437// BN_ucmp returns a value less than, equal to or greater than zero if the
438// absolute value of |a| is less than, equal to or greater than the absolute
439// value of |b|, respectively.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700440OPENSSL_EXPORT int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700441
David Benjamin4512b792017-08-18 19:21:50 -0400442// BN_equal_consttime returns one if |a| is equal to |b|, and zero otherwise.
443// It takes an amount of time dependent on the sizes of |a| and |b|, but
444// independent of the contents (including the signs) of |a| and |b|.
Brian Smith86080c32016-03-25 12:23:16 -1000445OPENSSL_EXPORT int BN_equal_consttime(const BIGNUM *a, const BIGNUM *b);
446
David Benjamin4512b792017-08-18 19:21:50 -0400447// BN_abs_is_word returns one if the absolute value of |bn| equals |w| and zero
448// otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700449OPENSSL_EXPORT int BN_abs_is_word(const BIGNUM *bn, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700450
David Benjamin4512b792017-08-18 19:21:50 -0400451// BN_is_zero returns one if |bn| is zero and zero otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700452OPENSSL_EXPORT int BN_is_zero(const BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700453
David Benjamin4512b792017-08-18 19:21:50 -0400454// BN_is_one returns one if |bn| equals one and zero otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700455OPENSSL_EXPORT int BN_is_one(const BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700456
David Benjamin4512b792017-08-18 19:21:50 -0400457// BN_is_word returns one if |bn| is exactly |w| and zero otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700458OPENSSL_EXPORT int BN_is_word(const BIGNUM *bn, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700459
David Benjamin4512b792017-08-18 19:21:50 -0400460// BN_is_odd returns one if |bn| is odd and zero otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700461OPENSSL_EXPORT int BN_is_odd(const BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700462
David Benjamin4512b792017-08-18 19:21:50 -0400463// BN_is_pow2 returns 1 if |a| is a power of two, and 0 otherwise.
Rob Sloanb9873552017-01-30 11:52:27 -0800464OPENSSL_EXPORT int BN_is_pow2(const BIGNUM *a);
Adam Langley95c29f32014-06-20 12:00:00 -0700465
David Benjamin4512b792017-08-18 19:21:50 -0400466// Bitwise operations.
Adam Langley95c29f32014-06-20 12:00:00 -0700467
David Benjamin4512b792017-08-18 19:21:50 -0400468// BN_lshift sets |r| equal to |a| << n. The |a| and |r| arguments may be the
469// same |BIGNUM|. It returns one on success and zero on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700470OPENSSL_EXPORT int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700471
David Benjamin4512b792017-08-18 19:21:50 -0400472// BN_lshift1 sets |r| equal to |a| << 1, where |r| and |a| may be the same
473// pointer. It returns one on success and zero on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700474OPENSSL_EXPORT int BN_lshift1(BIGNUM *r, const BIGNUM *a);
Adam Langley95c29f32014-06-20 12:00:00 -0700475
David Benjamin4512b792017-08-18 19:21:50 -0400476// BN_rshift sets |r| equal to |a| >> n, where |r| and |a| may be the same
477// pointer. It returns one on success and zero on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700478OPENSSL_EXPORT int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700479
David Benjamin4512b792017-08-18 19:21:50 -0400480// BN_rshift1 sets |r| equal to |a| >> 1, where |r| and |a| may be the same
481// pointer. It returns one on success and zero on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700482OPENSSL_EXPORT int BN_rshift1(BIGNUM *r, const BIGNUM *a);
Adam Langley95c29f32014-06-20 12:00:00 -0700483
David Benjamin4512b792017-08-18 19:21:50 -0400484// BN_set_bit sets the |n|th, least-significant bit in |a|. For example, if |a|
485// is 2 then setting bit zero will make it 3. It returns one on success or zero
486// on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700487OPENSSL_EXPORT int BN_set_bit(BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700488
David Benjamin4512b792017-08-18 19:21:50 -0400489// BN_clear_bit clears the |n|th, least-significant bit in |a|. For example, if
490// |a| is 3, clearing bit zero will make it two. It returns one on success or
491// zero on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700492OPENSSL_EXPORT int BN_clear_bit(BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700493
David Benjamin4512b792017-08-18 19:21:50 -0400494// BN_is_bit_set returns the value of the |n|th, least-significant bit in |a|,
495// or zero if the bit doesn't exist.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700496OPENSSL_EXPORT int BN_is_bit_set(const BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700497
David Benjamin4512b792017-08-18 19:21:50 -0400498// BN_mask_bits truncates |a| so that it is only |n| bits long. It returns one
499// on success or zero if |n| is greater than the length of |a| already.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700500OPENSSL_EXPORT int BN_mask_bits(BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700501
502
David Benjamin4512b792017-08-18 19:21:50 -0400503// Modulo arithmetic.
Adam Langley95c29f32014-06-20 12:00:00 -0700504
David Benjamin4512b792017-08-18 19:21:50 -0400505// BN_mod_word returns |a| mod |w| or (BN_ULONG)-1 on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700506OPENSSL_EXPORT BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700507
David Benjamin4512b792017-08-18 19:21:50 -0400508// BN_mod_pow2 sets |r| = |a| mod 2^|e|. It returns 1 on success and
509// 0 on error.
Rob Sloanb9873552017-01-30 11:52:27 -0800510OPENSSL_EXPORT int BN_mod_pow2(BIGNUM *r, const BIGNUM *a, size_t e);
511
David Benjamin4512b792017-08-18 19:21:50 -0400512// BN_nnmod_pow2 sets |r| = |a| mod 2^|e| where |r| is always positive.
513// It returns 1 on success and 0 on error.
Rob Sloanb9873552017-01-30 11:52:27 -0800514OPENSSL_EXPORT int BN_nnmod_pow2(BIGNUM *r, const BIGNUM *a, size_t e);
515
David Benjamin4512b792017-08-18 19:21:50 -0400516// BN_mod is a helper macro that calls |BN_div| and discards the quotient.
Adam Langley95c29f32014-06-20 12:00:00 -0700517#define BN_mod(rem, numerator, divisor, ctx) \
518 BN_div(NULL, (rem), (numerator), (divisor), (ctx))
519
David Benjamin4512b792017-08-18 19:21:50 -0400520// BN_nnmod is a non-negative modulo function. It acts like |BN_mod|, but 0 <=
521// |rem| < |divisor| is always true. It returns one on success and zero on
522// error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700523OPENSSL_EXPORT int BN_nnmod(BIGNUM *rem, const BIGNUM *numerator,
524 const BIGNUM *divisor, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700525
David Benjamin4512b792017-08-18 19:21:50 -0400526// BN_mod_add sets |r| = |a| + |b| mod |m|. It returns one on success and zero
527// on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700528OPENSSL_EXPORT int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
529 const BIGNUM *m, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700530
David Benjamin4512b792017-08-18 19:21:50 -0400531// BN_mod_add_quick acts like |BN_mod_add| but requires that |a| and |b| be
532// non-negative and less than |m|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700533OPENSSL_EXPORT int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
534 const BIGNUM *m);
Adam Langley95c29f32014-06-20 12:00:00 -0700535
David Benjamin4512b792017-08-18 19:21:50 -0400536// BN_mod_sub sets |r| = |a| - |b| mod |m|. It returns one on success and zero
537// on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700538OPENSSL_EXPORT int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
539 const BIGNUM *m, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700540
David Benjamin4512b792017-08-18 19:21:50 -0400541// BN_mod_sub_quick acts like |BN_mod_sub| but requires that |a| and |b| be
542// non-negative and less than |m|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700543OPENSSL_EXPORT int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
544 const BIGNUM *m);
Adam Langley95c29f32014-06-20 12:00:00 -0700545
David Benjamin4512b792017-08-18 19:21:50 -0400546// BN_mod_mul sets |r| = |a|*|b| mod |m|. It returns one on success and zero
547// on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700548OPENSSL_EXPORT int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
549 const BIGNUM *m, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700550
David Benjamin4512b792017-08-18 19:21:50 -0400551// BN_mod_sqr sets |r| = |a|^2 mod |m|. It returns one on success and zero
552// on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700553OPENSSL_EXPORT int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m,
554 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700555
David Benjamin4512b792017-08-18 19:21:50 -0400556// BN_mod_lshift sets |r| = (|a| << n) mod |m|, where |r| and |a| may be the
557// same pointer. It returns one on success and zero on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700558OPENSSL_EXPORT int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n,
559 const BIGNUM *m, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700560
David Benjamin4512b792017-08-18 19:21:50 -0400561// BN_mod_lshift_quick acts like |BN_mod_lshift| but requires that |a| be
562// non-negative and less than |m|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700563OPENSSL_EXPORT int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n,
564 const BIGNUM *m);
Adam Langley95c29f32014-06-20 12:00:00 -0700565
David Benjamin4512b792017-08-18 19:21:50 -0400566// BN_mod_lshift1 sets |r| = (|a| << 1) mod |m|, where |r| and |a| may be the
567// same pointer. It returns one on success and zero on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700568OPENSSL_EXPORT int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m,
569 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700570
David Benjamin4512b792017-08-18 19:21:50 -0400571// BN_mod_lshift1_quick acts like |BN_mod_lshift1| but requires that |a| be
572// non-negative and less than |m|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700573OPENSSL_EXPORT int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a,
574 const BIGNUM *m);
Adam Langley95c29f32014-06-20 12:00:00 -0700575
David Benjamin4512b792017-08-18 19:21:50 -0400576// BN_mod_sqrt returns a newly-allocated |BIGNUM|, r, such that
577// r^2 == a (mod p). |p| must be a prime. It returns NULL on error or if |a| is
578// not a square mod |p|. In the latter case, it will add |BN_R_NOT_A_SQUARE| to
579// the error queue.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700580OPENSSL_EXPORT BIGNUM *BN_mod_sqrt(BIGNUM *in, const BIGNUM *a, const BIGNUM *p,
581 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700582
583
David Benjamin4512b792017-08-18 19:21:50 -0400584// Random and prime number generation.
Adam Langley95c29f32014-06-20 12:00:00 -0700585
David Benjamin4512b792017-08-18 19:21:50 -0400586// The following are values for the |top| parameter of |BN_rand|.
David Benjamin1e5ac5d2016-11-01 16:37:09 -0400587#define BN_RAND_TOP_ANY (-1)
David Benjamind224d522016-08-16 10:03:45 -0400588#define BN_RAND_TOP_ONE 0
589#define BN_RAND_TOP_TWO 1
590
David Benjamin4512b792017-08-18 19:21:50 -0400591// The following are values for the |bottom| parameter of |BN_rand|.
David Benjamind224d522016-08-16 10:03:45 -0400592#define BN_RAND_BOTTOM_ANY 0
593#define BN_RAND_BOTTOM_ODD 1
594
David Benjamin4512b792017-08-18 19:21:50 -0400595// BN_rand sets |rnd| to a random number of length |bits|. It returns one on
596// success and zero otherwise.
597//
598// |top| must be one of the |BN_RAND_TOP_*| values. If |BN_RAND_TOP_ONE|, the
599// most-significant bit, if any, will be set. If |BN_RAND_TOP_TWO|, the two
600// most significant bits, if any, will be set. If |BN_RAND_TOP_ANY|, no extra
601// action will be taken and |BN_num_bits(rnd)| may not equal |bits| if the most
602// significant bits randomly ended up as zeros.
603//
604// |bottom| must be one of the |BN_RAND_BOTTOM_*| values. If
605// |BN_RAND_BOTTOM_ODD|, the least-significant bit, if any, will be set. If
606// |BN_RAND_BOTTOM_ANY|, no extra action will be taken.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700607OPENSSL_EXPORT int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
Adam Langley95c29f32014-06-20 12:00:00 -0700608
David Benjamin4512b792017-08-18 19:21:50 -0400609// BN_pseudo_rand is an alias for |BN_rand|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700610OPENSSL_EXPORT int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
Adam Langley95c29f32014-06-20 12:00:00 -0700611
David Benjamin4512b792017-08-18 19:21:50 -0400612// BN_rand_range is equivalent to |BN_rand_range_ex| with |min_inclusive| set
613// to zero and |max_exclusive| set to |range|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700614OPENSSL_EXPORT int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
Adam Langley95c29f32014-06-20 12:00:00 -0700615
David Benjamin4512b792017-08-18 19:21:50 -0400616// BN_rand_range_ex sets |rnd| to a random value in
617// [min_inclusive..max_exclusive). It returns one on success and zero
618// otherwise.
Brian Smith4edca0b2016-07-25 10:36:58 -1000619OPENSSL_EXPORT int BN_rand_range_ex(BIGNUM *r, BN_ULONG min_inclusive,
620 const BIGNUM *max_exclusive);
621
David Benjamin4512b792017-08-18 19:21:50 -0400622// BN_pseudo_rand_range is an alias for BN_rand_range.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700623OPENSSL_EXPORT int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
Adam Langley95c29f32014-06-20 12:00:00 -0700624
David Benjamin4512b792017-08-18 19:21:50 -0400625// BN_generate_dsa_nonce generates a random number 0 <= out < range. Unlike
626// BN_rand_range, it also includes the contents of |priv| and |message| in the
627// generation so that an RNG failure isn't fatal as long as |priv| remains
628// secret. This is intended for use in DSA and ECDSA where an RNG weakness
629// leads directly to private key exposure unless this function is used.
630// It returns one on success and zero on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700631OPENSSL_EXPORT int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range,
632 const BIGNUM *priv,
633 const uint8_t *message,
634 size_t message_len, BN_CTX *ctx);
Adam Langleyd4b4f082014-06-20 12:00:00 -0700635
David Benjamin4512b792017-08-18 19:21:50 -0400636// BN_GENCB holds a callback function that is used by generation functions that
637// can take a very long time to complete. Use |BN_GENCB_set| to initialise a
638// |BN_GENCB| structure.
639//
640// The callback receives the address of that |BN_GENCB| structure as its last
641// argument and the user is free to put an arbitrary pointer in |arg|. The other
642// arguments are set as follows:
643// event=BN_GENCB_GENERATED, n=i: after generating the i'th possible prime
644// number.
645// event=BN_GENCB_PRIME_TEST, n=-1: when finished trial division primality
646// checks.
647// event=BN_GENCB_PRIME_TEST, n=i: when the i'th primality test has finished.
648//
649// The callback can return zero to abort the generation progress or one to
650// allow it to continue.
651//
652// When other code needs to call a BN generation function it will often take a
653// BN_GENCB argument and may call the function with other argument values.
Adam Langley95c29f32014-06-20 12:00:00 -0700654#define BN_GENCB_GENERATED 0
655#define BN_GENCB_PRIME_TEST 1
656
657struct bn_gencb_st {
David Benjamin4512b792017-08-18 19:21:50 -0400658 void *arg; // callback-specific data
Adam Langley95c29f32014-06-20 12:00:00 -0700659 int (*callback)(int event, int n, struct bn_gencb_st *);
660};
661
David Benjamin4512b792017-08-18 19:21:50 -0400662// BN_GENCB_set configures |callback| to call |f| and sets |callout->arg| to
663// |arg|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700664OPENSSL_EXPORT void BN_GENCB_set(BN_GENCB *callback,
665 int (*f)(int event, int n,
666 struct bn_gencb_st *),
667 void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -0700668
David Benjamin4512b792017-08-18 19:21:50 -0400669// BN_GENCB_call calls |callback|, if not NULL, and returns the return value of
670// the callback, or 1 if |callback| is NULL.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700671OPENSSL_EXPORT int BN_GENCB_call(BN_GENCB *callback, int event, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700672
David Benjamin4512b792017-08-18 19:21:50 -0400673// BN_generate_prime_ex sets |ret| to a prime number of |bits| length. If safe
674// is non-zero then the prime will be such that (ret-1)/2 is also a prime.
675// (This is needed for Diffie-Hellman groups to ensure that the only subgroups
676// are of size 2 and (p-1)/2.).
677//
678// If |add| is not NULL, the prime will fulfill the condition |ret| % |add| ==
679// |rem| in order to suit a given generator. (If |rem| is NULL then |ret| %
680// |add| == 1.)
681//
682// If |cb| is not NULL, it will be called during processing to give an
683// indication of progress. See the comments for |BN_GENCB|. It returns one on
684// success and zero otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700685OPENSSL_EXPORT int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe,
686 const BIGNUM *add, const BIGNUM *rem,
687 BN_GENCB *cb);
Adam Langley95c29f32014-06-20 12:00:00 -0700688
David Benjamin4512b792017-08-18 19:21:50 -0400689// BN_prime_checks is magic value that can be used as the |checks| argument to
690// the primality testing functions in order to automatically select a number of
691// Miller-Rabin checks that gives a false positive rate of ~2^{-80}.
Adam Langley95c29f32014-06-20 12:00:00 -0700692#define BN_prime_checks 0
693
David Benjamin4512b792017-08-18 19:21:50 -0400694// bn_primality_result_t enumerates the outcomes of primality-testing.
Steven Valdezfc9f10f2017-04-17 16:03:38 -0400695enum bn_primality_result_t {
696 bn_probably_prime,
697 bn_composite,
698 bn_non_prime_power_composite,
699};
700
David Benjamin4512b792017-08-18 19:21:50 -0400701// BN_enhanced_miller_rabin_primality_test tests whether |w| is probably a prime
702// number using the Enhanced Miller-Rabin Test (FIPS 186-4 C.3.2) with
703// |iterations| iterations and returns the result in |out_result|. Enhanced
704// Miller-Rabin tests primality for odd integers greater than 3, returning
705// |bn_probably_prime| if the number is probably prime,
706// |bn_non_prime_power_composite| if the number is a composite that is not the
707// power of a single prime, and |bn_composite| otherwise. If |iterations| is
708// |BN_prime_checks|, then a value that results in a false positive rate lower
709// than the number-field sieve security level of |w| is used. It returns one on
710// success and zero on failure. If |cb| is not NULL, then it is called during
711// each iteration of the primality test.
Steven Valdezfc9f10f2017-04-17 16:03:38 -0400712int BN_enhanced_miller_rabin_primality_test(
713 enum bn_primality_result_t *out_result, const BIGNUM *w, int iterations,
714 BN_CTX *ctx, BN_GENCB *cb);
715
David Benjamin4512b792017-08-18 19:21:50 -0400716// BN_primality_test sets |*is_probably_prime| to one if |candidate| is
717// probably a prime number by the Miller-Rabin test or zero if it's certainly
718// not.
719//
720// If |do_trial_division| is non-zero then |candidate| will be tested against a
721// list of small primes before Miller-Rabin tests. The probability of this
722// function returning a false positive is 2^{2*checks}. If |checks| is
723// |BN_prime_checks| then a value that results in a false positive rate lower
724// than the number-field sieve security level of |candidate| is used. If |cb| is
725// not NULL then it is called during the checking process. See the comment above
726// |BN_GENCB|.
727//
728// The function returns one on success and zero on error.
729//
730// (If you are unsure whether you want |do_trial_division|, don't set it.)
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700731OPENSSL_EXPORT int BN_primality_test(int *is_probably_prime,
732 const BIGNUM *candidate, int checks,
733 BN_CTX *ctx, int do_trial_division,
734 BN_GENCB *cb);
Adam Langley95c29f32014-06-20 12:00:00 -0700735
David Benjamin4512b792017-08-18 19:21:50 -0400736// BN_is_prime_fasttest_ex returns one if |candidate| is probably a prime
737// number by the Miller-Rabin test, zero if it's certainly not and -1 on error.
738//
739// If |do_trial_division| is non-zero then |candidate| will be tested against a
740// list of small primes before Miller-Rabin tests. The probability of this
741// function returning one when |candidate| is composite is 2^{2*checks}. If
742// |checks| is |BN_prime_checks| then a value that results in a false positive
743// rate lower than the number-field sieve security level of |candidate| is used.
744// If |cb| is not NULL then it is called during the checking process. See the
745// comment above |BN_GENCB|.
746//
747// WARNING: deprecated. Use |BN_primality_test|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700748OPENSSL_EXPORT int BN_is_prime_fasttest_ex(const BIGNUM *candidate, int checks,
749 BN_CTX *ctx, int do_trial_division,
750 BN_GENCB *cb);
Adam Langley95c29f32014-06-20 12:00:00 -0700751
David Benjamin4512b792017-08-18 19:21:50 -0400752// BN_is_prime_ex acts the same as |BN_is_prime_fasttest_ex| with
753// |do_trial_division| set to zero.
754//
755// WARNING: deprecated: Use |BN_primality_test|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700756OPENSSL_EXPORT int BN_is_prime_ex(const BIGNUM *candidate, int checks,
757 BN_CTX *ctx, BN_GENCB *cb);
Adam Langley95c29f32014-06-20 12:00:00 -0700758
759
David Benjamin4512b792017-08-18 19:21:50 -0400760// Number theory functions
Adam Langley95c29f32014-06-20 12:00:00 -0700761
David Benjamin4512b792017-08-18 19:21:50 -0400762// BN_gcd sets |r| = gcd(|a|, |b|). It returns one on success and zero
763// otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700764OPENSSL_EXPORT int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
765 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700766
David Benjamin4512b792017-08-18 19:21:50 -0400767// BN_mod_inverse sets |out| equal to |a|^-1, mod |n|. If |out| is NULL, a
768// fresh BIGNUM is allocated. It returns the result or NULL on error.
769//
770// If |n| is even then the operation is performed using an algorithm that avoids
771// some branches but which isn't constant-time. This function shouldn't be used
772// for secret values; use |BN_mod_inverse_blinded| instead. Or, if |n| is
773// guaranteed to be prime, use
774// |BN_mod_exp_mont_consttime(out, a, m_minus_2, m, ctx, m_mont)|, taking
775// advantage of Fermat's Little Theorem.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700776OPENSSL_EXPORT BIGNUM *BN_mod_inverse(BIGNUM *out, const BIGNUM *a,
777 const BIGNUM *n, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700778
David Benjamin4512b792017-08-18 19:21:50 -0400779// BN_mod_inverse_blinded sets |out| equal to |a|^-1, mod |n|, where |n| is the
780// Montgomery modulus for |mont|. |a| must be non-negative and must be less
781// than |n|. |n| must be greater than 1. |a| is blinded (masked by a random
782// value) to protect it against side-channel attacks. On failure, if the failure
783// was caused by |a| having no inverse mod |n| then |*out_no_inverse| will be
784// set to one; otherwise it will be set to zero.
Brian Smithec3cb3a2016-07-25 15:35:20 -1000785int BN_mod_inverse_blinded(BIGNUM *out, int *out_no_inverse, const BIGNUM *a,
786 const BN_MONT_CTX *mont, BN_CTX *ctx);
Adam Langley06fa67c2015-09-08 16:31:33 -0700787
David Benjamin4512b792017-08-18 19:21:50 -0400788// BN_mod_inverse_odd sets |out| equal to |a|^-1, mod |n|. |a| must be
789// non-negative and must be less than |n|. |n| must be odd. This function
790// shouldn't be used for secret values; use |BN_mod_inverse_blinded| instead.
791// Or, if |n| is guaranteed to be prime, use
792// |BN_mod_exp_mont_consttime(out, a, m_minus_2, m, ctx, m_mont)|, taking
793// advantage of Fermat's Little Theorem. It returns one on success or zero on
794// failure. On failure, if the failure was caused by |a| having no inverse mod
795// |n| then |*out_no_inverse| will be set to one; otherwise it will be set to
796// zero.
Brian Smitha4327572016-08-02 16:58:57 -1000797int BN_mod_inverse_odd(BIGNUM *out, int *out_no_inverse, const BIGNUM *a,
798 const BIGNUM *n, BN_CTX *ctx);
799
Adam Langley95c29f32014-06-20 12:00:00 -0700800
David Benjamin4512b792017-08-18 19:21:50 -0400801// Montgomery arithmetic.
Adam Langley95c29f32014-06-20 12:00:00 -0700802
David Benjamin4512b792017-08-18 19:21:50 -0400803// BN_MONT_CTX contains the precomputed values needed to work in a specific
804// Montgomery domain.
Adam Langley95c29f32014-06-20 12:00:00 -0700805
David Benjamin4512b792017-08-18 19:21:50 -0400806// BN_MONT_CTX_new returns a fresh BN_MONT_CTX or NULL on allocation failure.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700807OPENSSL_EXPORT BN_MONT_CTX *BN_MONT_CTX_new(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700808
David Benjamin4512b792017-08-18 19:21:50 -0400809// BN_MONT_CTX_free frees memory associated with |mont|.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700810OPENSSL_EXPORT void BN_MONT_CTX_free(BN_MONT_CTX *mont);
Adam Langley95c29f32014-06-20 12:00:00 -0700811
David Benjamin4512b792017-08-18 19:21:50 -0400812// BN_MONT_CTX_copy sets |to| equal to |from|. It returns |to| on success or
813// NULL on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700814OPENSSL_EXPORT BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,
David Benjamine82e6f62015-11-03 10:40:23 -0500815 const BN_MONT_CTX *from);
Adam Langley95c29f32014-06-20 12:00:00 -0700816
David Benjamin4512b792017-08-18 19:21:50 -0400817// BN_MONT_CTX_set sets up a Montgomery context given the modulus, |mod|. It
818// returns one on success and zero on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700819OPENSSL_EXPORT int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod,
820 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700821
David Benjamin4512b792017-08-18 19:21:50 -0400822// BN_MONT_CTX_set_locked takes |lock| and checks whether |*pmont| is NULL. If
823// so, it creates a new |BN_MONT_CTX| and sets the modulus for it to |mod|. It
824// then stores it as |*pmont|. It returns one on success and zero on error.
825//
826// If |*pmont| is already non-NULL then it does nothing and returns one.
Brian Smithd0357302016-03-25 10:11:04 -1000827int BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, CRYPTO_MUTEX *lock,
828 const BIGNUM *mod, BN_CTX *bn_ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700829
David Benjamin4512b792017-08-18 19:21:50 -0400830// BN_to_montgomery sets |ret| equal to |a| in the Montgomery domain. |a| is
831// assumed to be in the range [0, n), where |n| is the Montgomery modulus. It
832// returns one on success or zero on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700833OPENSSL_EXPORT int BN_to_montgomery(BIGNUM *ret, const BIGNUM *a,
834 const BN_MONT_CTX *mont, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700835
David Benjamin4512b792017-08-18 19:21:50 -0400836// BN_from_montgomery sets |ret| equal to |a| * R^-1, i.e. translates values out
837// of the Montgomery domain. |a| is assumed to be in the range [0, n), where |n|
838// is the Montgomery modulus. It returns one on success or zero on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700839OPENSSL_EXPORT int BN_from_montgomery(BIGNUM *ret, const BIGNUM *a,
840 const BN_MONT_CTX *mont, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700841
David Benjamin4512b792017-08-18 19:21:50 -0400842// BN_mod_mul_montgomery set |r| equal to |a| * |b|, in the Montgomery domain.
843// Both |a| and |b| must already be in the Montgomery domain (by
844// |BN_to_montgomery|). In particular, |a| and |b| are assumed to be in the
845// range [0, n), where |n| is the Montgomery modulus. It returns one on success
846// or zero on error.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700847OPENSSL_EXPORT int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a,
848 const BIGNUM *b,
849 const BN_MONT_CTX *mont, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700850
851
David Benjamin4512b792017-08-18 19:21:50 -0400852// Exponentiation.
Adam Langley95c29f32014-06-20 12:00:00 -0700853
David Benjamin4512b792017-08-18 19:21:50 -0400854// BN_exp sets |r| equal to |a|^{|p|}. It does so with a square-and-multiply
855// algorithm that leaks side-channel information. It returns one on success or
856// zero otherwise.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700857OPENSSL_EXPORT int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
858 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700859
David Benjamin4512b792017-08-18 19:21:50 -0400860// BN_mod_exp sets |r| equal to |a|^{|p|} mod |m|. It does so with the best
861// algorithm for the values provided. It returns one on success or zero
862// otherwise. The |BN_mod_exp_mont_consttime| variant must be used if the
863// exponent is secret.
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700864OPENSSL_EXPORT int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
865 const BIGNUM *m, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700866
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700867OPENSSL_EXPORT int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
868 const BIGNUM *m, BN_CTX *ctx,
David Benjamine82e6f62015-11-03 10:40:23 -0500869 const BN_MONT_CTX *mont);
Adam Langley95c29f32014-06-20 12:00:00 -0700870
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700871OPENSSL_EXPORT int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a,
872 const BIGNUM *p, const BIGNUM *m,
Adam Langleyefb42fb2015-11-02 17:39:02 -0800873 BN_CTX *ctx,
874 const BN_MONT_CTX *mont);
Adam Langley95c29f32014-06-20 12:00:00 -0700875
Adam Langley95c29f32014-06-20 12:00:00 -0700876
David Benjamin4512b792017-08-18 19:21:50 -0400877// Deprecated functions
Matt Braithwaite64887252015-08-11 17:17:28 -0700878
David Benjamin4512b792017-08-18 19:21:50 -0400879// BN_bn2mpi serialises the value of |in| to |out|, using a format that consists
880// of the number's length in bytes represented as a 4-byte big-endian number,
881// and the number itself in big-endian format, where the most significant bit
882// signals a negative number. (The representation of numbers with the MSB set is
883// prefixed with null byte). |out| must have sufficient space available; to
884// find the needed amount of space, call the function with |out| set to NULL.
Matt Braithwaite64887252015-08-11 17:17:28 -0700885OPENSSL_EXPORT size_t BN_bn2mpi(const BIGNUM *in, uint8_t *out);
886
David Benjamin4512b792017-08-18 19:21:50 -0400887// BN_mpi2bn parses |len| bytes from |in| and returns the resulting value. The
888// bytes at |in| are expected to be in the format emitted by |BN_bn2mpi|.
889//
890// If |out| is NULL then a fresh |BIGNUM| is allocated and returned, otherwise
891// |out| is reused and returned. On error, NULL is returned and the error queue
892// is updated.
Matt Braithwaite64887252015-08-11 17:17:28 -0700893OPENSSL_EXPORT BIGNUM *BN_mpi2bn(const uint8_t *in, size_t len, BIGNUM *out);
894
David Benjamin4512b792017-08-18 19:21:50 -0400895// BN_mod_exp_mont_word is like |BN_mod_exp_mont| except that the base |a| is
896// given as a |BN_ULONG| instead of a |BIGNUM *|. It returns one on success
897// or zero otherwise.
Brian Smithe31d1032016-04-21 17:08:13 -1000898OPENSSL_EXPORT int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
899 const BIGNUM *m, BN_CTX *ctx,
900 const BN_MONT_CTX *mont);
901
David Benjamin4512b792017-08-18 19:21:50 -0400902// BN_mod_exp2_mont calculates (a1^p1) * (a2^p2) mod m. It returns 1 on success
903// or zero otherwise.
Brian Smith448fa422016-04-21 17:08:29 -1000904OPENSSL_EXPORT int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1,
905 const BIGNUM *p1, const BIGNUM *a2,
906 const BIGNUM *p2, const BIGNUM *m,
907 BN_CTX *ctx, const BN_MONT_CTX *mont);
908
Matt Braithwaite64887252015-08-11 17:17:28 -0700909
David Benjamin4512b792017-08-18 19:21:50 -0400910// Private functions
Adam Langley95c29f32014-06-20 12:00:00 -0700911
912struct bignum_st {
913 BN_ULONG *d; /* Pointer to an array of 'BN_BITS2' bit chunks in little-endian
914 order. */
David Benjamin4512b792017-08-18 19:21:50 -0400915 int top; // Index of last used element in |d|, plus one.
916 int dmax; // Size of |d|, in words.
917 int neg; // one if the number is negative
918 int flags; // bitmask of BN_FLG_* values
Adam Langley95c29f32014-06-20 12:00:00 -0700919};
920
921struct bn_mont_ctx_st {
David Benjamin4512b792017-08-18 19:21:50 -0400922 BIGNUM RR; // used to convert to montgomery form
923 BIGNUM N; // The modulus
924 BN_ULONG n0[2]; // least significant words of (R*Ri-1)/N
Adam Langley95c29f32014-06-20 12:00:00 -0700925};
926
Adam Langley214cd442014-08-18 11:35:45 -0700927OPENSSL_EXPORT unsigned BN_num_bits_word(BN_ULONG l);
Adam Langley95c29f32014-06-20 12:00:00 -0700928
929#define BN_FLG_MALLOCED 0x01
930#define BN_FLG_STATIC_DATA 0x02
David Benjamin4512b792017-08-18 19:21:50 -0400931// |BN_FLG_CONSTTIME| has been removed and intentionally omitted so code relying
932// on it will not compile. Consumers outside BoringSSL should use the
933// higher-level cryptographic algorithms exposed by other modules. Consumers
934// within the library should call the appropriate timing-sensitive algorithm
935// directly.
Adam Langley95c29f32014-06-20 12:00:00 -0700936
937
938#if defined(__cplusplus)
David Benjamin4512b792017-08-18 19:21:50 -0400939} // extern C
Matt Braithwaited17d74d2016-08-17 20:10:28 -0700940
David Benjamin9f9f4ea2017-07-20 17:14:24 -0400941#if !defined(BORINGSSL_NO_CXX)
Matt Braithwaited17d74d2016-08-17 20:10:28 -0700942extern "C++" {
943
944namespace bssl {
945
Matt Braithwaited17d74d2016-08-17 20:10:28 -0700946BORINGSSL_MAKE_DELETER(BIGNUM, BN_free)
947BORINGSSL_MAKE_DELETER(BN_CTX, BN_CTX_free)
948BORINGSSL_MAKE_DELETER(BN_MONT_CTX, BN_MONT_CTX_free)
949
David Benjamin81a5df42017-07-12 17:08:45 -0400950class BN_CTXScope {
951 public:
952 BN_CTXScope(BN_CTX *ctx) : ctx_(ctx) { BN_CTX_start(ctx_); }
953 ~BN_CTXScope() { BN_CTX_end(ctx_); }
954
955 private:
956 BN_CTX *ctx_;
957
958 BN_CTXScope(BN_CTXScope &) = delete;
959 BN_CTXScope &operator=(BN_CTXScope &) = delete;
960};
961
Matt Braithwaited17d74d2016-08-17 20:10:28 -0700962} // namespace bssl
963
David Benjamin4512b792017-08-18 19:21:50 -0400964} // extern C++
David Benjamin81a5df42017-07-12 17:08:45 -0400965#endif
Matt Braithwaited17d74d2016-08-17 20:10:28 -0700966
Adam Langley95c29f32014-06-20 12:00:00 -0700967#endif
968
David Benjamin689be0f2015-02-11 15:55:26 -0500969#define BN_R_ARG2_LT_ARG3 100
970#define BN_R_BAD_RECIPROCAL 101
971#define BN_R_BIGNUM_TOO_LONG 102
972#define BN_R_BITS_TOO_SMALL 103
973#define BN_R_CALLED_WITH_EVEN_MODULUS 104
974#define BN_R_DIV_BY_ZERO 105
975#define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA 106
976#define BN_R_INPUT_NOT_REDUCED 107
977#define BN_R_INVALID_RANGE 108
978#define BN_R_NEGATIVE_NUMBER 109
979#define BN_R_NOT_A_SQUARE 110
980#define BN_R_NOT_INITIALIZED 111
981#define BN_R_NO_INVERSE 112
982#define BN_R_PRIVATE_KEY_TOO_LARGE 113
983#define BN_R_P_IS_NOT_PRIME 114
984#define BN_R_TOO_MANY_ITERATIONS 115
985#define BN_R_TOO_MANY_TEMPORARY_VARIABLES 116
David Benjaminb9c579d2015-06-11 22:52:07 -0400986#define BN_R_BAD_ENCODING 117
987#define BN_R_ENCODE_ERROR 118
Steven Valdez8ebc9ea2017-04-21 15:29:45 -0400988#define BN_R_INVALID_INPUT 119
Adam Langley95c29f32014-06-20 12:00:00 -0700989
David Benjamin4512b792017-08-18 19:21:50 -0400990#endif // OPENSSL_HEADER_BN_H