mbed TLS v2.3.0
bignum.h
Go to the documentation of this file.
1 
25 #ifndef MBEDTLS_BIGNUM_H
26 #define MBEDTLS_BIGNUM_H
27 
28 #if !defined(MBEDTLS_CONFIG_FILE)
29 #include "config.h"
30 #else
31 #include MBEDTLS_CONFIG_FILE
32 #endif
33 
34 #include <stddef.h>
35 #include <stdint.h>
36 
37 #if defined(MBEDTLS_FS_IO)
38 #include <stdio.h>
39 #endif
40 
41 #define MBEDTLS_ERR_MPI_FILE_IO_ERROR -0x0002
42 #define MBEDTLS_ERR_MPI_BAD_INPUT_DATA -0x0004
43 #define MBEDTLS_ERR_MPI_INVALID_CHARACTER -0x0006
44 #define MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL -0x0008
45 #define MBEDTLS_ERR_MPI_NEGATIVE_VALUE -0x000A
46 #define MBEDTLS_ERR_MPI_DIVISION_BY_ZERO -0x000C
47 #define MBEDTLS_ERR_MPI_NOT_ACCEPTABLE -0x000E
48 #define MBEDTLS_ERR_MPI_ALLOC_FAILED -0x0010
50 #define MBEDTLS_MPI_CHK(f) do { if( ( ret = f ) != 0 ) goto cleanup; } while( 0 )
51 
52 /*
53  * Maximum size MPIs are allowed to grow to in number of limbs.
54  */
55 #define MBEDTLS_MPI_MAX_LIMBS 10000
56 
57 #if !defined(MBEDTLS_MPI_WINDOW_SIZE)
58 /*
59  * Maximum window size used for modular exponentiation. Default: 6
60  * Minimum value: 1. Maximum value: 6.
61  *
62  * Result is an array of ( 2 << MBEDTLS_MPI_WINDOW_SIZE ) MPIs used
63  * for the sliding window calculation. (So 64 by default)
64  *
65  * Reduction in size, reduces speed.
66  */
67 #define MBEDTLS_MPI_WINDOW_SIZE 6
68 #endif /* !MBEDTLS_MPI_WINDOW_SIZE */
69 
70 #if !defined(MBEDTLS_MPI_MAX_SIZE)
71 /*
72  * Maximum size of MPIs allowed in bits and bytes for user-MPIs.
73  * ( Default: 512 bytes => 4096 bits, Maximum tested: 2048 bytes => 16384 bits )
74  *
75  * Note: Calculations can results temporarily in larger MPIs. So the number
76  * of limbs required (MBEDTLS_MPI_MAX_LIMBS) is higher.
77  */
78 #define MBEDTLS_MPI_MAX_SIZE 1024
79 #endif /* !MBEDTLS_MPI_MAX_SIZE */
80 
81 #define MBEDTLS_MPI_MAX_BITS ( 8 * MBEDTLS_MPI_MAX_SIZE )
83 /*
84  * When reading from files with mbedtls_mpi_read_file() and writing to files with
85  * mbedtls_mpi_write_file() the buffer should have space
86  * for a (short) label, the MPI (in the provided radix), the newline
87  * characters and the '\0'.
88  *
89  * By default we assume at least a 10 char label, a minimum radix of 10
90  * (decimal) and a maximum of 4096 bit numbers (1234 decimal chars).
91  * Autosized at compile time for at least a 10 char label, a minimum radix
92  * of 10 (decimal) for a number of MBEDTLS_MPI_MAX_BITS size.
93  *
94  * This used to be statically sized to 1250 for a maximum of 4096 bit
95  * numbers (1234 decimal chars).
96  *
97  * Calculate using the formula:
98  * MBEDTLS_MPI_RW_BUFFER_SIZE = ceil(MBEDTLS_MPI_MAX_BITS / ln(10) * ln(2)) +
99  * LabelSize + 6
100  */
101 #define MBEDTLS_MPI_MAX_BITS_SCALE100 ( 100 * MBEDTLS_MPI_MAX_BITS )
102 #define MBEDTLS_LN_2_DIV_LN_10_SCALE100 332
103 #define MBEDTLS_MPI_RW_BUFFER_SIZE ( ((MBEDTLS_MPI_MAX_BITS_SCALE100 + MBEDTLS_LN_2_DIV_LN_10_SCALE100 - 1) / MBEDTLS_LN_2_DIV_LN_10_SCALE100) + 10 + 6 )
104 
105 /*
106  * Define the base integer type, architecture-wise.
107  *
108  * 32-bit integers can be forced on 64-bit arches (eg. for testing purposes)
109  * by defining MBEDTLS_HAVE_INT32 and undefining MBEDTLS_HAVE_ASM
110  */
111 #if ( ! defined(MBEDTLS_HAVE_INT32) && \
112  defined(_MSC_VER) && defined(_M_AMD64) )
113  #define MBEDTLS_HAVE_INT64
114  typedef int64_t mbedtls_mpi_sint;
115  typedef uint64_t mbedtls_mpi_uint;
116 #else
117  #if ( ! defined(MBEDTLS_HAVE_INT32) && \
118  defined(__GNUC__) && ( \
119  defined(__amd64__) || defined(__x86_64__) || \
120  defined(__ppc64__) || defined(__powerpc64__) || \
121  defined(__ia64__) || defined(__alpha__) || \
122  (defined(__sparc__) && defined(__arch64__)) || \
123  defined(__s390x__) || defined(__mips64) ) )
124  #define MBEDTLS_HAVE_INT64
125  typedef int64_t mbedtls_mpi_sint;
126  typedef uint64_t mbedtls_mpi_uint;
127  /* mbedtls_t_udbl defined as 128-bit unsigned int */
128  typedef unsigned int mbedtls_t_udbl __attribute__((mode(TI)));
129  #define MBEDTLS_HAVE_UDBL
130  #else
131  #define MBEDTLS_HAVE_INT32
132  typedef int32_t mbedtls_mpi_sint;
133  typedef uint32_t mbedtls_mpi_uint;
134  typedef uint64_t mbedtls_t_udbl;
135  #define MBEDTLS_HAVE_UDBL
136  #endif /* !MBEDTLS_HAVE_INT32 && __GNUC__ && 64-bit platform */
137 #endif /* !MBEDTLS_HAVE_INT32 && _MSC_VER && _M_AMD64 */
138 
139 #ifdef __cplusplus
140 extern "C" {
141 #endif
142 
146 typedef struct
147 {
148  int s;
149  size_t n;
150  mbedtls_mpi_uint *p;
151 }
153 
161 void mbedtls_mpi_init( mbedtls_mpi *X );
162 
168 void mbedtls_mpi_free( mbedtls_mpi *X );
169 
179 int mbedtls_mpi_grow( mbedtls_mpi *X, size_t nblimbs );
180 
190 int mbedtls_mpi_shrink( mbedtls_mpi *X, size_t nblimbs );
191 
201 int mbedtls_mpi_copy( mbedtls_mpi *X, const mbedtls_mpi *Y );
202 
210 
228 int mbedtls_mpi_safe_cond_assign( mbedtls_mpi *X, const mbedtls_mpi *Y, unsigned char assign );
229 
247 int mbedtls_mpi_safe_cond_swap( mbedtls_mpi *X, mbedtls_mpi *Y, unsigned char assign );
248 
258 int mbedtls_mpi_lset( mbedtls_mpi *X, mbedtls_mpi_sint z );
259 
268 int mbedtls_mpi_get_bit( const mbedtls_mpi *X, size_t pos );
269 
284 int mbedtls_mpi_set_bit( mbedtls_mpi *X, size_t pos, unsigned char val );
285 
294 size_t mbedtls_mpi_lsb( const mbedtls_mpi *X );
295 
304 size_t mbedtls_mpi_bitlen( const mbedtls_mpi *X );
305 
311 size_t mbedtls_mpi_size( const mbedtls_mpi *X );
312 
322 int mbedtls_mpi_read_string( mbedtls_mpi *X, int radix, const char *s );
323 
340 int mbedtls_mpi_write_string( const mbedtls_mpi *X, int radix,
341  char *buf, size_t buflen, size_t *olen );
342 
343 #if defined(MBEDTLS_FS_IO)
344 
355 int mbedtls_mpi_read_file( mbedtls_mpi *X, int radix, FILE *fin );
356 
369 int mbedtls_mpi_write_file( const char *p, const mbedtls_mpi *X, int radix, FILE *fout );
370 #endif /* MBEDTLS_FS_IO */
371 
382 int mbedtls_mpi_read_binary( mbedtls_mpi *X, const unsigned char *buf, size_t buflen );
383 
396 int mbedtls_mpi_write_binary( const mbedtls_mpi *X, unsigned char *buf, size_t buflen );
397 
407 int mbedtls_mpi_shift_l( mbedtls_mpi *X, size_t count );
408 
418 int mbedtls_mpi_shift_r( mbedtls_mpi *X, size_t count );
419 
430 int mbedtls_mpi_cmp_abs( const mbedtls_mpi *X, const mbedtls_mpi *Y );
431 
442 int mbedtls_mpi_cmp_mpi( const mbedtls_mpi *X, const mbedtls_mpi *Y );
443 
454 int mbedtls_mpi_cmp_int( const mbedtls_mpi *X, mbedtls_mpi_sint z );
455 
466 int mbedtls_mpi_add_abs( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B );
467 
478 int mbedtls_mpi_sub_abs( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B );
479 
490 int mbedtls_mpi_add_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B );
491 
502 int mbedtls_mpi_sub_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B );
503 
514 int mbedtls_mpi_add_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b );
515 
526 int mbedtls_mpi_sub_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b );
527 
538 int mbedtls_mpi_mul_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B );
539 
552 int mbedtls_mpi_mul_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_uint b );
553 
568 int mbedtls_mpi_div_mpi( mbedtls_mpi *Q, mbedtls_mpi *R, const mbedtls_mpi *A, const mbedtls_mpi *B );
569 
584 int mbedtls_mpi_div_int( mbedtls_mpi *Q, mbedtls_mpi *R, const mbedtls_mpi *A, mbedtls_mpi_sint b );
585 
598 int mbedtls_mpi_mod_mpi( mbedtls_mpi *R, const mbedtls_mpi *A, const mbedtls_mpi *B );
599 
612 int mbedtls_mpi_mod_int( mbedtls_mpi_uint *r, const mbedtls_mpi *A, mbedtls_mpi_sint b );
613 
632 int mbedtls_mpi_exp_mod( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *E, const mbedtls_mpi *N, mbedtls_mpi *_RR );
633 
645 int mbedtls_mpi_fill_random( mbedtls_mpi *X, size_t size,
646  int (*f_rng)(void *, unsigned char *, size_t),
647  void *p_rng );
648 
659 int mbedtls_mpi_gcd( mbedtls_mpi *G, const mbedtls_mpi *A, const mbedtls_mpi *B );
660 
673 int mbedtls_mpi_inv_mod( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *N );
674 
686 int mbedtls_mpi_is_prime( const mbedtls_mpi *X,
687  int (*f_rng)(void *, unsigned char *, size_t),
688  void *p_rng );
689 
704 int mbedtls_mpi_gen_prime( mbedtls_mpi *X, size_t nbits, int dh_flag,
705  int (*f_rng)(void *, unsigned char *, size_t),
706  void *p_rng );
707 
713 int mbedtls_mpi_self_test( int verbose );
714 
715 #ifdef __cplusplus
716 }
717 #endif
718 
719 #endif /* bignum.h */
int mbedtls_mpi_div_mpi(mbedtls_mpi *Q, mbedtls_mpi *R, const mbedtls_mpi *A, const mbedtls_mpi *B)
Division by mbedtls_mpi: A = Q * B + R.
void mbedtls_mpi_free(mbedtls_mpi *X)
Unallocate one MPI.
int mbedtls_mpi_gcd(mbedtls_mpi *G, const mbedtls_mpi *A, const mbedtls_mpi *B)
Greatest common divisor: G = gcd(A, B)
int mbedtls_mpi_fill_random(mbedtls_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 mbedtls_mpi_sub_int(mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b)
Signed subtraction: X = A - b.
size_t mbedtls_mpi_lsb(const mbedtls_mpi *X)
Return the number of zero-bits before the least significant '1' bit.
int mbedtls_mpi_grow(mbedtls_mpi *X, size_t nblimbs)
Enlarge to the specified number of limbs.
int mbedtls_mpi_safe_cond_assign(mbedtls_mpi *X, const mbedtls_mpi *Y, unsigned char assign)
Safe conditional assignement X = Y if assign is 1.
int mbedtls_mpi_mod_mpi(mbedtls_mpi *R, const mbedtls_mpi *A, const mbedtls_mpi *B)
Modulo: R = A mod B.
int mbedtls_mpi_exp_mod(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *E, const mbedtls_mpi *N, mbedtls_mpi *_RR)
Sliding-window exponentiation: X = A^E mod N.
int32_t mbedtls_mpi_sint
Definition: bignum.h:132
size_t mbedtls_mpi_bitlen(const mbedtls_mpi *X)
Return the number of bits up to and including the most significant '1' bit'.
int mbedtls_mpi_cmp_mpi(const mbedtls_mpi *X, const mbedtls_mpi *Y)
Compare signed values.
size_t mbedtls_mpi_size(const mbedtls_mpi *X)
Return the total size in bytes.
int mbedtls_mpi_sub_mpi(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B)
Signed subtraction: X = A - B.
int mbedtls_mpi_sub_abs(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B)
Unsigned subtraction: X = |A| - |B|.
Configuration options (set of defines)
int mbedtls_mpi_read_string(mbedtls_mpi *X, int radix, const char *s)
Import from an ASCII string.
uint64_t mbedtls_t_udbl
Definition: bignum.h:134
int mbedtls_mpi_set_bit(mbedtls_mpi *X, size_t pos, unsigned char val)
Set a bit of X to a specific value of 0 or 1.
int mbedtls_mpi_lset(mbedtls_mpi *X, mbedtls_mpi_sint z)
Set value from integer.
int mbedtls_mpi_div_int(mbedtls_mpi *Q, mbedtls_mpi *R, const mbedtls_mpi *A, mbedtls_mpi_sint b)
Division by int: A = Q * b + R.
int mbedtls_mpi_read_binary(mbedtls_mpi *X, const unsigned char *buf, size_t buflen)
Import X from unsigned binary data, big endian.
mbedtls_mpi_uint * p
Definition: bignum.h:150
int mbedtls_mpi_shrink(mbedtls_mpi *X, size_t nblimbs)
Resize down, keeping at least the specified number of limbs.
int mbedtls_mpi_add_int(mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b)
Signed addition: X = A + b.
int mbedtls_mpi_shift_r(mbedtls_mpi *X, size_t count)
Right-shift: X >>= count.
int mbedtls_mpi_gen_prime(mbedtls_mpi *X, size_t nbits, int dh_flag, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Prime number generation.
int mbedtls_mpi_mod_int(mbedtls_mpi_uint *r, const mbedtls_mpi *A, mbedtls_mpi_sint b)
Modulo: r = A mod b.
int mbedtls_mpi_shift_l(mbedtls_mpi *X, size_t count)
Left-shift: X <<= count.
mbedtls_asn1_buf val
The named value.
Definition: asn1.h:155
int mbedtls_mpi_mul_int(mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_uint b)
Baseline multiplication: X = A * b.
int mbedtls_mpi_is_prime(const mbedtls_mpi *X, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Miller-Rabin primality test.
uint32_t mbedtls_mpi_uint
Definition: bignum.h:133
int mbedtls_mpi_self_test(int verbose)
Checkup routine.
int mbedtls_mpi_safe_cond_swap(mbedtls_mpi *X, mbedtls_mpi *Y, unsigned char assign)
Safe conditional swap X <-> Y if swap is 1.
void mbedtls_mpi_init(mbedtls_mpi *X)
Initialize one MPI (make internal references valid) This just makes it ready to be set or freed...
void mbedtls_mpi_swap(mbedtls_mpi *X, mbedtls_mpi *Y)
Swap the contents of X and Y.
int mbedtls_mpi_add_mpi(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B)
Signed addition: X = A + B.
int mbedtls_mpi_inv_mod(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *N)
Modular inverse: X = A^-1 mod N.
MPI structure.
Definition: bignum.h:146
int mbedtls_mpi_copy(mbedtls_mpi *X, const mbedtls_mpi *Y)
Copy the contents of Y into X.
int mbedtls_mpi_write_string(const mbedtls_mpi *X, int radix, char *buf, size_t buflen, size_t *olen)
Export into an ASCII string.
int mbedtls_mpi_read_file(mbedtls_mpi *X, int radix, FILE *fin)
Read X from an opened file.
int mbedtls_mpi_write_file(const char *p, const mbedtls_mpi *X, int radix, FILE *fout)
Write X into an opened file, or stdout if fout is NULL.
size_t n
Definition: bignum.h:149
int mbedtls_mpi_add_abs(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B)
Unsigned addition: X = |A| + |B|.
int mbedtls_mpi_cmp_abs(const mbedtls_mpi *X, const mbedtls_mpi *Y)
Compare unsigned values.
int mbedtls_mpi_write_binary(const mbedtls_mpi *X, unsigned char *buf, size_t buflen)
Export X into unsigned binary data, big endian.
int mbedtls_mpi_mul_mpi(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B)
Baseline multiplication: X = A * B.
int mbedtls_mpi_cmp_int(const mbedtls_mpi *X, mbedtls_mpi_sint z)
Compare signed values.
int mbedtls_mpi_get_bit(const mbedtls_mpi *X, size_t pos)
Get a specific bit from X.