mbed TLS v3.1.0
bignum.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
8  * SPDX-License-Identifier: Apache-2.0
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License"); you may
11  * not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  */
22 #ifndef MBEDTLS_BIGNUM_H
23 #define MBEDTLS_BIGNUM_H
24 #include "mbedtls/private_access.h"
25 
26 #include "mbedtls/build_info.h"
27 
28 #include <stddef.h>
29 #include <stdint.h>
30 
31 #if defined(MBEDTLS_FS_IO)
32 #include <stdio.h>
33 #endif
34 
36 #define MBEDTLS_ERR_MPI_FILE_IO_ERROR -0x0002
37 
38 #define MBEDTLS_ERR_MPI_BAD_INPUT_DATA -0x0004
39 
40 #define MBEDTLS_ERR_MPI_INVALID_CHARACTER -0x0006
41 
42 #define MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL -0x0008
43 
44 #define MBEDTLS_ERR_MPI_NEGATIVE_VALUE -0x000A
45 
46 #define MBEDTLS_ERR_MPI_DIVISION_BY_ZERO -0x000C
47 
48 #define MBEDTLS_ERR_MPI_NOT_ACCEPTABLE -0x000E
49 
50 #define MBEDTLS_ERR_MPI_ALLOC_FAILED -0x0010
51 
52 #define MBEDTLS_MPI_CHK(f) \
53  do \
54  { \
55  if( ( ret = (f) ) != 0 ) \
56  goto cleanup; \
57  } while( 0 )
58 
59 /*
60  * Maximum size MPIs are allowed to grow to in number of limbs.
61  */
62 #define MBEDTLS_MPI_MAX_LIMBS 10000
63 
64 #if !defined(MBEDTLS_MPI_WINDOW_SIZE)
65 /*
66  * Maximum window size used for modular exponentiation. Default: 6
67  * Minimum value: 1. Maximum value: 6.
68  *
69  * Result is an array of ( 2 ** MBEDTLS_MPI_WINDOW_SIZE ) MPIs used
70  * for the sliding window calculation. (So 64 by default)
71  *
72  * Reduction in size, reduces speed.
73  */
74 #define MBEDTLS_MPI_WINDOW_SIZE 6
75 #endif /* !MBEDTLS_MPI_WINDOW_SIZE */
76 
77 #if !defined(MBEDTLS_MPI_MAX_SIZE)
78 /*
79  * Maximum size of MPIs allowed in bits and bytes for user-MPIs.
80  * ( Default: 512 bytes => 4096 bits, Maximum tested: 2048 bytes => 16384 bits )
81  *
82  * Note: Calculations can temporarily result in larger MPIs. So the number
83  * of limbs required (MBEDTLS_MPI_MAX_LIMBS) is higher.
84  */
85 #define MBEDTLS_MPI_MAX_SIZE 1024
86 #endif /* !MBEDTLS_MPI_MAX_SIZE */
87 
88 #define MBEDTLS_MPI_MAX_BITS ( 8 * MBEDTLS_MPI_MAX_SIZE )
90 /*
91  * When reading from files with mbedtls_mpi_read_file() and writing to files with
92  * mbedtls_mpi_write_file() the buffer should have space
93  * for a (short) label, the MPI (in the provided radix), the newline
94  * characters and the '\0'.
95  *
96  * By default we assume at least a 10 char label, a minimum radix of 10
97  * (decimal) and a maximum of 4096 bit numbers (1234 decimal chars).
98  * Autosized at compile time for at least a 10 char label, a minimum radix
99  * of 10 (decimal) for a number of MBEDTLS_MPI_MAX_BITS size.
100  *
101  * This used to be statically sized to 1250 for a maximum of 4096 bit
102  * numbers (1234 decimal chars).
103  *
104  * Calculate using the formula:
105  * MBEDTLS_MPI_RW_BUFFER_SIZE = ceil(MBEDTLS_MPI_MAX_BITS / ln(10) * ln(2)) +
106  * LabelSize + 6
107  */
108 #define MBEDTLS_MPI_MAX_BITS_SCALE100 ( 100 * MBEDTLS_MPI_MAX_BITS )
109 #define MBEDTLS_LN_2_DIV_LN_10_SCALE100 332
110 #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 )
111 
112 /*
113  * Define the base integer type, architecture-wise.
114  *
115  * 32 or 64-bit integer types can be forced regardless of the underlying
116  * architecture by defining MBEDTLS_HAVE_INT32 or MBEDTLS_HAVE_INT64
117  * respectively and undefining MBEDTLS_HAVE_ASM.
118  *
119  * Double-width integers (e.g. 128-bit in 64-bit architectures) can be
120  * disabled by defining MBEDTLS_NO_UDBL_DIVISION.
121  */
122 #if !defined(MBEDTLS_HAVE_INT32)
123  #if defined(_MSC_VER) && defined(_M_AMD64)
124  /* Always choose 64-bit when using MSC */
125  #if !defined(MBEDTLS_HAVE_INT64)
126  #define MBEDTLS_HAVE_INT64
127  #endif /* !MBEDTLS_HAVE_INT64 */
128  typedef int64_t mbedtls_mpi_sint;
129  typedef uint64_t mbedtls_mpi_uint;
130  #elif defined(__GNUC__) && ( \
131  defined(__amd64__) || defined(__x86_64__) || \
132  defined(__ppc64__) || defined(__powerpc64__) || \
133  defined(__ia64__) || defined(__alpha__) || \
134  ( defined(__sparc__) && defined(__arch64__) ) || \
135  defined(__s390x__) || defined(__mips64) || \
136  defined(__aarch64__) )
137  #if !defined(MBEDTLS_HAVE_INT64)
138  #define MBEDTLS_HAVE_INT64
139  #endif /* MBEDTLS_HAVE_INT64 */
140  typedef int64_t mbedtls_mpi_sint;
141  typedef uint64_t mbedtls_mpi_uint;
142  #if !defined(MBEDTLS_NO_UDBL_DIVISION)
143  /* mbedtls_t_udbl defined as 128-bit unsigned int */
144  typedef unsigned int mbedtls_t_udbl __attribute__((mode(TI)));
145  #define MBEDTLS_HAVE_UDBL
146  #endif /* !MBEDTLS_NO_UDBL_DIVISION */
147  #elif defined(__ARMCC_VERSION) && defined(__aarch64__)
148  /*
149  * __ARMCC_VERSION is defined for both armcc and armclang and
150  * __aarch64__ is only defined by armclang when compiling 64-bit code
151  */
152  #if !defined(MBEDTLS_HAVE_INT64)
153  #define MBEDTLS_HAVE_INT64
154  #endif /* !MBEDTLS_HAVE_INT64 */
155  typedef int64_t mbedtls_mpi_sint;
156  typedef uint64_t mbedtls_mpi_uint;
157  #if !defined(MBEDTLS_NO_UDBL_DIVISION)
158  /* mbedtls_t_udbl defined as 128-bit unsigned int */
159  typedef __uint128_t mbedtls_t_udbl;
160  #define MBEDTLS_HAVE_UDBL
161  #endif /* !MBEDTLS_NO_UDBL_DIVISION */
162  #elif defined(MBEDTLS_HAVE_INT64)
163  /* Force 64-bit integers with unknown compiler */
164  typedef int64_t mbedtls_mpi_sint;
165  typedef uint64_t mbedtls_mpi_uint;
166  #endif
167 #endif /* !MBEDTLS_HAVE_INT32 */
168 
169 #if !defined(MBEDTLS_HAVE_INT64)
170  /* Default to 32-bit compilation */
171  #if !defined(MBEDTLS_HAVE_INT32)
172  #define MBEDTLS_HAVE_INT32
173  #endif /* !MBEDTLS_HAVE_INT32 */
174  typedef int32_t mbedtls_mpi_sint;
175  typedef uint32_t mbedtls_mpi_uint;
176  #if !defined(MBEDTLS_NO_UDBL_DIVISION)
177  typedef uint64_t mbedtls_t_udbl;
178  #define MBEDTLS_HAVE_UDBL
179  #endif /* !MBEDTLS_NO_UDBL_DIVISION */
180 #endif /* !MBEDTLS_HAVE_INT64 */
181 
182 #ifdef __cplusplus
183 extern "C" {
184 #endif
185 
189 typedef struct mbedtls_mpi
190 {
192  size_t MBEDTLS_PRIVATE(n);
193  mbedtls_mpi_uint *MBEDTLS_PRIVATE(p);
194 }
196 
205 void mbedtls_mpi_init( mbedtls_mpi *X );
206 
214 void mbedtls_mpi_free( mbedtls_mpi *X );
215 
229 int mbedtls_mpi_grow( mbedtls_mpi *X, size_t nblimbs );
230 
246 int mbedtls_mpi_shrink( mbedtls_mpi *X, size_t nblimbs );
247 
261 int mbedtls_mpi_copy( mbedtls_mpi *X, const mbedtls_mpi *Y );
262 
270 
295 int mbedtls_mpi_safe_cond_assign( mbedtls_mpi *X, const mbedtls_mpi *Y, unsigned char assign );
296 
320 int mbedtls_mpi_safe_cond_swap( mbedtls_mpi *X, mbedtls_mpi *Y, unsigned char assign );
321 
332 int mbedtls_mpi_lset( mbedtls_mpi *X, mbedtls_mpi_sint z );
333 
344 int mbedtls_mpi_get_bit( const mbedtls_mpi *X, size_t pos );
345 
361 int mbedtls_mpi_set_bit( mbedtls_mpi *X, size_t pos, unsigned char val );
362 
375 size_t mbedtls_mpi_lsb( const mbedtls_mpi *X );
376 
389 size_t mbedtls_mpi_bitlen( const mbedtls_mpi *X );
390 
404 size_t mbedtls_mpi_size( const mbedtls_mpi *X );
405 
416 int mbedtls_mpi_read_string( mbedtls_mpi *X, int radix, const char *s );
417 
440 int mbedtls_mpi_write_string( const mbedtls_mpi *X, int radix,
441  char *buf, size_t buflen, size_t *olen );
442 
443 #if defined(MBEDTLS_FS_IO)
444 
465 int mbedtls_mpi_read_file( mbedtls_mpi *X, int radix, FILE *fin );
466 
482 int mbedtls_mpi_write_file( const char *p, const mbedtls_mpi *X,
483  int radix, FILE *fout );
484 #endif /* MBEDTLS_FS_IO */
485 
498 int mbedtls_mpi_read_binary( mbedtls_mpi *X, const unsigned char *buf,
499  size_t buflen );
500 
514  const unsigned char *buf, size_t buflen );
515 
531 int mbedtls_mpi_write_binary( const mbedtls_mpi *X, unsigned char *buf,
532  size_t buflen );
533 
550  unsigned char *buf, size_t buflen );
551 
562 int mbedtls_mpi_shift_l( mbedtls_mpi *X, size_t count );
563 
574 int mbedtls_mpi_shift_r( mbedtls_mpi *X, size_t count );
575 
586 int mbedtls_mpi_cmp_abs( const mbedtls_mpi *X, const mbedtls_mpi *Y );
587 
598 int mbedtls_mpi_cmp_mpi( const mbedtls_mpi *X, const mbedtls_mpi *Y );
599 
615 int mbedtls_mpi_lt_mpi_ct( const mbedtls_mpi *X, const mbedtls_mpi *Y,
616  unsigned *ret );
617 
628 int mbedtls_mpi_cmp_int( const mbedtls_mpi *X, mbedtls_mpi_sint z );
629 
642  const mbedtls_mpi *B );
643 
657  const mbedtls_mpi *B );
658 
671  const mbedtls_mpi *B );
672 
685  const mbedtls_mpi *B );
686 
699  mbedtls_mpi_sint b );
700 
714  mbedtls_mpi_sint b );
715 
729  const mbedtls_mpi *B );
730 
745  mbedtls_mpi_uint b );
746 
766  const mbedtls_mpi *B );
767 
787  mbedtls_mpi_sint b );
788 
807  const mbedtls_mpi *B );
808 
825 int mbedtls_mpi_mod_int( mbedtls_mpi_uint *r, const mbedtls_mpi *A,
826  mbedtls_mpi_sint b );
827 
855  const mbedtls_mpi *E, const mbedtls_mpi *N,
856  mbedtls_mpi *prec_RR );
857 
875 int mbedtls_mpi_fill_random( mbedtls_mpi *X, size_t size,
876  int (*f_rng)(void *, unsigned char *, size_t),
877  void *p_rng );
878 
912  mbedtls_mpi_sint min,
913  const mbedtls_mpi *N,
914  int (*f_rng)(void *, unsigned char *, size_t),
915  void *p_rng );
916 
928 int mbedtls_mpi_gcd( mbedtls_mpi *G, const mbedtls_mpi *A,
929  const mbedtls_mpi *B );
930 
948  const mbedtls_mpi *N );
949 
977 int mbedtls_mpi_is_prime_ext( const mbedtls_mpi *X, int rounds,
978  int (*f_rng)(void *, unsigned char *, size_t),
979  void *p_rng );
986 typedef enum {
990 
1010 int mbedtls_mpi_gen_prime( mbedtls_mpi *X, size_t nbits, int flags,
1011  int (*f_rng)(void *, unsigned char *, size_t),
1012  void *p_rng );
1013 
1014 #if defined(MBEDTLS_SELF_TEST)
1015 
1021 int mbedtls_mpi_self_test( int verbose );
1022 
1023 #endif /* MBEDTLS_SELF_TEST */
1024 
1025 #ifdef __cplusplus
1026 }
1027 #endif
1028 
1029 #endif /* bignum.h */
int mbedtls_mpi_div_mpi(mbedtls_mpi *Q, mbedtls_mpi *R, const mbedtls_mpi *A, const mbedtls_mpi *B)
Perform a division with remainder of two MPIs: A = Q * B + R.
void mbedtls_mpi_free(mbedtls_mpi *X)
This function frees the components of an MPI context.
int mbedtls_mpi_gcd(mbedtls_mpi *G, const mbedtls_mpi *A, const mbedtls_mpi *B)
Compute the 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 with a number of random bytes.
int mbedtls_mpi_is_prime_ext(const mbedtls_mpi *X, int rounds, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Miller-Rabin primality test.
int mbedtls_mpi_sub_int(mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b)
Perform a signed subtraction of an MPI and an integer: X = A - b.
size_t mbedtls_mpi_lsb(const mbedtls_mpi *X)
Return the number of bits of value 0 before the least significant bit of value 1. ...
int mbedtls_mpi_grow(mbedtls_mpi *X, size_t nblimbs)
Enlarge an MPI to the specified number of limbs.
int mbedtls_mpi_safe_cond_assign(mbedtls_mpi *X, const mbedtls_mpi *Y, unsigned char assign)
Perform a safe conditional copy of MPI which doesn't reveal whether the condition was true or not...
int mbedtls_mpi_mod_mpi(mbedtls_mpi *R, const mbedtls_mpi *A, const mbedtls_mpi *B)
Perform a modular reduction. R = A mod B.
int32_t mbedtls_mpi_sint
Definition: bignum.h:174
size_t mbedtls_mpi_bitlen(const mbedtls_mpi *X)
Return the number of bits up to and including the most significant bit of value 1.
int mbedtls_mpi_cmp_mpi(const mbedtls_mpi *X, const mbedtls_mpi *Y)
Compare two MPIs.
size_t mbedtls_mpi_size(const mbedtls_mpi *X)
Return the total size of an MPI value in bytes.
int mbedtls_mpi_sub_mpi(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B)
Perform a signed subtraction of MPIs: X = A - B.
#define MBEDTLS_PRIVATE(member)
int mbedtls_mpi_sub_abs(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B)
Perform an unsigned subtraction of MPIs: X = |A| - |B|.
int mbedtls_mpi_read_string(mbedtls_mpi *X, int radix, const char *s)
Import an MPI from an ASCII string.
int mbedtls_mpi_random(mbedtls_mpi *X, mbedtls_mpi_sint min, const mbedtls_mpi *N, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
int mbedtls_mpi_set_bit(mbedtls_mpi *X, size_t pos, unsigned char val)
Modify a specific bit in an MPI.
int mbedtls_mpi_lset(mbedtls_mpi *X, mbedtls_mpi_sint z)
Store integer value in MPI.
int mbedtls_mpi_div_int(mbedtls_mpi *Q, mbedtls_mpi *R, const mbedtls_mpi *A, mbedtls_mpi_sint b)
Perform a division with remainder of an MPI by an integer: A = Q * b + R.
int mbedtls_mpi_read_binary(mbedtls_mpi *X, const unsigned char *buf, size_t buflen)
Import an MPI from unsigned big endian binary data.
int mbedtls_mpi_shrink(mbedtls_mpi *X, size_t nblimbs)
This function resizes an MPI downwards, keeping at least the specified number of limbs.
int mbedtls_mpi_lt_mpi_ct(const mbedtls_mpi *X, const mbedtls_mpi *Y, unsigned *ret)
Check if an MPI is less than the other in constant time.
int mbedtls_mpi_read_binary_le(mbedtls_mpi *X, const unsigned char *buf, size_t buflen)
Import X from unsigned binary data, little endian.
int mbedtls_mpi_add_int(mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b)
Perform a signed addition of an MPI and an integer: X = A + b.
int mbedtls_mpi_shift_r(mbedtls_mpi *X, size_t count)
Perform a right-shift on an MPI: X >>= count.
int mbedtls_mpi_write_binary_le(const mbedtls_mpi *X, unsigned char *buf, size_t buflen)
Export X into unsigned binary data, little endian. Always fills the whole buffer, which will end with...
int mbedtls_mpi_mod_int(mbedtls_mpi_uint *r, const mbedtls_mpi *A, mbedtls_mpi_sint b)
Perform a modular reduction with respect to an integer. r = A mod b.
int mbedtls_mpi_shift_l(mbedtls_mpi *X, size_t count)
Perform a left-shift on an MPI: X <<= count.
Macro wrapper for struct's memebrs.
int mbedtls_mpi_mul_int(mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_uint b)
Perform a multiplication of an MPI with an unsigned integer: X = A * b.
uint32_t mbedtls_mpi_uint
Definition: bignum.h:175
int mbedtls_mpi_self_test(int verbose)
Checkup routine.
int mbedtls_mpi_safe_cond_swap(mbedtls_mpi *X, mbedtls_mpi *Y, unsigned char assign)
Perform a safe conditional swap which doesn't reveal whether the condition was true or not...
void mbedtls_mpi_init(mbedtls_mpi *X)
Initialize an MPI context.
Build-time configuration info.
void mbedtls_mpi_swap(mbedtls_mpi *X, mbedtls_mpi *Y)
Swap the contents of two MPIs.
int mbedtls_mpi_add_mpi(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B)
Perform a signed addition of MPIs: X = A + B.
int mbedtls_mpi_inv_mod(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *N)
Compute the modular inverse: X = A^-1 mod N.
MPI structure.
Definition: bignum.h:189
int mbedtls_mpi_copy(mbedtls_mpi *X, const mbedtls_mpi *Y)
Make a copy of an MPI.
int mbedtls_mpi_write_string(const mbedtls_mpi *X, int radix, char *buf, size_t buflen, size_t *olen)
Export an MPI to an ASCII string.
int mbedtls_mpi_read_file(mbedtls_mpi *X, int radix, FILE *fin)
Read an MPI from a line in an opened file.
int mbedtls_mpi_write_file(const char *p, const mbedtls_mpi *X, int radix, FILE *fout)
Export an MPI into an opened file.
int mbedtls_mpi_add_abs(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B)
Perform an unsigned addition of MPIs: X = |A| + |B|.
int mbedtls_mpi_exp_mod(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *E, const mbedtls_mpi *N, mbedtls_mpi *prec_RR)
Perform a sliding-window exponentiation: X = A^E mod N.
int mbedtls_mpi_cmp_abs(const mbedtls_mpi *X, const mbedtls_mpi *Y)
Compare the absolute values of two MPIs.
int mbedtls_mpi_write_binary(const mbedtls_mpi *X, unsigned char *buf, size_t buflen)
Export X into unsigned binary data, big endian. Always fills the whole buffer, which will start with ...
mbedtls_mpi_gen_prime_flag_t
Flags for mbedtls_mpi_gen_prime()
Definition: bignum.h:986
int mbedtls_mpi_mul_mpi(mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B)
Perform a multiplication of two MPIs: X = A * B.
int mbedtls_mpi_cmp_int(const mbedtls_mpi *X, mbedtls_mpi_sint z)
Compare an MPI with an integer.
int mbedtls_mpi_get_bit(const mbedtls_mpi *X, size_t pos)
Get a specific bit from an MPI.
struct mbedtls_mpi mbedtls_mpi
MPI structure.
int mbedtls_mpi_gen_prime(mbedtls_mpi *X, size_t nbits, int flags, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Generate a prime number.