blob: 77f61963e11d3a028cac7f56b65cf1cdb2ee4b75 [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
Matt Braithwaitee7b32c32015-04-30 13:02:30 -0700129#include <inttypes.h> /* for PRIu64 and friends */
Adam Langley95c29f32014-06-20 12:00:00 -0700130#include <stdio.h> /* for FILE* */
131
132#if defined(__cplusplus)
133extern "C" {
134#endif
135
136
David Benjamin1d6eeb32017-01-08 05:15:58 -0500137/* BN provides support for working with arbitrary sized integers. For example,
Adam Langley95c29f32014-06-20 12:00:00 -0700138 * 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. */
140
141
David Benjaminc561aa62015-05-09 01:38:06 -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
167/* Allocation and freeing. */
168
169/* 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
172/* 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
175/* 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
179/* 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
183/* 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 Benjamin1c703cb2015-06-11 21:42:14 -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
191/* 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
194/* 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
198/* Basic functions. */
199
200/* 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
204/* 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
208/* 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
211/* 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
215/* 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 Benjamin40a63112016-08-23 20:53:12 -0700219/* BN_set_u64 sets |bn| to |value|. It returns one on success or zero on
220 * allocation failure. */
221OPENSSL_EXPORT int BN_set_u64(BIGNUM *bn, uint64_t value);
222
Adam Langley95c29f32014-06-20 12:00:00 -0700223/* 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
226/* 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
230/* Conversion functions. */
231
232/* 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
238/* 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
Rob Sloan45573cc2016-12-07 20:53:22 -0800243/* 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. */
247OPENSSL_EXPORT BIGNUM *BN_le2bn(const uint8_t *in, size_t len, BIGNUM *ret);
248
249/* 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. */
253OPENSSL_EXPORT int BN_bn2le_padded(uint8_t *out, size_t len, const BIGNUM *in);
254
Adam Langley6887edb2014-06-20 12:00:00 -0700255/* 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 Benjaminae0eaaa2015-12-17 02:01:25 -0500261/* BN_bn2cbb_padded behaves like |BN_bn2bin_padded| but writes to a |CBB|. */
262OPENSSL_EXPORT int BN_bn2cbb_padded(CBB *out, size_t len, const BIGNUM *in);
263
Adam Langley95c29f32014-06-20 12:00:00 -0700264/* 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
269/* 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
277/* 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
282/* 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
290/* 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
296/* 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
300/* 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
303/* 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
Rob Sloan2ee1edf2016-12-15 16:28:44 -0800308/* 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. */
311OPENSSL_EXPORT int BN_get_u64(const BIGNUM *bn, uint64_t *out);
312
Adam Langley95c29f32014-06-20 12:00:00 -0700313
David Benjaminb9c579d2015-06-11 22:52:07 -0400314/* ASN.1 functions. */
315
David Benjaminacb24512015-12-22 15:02:01 -0500316/* 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. */
318OPENSSL_EXPORT int BN_parse_asn1_unsigned(CBS *cbs, BIGNUM *ret);
David Benjaminb9c579d2015-06-11 22:52:07 -0400319
David Benjaminacb24512015-12-22 15:02:01 -0500320/* BN_parse_asn1_unsigned_buggy acts like |BN_parse_asn1_unsigned| but tolerates
321 * some invalid encodings. Do not use this function. */
322OPENSSL_EXPORT int BN_parse_asn1_unsigned_buggy(CBS *cbs, BIGNUM *ret);
David Benjamin231cb822015-09-15 16:47:35 -0400323
David Benjaminacb24512015-12-22 15:02:01 -0500324/* 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. */
326OPENSSL_EXPORT int BN_marshal_asn1(CBB *cbb, const BIGNUM *bn);
David Benjaminb9c579d2015-06-11 22:52:07 -0400327
328
Adam Langleyb8b54782014-08-13 10:31:52 -0700329/* Internal functions.
330 *
331 * These functions are useful for code that is doing low-level manipulations of
332 * BIGNUM values. However, be sure that no other function in this file does
333 * what you want before turning to these. */
334
335/* bn_correct_top decrements |bn->top| until |bn->d[top-1]| is non-zero or
David Benjamin899b9b12016-08-02 13:09:19 -0400336 * until |top| is zero. If |bn| is zero, |bn->neg| is set to zero. */
Adam Langleyb8b54782014-08-13 10:31:52 -0700337OPENSSL_EXPORT void bn_correct_top(BIGNUM *bn);
338
339/* bn_wexpand ensures that |bn| has at least |words| works of space without
David Benjamin4c4ff022016-08-23 10:09:04 -0700340 * altering its value. It returns |bn| on success or NULL on allocation
Adam Langleyb8b54782014-08-13 10:31:52 -0700341 * failure. */
David Benjamin719220e2015-08-11 12:05:02 -0400342OPENSSL_EXPORT BIGNUM *bn_wexpand(BIGNUM *bn, size_t words);
Adam Langleyb8b54782014-08-13 10:31:52 -0700343
344
Adam Langley95c29f32014-06-20 12:00:00 -0700345/* BIGNUM pools.
346 *
347 * Certain BIGNUM operations need to use many temporary variables and
David Benjamin1d6eeb32017-01-08 05:15:58 -0500348 * allocating and freeing them can be quite slow. Thus such operations typically
Adam Langley95c29f32014-06-20 12:00:00 -0700349 * take a |BN_CTX| parameter, which contains a pool of |BIGNUMs|. The |ctx|
350 * argument to a public function may be NULL, in which case a local |BN_CTX|
351 * will be created just for the lifetime of that call.
352 *
353 * A function must call |BN_CTX_start| first. Then, |BN_CTX_get| may be called
354 * repeatedly to obtain temporary |BIGNUM|s. All |BN_CTX_get| calls must be made
355 * before calling any other functions that use the |ctx| as an argument.
356 *
357 * Finally, |BN_CTX_end| must be called before returning from the function.
358 * When |BN_CTX_end| is called, the |BIGNUM| pointers obtained from
359 * |BN_CTX_get| become invalid. */
360
361/* BN_CTX_new returns a new, empty BN_CTX or NULL on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700362OPENSSL_EXPORT BN_CTX *BN_CTX_new(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700363
364/* BN_CTX_free frees all BIGNUMs contained in |ctx| and then frees |ctx|
365 * itself. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700366OPENSSL_EXPORT void BN_CTX_free(BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700367
368/* BN_CTX_start "pushes" a new entry onto the |ctx| stack and allows future
369 * calls to |BN_CTX_get|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700370OPENSSL_EXPORT void BN_CTX_start(BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700371
372/* BN_CTX_get returns a new |BIGNUM|, or NULL on allocation failure. Once
373 * |BN_CTX_get| has returned NULL, all future calls will also return NULL until
374 * |BN_CTX_end| is called. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700375OPENSSL_EXPORT BIGNUM *BN_CTX_get(BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700376
377/* BN_CTX_end invalidates all |BIGNUM|s returned from |BN_CTX_get| since the
378 * matching |BN_CTX_start| call. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700379OPENSSL_EXPORT void BN_CTX_end(BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700380
381
382/* Simple arithmetic */
383
384/* BN_add sets |r| = |a| + |b|, where |r| may be the same pointer as either |a|
385 * or |b|. It returns one on success and zero on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700386OPENSSL_EXPORT int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700387
388/* BN_uadd sets |r| = |a| + |b|, where |a| and |b| are non-negative and |r| may
389 * be the same pointer as either |a| or |b|. It returns one on success and zero
390 * on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700391OPENSSL_EXPORT int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700392
393/* BN_add_word adds |w| to |a|. It returns one on success and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700394OPENSSL_EXPORT int BN_add_word(BIGNUM *a, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700395
Brian Smithe4bf8b32016-07-01 13:36:06 -1000396/* BN_sub sets |r| = |a| - |b|, where |r| may be the same pointer as either |a|
397 * or |b|. It returns one on success and zero on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700398OPENSSL_EXPORT int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700399
David Benjamin25c93ff2014-08-27 12:09:26 -0400400/* BN_usub sets |r| = |a| - |b|, where |a| and |b| are non-negative integers,
Brian Smith3d4030b2016-07-01 14:12:40 -1000401 * |b| < |a| and |r| may be the same pointer as either |a| or |b|. It returns
Adam Langley95c29f32014-06-20 12:00:00 -0700402 * one on success and zero on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700403OPENSSL_EXPORT int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700404
405/* BN_sub_word subtracts |w| from |a|. It returns one on success and zero on
406 * allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700407OPENSSL_EXPORT int BN_sub_word(BIGNUM *a, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700408
409/* BN_mul sets |r| = |a| * |b|, where |r| may be the same pointer as |a| or
410 * |b|. Returns one on success and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700411OPENSSL_EXPORT int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
412 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700413
414/* BN_mul_word sets |bn| = |bn| * |w|. It returns one on success or zero on
415 * allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700416OPENSSL_EXPORT int BN_mul_word(BIGNUM *bn, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700417
418/* BN_sqr sets |r| = |a|^2 (i.e. squares), where |r| may be the same pointer as
419 * |a|. Returns one on success and zero otherwise. This is more efficient than
420 * BN_mul(r, a, a, ctx). */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700421OPENSSL_EXPORT int BN_sqr(BIGNUM *r, const BIGNUM *a, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700422
423/* BN_div divides |numerator| by |divisor| and places the result in |quotient|
424 * and the remainder in |rem|. Either of |quotient| or |rem| may be NULL, in
425 * which case the respective value is not returned. The result is rounded
426 * towards zero; thus if |numerator| is negative, the remainder will be zero or
427 * negative. It returns one on success or zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700428OPENSSL_EXPORT int BN_div(BIGNUM *quotient, BIGNUM *rem,
429 const BIGNUM *numerator, const BIGNUM *divisor,
430 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700431
432/* BN_div_word sets |numerator| = |numerator|/|divisor| and returns the
433 * remainder or (BN_ULONG)-1 on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700434OPENSSL_EXPORT BN_ULONG BN_div_word(BIGNUM *numerator, BN_ULONG divisor);
Adam Langley95c29f32014-06-20 12:00:00 -0700435
Adam Langley409766d2014-06-20 12:00:00 -0700436/* BN_sqrt sets |*out_sqrt| (which may be the same |BIGNUM| as |in|) to the
437 * square root of |in|, using |ctx|. It returns one on success or zero on
438 * error. Negative numbers and non-square numbers will result in an error with
439 * appropriate errors on the error queue. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700440OPENSSL_EXPORT int BN_sqrt(BIGNUM *out_sqrt, const BIGNUM *in, BN_CTX *ctx);
Adam Langley409766d2014-06-20 12:00:00 -0700441
Adam Langley95c29f32014-06-20 12:00:00 -0700442
443/* Comparison functions */
444
445/* BN_cmp returns a value less than, equal to or greater than zero if |a| is
446 * less than, equal to or greater than |b|, respectively. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700447OPENSSL_EXPORT int BN_cmp(const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700448
Brian Smith4edca0b2016-07-25 10:36:58 -1000449/* BN_cmp_word is like |BN_cmp| except it takes its second argument as a
450 * |BN_ULONG| instead of a |BIGNUM|. */
David Benjaminccd511e2016-07-29 12:11:34 -0400451OPENSSL_EXPORT int BN_cmp_word(const BIGNUM *a, BN_ULONG b);
Brian Smith4edca0b2016-07-25 10:36:58 -1000452
Adam Langley95c29f32014-06-20 12:00:00 -0700453/* BN_ucmp returns a value less than, equal to or greater than zero if the
454 * absolute value of |a| is less than, equal to or greater than the absolute
455 * value of |b|, respectively. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700456OPENSSL_EXPORT int BN_ucmp(const BIGNUM *a, const BIGNUM *b);
Adam Langley95c29f32014-06-20 12:00:00 -0700457
Brian Smith86080c32016-03-25 12:23:16 -1000458/* BN_equal_consttime returns one if |a| is equal to |b|, and zero otherwise.
459 * It takes an amount of time dependent on the sizes of |a| and |b|, but
460 * independent of the contents (including the signs) of |a| and |b|. */
461OPENSSL_EXPORT int BN_equal_consttime(const BIGNUM *a, const BIGNUM *b);
462
Adam Langley95c29f32014-06-20 12:00:00 -0700463/* BN_abs_is_word returns one if the absolute value of |bn| equals |w| and zero
464 * otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700465OPENSSL_EXPORT int BN_abs_is_word(const BIGNUM *bn, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700466
467/* BN_is_zero returns one if |bn| is zero and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700468OPENSSL_EXPORT int BN_is_zero(const BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700469
470/* BN_is_one returns one if |bn| equals one and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700471OPENSSL_EXPORT int BN_is_one(const BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700472
473/* BN_is_word returns one if |bn| is exactly |w| and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700474OPENSSL_EXPORT int BN_is_word(const BIGNUM *bn, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700475
476/* BN_is_odd returns one if |bn| is odd and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700477OPENSSL_EXPORT int BN_is_odd(const BIGNUM *bn);
Adam Langley95c29f32014-06-20 12:00:00 -0700478
479
480/* Bitwise operations. */
481
482/* BN_lshift sets |r| equal to |a| << n. The |a| and |r| arguments may be the
483 * same |BIGNUM|. It returns one on success and zero on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700484OPENSSL_EXPORT int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700485
486/* BN_lshift1 sets |r| equal to |a| << 1, where |r| and |a| may be the same
487 * pointer. It returns one on success and zero on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700488OPENSSL_EXPORT int BN_lshift1(BIGNUM *r, const BIGNUM *a);
Adam Langley95c29f32014-06-20 12:00:00 -0700489
490/* BN_rshift sets |r| equal to |a| >> n, where |r| and |a| may be the same
491 * pointer. It returns one on success and zero on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700492OPENSSL_EXPORT int BN_rshift(BIGNUM *r, const BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700493
494/* BN_rshift1 sets |r| equal to |a| >> 1, where |r| and |a| may be the same
495 * pointer. It returns one on success and zero on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700496OPENSSL_EXPORT int BN_rshift1(BIGNUM *r, const BIGNUM *a);
Adam Langley95c29f32014-06-20 12:00:00 -0700497
498/* BN_set_bit sets the |n|th, least-significant bit in |a|. For example, if |a|
499 * is 2 then setting bit zero will make it 3. It returns one on success or zero
500 * on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700501OPENSSL_EXPORT int BN_set_bit(BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700502
503/* BN_clear_bit clears the |n|th, least-significant bit in |a|. For example, if
504 * |a| is 3, clearing bit zero will make it two. It returns one on success or
505 * zero on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700506OPENSSL_EXPORT int BN_clear_bit(BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700507
508/* BN_is_bit_set returns the value of the |n|th, least-significant bit in |a|,
509 * or zero if the bit doesn't exist. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700510OPENSSL_EXPORT int BN_is_bit_set(const BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700511
512/* BN_mask_bits truncates |a| so that it is only |n| bits long. It returns one
513 * on success or zero if |n| is greater than the length of |a| already. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700514OPENSSL_EXPORT int BN_mask_bits(BIGNUM *a, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700515
516
517/* Modulo arithmetic. */
518
David Benjamin44bedc32016-06-23 16:05:02 -0400519/* BN_mod_word returns |a| mod |w| or (BN_ULONG)-1 on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700520OPENSSL_EXPORT BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
Adam Langley95c29f32014-06-20 12:00:00 -0700521
522/* BN_mod is a helper macro that calls |BN_div| and discards the quotient. */
523#define BN_mod(rem, numerator, divisor, ctx) \
524 BN_div(NULL, (rem), (numerator), (divisor), (ctx))
525
526/* BN_nnmod is a non-negative modulo function. It acts like |BN_mod|, but 0 <=
David Benjamina5974bf2015-03-25 23:49:37 -0400527 * |rem| < |divisor| is always true. It returns one on success and zero on
528 * error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700529OPENSSL_EXPORT int BN_nnmod(BIGNUM *rem, const BIGNUM *numerator,
530 const BIGNUM *divisor, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700531
532/* BN_mod_add sets |r| = |a| + |b| mod |m|. It returns one on success and zero
533 * on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700534OPENSSL_EXPORT int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
535 const BIGNUM *m, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700536
537/* BN_mod_add_quick acts like |BN_mod_add| but requires that |a| and |b| be
538 * non-negative and less than |m|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700539OPENSSL_EXPORT int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
540 const BIGNUM *m);
Adam Langley95c29f32014-06-20 12:00:00 -0700541
542/* BN_mod_sub sets |r| = |a| - |b| mod |m|. It returns one on success and zero
543 * on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700544OPENSSL_EXPORT int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
545 const BIGNUM *m, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700546
547/* BN_mod_sub_quick acts like |BN_mod_sub| but requires that |a| and |b| be
548 * non-negative and less than |m|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700549OPENSSL_EXPORT int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
550 const BIGNUM *m);
Adam Langley95c29f32014-06-20 12:00:00 -0700551
552/* BN_mod_mul sets |r| = |a|*|b| mod |m|. It returns one on success and zero
553 * on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700554OPENSSL_EXPORT int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
555 const BIGNUM *m, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700556
Adam Langley5f889992015-11-04 14:05:00 -0800557/* BN_mod_sqr sets |r| = |a|^2 mod |m|. It returns one on success and zero
Adam Langley95c29f32014-06-20 12:00:00 -0700558 * on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700559OPENSSL_EXPORT int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m,
560 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700561
562/* BN_mod_lshift sets |r| = (|a| << n) mod |m|, where |r| and |a| may be the
563 * same pointer. It returns one on success and zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700564OPENSSL_EXPORT int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n,
565 const BIGNUM *m, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700566
567/* BN_mod_lshift_quick acts like |BN_mod_lshift| but requires that |a| be
568 * non-negative and less than |m|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700569OPENSSL_EXPORT int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n,
570 const BIGNUM *m);
Adam Langley95c29f32014-06-20 12:00:00 -0700571
572/* BN_mod_lshift1 sets |r| = (|a| << 1) mod |m|, where |r| and |a| may be the
573 * same pointer. It returns one on success and zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700574OPENSSL_EXPORT int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m,
575 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700576
577/* BN_mod_lshift1_quick acts like |BN_mod_lshift1| but requires that |a| be
578 * non-negative and less than |m|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700579OPENSSL_EXPORT int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a,
580 const BIGNUM *m);
Adam Langley95c29f32014-06-20 12:00:00 -0700581
David Benjaminbd691752016-11-25 15:10:17 -0500582/* BN_mod_sqrt returns a newly-allocated |BIGNUM|, r, such that
583 * r^2 == a (mod p). |p| must be a prime. It returns NULL on error or if |a| is
584 * not a square mod |p|. In the latter case, it will add |BN_R_NOT_A_SQUARE| to
585 * the error queue. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700586OPENSSL_EXPORT BIGNUM *BN_mod_sqrt(BIGNUM *in, const BIGNUM *a, const BIGNUM *p,
587 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700588
589
590/* Random and prime number generation. */
591
David Benjamind224d522016-08-16 10:03:45 -0400592/* The following are values for the |top| parameter of |BN_rand|. */
David Benjamin1e5ac5d2016-11-01 16:37:09 -0400593#define BN_RAND_TOP_ANY (-1)
David Benjamind224d522016-08-16 10:03:45 -0400594#define BN_RAND_TOP_ONE 0
595#define BN_RAND_TOP_TWO 1
596
597/* The following are values for the |bottom| parameter of |BN_rand|. */
598#define BN_RAND_BOTTOM_ANY 0
599#define BN_RAND_BOTTOM_ODD 1
600
601/* BN_rand sets |rnd| to a random number of length |bits|. It returns one on
602 * success and zero otherwise.
Adam Langley95c29f32014-06-20 12:00:00 -0700603 *
David Benjamind224d522016-08-16 10:03:45 -0400604 * |top| must be one of the |BN_RAND_TOP_*| values. If |BN_RAND_TOP_ONE|, the
605 * most-significant bit, if any, will be set. If |BN_RAND_TOP_TWO|, the two
606 * most significant bits, if any, will be set. If |BN_RAND_TOP_ANY|, no extra
607 * action will be taken and |BN_num_bits(rnd)| may not equal |bits| if the most
608 * significant bits randomly ended up as zeros.
Adam Langley95c29f32014-06-20 12:00:00 -0700609 *
David Benjamind224d522016-08-16 10:03:45 -0400610 * |bottom| must be one of the |BN_RAND_BOTTOM_*| values. If
611 * |BN_RAND_BOTTOM_ODD|, the least-significant bit, if any, will be set. If
612 * |BN_RAND_BOTTOM_ANY|, no extra action will be taken. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700613OPENSSL_EXPORT int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
Adam Langley95c29f32014-06-20 12:00:00 -0700614
615/* BN_pseudo_rand is an alias for |BN_rand|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700616OPENSSL_EXPORT int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
Adam Langley95c29f32014-06-20 12:00:00 -0700617
Brian Smith4edca0b2016-07-25 10:36:58 -1000618/* BN_rand_range is equivalent to |BN_rand_range_ex| with |min_inclusive| set
619 * to zero and |max_exclusive| set to |range|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700620OPENSSL_EXPORT int BN_rand_range(BIGNUM *rnd, const BIGNUM *range);
Adam Langley95c29f32014-06-20 12:00:00 -0700621
Brian Smith4edca0b2016-07-25 10:36:58 -1000622/* BN_rand_range_ex sets |rnd| to a random value in
623 * [min_inclusive..max_exclusive). It returns one on success and zero
624 * otherwise. */
625OPENSSL_EXPORT int BN_rand_range_ex(BIGNUM *r, BN_ULONG min_inclusive,
626 const BIGNUM *max_exclusive);
627
Adam Langley95c29f32014-06-20 12:00:00 -0700628/* BN_pseudo_rand_range is an alias for BN_rand_range. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700629OPENSSL_EXPORT int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range);
Adam Langley95c29f32014-06-20 12:00:00 -0700630
Adam Langleyd4b4f082014-06-20 12:00:00 -0700631/* BN_generate_dsa_nonce generates a random number 0 <= out < range. Unlike
632 * BN_rand_range, it also includes the contents of |priv| and |message| in the
633 * generation so that an RNG failure isn't fatal as long as |priv| remains
634 * secret. This is intended for use in DSA and ECDSA where an RNG weakness
635 * leads directly to private key exposure unless this function is used.
636 * It returns one on success and zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700637OPENSSL_EXPORT int BN_generate_dsa_nonce(BIGNUM *out, const BIGNUM *range,
638 const BIGNUM *priv,
639 const uint8_t *message,
640 size_t message_len, BN_CTX *ctx);
Adam Langleyd4b4f082014-06-20 12:00:00 -0700641
Adam Langley95c29f32014-06-20 12:00:00 -0700642/* BN_GENCB holds a callback function that is used by generation functions that
643 * can take a very long time to complete. Use |BN_GENCB_set| to initialise a
644 * |BN_GENCB| structure.
645 *
646 * The callback receives the address of that |BN_GENCB| structure as its last
David Benjamin1d6eeb32017-01-08 05:15:58 -0500647 * argument and the user is free to put an arbitrary pointer in |arg|. The other
Adam Langley95c29f32014-06-20 12:00:00 -0700648 * arguments are set as follows:
649 * event=BN_GENCB_GENERATED, n=i: after generating the i'th possible prime
650 * number.
651 * event=BN_GENCB_PRIME_TEST, n=-1: when finished trial division primality
652 * checks.
653 * event=BN_GENCB_PRIME_TEST, n=i: when the i'th primality test has finished.
654 *
655 * The callback can return zero to abort the generation progress or one to
656 * allow it to continue.
657 *
658 * When other code needs to call a BN generation function it will often take a
659 * BN_GENCB argument and may call the function with other argument values. */
660#define BN_GENCB_GENERATED 0
661#define BN_GENCB_PRIME_TEST 1
662
663struct bn_gencb_st {
664 void *arg; /* callback-specific data */
665 int (*callback)(int event, int n, struct bn_gencb_st *);
666};
667
668/* BN_GENCB_set configures |callback| to call |f| and sets |callout->arg| to
669 * |arg|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700670OPENSSL_EXPORT void BN_GENCB_set(BN_GENCB *callback,
671 int (*f)(int event, int n,
672 struct bn_gencb_st *),
673 void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -0700674
675/* BN_GENCB_call calls |callback|, if not NULL, and returns the return value of
676 * the callback, or 1 if |callback| is NULL. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700677OPENSSL_EXPORT int BN_GENCB_call(BN_GENCB *callback, int event, int n);
Adam Langley95c29f32014-06-20 12:00:00 -0700678
679/* BN_generate_prime_ex sets |ret| to a prime number of |bits| length. If safe
680 * is non-zero then the prime will be such that (ret-1)/2 is also a prime.
681 * (This is needed for Diffie-Hellman groups to ensure that the only subgroups
682 * are of size 2 and (p-1)/2.).
683 *
684 * If |add| is not NULL, the prime will fulfill the condition |ret| % |add| ==
685 * |rem| in order to suit a given generator. (If |rem| is NULL then |ret| %
686 * |add| == 1.)
687 *
688 * If |cb| is not NULL, it will be called during processing to give an
689 * indication of progress. See the comments for |BN_GENCB|. It returns one on
690 * success and zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700691OPENSSL_EXPORT int BN_generate_prime_ex(BIGNUM *ret, int bits, int safe,
692 const BIGNUM *add, const BIGNUM *rem,
693 BN_GENCB *cb);
Adam Langley95c29f32014-06-20 12:00:00 -0700694
695/* BN_prime_checks is magic value that can be used as the |checks| argument to
696 * the primality testing functions in order to automatically select a number of
697 * Miller-Rabin checks that gives a false positive rate of ~2^{-80}. */
698#define BN_prime_checks 0
699
700/* BN_primality_test sets |*is_probably_prime| to one if |candidate| is
701 * probably a prime number by the Miller-Rabin test or zero if it's certainly
702 * not.
703 *
704 * If |do_trial_division| is non-zero then |candidate| will be tested against a
705 * list of small primes before Miller-Rabin tests. The probability of this
706 * function returning a false positive is 2^{2*checks}. If |checks| is
707 * |BN_prime_checks| then a value that results in approximately 2^{-80} false
708 * positive probability is used. If |cb| is not NULL then it is called during
709 * the checking process. See the comment above |BN_GENCB|.
710 *
711 * The function returns one on success and zero on error.
712 *
713 * (If you are unsure whether you want |do_trial_division|, don't set it.) */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700714OPENSSL_EXPORT int BN_primality_test(int *is_probably_prime,
715 const BIGNUM *candidate, int checks,
716 BN_CTX *ctx, int do_trial_division,
717 BN_GENCB *cb);
Adam Langley95c29f32014-06-20 12:00:00 -0700718
719/* BN_is_prime_fasttest_ex returns one if |candidate| is probably a prime
720 * number by the Miller-Rabin test, zero if it's certainly not and -1 on error.
721 *
722 * If |do_trial_division| is non-zero then |candidate| will be tested against a
723 * list of small primes before Miller-Rabin tests. The probability of this
724 * function returning one when |candidate| is composite is 2^{2*checks}. If
725 * |checks| is |BN_prime_checks| then a value that results in approximately
726 * 2^{-80} false positive probability is used. If |cb| is not NULL then it is
727 * called during the checking process. See the comment above |BN_GENCB|.
728 *
729 * WARNING: deprecated. Use |BN_primality_test|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700730OPENSSL_EXPORT int BN_is_prime_fasttest_ex(const BIGNUM *candidate, int checks,
731 BN_CTX *ctx, int do_trial_division,
732 BN_GENCB *cb);
Adam Langley95c29f32014-06-20 12:00:00 -0700733
734/* BN_is_prime_ex acts the same as |BN_is_prime_fasttest_ex| with
735 * |do_trial_division| set to zero.
736 *
737 * WARNING: deprecated: Use |BN_primality_test|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700738OPENSSL_EXPORT int BN_is_prime_ex(const BIGNUM *candidate, int checks,
739 BN_CTX *ctx, BN_GENCB *cb);
Adam Langley95c29f32014-06-20 12:00:00 -0700740
741
742/* Number theory functions */
743
744/* BN_gcd sets |r| = gcd(|a|, |b|). It returns one on success and zero
745 * otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700746OPENSSL_EXPORT int BN_gcd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
747 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700748
Brian Smithec3cb3a2016-07-25 15:35:20 -1000749/* BN_mod_inverse sets |out| equal to |a|^-1, mod |n|. If |out| is NULL, a
750 * fresh BIGNUM is allocated. It returns the result or NULL on error.
751 *
David Benjamin0a211df2016-12-17 15:25:55 -0500752 * If |n| is even then the operation is performed using an algorithm that avoids
753 * some branches but which isn't constant-time. This function shouldn't be used
754 * for secret values; use |BN_mod_inverse_blinded| instead. Or, if |n| is
755 * guaranteed to be prime, use
Brian Smithec3cb3a2016-07-25 15:35:20 -1000756 * |BN_mod_exp_mont_consttime(out, a, m_minus_2, m, ctx, m_mont)|, taking
757 * advantage of Fermat's Little Theorem. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700758OPENSSL_EXPORT BIGNUM *BN_mod_inverse(BIGNUM *out, const BIGNUM *a,
759 const BIGNUM *n, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700760
Brian Smithec3cb3a2016-07-25 15:35:20 -1000761/* BN_mod_inverse_blinded sets |out| equal to |a|^-1, mod |n|, where |n| is the
762 * Montgomery modulus for |mont|. |a| must be non-negative and must be less
763 * than |n|. |n| must be greater than 1. |a| is blinded (masked by a random
David Benjamin0a211df2016-12-17 15:25:55 -0500764 * value) to protect it against side-channel attacks. On failure, if the failure
765 * was caused by |a| having no inverse mod |n| then |*out_no_inverse| will be
766 * set to one; otherwise it will be set to zero. */
Brian Smithec3cb3a2016-07-25 15:35:20 -1000767int BN_mod_inverse_blinded(BIGNUM *out, int *out_no_inverse, const BIGNUM *a,
768 const BN_MONT_CTX *mont, BN_CTX *ctx);
Adam Langley06fa67c2015-09-08 16:31:33 -0700769
Brian Smitha4327572016-08-02 16:58:57 -1000770/* BN_mod_inverse_odd sets |out| equal to |a|^-1, mod |n|. |a| must be
771 * non-negative and must be less than |n|. |n| must be odd. This function
772 * shouldn't be used for secret values; use |BN_mod_inverse_blinded| instead.
773 * Or, if |n| is 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. It returns one on success or zero on
776 * failure. On failure, if the failure was caused by |a| having no inverse mod
777 * |n| then |*out_no_inverse| will be set to one; otherwise it will be set to
778 * zero. */
779int BN_mod_inverse_odd(BIGNUM *out, int *out_no_inverse, const BIGNUM *a,
780 const BIGNUM *n, BN_CTX *ctx);
781
Adam Langley95c29f32014-06-20 12:00:00 -0700782/* BN_kronecker returns the Kronecker symbol of |a| and |b| (which is -1, 0 or
783 * 1), or -2 on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700784OPENSSL_EXPORT int BN_kronecker(const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700785
786
787/* Montgomery arithmetic. */
788
789/* BN_MONT_CTX contains the precomputed values needed to work in a specific
790 * Montgomery domain. */
791
792/* BN_MONT_CTX_new returns a fresh BN_MONT_CTX or NULL on allocation failure. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700793OPENSSL_EXPORT BN_MONT_CTX *BN_MONT_CTX_new(void);
Adam Langley95c29f32014-06-20 12:00:00 -0700794
David Benjamin12f77372015-10-26 11:31:51 -0400795/* BN_MONT_CTX_free frees memory associated with |mont|. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700796OPENSSL_EXPORT void BN_MONT_CTX_free(BN_MONT_CTX *mont);
Adam Langley95c29f32014-06-20 12:00:00 -0700797
798/* BN_MONT_CTX_copy sets |to| equal to |from|. It returns |to| on success or
799 * NULL on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700800OPENSSL_EXPORT BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,
David Benjamine82e6f62015-11-03 10:40:23 -0500801 const BN_MONT_CTX *from);
Adam Langley95c29f32014-06-20 12:00:00 -0700802
803/* BN_MONT_CTX_set sets up a Montgomery context given the modulus, |mod|. It
804 * returns one on success and zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700805OPENSSL_EXPORT int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *mod,
806 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700807
Adam Langley683d7bd2015-04-13 11:04:14 -0700808/* BN_MONT_CTX_set_locked takes |lock| and checks whether |*pmont| is NULL. If
809 * so, it creates a new |BN_MONT_CTX| and sets the modulus for it to |mod|. It
Brian Smithd0357302016-03-25 10:11:04 -1000810 * then stores it as |*pmont|. It returns one on success and zero on error.
Adam Langley95c29f32014-06-20 12:00:00 -0700811 *
Brian Smithd0357302016-03-25 10:11:04 -1000812 * If |*pmont| is already non-NULL then it does nothing and returns one. */
813int BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, CRYPTO_MUTEX *lock,
814 const BIGNUM *mod, BN_CTX *bn_ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700815
Brian Smith78f84f42016-07-30 21:17:10 -1000816/* BN_to_montgomery sets |ret| equal to |a| in the Montgomery domain. |a| is
817 * assumed to be in the range [0, n), where |n| is the Montgomery modulus. It
818 * returns one on success or zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700819OPENSSL_EXPORT int BN_to_montgomery(BIGNUM *ret, const BIGNUM *a,
820 const BN_MONT_CTX *mont, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700821
Brian Smith78f84f42016-07-30 21:17:10 -1000822/* BN_from_montgomery sets |ret| equal to |a| * R^-1, i.e. translates values out
823 * of the Montgomery domain. |a| is assumed to be in the range [0, n), where |n|
824 * is the Montgomery modulus. It returns one on success or zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700825OPENSSL_EXPORT int BN_from_montgomery(BIGNUM *ret, const BIGNUM *a,
826 const BN_MONT_CTX *mont, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700827
828/* BN_mod_mul_montgomery set |r| equal to |a| * |b|, in the Montgomery domain.
829 * Both |a| and |b| must already be in the Montgomery domain (by
Brian Smith78f84f42016-07-30 21:17:10 -1000830 * |BN_to_montgomery|). In particular, |a| and |b| are assumed to be in the
831 * range [0, n), where |n| is the Montgomery modulus. It returns one on success
832 * or zero on error. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700833OPENSSL_EXPORT int BN_mod_mul_montgomery(BIGNUM *r, const BIGNUM *a,
834 const BIGNUM *b,
835 const BN_MONT_CTX *mont, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700836
837
838/* Exponentiation. */
839
840/* BN_exp sets |r| equal to |a|^{|p|}. It does so with a square-and-multiply
841 * algorithm that leaks side-channel information. It returns one on success or
842 * zero otherwise. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700843OPENSSL_EXPORT int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
844 BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700845
Adam Langley5d17dd62014-06-30 14:22:32 -0700846/* BN_mod_exp sets |r| equal to |a|^{|p|} mod |m|. It does so with the best
David Benjamin0a211df2016-12-17 15:25:55 -0500847 * algorithm for the values provided. It returns one on success or zero
848 * otherwise. The |BN_mod_exp_mont_consttime| variant must be used if the
849 * exponent is secret. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700850OPENSSL_EXPORT int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
851 const BIGNUM *m, BN_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -0700852
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700853OPENSSL_EXPORT int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
854 const BIGNUM *m, BN_CTX *ctx,
David Benjamine82e6f62015-11-03 10:40:23 -0500855 const BN_MONT_CTX *mont);
Adam Langley95c29f32014-06-20 12:00:00 -0700856
Adam Langleyeb7d2ed2014-07-30 16:02:14 -0700857OPENSSL_EXPORT int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a,
858 const BIGNUM *p, const BIGNUM *m,
Adam Langleyefb42fb2015-11-02 17:39:02 -0800859 BN_CTX *ctx,
860 const BN_MONT_CTX *mont);
Adam Langley95c29f32014-06-20 12:00:00 -0700861
Adam Langley95c29f32014-06-20 12:00:00 -0700862
Matt Braithwaite64887252015-08-11 17:17:28 -0700863/* Deprecated functions */
864
865/* BN_bn2mpi serialises the value of |in| to |out|, using a format that consists
866 * of the number's length in bytes represented as a 4-byte big-endian number,
867 * and the number itself in big-endian format, where the most significant bit
868 * signals a negative number. (The representation of numbers with the MSB set is
869 * prefixed with null byte). |out| must have sufficient space available; to
870 * find the needed amount of space, call the function with |out| set to NULL. */
871OPENSSL_EXPORT size_t BN_bn2mpi(const BIGNUM *in, uint8_t *out);
872
Adam Langley5f889992015-11-04 14:05:00 -0800873/* BN_mpi2bn parses |len| bytes from |in| and returns the resulting value. The
Matt Braithwaite64887252015-08-11 17:17:28 -0700874 * bytes at |in| are expected to be in the format emitted by |BN_bn2mpi|.
875 *
876 * If |out| is NULL then a fresh |BIGNUM| is allocated and returned, otherwise
877 * |out| is reused and returned. On error, NULL is returned and the error queue
878 * is updated. */
879OPENSSL_EXPORT BIGNUM *BN_mpi2bn(const uint8_t *in, size_t len, BIGNUM *out);
880
Brian Smithe31d1032016-04-21 17:08:13 -1000881/* BN_mod_exp_mont_word is like |BN_mod_exp_mont| except that the base |a| is
882 * given as a |BN_ULONG| instead of a |BIGNUM *|. It returns one on success
883 * or zero otherwise. */
884OPENSSL_EXPORT int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p,
885 const BIGNUM *m, BN_CTX *ctx,
886 const BN_MONT_CTX *mont);
887
Brian Smith448fa422016-04-21 17:08:29 -1000888/* BN_mod_exp2_mont calculates (a1^p1) * (a2^p2) mod m. It returns 1 on success
889 * or zero otherwise. */
890OPENSSL_EXPORT int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1,
891 const BIGNUM *p1, const BIGNUM *a2,
892 const BIGNUM *p2, const BIGNUM *m,
893 BN_CTX *ctx, const BN_MONT_CTX *mont);
894
Matt Braithwaite64887252015-08-11 17:17:28 -0700895
Adam Langley95c29f32014-06-20 12:00:00 -0700896/* Private functions */
897
898struct bignum_st {
899 BN_ULONG *d; /* Pointer to an array of 'BN_BITS2' bit chunks in little-endian
900 order. */
901 int top; /* Index of last used element in |d|, plus one. */
902 int dmax; /* Size of |d|, in words. */
903 int neg; /* one if the number is negative */
904 int flags; /* bitmask of BN_FLG_* values */
905};
906
907struct bn_mont_ctx_st {
908 BIGNUM RR; /* used to convert to montgomery form */
909 BIGNUM N; /* The modulus */
Brian Smith8bde5d22015-11-11 18:36:23 -1000910 BN_ULONG n0[2]; /* least significant words of (R*Ri-1)/N */
Adam Langley95c29f32014-06-20 12:00:00 -0700911};
912
Adam Langley214cd442014-08-18 11:35:45 -0700913OPENSSL_EXPORT unsigned BN_num_bits_word(BN_ULONG l);
Adam Langley95c29f32014-06-20 12:00:00 -0700914
915#define BN_FLG_MALLOCED 0x01
916#define BN_FLG_STATIC_DATA 0x02
David Benjamin0a211df2016-12-17 15:25:55 -0500917/* |BN_FLG_CONSTTIME| has been removed and intentionally omitted so code relying
918 * on it will not compile. Consumers outside BoringSSL should use the
919 * higher-level cryptographic algorithms exposed by other modules. Consumers
920 * within the library should call the appropriate timing-sensitive algorithm
921 * directly. */
Adam Langley95c29f32014-06-20 12:00:00 -0700922
923
924#if defined(__cplusplus)
925} /* extern C */
Matt Braithwaited17d74d2016-08-17 20:10:28 -0700926
927extern "C++" {
928
929namespace bssl {
930
Matt Braithwaited17d74d2016-08-17 20:10:28 -0700931BORINGSSL_MAKE_DELETER(BIGNUM, BN_free)
932BORINGSSL_MAKE_DELETER(BN_CTX, BN_CTX_free)
933BORINGSSL_MAKE_DELETER(BN_MONT_CTX, BN_MONT_CTX_free)
934
Matt Braithwaited17d74d2016-08-17 20:10:28 -0700935} // namespace bssl
936
937} /* extern C++ */
938
Adam Langley95c29f32014-06-20 12:00:00 -0700939#endif
940
David Benjamin689be0f2015-02-11 15:55:26 -0500941#define BN_R_ARG2_LT_ARG3 100
942#define BN_R_BAD_RECIPROCAL 101
943#define BN_R_BIGNUM_TOO_LONG 102
944#define BN_R_BITS_TOO_SMALL 103
945#define BN_R_CALLED_WITH_EVEN_MODULUS 104
946#define BN_R_DIV_BY_ZERO 105
947#define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA 106
948#define BN_R_INPUT_NOT_REDUCED 107
949#define BN_R_INVALID_RANGE 108
950#define BN_R_NEGATIVE_NUMBER 109
951#define BN_R_NOT_A_SQUARE 110
952#define BN_R_NOT_INITIALIZED 111
953#define BN_R_NO_INVERSE 112
954#define BN_R_PRIVATE_KEY_TOO_LARGE 113
955#define BN_R_P_IS_NOT_PRIME 114
956#define BN_R_TOO_MANY_ITERATIONS 115
957#define BN_R_TOO_MANY_TEMPORARY_VARIABLES 116
David Benjaminb9c579d2015-06-11 22:52:07 -0400958#define BN_R_BAD_ENCODING 117
959#define BN_R_ENCODE_ERROR 118
Adam Langley95c29f32014-06-20 12:00:00 -0700960
961#endif /* OPENSSL_HEADER_BN_H */