blob: 8541403b7022d05249675b668ba0ee7a68c178cf [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file bignum.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Multi-precision integer library
5 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02006 * Copyright (C) 2006-2013, Brainspark B.V.
Paul Bakkerb96f1542010-07-18 20:36:00 +00007 *
8 * This file is part of PolarSSL (http://www.polarssl.org)
Paul Bakker84f12b72010-07-18 10:13:04 +00009 * Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
Paul Bakkerb96f1542010-07-18 20:36:00 +000010 *
Paul Bakker77b385e2009-07-28 17:23:11 +000011 * All rights reserved.
Paul Bakkere0ccd0a2009-01-04 16:27:10 +000012 *
Paul Bakkere0ccd0a2009-01-04 16:27:10 +000013 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Paul Bakker5121ce52009-01-03 21:22:43 +000026 */
Paul Bakker40e46942009-01-03 21:51:57 +000027#ifndef POLARSSL_BIGNUM_H
28#define POLARSSL_BIGNUM_H
Paul Bakker5121ce52009-01-03 21:22:43 +000029
30#include <stdio.h>
Paul Bakker23986e52011-04-24 08:57:21 +000031#include <string.h>
Paul Bakker5121ce52009-01-03 21:22:43 +000032
Paul Bakkercf0360a2012-01-20 10:08:14 +000033#include "config.h"
34
Paul Bakkerfa6a6202013-10-28 18:48:30 +010035#if defined(_MSC_VER) && !defined(EFIX64) && !defined(EFI32)
Paul Bakker5c2364c2012-10-01 14:41:15 +000036#include <basetsd.h>
Paul Bakker4a2bd0d2012-11-02 11:06:08 +000037#if (_MSC_VER <= 1200)
38typedef signed short int16_t;
39typedef unsigned short uint16_t;
40#else
Paul Bakker5c2364c2012-10-01 14:41:15 +000041typedef INT16 int16_t;
42typedef UINT16 uint16_t;
Paul Bakker4a2bd0d2012-11-02 11:06:08 +000043#endif
Paul Bakker9ef6e2b2012-10-01 20:57:38 +000044typedef INT32 int32_t;
Paul Bakker8ea31ff2013-02-27 15:02:50 +010045typedef INT64 int64_t;
Paul Bakker5c2364c2012-10-01 14:41:15 +000046typedef UINT32 uint32_t;
47typedef UINT64 uint64_t;
48#else
49#include <inttypes.h>
50#endif
51
Paul Bakker9d781402011-05-09 16:17:09 +000052#define POLARSSL_ERR_MPI_FILE_IO_ERROR -0x0002 /**< An error occurred while reading from or writing to a file. */
53#define POLARSSL_ERR_MPI_BAD_INPUT_DATA -0x0004 /**< Bad input parameters to function. */
54#define POLARSSL_ERR_MPI_INVALID_CHARACTER -0x0006 /**< There is an invalid character in the digit string. */
Paul Bakker69e095c2011-12-10 21:55:01 +000055#define POLARSSL_ERR_MPI_BUFFER_TOO_SMALL -0x0008 /**< The buffer is too small to write to. */
Paul Bakker9d781402011-05-09 16:17:09 +000056#define POLARSSL_ERR_MPI_NEGATIVE_VALUE -0x000A /**< The input arguments are negative or result in illegal output. */
57#define POLARSSL_ERR_MPI_DIVISION_BY_ZERO -0x000C /**< The input argument for division is zero, which is not allowed. */
58#define POLARSSL_ERR_MPI_NOT_ACCEPTABLE -0x000E /**< The input arguments are not acceptable. */
Paul Bakker69e095c2011-12-10 21:55:01 +000059#define POLARSSL_ERR_MPI_MALLOC_FAILED -0x0010 /**< Memory allocation failed. */
Paul Bakker5121ce52009-01-03 21:22:43 +000060
61#define MPI_CHK(f) if( ( ret = f ) != 0 ) goto cleanup
62
63/*
Paul Bakkerf9688572011-05-05 10:00:45 +000064 * Maximum size MPIs are allowed to grow to in number of limbs.
65 */
66#define POLARSSL_MPI_MAX_LIMBS 10000
67
Paul Bakker9bcf16c2013-06-24 19:31:17 +020068#if !defined(POLARSSL_CONFIG_OPTIONS)
Paul Bakkerf9688572011-05-05 10:00:45 +000069/*
Paul Bakkerb6d5f082011-11-25 11:52:11 +000070 * Maximum window size used for modular exponentiation. Default: 6
71 * Minimum value: 1. Maximum value: 6.
72 *
73 * Result is an array of ( 2 << POLARSSL_MPI_WINDOW_SIZE ) MPIs used
74 * for the sliding window calculation. (So 64 by default)
75 *
76 * Reduction in size, reduces speed.
77 */
78#define POLARSSL_MPI_WINDOW_SIZE 6 /**< Maximum windows size used. */
79
80/*
Paul Bakkerfe3256e2011-11-25 12:11:43 +000081 * Maximum size of MPIs allowed in bits and bytes for user-MPIs.
Paul Bakkerf626e1d2013-01-21 12:10:00 +010082 * ( Default: 512 bytes => 4096 bits, Maximum tested: 2048 bytes => 16384 bits )
Paul Bakkerfe3256e2011-11-25 12:11:43 +000083 *
84 * Note: Calculations can results temporarily in larger MPIs. So the number
85 * of limbs required (POLARSSL_MPI_MAX_LIMBS) is higher.
86 */
87#define POLARSSL_MPI_MAX_SIZE 512 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +020088
89#endif /* !POLARSSL_CONFIG_OPTIONS */
90
Paul Bakkerfe3256e2011-11-25 12:11:43 +000091#define POLARSSL_MPI_MAX_BITS ( 8 * POLARSSL_MPI_MAX_SIZE ) /**< Maximum number of bits for usable MPIs. */
92
93/*
Paul Bakker5531c6d2012-09-26 19:20:46 +000094 * When reading from files with mpi_read_file() and writing to files with
95 * mpi_write_file() the buffer should have space
Paul Bakkercb37aa52011-11-30 16:00:20 +000096 * for a (short) label, the MPI (in the provided radix), the newline
97 * characters and the '\0'.
98 *
99 * By default we assume at least a 10 char label, a minimum radix of 10
100 * (decimal) and a maximum of 4096 bit numbers (1234 decimal chars).
Paul Bakkerf9183102012-09-27 20:42:35 +0000101 * Autosized at compile time for at least a 10 char label, a minimum radix
102 * of 10 (decimal) for a number of POLARSSL_MPI_MAX_BITS size.
103 *
104 * This used to be statically sized to 1250 for a maximum of 4096 bit
105 * numbers (1234 decimal chars).
106 *
107 * Calculate using the formula:
108 * POLARSSL_MPI_RW_BUFFER_SIZE = ceil(POLARSSL_MPI_MAX_BITS / ln(10) * ln(2)) +
109 * LabelSize + 6
Paul Bakkercb37aa52011-11-30 16:00:20 +0000110 */
Paul Bakkerf9183102012-09-27 20:42:35 +0000111#define POLARSSL_MPI_MAX_BITS_SCALE100 ( 100 * POLARSSL_MPI_MAX_BITS )
112#define LN_2_DIV_LN_10_SCALE100 332
113#define POLARSSL_MPI_RW_BUFFER_SIZE ( ((POLARSSL_MPI_MAX_BITS_SCALE100 + LN_2_DIV_LN_10_SCALE100 - 1) / LN_2_DIV_LN_10_SCALE100) + 10 + 6 )
Paul Bakkercb37aa52011-11-30 16:00:20 +0000114
115/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000116 * Define the base integer type, architecture-wise
117 */
Paul Bakker40e46942009-01-03 21:51:57 +0000118#if defined(POLARSSL_HAVE_INT8)
Paul Bakkera755ca12011-04-24 09:11:17 +0000119typedef signed char t_sint;
120typedef unsigned char t_uint;
Paul Bakker5c2364c2012-10-01 14:41:15 +0000121typedef uint16_t t_udbl;
Paul Bakker62261d62012-10-02 12:19:31 +0000122#define POLARSSL_HAVE_UDBL
Paul Bakker5121ce52009-01-03 21:22:43 +0000123#else
Paul Bakker40e46942009-01-03 21:51:57 +0000124#if defined(POLARSSL_HAVE_INT16)
Paul Bakker5c2364c2012-10-01 14:41:15 +0000125typedef int16_t t_sint;
126typedef uint16_t t_uint;
127typedef uint32_t t_udbl;
Paul Bakker62261d62012-10-02 12:19:31 +0000128#define POLARSSL_HAVE_UDBL
Paul Bakker5121ce52009-01-03 21:22:43 +0000129#else
Paul Bakker9f2018e2013-02-27 15:01:34 +0100130 #if ( defined(_MSC_VER) && defined(_M_AMD64) )
Manuel Pégourié-Gonnard5779cbe2013-10-23 20:17:00 +0200131 #define POLARSSL_HAVE_INT64
Paul Bakker62261d62012-10-02 12:19:31 +0000132 typedef int64_t t_sint;
133 typedef uint64_t t_uint;
134 #else
135 #if ( defined(__GNUC__) && ( \
136 defined(__amd64__) || defined(__x86_64__) || \
137 defined(__ppc64__) || defined(__powerpc64__) || \
138 defined(__ia64__) || defined(__alpha__) || \
139 (defined(__sparc__) && defined(__arch64__)) || \
140 defined(__s390x__) ) )
Manuel Pégourié-Gonnard5779cbe2013-10-23 20:17:00 +0200141 #define POLARSSL_HAVE_INT64
Paul Bakker62261d62012-10-02 12:19:31 +0000142 typedef int64_t t_sint;
143 typedef uint64_t t_uint;
144 typedef unsigned int t_udbl __attribute__((mode(TI)));
145 #define POLARSSL_HAVE_UDBL
146 #else
Manuel Pégourié-Gonnarda47e7052013-10-21 17:51:45 +0200147 #define POLARSSL_HAVE_INT32
Paul Bakker62261d62012-10-02 12:19:31 +0000148 typedef int32_t t_sint;
149 typedef uint32_t t_uint;
150 #if ( defined(_MSC_VER) && defined(_M_IX86) )
151 typedef uint64_t t_udbl;
152 #define POLARSSL_HAVE_UDBL
153 #else
154 #if defined( POLARSSL_HAVE_LONGLONG )
155 typedef unsigned long long t_udbl;
156 #define POLARSSL_HAVE_UDBL
157 #endif
158 #endif
159 #endif
Paul Bakker5c2364c2012-10-01 14:41:15 +0000160 #endif
161#endif /* POLARSSL_HAVE_INT16 */
162#endif /* POLARSSL_HAVE_INT8 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000163
Paul Bakker407a0da2013-06-27 14:29:21 +0200164#ifdef __cplusplus
165extern "C" {
166#endif
167
Paul Bakker5121ce52009-01-03 21:22:43 +0000168/**
169 * \brief MPI structure
170 */
171typedef struct
172{
173 int s; /*!< integer sign */
Paul Bakker23986e52011-04-24 08:57:21 +0000174 size_t n; /*!< total # of limbs */
Paul Bakkera755ca12011-04-24 09:11:17 +0000175 t_uint *p; /*!< pointer to limbs */
Paul Bakker5121ce52009-01-03 21:22:43 +0000176}
177mpi;
178
Paul Bakker5121ce52009-01-03 21:22:43 +0000179/**
Paul Bakker6c591fa2011-05-05 11:49:20 +0000180 * \brief Initialize one MPI
181 *
182 * \param X One MPI to initialize.
Paul Bakker5121ce52009-01-03 21:22:43 +0000183 */
Paul Bakker6c591fa2011-05-05 11:49:20 +0000184void mpi_init( mpi *X );
Paul Bakker5121ce52009-01-03 21:22:43 +0000185
186/**
Paul Bakker6c591fa2011-05-05 11:49:20 +0000187 * \brief Unallocate one MPI
188 *
189 * \param X One MPI to unallocate.
Paul Bakker5121ce52009-01-03 21:22:43 +0000190 */
Paul Bakker6c591fa2011-05-05 11:49:20 +0000191void mpi_free( mpi *X );
Paul Bakker5121ce52009-01-03 21:22:43 +0000192
193/**
194 * \brief Enlarge to the specified number of limbs
195 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000196 * \param X MPI to grow
197 * \param nblimbs The target number of limbs
198 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000199 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000200 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000201 */
Paul Bakker23986e52011-04-24 08:57:21 +0000202int mpi_grow( mpi *X, size_t nblimbs );
Paul Bakker5121ce52009-01-03 21:22:43 +0000203
204/**
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100205 * \brief Resize down, keeping at least the specified number of limbs
206 *
207 * \param X MPI to shrink
208 * \param nblimbs The minimum number of limbs to keep
209 *
210 * \return 0 if successful,
211 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
212 */
213int mpi_shrink( mpi *X, size_t nblimbs );
214
215/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000216 * \brief Copy the contents of Y into X
217 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000218 * \param X Destination MPI
219 * \param Y Source MPI
220 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000221 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000222 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000223 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000224int mpi_copy( mpi *X, const mpi *Y );
Paul Bakker5121ce52009-01-03 21:22:43 +0000225
226/**
227 * \brief Swap the contents of X and Y
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000228 *
229 * \param X First MPI value
230 * \param Y Second MPI value
Paul Bakker5121ce52009-01-03 21:22:43 +0000231 */
232void mpi_swap( mpi *X, mpi *Y );
233
234/**
Manuel Pégourié-Gonnard71c2c212013-11-21 16:56:39 +0100235 * \brief Safe conditional assignement X = Y if assign is 1
236 *
237 * \param X MPI to conditionally assign to
238 * \param Y Value to be assigned
239 * \param assign 1: perform the assignment, 0: leave X untouched
240 *
241 * \return 0 if successful,
242 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed,
243 * POLARSSL_ERR_MPI_BAD_INPUT_DATA if assing is not 0 or 1
244 *
245 * \note This function is equivalent to
246 * if( assign ) mpi_copy( X, Y );
247 * except that it avoids leaking any information about whether
248 * the assignment was done or not (the above code may leak
Manuel Pégourié-Gonnardd7283502013-11-21 20:00:38 +0100249 * information through branch prediction and/or memory access
250 * patterns analysis).
Manuel Pégourié-Gonnard71c2c212013-11-21 16:56:39 +0100251 */
Manuel Pégourié-Gonnard96c7a922013-11-25 18:28:53 +0100252int mpi_safe_cond_assign( mpi *X, const mpi *Y, unsigned char assign );
Manuel Pégourié-Gonnard71c2c212013-11-21 16:56:39 +0100253
254/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000255 * \brief Set value from integer
256 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000257 * \param X MPI to set
258 * \param z Value to use
259 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000260 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000261 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000262 */
Paul Bakkera755ca12011-04-24 09:11:17 +0000263int mpi_lset( mpi *X, t_sint z );
Paul Bakker5121ce52009-01-03 21:22:43 +0000264
Paul Bakker9a736322012-11-14 12:39:52 +0000265/**
Paul Bakker2f5947e2011-05-18 15:47:11 +0000266 * \brief Get a specific bit from X
267 *
268 * \param X MPI to use
269 * \param pos Zero-based index of the bit in X
270 *
271 * \return Either a 0 or a 1
272 */
Paul Bakker6b906e52012-05-08 12:01:43 +0000273int mpi_get_bit( const mpi *X, size_t pos );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000274
Paul Bakker9a736322012-11-14 12:39:52 +0000275/**
Paul Bakker2f5947e2011-05-18 15:47:11 +0000276 * \brief Set a bit of X to a specific value of 0 or 1
277 *
278 * \note Will grow X if necessary to set a bit to 1 in a not yet
279 * existing limb. Will not grow if bit should be set to 0
280 *
281 * \param X MPI to use
282 * \param pos Zero-based index of the bit in X
283 * \param val The value to set the bit to (0 or 1)
284 *
285 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000286 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed,
Paul Bakker2f5947e2011-05-18 15:47:11 +0000287 * POLARSSL_ERR_MPI_BAD_INPUT_DATA if val is not 0 or 1
288 */
289int mpi_set_bit( mpi *X, size_t pos, unsigned char val );
290
Paul Bakker5121ce52009-01-03 21:22:43 +0000291/**
Paul Bakker6b906e52012-05-08 12:01:43 +0000292 * \brief Return the number of zero-bits before the least significant
293 * '1' bit
294 *
295 * Note: Thus also the zero-based index of the least significant '1' bit
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000296 *
297 * \param X MPI to use
Paul Bakker5121ce52009-01-03 21:22:43 +0000298 */
Paul Bakker23986e52011-04-24 08:57:21 +0000299size_t mpi_lsb( const mpi *X );
Paul Bakker5121ce52009-01-03 21:22:43 +0000300
301/**
Paul Bakker6b906e52012-05-08 12:01:43 +0000302 * \brief Return the number of bits up to and including the most
303 * significant '1' bit'
304 *
305 * Note: Thus also the one-based index of the most significant '1' bit
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000306 *
307 * \param X MPI to use
Paul Bakker5121ce52009-01-03 21:22:43 +0000308 */
Paul Bakker23986e52011-04-24 08:57:21 +0000309size_t mpi_msb( const mpi *X );
Paul Bakker5121ce52009-01-03 21:22:43 +0000310
311/**
312 * \brief Return the total size in bytes
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000313 *
314 * \param X MPI to use
Paul Bakker5121ce52009-01-03 21:22:43 +0000315 */
Paul Bakker23986e52011-04-24 08:57:21 +0000316size_t mpi_size( const mpi *X );
Paul Bakker5121ce52009-01-03 21:22:43 +0000317
318/**
319 * \brief Import from an ASCII string
320 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000321 * \param X Destination MPI
322 * \param radix Input numeric base
323 * \param s Null-terminated string buffer
Paul Bakker5121ce52009-01-03 21:22:43 +0000324 *
Paul Bakkercb37aa52011-11-30 16:00:20 +0000325 * \return 0 if successful, or a POLARSSL_ERR_MPI_XXX error code
Paul Bakker5121ce52009-01-03 21:22:43 +0000326 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000327int mpi_read_string( mpi *X, int radix, const char *s );
Paul Bakker5121ce52009-01-03 21:22:43 +0000328
329/**
330 * \brief Export into an ASCII string
331 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000332 * \param X Source MPI
333 * \param radix Output numeric base
334 * \param s String buffer
335 * \param slen String buffer size
Paul Bakker5121ce52009-01-03 21:22:43 +0000336 *
Paul Bakkercb37aa52011-11-30 16:00:20 +0000337 * \return 0 if successful, or a POLARSSL_ERR_MPI_XXX error code.
Paul Bakkerff60ee62010-03-16 21:09:09 +0000338 * *slen is always updated to reflect the amount
339 * of data that has (or would have) been written.
Paul Bakker5121ce52009-01-03 21:22:43 +0000340 *
341 * \note Call this function with *slen = 0 to obtain the
342 * minimum required buffer size in *slen.
343 */
Paul Bakker23986e52011-04-24 08:57:21 +0000344int mpi_write_string( const mpi *X, int radix, char *s, size_t *slen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000345
Paul Bakker2b6af2f2012-10-23 11:08:02 +0000346#if defined(POLARSSL_FS_IO)
Paul Bakker5121ce52009-01-03 21:22:43 +0000347/**
348 * \brief Read X from an opened file
349 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000350 * \param X Destination MPI
351 * \param radix Input numeric base
352 * \param fin Input file handle
Paul Bakker5121ce52009-01-03 21:22:43 +0000353 *
Paul Bakkercb37aa52011-11-30 16:00:20 +0000354 * \return 0 if successful, POLARSSL_ERR_MPI_BUFFER_TOO_SMALL if
355 * the file read buffer is too small or a
356 * POLARSSL_ERR_MPI_XXX error code
Paul Bakker5121ce52009-01-03 21:22:43 +0000357 */
358int mpi_read_file( mpi *X, int radix, FILE *fin );
359
360/**
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000361 * \brief Write X into an opened file, or stdout if fout is NULL
Paul Bakker5121ce52009-01-03 21:22:43 +0000362 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000363 * \param p Prefix, can be NULL
364 * \param X Source MPI
365 * \param radix Output numeric base
366 * \param fout Output file handle (can be NULL)
Paul Bakker5121ce52009-01-03 21:22:43 +0000367 *
Paul Bakkercb37aa52011-11-30 16:00:20 +0000368 * \return 0 if successful, or a POLARSSL_ERR_MPI_XXX error code
Paul Bakker5121ce52009-01-03 21:22:43 +0000369 *
370 * \note Set fout == NULL to print X on the console.
371 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000372int mpi_write_file( const char *p, const mpi *X, int radix, FILE *fout );
Paul Bakker2b6af2f2012-10-23 11:08:02 +0000373#endif /* POLARSSL_FS_IO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000374
375/**
376 * \brief Import X from unsigned binary data, big endian
377 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000378 * \param X Destination MPI
379 * \param buf Input buffer
380 * \param buflen Input buffer size
Paul Bakker5121ce52009-01-03 21:22:43 +0000381 *
382 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000383 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000384 */
Paul Bakker23986e52011-04-24 08:57:21 +0000385int mpi_read_binary( mpi *X, const unsigned char *buf, size_t buflen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000386
387/**
388 * \brief Export X into unsigned binary data, big endian
389 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000390 * \param X Source MPI
391 * \param buf Output buffer
392 * \param buflen Output buffer size
Paul Bakker5121ce52009-01-03 21:22:43 +0000393 *
394 * \return 0 if successful,
Paul Bakker40e46942009-01-03 21:51:57 +0000395 * POLARSSL_ERR_MPI_BUFFER_TOO_SMALL if buf isn't large enough
Paul Bakker5121ce52009-01-03 21:22:43 +0000396 */
Paul Bakker23986e52011-04-24 08:57:21 +0000397int mpi_write_binary( const mpi *X, unsigned char *buf, size_t buflen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000398
399/**
400 * \brief Left-shift: X <<= count
401 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000402 * \param X MPI to shift
403 * \param count Amount to shift
404 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000405 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000406 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000407 */
Paul Bakker23986e52011-04-24 08:57:21 +0000408int mpi_shift_l( mpi *X, size_t count );
Paul Bakker5121ce52009-01-03 21:22:43 +0000409
410/**
411 * \brief Right-shift: X >>= count
412 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000413 * \param X MPI to shift
414 * \param count Amount to shift
415 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000416 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000417 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000418 */
Paul Bakker23986e52011-04-24 08:57:21 +0000419int mpi_shift_r( mpi *X, size_t count );
Paul Bakker5121ce52009-01-03 21:22:43 +0000420
421/**
422 * \brief Compare unsigned values
423 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000424 * \param X Left-hand MPI
425 * \param Y Right-hand MPI
426 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000427 * \return 1 if |X| is greater than |Y|,
428 * -1 if |X| is lesser than |Y| or
429 * 0 if |X| is equal to |Y|
430 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000431int mpi_cmp_abs( const mpi *X, const mpi *Y );
Paul Bakker5121ce52009-01-03 21:22:43 +0000432
433/**
434 * \brief Compare signed values
435 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000436 * \param X Left-hand MPI
437 * \param Y Right-hand MPI
438 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000439 * \return 1 if X is greater than Y,
440 * -1 if X is lesser than Y or
441 * 0 if X is equal to Y
442 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000443int mpi_cmp_mpi( const mpi *X, const mpi *Y );
Paul Bakker5121ce52009-01-03 21:22:43 +0000444
445/**
446 * \brief Compare signed values
447 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000448 * \param X Left-hand MPI
449 * \param z The integer value to compare to
450 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000451 * \return 1 if X is greater than z,
452 * -1 if X is lesser than z or
453 * 0 if X is equal to z
454 */
Paul Bakkera755ca12011-04-24 09:11:17 +0000455int mpi_cmp_int( const mpi *X, t_sint z );
Paul Bakker5121ce52009-01-03 21:22:43 +0000456
457/**
458 * \brief Unsigned addition: X = |A| + |B|
459 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000460 * \param X Destination MPI
461 * \param A Left-hand MPI
462 * \param B Right-hand MPI
463 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000464 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000465 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000466 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000467int mpi_add_abs( mpi *X, const mpi *A, const mpi *B );
Paul Bakker5121ce52009-01-03 21:22:43 +0000468
469/**
Paul Bakker60b1d102013-10-29 10:02:51 +0100470 * \brief Unsigned subtraction: X = |A| - |B|
Paul Bakker5121ce52009-01-03 21:22:43 +0000471 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000472 * \param X Destination MPI
473 * \param A Left-hand MPI
474 * \param B Right-hand MPI
475 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000476 * \return 0 if successful,
Paul Bakker40e46942009-01-03 21:51:57 +0000477 * POLARSSL_ERR_MPI_NEGATIVE_VALUE if B is greater than A
Paul Bakker5121ce52009-01-03 21:22:43 +0000478 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000479int mpi_sub_abs( mpi *X, const mpi *A, const mpi *B );
Paul Bakker5121ce52009-01-03 21:22:43 +0000480
481/**
482 * \brief Signed addition: X = A + B
483 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000484 * \param X Destination MPI
485 * \param A Left-hand MPI
486 * \param B Right-hand MPI
487 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000488 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000489 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000490 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000491int mpi_add_mpi( mpi *X, const mpi *A, const mpi *B );
Paul Bakker5121ce52009-01-03 21:22:43 +0000492
493/**
Paul Bakker60b1d102013-10-29 10:02:51 +0100494 * \brief Signed subtraction: X = A - B
Paul Bakker5121ce52009-01-03 21:22:43 +0000495 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000496 * \param X Destination MPI
497 * \param A Left-hand MPI
498 * \param B Right-hand MPI
499 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000500 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000501 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000502 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000503int mpi_sub_mpi( mpi *X, const mpi *A, const mpi *B );
Paul Bakker5121ce52009-01-03 21:22:43 +0000504
505/**
506 * \brief Signed addition: X = A + b
507 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000508 * \param X Destination MPI
509 * \param A Left-hand MPI
510 * \param b The integer value to add
511 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000512 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000513 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000514 */
Paul Bakkera755ca12011-04-24 09:11:17 +0000515int mpi_add_int( mpi *X, const mpi *A, t_sint b );
Paul Bakker5121ce52009-01-03 21:22:43 +0000516
517/**
Paul Bakker60b1d102013-10-29 10:02:51 +0100518 * \brief Signed subtraction: X = A - b
Paul Bakker5121ce52009-01-03 21:22:43 +0000519 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000520 * \param X Destination MPI
521 * \param A Left-hand MPI
522 * \param b The integer value to subtract
523 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000524 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000525 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000526 */
Paul Bakkera755ca12011-04-24 09:11:17 +0000527int mpi_sub_int( mpi *X, const mpi *A, t_sint b );
Paul Bakker5121ce52009-01-03 21:22:43 +0000528
529/**
530 * \brief Baseline multiplication: X = A * B
531 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000532 * \param X Destination MPI
533 * \param A Left-hand MPI
534 * \param B Right-hand MPI
535 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000536 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000537 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000538 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000539int mpi_mul_mpi( mpi *X, const mpi *A, const mpi *B );
Paul Bakker5121ce52009-01-03 21:22:43 +0000540
541/**
542 * \brief Baseline multiplication: X = A * b
Paul Bakkerce40a6d2009-06-23 19:46:08 +0000543 * Note: b is an unsigned integer type, thus
544 * Negative values of b are ignored.
Paul Bakker5121ce52009-01-03 21:22:43 +0000545 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000546 * \param X Destination MPI
547 * \param A Left-hand MPI
548 * \param b The integer value to multiply with
549 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000550 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000551 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000552 */
Paul Bakkera755ca12011-04-24 09:11:17 +0000553int mpi_mul_int( mpi *X, const mpi *A, t_sint b );
Paul Bakker5121ce52009-01-03 21:22:43 +0000554
555/**
556 * \brief Division by mpi: A = Q * B + R
557 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000558 * \param Q Destination MPI for the quotient
559 * \param R Destination MPI for the rest value
560 * \param A Left-hand MPI
561 * \param B Right-hand MPI
562 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000563 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000564 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed,
Paul Bakker40e46942009-01-03 21:51:57 +0000565 * POLARSSL_ERR_MPI_DIVISION_BY_ZERO if B == 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000566 *
567 * \note Either Q or R can be NULL.
568 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000569int mpi_div_mpi( mpi *Q, mpi *R, const mpi *A, const mpi *B );
Paul Bakker5121ce52009-01-03 21:22:43 +0000570
571/**
572 * \brief Division by int: A = Q * b + R
573 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000574 * \param Q Destination MPI for the quotient
575 * \param R Destination MPI for the rest value
576 * \param A Left-hand MPI
577 * \param b Integer to divide by
578 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000579 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000580 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed,
Paul Bakker40e46942009-01-03 21:51:57 +0000581 * POLARSSL_ERR_MPI_DIVISION_BY_ZERO if b == 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000582 *
583 * \note Either Q or R can be NULL.
584 */
Paul Bakkera755ca12011-04-24 09:11:17 +0000585int mpi_div_int( mpi *Q, mpi *R, const mpi *A, t_sint b );
Paul Bakker5121ce52009-01-03 21:22:43 +0000586
587/**
588 * \brief Modulo: R = A mod B
589 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000590 * \param R Destination MPI for the rest value
591 * \param A Left-hand MPI
592 * \param B Right-hand MPI
593 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000594 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000595 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed,
Paul Bakkerce40a6d2009-06-23 19:46:08 +0000596 * POLARSSL_ERR_MPI_DIVISION_BY_ZERO if B == 0,
597 * POLARSSL_ERR_MPI_NEGATIVE_VALUE if B < 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000598 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000599int mpi_mod_mpi( mpi *R, const mpi *A, const mpi *B );
Paul Bakker5121ce52009-01-03 21:22:43 +0000600
601/**
602 * \brief Modulo: r = A mod b
603 *
Paul Bakkera755ca12011-04-24 09:11:17 +0000604 * \param r Destination t_uint
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000605 * \param A Left-hand MPI
606 * \param b Integer to divide by
607 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000608 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000609 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed,
Paul Bakkerce40a6d2009-06-23 19:46:08 +0000610 * POLARSSL_ERR_MPI_DIVISION_BY_ZERO if b == 0,
611 * POLARSSL_ERR_MPI_NEGATIVE_VALUE if b < 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000612 */
Paul Bakkera755ca12011-04-24 09:11:17 +0000613int mpi_mod_int( t_uint *r, const mpi *A, t_sint b );
Paul Bakker5121ce52009-01-03 21:22:43 +0000614
615/**
616 * \brief Sliding-window exponentiation: X = A^E mod N
617 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000618 * \param X Destination MPI
619 * \param A Left-hand MPI
620 * \param E Exponent MPI
621 * \param N Modular MPI
622 * \param _RR Speed-up MPI used for recalculations
623 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000624 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000625 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed,
Paul Bakkerf6198c12012-05-16 08:02:29 +0000626 * POLARSSL_ERR_MPI_BAD_INPUT_DATA if N is negative or even or if
627 * E is negative
Paul Bakker5121ce52009-01-03 21:22:43 +0000628 *
629 * \note _RR is used to avoid re-computing R*R mod N across
630 * multiple calls, which speeds up things a bit. It can
631 * be set to NULL if the extra performance is unneeded.
632 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000633int mpi_exp_mod( mpi *X, const mpi *A, const mpi *E, const mpi *N, mpi *_RR );
Paul Bakker5121ce52009-01-03 21:22:43 +0000634
635/**
Paul Bakker287781a2011-03-26 13:18:49 +0000636 * \brief Fill an MPI X with size bytes of random
637 *
638 * \param X Destination MPI
639 * \param size Size in bytes
640 * \param f_rng RNG function
641 * \param p_rng RNG parameter
642 *
643 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000644 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker287781a2011-03-26 13:18:49 +0000645 */
Paul Bakkera3d195c2011-11-27 21:07:34 +0000646int mpi_fill_random( mpi *X, size_t size,
647 int (*f_rng)(void *, unsigned char *, size_t),
648 void *p_rng );
Paul Bakker287781a2011-03-26 13:18:49 +0000649
650/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000651 * \brief Greatest common divisor: G = gcd(A, B)
652 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000653 * \param G Destination MPI
654 * \param A Left-hand MPI
655 * \param B Right-hand MPI
656 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000657 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000658 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000659 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000660int mpi_gcd( mpi *G, const mpi *A, const mpi *B );
Paul Bakker5121ce52009-01-03 21:22:43 +0000661
662/**
663 * \brief Modular inverse: X = A^-1 mod N
664 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000665 * \param X Destination MPI
666 * \param A Left-hand MPI
667 * \param N Right-hand MPI
668 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000669 * \return 0 if successful,
Paul Bakker69e095c2011-12-10 21:55:01 +0000670 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed,
Paul Bakker40e46942009-01-03 21:51:57 +0000671 * POLARSSL_ERR_MPI_BAD_INPUT_DATA if N is negative or nil
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000672 POLARSSL_ERR_MPI_NOT_ACCEPTABLE if A has no inverse mod N
Paul Bakker5121ce52009-01-03 21:22:43 +0000673 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000674int mpi_inv_mod( mpi *X, const mpi *A, const mpi *N );
Paul Bakker5121ce52009-01-03 21:22:43 +0000675
676/**
677 * \brief Miller-Rabin primality test
678 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000679 * \param X MPI to check
680 * \param f_rng RNG function
681 * \param p_rng RNG parameter
682 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000683 * \return 0 if successful (probably prime),
Paul Bakker69e095c2011-12-10 21:55:01 +0000684 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed,
Paul Bakker40e46942009-01-03 21:51:57 +0000685 * POLARSSL_ERR_MPI_NOT_ACCEPTABLE if X is not prime
Paul Bakker5121ce52009-01-03 21:22:43 +0000686 */
Paul Bakkera3d195c2011-11-27 21:07:34 +0000687int mpi_is_prime( mpi *X,
688 int (*f_rng)(void *, unsigned char *, size_t),
689 void *p_rng );
Paul Bakker5121ce52009-01-03 21:22:43 +0000690
691/**
692 * \brief Prime number generation
693 *
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000694 * \param X Destination MPI
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000695 * \param nbits Required size of X in bits ( 3 <= nbits <= POLARSSL_MPI_MAX_BITS )
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000696 * \param dh_flag If 1, then (X-1)/2 will be prime too
Paul Bakker5121ce52009-01-03 21:22:43 +0000697 * \param f_rng RNG function
698 * \param p_rng RNG parameter
699 *
700 * \return 0 if successful (probably prime),
Paul Bakker69e095c2011-12-10 21:55:01 +0000701 * POLARSSL_ERR_MPI_MALLOC_FAILED if memory allocation failed,
Paul Bakker40e46942009-01-03 21:51:57 +0000702 * POLARSSL_ERR_MPI_BAD_INPUT_DATA if nbits is < 3
Paul Bakker5121ce52009-01-03 21:22:43 +0000703 */
Paul Bakker23986e52011-04-24 08:57:21 +0000704int mpi_gen_prime( mpi *X, size_t nbits, int dh_flag,
Paul Bakkera3d195c2011-11-27 21:07:34 +0000705 int (*f_rng)(void *, unsigned char *, size_t),
706 void *p_rng );
Paul Bakker5121ce52009-01-03 21:22:43 +0000707
708/**
709 * \brief Checkup routine
710 *
711 * \return 0 if successful, or 1 if the test failed
712 */
713int mpi_self_test( int verbose );
714
715#ifdef __cplusplus
716}
717#endif
718
719#endif /* bignum.h */