PolarSSL v1.3.1
bignum.h
Go to the documentation of this file.
1 
27 #ifndef POLARSSL_BIGNUM_H
28 #define POLARSSL_BIGNUM_H
29 
30 #include <stdio.h>
31 #include <string.h>
32 
33 #include "config.h"
34 
35 #ifdef _MSC_VER
36 #include <basetsd.h>
37 #if (_MSC_VER <= 1200)
38 typedef signed short int16_t;
39 typedef unsigned short uint16_t;
40 #else
41 typedef INT16 int16_t;
42 typedef UINT16 uint16_t;
43 #endif
44 typedef INT32 int32_t;
45 typedef INT64 int64_t;
46 typedef UINT32 uint32_t;
47 typedef UINT64 uint64_t;
48 #else
49 #include <inttypes.h>
50 #endif
51 
52 #define POLARSSL_ERR_MPI_FILE_IO_ERROR -0x0002
53 #define POLARSSL_ERR_MPI_BAD_INPUT_DATA -0x0004
54 #define POLARSSL_ERR_MPI_INVALID_CHARACTER -0x0006
55 #define POLARSSL_ERR_MPI_BUFFER_TOO_SMALL -0x0008
56 #define POLARSSL_ERR_MPI_NEGATIVE_VALUE -0x000A
57 #define POLARSSL_ERR_MPI_DIVISION_BY_ZERO -0x000C
58 #define POLARSSL_ERR_MPI_NOT_ACCEPTABLE -0x000E
59 #define POLARSSL_ERR_MPI_MALLOC_FAILED -0x0010
61 #define MPI_CHK(f) if( ( ret = f ) != 0 ) goto cleanup
62 
63 /*
64  * Maximum size MPIs are allowed to grow to in number of limbs.
65  */
66 #define POLARSSL_MPI_MAX_LIMBS 10000
67 
68 #if !defined(POLARSSL_CONFIG_OPTIONS)
69 /*
70  * 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
80 /*
81  * Maximum size of MPIs allowed in bits and bytes for user-MPIs.
82  * ( Default: 512 bytes => 4096 bits, Maximum tested: 2048 bytes => 16384 bits )
83  *
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
89 #endif /* !POLARSSL_CONFIG_OPTIONS */
90 
91 #define POLARSSL_MPI_MAX_BITS ( 8 * POLARSSL_MPI_MAX_SIZE )
93 /*
94  * When reading from files with mpi_read_file() and writing to files with
95  * mpi_write_file() the buffer should have space
96  * 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).
101  * 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
110  */
111 #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 )
114 
115 /*
116  * Define the base integer type, architecture-wise
117  */
118 #if defined(POLARSSL_HAVE_INT8)
119 typedef signed char t_sint;
120 typedef unsigned char t_uint;
121 typedef uint16_t t_udbl;
122 #define POLARSSL_HAVE_UDBL
123 #else
124 #if defined(POLARSSL_HAVE_INT16)
125 typedef int16_t t_sint;
126 typedef uint16_t t_uint;
127 typedef uint32_t t_udbl;
128 #define POLARSSL_HAVE_UDBL
129 #else
130  #if ( defined(_MSC_VER) && defined(_M_AMD64) )
131  typedef int64_t t_sint;
132  typedef uint64_t t_uint;
133  #else
134  #if ( defined(__GNUC__) && ( \
135  defined(__amd64__) || defined(__x86_64__) || \
136  defined(__ppc64__) || defined(__powerpc64__) || \
137  defined(__ia64__) || defined(__alpha__) || \
138  (defined(__sparc__) && defined(__arch64__)) || \
139  defined(__s390x__) ) )
140  typedef int64_t t_sint;
141  typedef uint64_t t_uint;
142  typedef unsigned int t_udbl __attribute__((mode(TI)));
143  #define POLARSSL_HAVE_UDBL
144  #else
145  typedef int32_t t_sint;
146  typedef uint32_t t_uint;
147  #if ( defined(_MSC_VER) && defined(_M_IX86) )
148  typedef uint64_t t_udbl;
149  #define POLARSSL_HAVE_UDBL
150  #else
151  #if defined( POLARSSL_HAVE_LONGLONG )
152  typedef unsigned long long t_udbl;
153  #define POLARSSL_HAVE_UDBL
154  #endif
155  #endif
156  #endif
157  #endif
158 #endif /* POLARSSL_HAVE_INT16 */
159 #endif /* POLARSSL_HAVE_INT8 */
160 
161 #ifdef __cplusplus
162 extern "C" {
163 #endif
164 
168 typedef struct
169 {
170  int s;
171  size_t n;
172  t_uint *p;
173 }
174 mpi;
175 
181 void mpi_init( mpi *X );
182 
188 void mpi_free( mpi *X );
189 
199 int mpi_grow( mpi *X, size_t nblimbs );
200 
210 int mpi_copy( mpi *X, const mpi *Y );
211 
218 void mpi_swap( mpi *X, mpi *Y );
219 
229 int mpi_lset( mpi *X, t_sint z );
230 
239 int mpi_get_bit( const mpi *X, size_t pos );
240 
255 int mpi_set_bit( mpi *X, size_t pos, unsigned char val );
256 
265 size_t mpi_lsb( const mpi *X );
266 
275 size_t mpi_msb( const mpi *X );
276 
282 size_t mpi_size( const mpi *X );
283 
293 int mpi_read_string( mpi *X, int radix, const char *s );
294 
310 int mpi_write_string( const mpi *X, int radix, char *s, size_t *slen );
311 
312 #if defined(POLARSSL_FS_IO)
313 
324 int mpi_read_file( mpi *X, int radix, FILE *fin );
325 
338 int mpi_write_file( const char *p, const mpi *X, int radix, FILE *fout );
339 #endif /* POLARSSL_FS_IO */
340 
351 int mpi_read_binary( mpi *X, const unsigned char *buf, size_t buflen );
352 
363 int mpi_write_binary( const mpi *X, unsigned char *buf, size_t buflen );
364 
374 int mpi_shift_l( mpi *X, size_t count );
375 
385 int mpi_shift_r( mpi *X, size_t count );
386 
397 int mpi_cmp_abs( const mpi *X, const mpi *Y );
398 
409 int mpi_cmp_mpi( const mpi *X, const mpi *Y );
410 
421 int mpi_cmp_int( const mpi *X, t_sint z );
422 
433 int mpi_add_abs( mpi *X, const mpi *A, const mpi *B );
434 
445 int mpi_sub_abs( mpi *X, const mpi *A, const mpi *B );
446 
457 int mpi_add_mpi( mpi *X, const mpi *A, const mpi *B );
458 
469 int mpi_sub_mpi( mpi *X, const mpi *A, const mpi *B );
470 
481 int mpi_add_int( mpi *X, const mpi *A, t_sint b );
482 
493 int mpi_sub_int( mpi *X, const mpi *A, t_sint b );
494 
505 int mpi_mul_mpi( mpi *X, const mpi *A, const mpi *B );
506 
519 int mpi_mul_int( mpi *X, const mpi *A, t_sint b );
520 
535 int mpi_div_mpi( mpi *Q, mpi *R, const mpi *A, const mpi *B );
536 
551 int mpi_div_int( mpi *Q, mpi *R, const mpi *A, t_sint b );
552 
565 int mpi_mod_mpi( mpi *R, const mpi *A, const mpi *B );
566 
579 int mpi_mod_int( t_uint *r, const mpi *A, t_sint b );
580 
599 int mpi_exp_mod( mpi *X, const mpi *A, const mpi *E, const mpi *N, mpi *_RR );
600 
612 int mpi_fill_random( mpi *X, size_t size,
613  int (*f_rng)(void *, unsigned char *, size_t),
614  void *p_rng );
615 
626 int mpi_gcd( mpi *G, const mpi *A, const mpi *B );
627 
640 int mpi_inv_mod( mpi *X, const mpi *A, const mpi *N );
641 
653 int mpi_is_prime( mpi *X,
654  int (*f_rng)(void *, unsigned char *, size_t),
655  void *p_rng );
656 
670 int mpi_gen_prime( mpi *X, size_t nbits, int dh_flag,
671  int (*f_rng)(void *, unsigned char *, size_t),
672  void *p_rng );
673 
679 int mpi_self_test( int verbose );
680 
681 #ifdef __cplusplus
682 }
683 #endif
684 
685 #endif /* bignum.h */
int mpi_cmp_int(const mpi *X, t_sint z)
Compare signed values.
void mpi_swap(mpi *X, mpi *Y)
Swap the contents of X and Y.
uint32_t t_uint
Definition: bignum.h:146
int mpi_div_int(mpi *Q, mpi *R, const mpi *A, t_sint b)
Division by int: A = Q * b + R.
int mpi_gcd(mpi *G, const mpi *A, const mpi *B)
Greatest common divisor: G = gcd(A, B)
int s
Definition: bignum.h:170
int mpi_fill_random(mpi *X, size_t size, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Fill an MPI X with size bytes of random.
int mpi_sub_abs(mpi *X, const mpi *A, const mpi *B)
Unsigned substraction: X = |A| - |B|.
int mpi_cmp_abs(const mpi *X, const mpi *Y)
Compare unsigned values.
Configuration options (set of defines)
int mpi_add_int(mpi *X, const mpi *A, t_sint b)
Signed addition: X = A + b.
int mpi_read_file(mpi *X, int radix, FILE *fin)
Read X from an opened file.
int mpi_div_mpi(mpi *Q, mpi *R, const mpi *A, const mpi *B)
Division by mpi: A = Q * B + R.
int mpi_lset(mpi *X, t_sint z)
Set value from integer.
int mpi_is_prime(mpi *X, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Miller-Rabin primality test.
MPI structure.
Definition: bignum.h:168
int mpi_write_file(const char *p, const mpi *X, int radix, FILE *fout)
Write X into an opened file, or stdout if fout is NULL.
void mpi_init(mpi *X)
Initialize one MPI.
int mpi_cmp_mpi(const mpi *X, const mpi *Y)
Compare signed values.
unsigned long long t_udbl
Definition: bignum.h:152
int mpi_shift_r(mpi *X, size_t count)
Right-shift: X &gt;&gt;= count.
int mpi_add_mpi(mpi *X, const mpi *A, const mpi *B)
Signed addition: X = A + B.
asn1_buf val
The named value.
Definition: asn1.h:151
int mpi_write_string(const mpi *X, int radix, char *s, size_t *slen)
Export into an ASCII string.
int32_t t_sint
Definition: bignum.h:145
size_t mpi_lsb(const mpi *X)
Return the number of zero-bits before the least significant &#39;1&#39; bit.
int mpi_inv_mod(mpi *X, const mpi *A, const mpi *N)
Modular inverse: X = A^-1 mod N.
void mpi_free(mpi *X)
Unallocate one MPI.
int mpi_mul_int(mpi *X, const mpi *A, t_sint b)
Baseline multiplication: X = A * b Note: b is an unsigned integer type, thus Negative values of b are...
int mpi_grow(mpi *X, size_t nblimbs)
Enlarge to the specified number of limbs.
int mpi_mod_int(t_uint *r, const mpi *A, t_sint b)
Modulo: r = A mod b.
int mpi_exp_mod(mpi *X, const mpi *A, const mpi *E, const mpi *N, mpi *_RR)
Sliding-window exponentiation: X = A^E mod N.
int mpi_gen_prime(mpi *X, size_t nbits, int dh_flag, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Prime number generation.
size_t mpi_msb(const mpi *X)
Return the number of bits up to and including the most significant &#39;1&#39; bit&#39;.
int mpi_add_abs(mpi *X, const mpi *A, const mpi *B)
Unsigned addition: X = |A| + |B|.
int mpi_read_string(mpi *X, int radix, const char *s)
Import from an ASCII string.
t_uint * p
Definition: bignum.h:172
int mpi_read_binary(mpi *X, const unsigned char *buf, size_t buflen)
Import X from unsigned binary data, big endian.
int mpi_self_test(int verbose)
Checkup routine.
size_t mpi_size(const mpi *X)
Return the total size in bytes.
int mpi_copy(mpi *X, const mpi *Y)
Copy the contents of Y into X.
size_t n
Definition: bignum.h:171
int mpi_mod_mpi(mpi *R, const mpi *A, const mpi *B)
Modulo: R = A mod B.
int mpi_get_bit(const mpi *X, size_t pos)
Get a specific bit from X.
int mpi_write_binary(const mpi *X, unsigned char *buf, size_t buflen)
Export X into unsigned binary data, big endian.
int mpi_shift_l(mpi *X, size_t count)
Left-shift: X &lt;&lt;= count.
int mpi_mul_mpi(mpi *X, const mpi *A, const mpi *B)
Baseline multiplication: X = A * B.
int mpi_sub_mpi(mpi *X, const mpi *A, const mpi *B)
Signed substraction: X = A - B.
int mpi_set_bit(mpi *X, size_t pos, unsigned char val)
Set a bit of X to a specific value of 0 or 1.
int mpi_sub_int(mpi *X, const mpi *A, t_sint b)
Signed substraction: X = A - b.