blob: 82e47b7d8c4098bbf161a378faa9efad40c2ce94 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
2 * Multi-precision integer library
3 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
Simon Butcher15b15d12015-11-26 19:35:03 +000019
Paul Bakker5121ce52009-01-03 21:22:43 +000020/*
Simon Butcher15b15d12015-11-26 19:35:03 +000021 * The following sources were referenced in the design of this Multi-precision
22 * Integer library:
Paul Bakker5121ce52009-01-03 21:22:43 +000023 *
Simon Butcher15b15d12015-11-26 19:35:03 +000024 * [1] Handbook of Applied Cryptography - 1997
25 * Menezes, van Oorschot and Vanstone
26 *
27 * [2] Multi-Precision Math
28 * Tom St Denis
29 * https://github.com/libtom/libtommath/blob/develop/tommath.pdf
30 *
31 * [3] GNU Multi-Precision Arithmetic Library
32 * https://gmplib.org/manual/index.html
33 *
Simon Butcherf5ba0452015-12-27 23:01:55 +000034 */
Paul Bakker5121ce52009-01-03 21:22:43 +000035
Gilles Peskinedb09ef62020-06-03 01:43:33 +020036#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#if defined(MBEDTLS_BIGNUM_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/bignum.h"
Janos Follath4614b9a2022-07-21 15:34:47 +010041#include "bignum_core.h"
Chris Jones4c5819c2021-03-03 17:45:34 +000042#include "bn_mul.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050043#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000044#include "mbedtls/error.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020045#include "constant_time_internal.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000046
Dave Rodgman351c71b2021-12-06 17:50:53 +000047#include <limits.h>
Rich Evans00ab4702015-02-06 13:43:58 +000048#include <string.h>
49
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000050#include "mbedtls/platform.h"
Paul Bakker6e339b52013-07-03 13:37:05 +020051
Gabor Mezei66669142022-08-03 12:52:26 +020052#define MPI_VALIDATE_RET( cond ) \
53 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA )
54#define MPI_VALIDATE( cond ) \
55 MBEDTLS_INTERNAL_VALIDATE( cond )
56
Manuel Pégourié-Gonnard2d708342015-10-05 15:23:11 +010057#define MPI_SIZE_T_MAX ( (size_t) -1 ) /* SIZE_T_MAX is not standard */
58
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050059/* Implementation that should never be optimized out by the compiler */
Andres Amaya Garcia6698d2f2018-04-24 08:39:07 -050060static void mbedtls_mpi_zeroize( mbedtls_mpi_uint *v, size_t n )
61{
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050062 mbedtls_platform_zeroize( v, ciL * n );
63}
64
Paul Bakker5121ce52009-01-03 21:22:43 +000065/*
Paul Bakker6c591fa2011-05-05 11:49:20 +000066 * Initialize one MPI
Paul Bakker5121ce52009-01-03 21:22:43 +000067 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020068void mbedtls_mpi_init( mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +000069{
Hanno Becker73d7d792018-12-11 10:35:51 +000070 MPI_VALIDATE( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +000071
Paul Bakker6c591fa2011-05-05 11:49:20 +000072 X->s = 1;
73 X->n = 0;
74 X->p = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +000075}
76
77/*
Paul Bakker6c591fa2011-05-05 11:49:20 +000078 * Unallocate one MPI
Paul Bakker5121ce52009-01-03 21:22:43 +000079 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020080void mbedtls_mpi_free( mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +000081{
Paul Bakker6c591fa2011-05-05 11:49:20 +000082 if( X == NULL )
83 return;
Paul Bakker5121ce52009-01-03 21:22:43 +000084
Paul Bakker6c591fa2011-05-05 11:49:20 +000085 if( X->p != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +000086 {
Alexey Skalozube17a8da2016-01-13 17:19:33 +020087 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020088 mbedtls_free( X->p );
Paul Bakker5121ce52009-01-03 21:22:43 +000089 }
90
Paul Bakker6c591fa2011-05-05 11:49:20 +000091 X->s = 1;
92 X->n = 0;
93 X->p = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +000094}
95
96/*
97 * Enlarge to the specified number of limbs
98 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020099int mbedtls_mpi_grow( mbedtls_mpi *X, size_t nblimbs )
Paul Bakker5121ce52009-01-03 21:22:43 +0000100{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200101 mbedtls_mpi_uint *p;
Hanno Becker73d7d792018-12-11 10:35:51 +0000102 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000103
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200104 if( nblimbs > MBEDTLS_MPI_MAX_LIMBS )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200105 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Paul Bakkerf9688572011-05-05 10:00:45 +0000106
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 if( X->n < nblimbs )
108 {
Simon Butcher29176892016-05-20 00:19:09 +0100109 if( ( p = (mbedtls_mpi_uint*)mbedtls_calloc( nblimbs, ciL ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200110 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Paul Bakker5121ce52009-01-03 21:22:43 +0000111
Paul Bakker5121ce52009-01-03 21:22:43 +0000112 if( X->p != NULL )
113 {
114 memcpy( p, X->p, X->n * ciL );
Alexey Skalozube17a8da2016-01-13 17:19:33 +0200115 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200116 mbedtls_free( X->p );
Paul Bakker5121ce52009-01-03 21:22:43 +0000117 }
118
119 X->n = nblimbs;
120 X->p = p;
121 }
122
123 return( 0 );
124}
125
126/*
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100127 * Resize down as much as possible,
128 * while keeping at least the specified number of limbs
129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200130int mbedtls_mpi_shrink( mbedtls_mpi *X, size_t nblimbs )
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100131{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200132 mbedtls_mpi_uint *p;
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100133 size_t i;
Hanno Becker73d7d792018-12-11 10:35:51 +0000134 MPI_VALIDATE_RET( X != NULL );
135
136 if( nblimbs > MBEDTLS_MPI_MAX_LIMBS )
137 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100138
Gilles Peskinee2f563e2020-01-20 21:17:43 +0100139 /* Actually resize up if there are currently fewer than nblimbs limbs. */
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100140 if( X->n <= nblimbs )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200141 return( mbedtls_mpi_grow( X, nblimbs ) );
Gilles Peskine322752b2020-01-21 13:59:51 +0100142 /* After this point, then X->n > nblimbs and in particular X->n > 0. */
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100143
144 for( i = X->n - 1; i > 0; i-- )
145 if( X->p[i] != 0 )
146 break;
147 i++;
148
149 if( i < nblimbs )
150 i = nblimbs;
151
Simon Butcher29176892016-05-20 00:19:09 +0100152 if( ( p = (mbedtls_mpi_uint*)mbedtls_calloc( i, ciL ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200153 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100154
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100155 if( X->p != NULL )
156 {
157 memcpy( p, X->p, i * ciL );
Alexey Skalozube17a8da2016-01-13 17:19:33 +0200158 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200159 mbedtls_free( X->p );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100160 }
161
162 X->n = i;
163 X->p = p;
164
165 return( 0 );
166}
167
Gilles Peskineed32b572021-06-02 22:17:52 +0200168/* Resize X to have exactly n limbs and set it to 0. */
169static int mbedtls_mpi_resize_clear( mbedtls_mpi *X, size_t limbs )
170{
171 if( limbs == 0 )
172 {
173 mbedtls_mpi_free( X );
174 return( 0 );
175 }
176 else if( X->n == limbs )
177 {
178 memset( X->p, 0, limbs * ciL );
179 X->s = 1;
180 return( 0 );
181 }
182 else
183 {
184 mbedtls_mpi_free( X );
185 return( mbedtls_mpi_grow( X, limbs ) );
186 }
187}
188
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100189/*
Gilles Peskine3da1a8f2021-06-08 23:17:42 +0200190 * Copy the contents of Y into X.
191 *
192 * This function is not constant-time. Leading zeros in Y may be removed.
193 *
194 * Ensure that X does not shrink. This is not guaranteed by the public API,
195 * but some code in the bignum module relies on this property, for example
196 * in mbedtls_mpi_exp_mod().
Paul Bakker5121ce52009-01-03 21:22:43 +0000197 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198int mbedtls_mpi_copy( mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +0000199{
Gilles Peskine4e4be7c2018-03-21 16:29:03 +0100200 int ret = 0;
Paul Bakker23986e52011-04-24 08:57:21 +0000201 size_t i;
Hanno Becker73d7d792018-12-11 10:35:51 +0000202 MPI_VALIDATE_RET( X != NULL );
203 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000204
205 if( X == Y )
206 return( 0 );
207
Gilles Peskinedb420622020-01-20 21:12:50 +0100208 if( Y->n == 0 )
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200209 {
Gilles Peskine3da1a8f2021-06-08 23:17:42 +0200210 if( X->n != 0 )
211 {
212 X->s = 1;
213 memset( X->p, 0, X->n * ciL );
214 }
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200215 return( 0 );
216 }
217
Paul Bakker5121ce52009-01-03 21:22:43 +0000218 for( i = Y->n - 1; i > 0; i-- )
219 if( Y->p[i] != 0 )
220 break;
221 i++;
222
223 X->s = Y->s;
224
Gilles Peskine4e4be7c2018-03-21 16:29:03 +0100225 if( X->n < i )
226 {
227 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, i ) );
228 }
229 else
230 {
231 memset( X->p + i, 0, ( X->n - i ) * ciL );
232 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000233
Paul Bakker5121ce52009-01-03 21:22:43 +0000234 memcpy( X->p, Y->p, i * ciL );
235
236cleanup:
237
238 return( ret );
239}
240
241/*
242 * Swap the contents of X and Y
243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244void mbedtls_mpi_swap( mbedtls_mpi *X, mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +0000245{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000247 MPI_VALIDATE( X != NULL );
248 MPI_VALIDATE( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000249
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200250 memcpy( &T, X, sizeof( mbedtls_mpi ) );
251 memcpy( X, Y, sizeof( mbedtls_mpi ) );
252 memcpy( Y, &T, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000253}
254
Gilles Peskineef7f4e42022-11-15 23:25:27 +0100255static inline mbedtls_mpi_uint mpi_sint_abs( mbedtls_mpi_sint z )
256{
257 if( z >= 0 )
258 return( z );
259 /* Take care to handle the most negative value (-2^(biL-1)) correctly.
260 * A naive -z would have undefined behavior.
261 * Write this in a way that makes popular compilers happy (GCC, Clang,
262 * MSVC). */
263 return( (mbedtls_mpi_uint) 0 - (mbedtls_mpi_uint) z );
264}
265
Paul Bakker5121ce52009-01-03 21:22:43 +0000266/*
267 * Set value from integer
268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200269int mbedtls_mpi_lset( mbedtls_mpi *X, mbedtls_mpi_sint z )
Paul Bakker5121ce52009-01-03 21:22:43 +0000270{
Janos Follath24eed8d2019-11-22 13:21:35 +0000271 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker73d7d792018-12-11 10:35:51 +0000272 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000273
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200274 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000275 memset( X->p, 0, X->n * ciL );
276
Gilles Peskineef7f4e42022-11-15 23:25:27 +0100277 X->p[0] = mpi_sint_abs( z );
Paul Bakker5121ce52009-01-03 21:22:43 +0000278 X->s = ( z < 0 ) ? -1 : 1;
279
280cleanup:
281
282 return( ret );
283}
284
285/*
Paul Bakker2f5947e2011-05-18 15:47:11 +0000286 * Get a specific bit
287 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200288int mbedtls_mpi_get_bit( const mbedtls_mpi *X, size_t pos )
Paul Bakker2f5947e2011-05-18 15:47:11 +0000289{
Hanno Becker73d7d792018-12-11 10:35:51 +0000290 MPI_VALIDATE_RET( X != NULL );
291
Paul Bakker2f5947e2011-05-18 15:47:11 +0000292 if( X->n * biL <= pos )
293 return( 0 );
294
Paul Bakkerd8bb8262014-06-17 14:06:49 +0200295 return( ( X->p[pos / biL] >> ( pos % biL ) ) & 0x01 );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000296}
297
298/*
299 * Set a bit to a specific value of 0 or 1
300 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200301int mbedtls_mpi_set_bit( mbedtls_mpi *X, size_t pos, unsigned char val )
Paul Bakker2f5947e2011-05-18 15:47:11 +0000302{
303 int ret = 0;
304 size_t off = pos / biL;
305 size_t idx = pos % biL;
Hanno Becker73d7d792018-12-11 10:35:51 +0000306 MPI_VALIDATE_RET( X != NULL );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000307
308 if( val != 0 && val != 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200309 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker9af723c2014-05-01 13:03:14 +0200310
Paul Bakker2f5947e2011-05-18 15:47:11 +0000311 if( X->n * biL <= pos )
312 {
313 if( val == 0 )
Paul Bakkerd8bb8262014-06-17 14:06:49 +0200314 return( 0 );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000315
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, off + 1 ) );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000317 }
318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 X->p[off] &= ~( (mbedtls_mpi_uint) 0x01 << idx );
320 X->p[off] |= (mbedtls_mpi_uint) val << idx;
Paul Bakker2f5947e2011-05-18 15:47:11 +0000321
322cleanup:
Paul Bakker9af723c2014-05-01 13:03:14 +0200323
Paul Bakker2f5947e2011-05-18 15:47:11 +0000324 return( ret );
325}
326
327/*
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200328 * Return the number of less significant zero-bits
Paul Bakker5121ce52009-01-03 21:22:43 +0000329 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330size_t mbedtls_mpi_lsb( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000331{
Paul Bakker23986e52011-04-24 08:57:21 +0000332 size_t i, j, count = 0;
Hanno Beckerf25ee7f2018-12-19 16:51:02 +0000333 MBEDTLS_INTERNAL_VALIDATE_RET( X != NULL, 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000334
335 for( i = 0; i < X->n; i++ )
Paul Bakkerf9688572011-05-05 10:00:45 +0000336 for( j = 0; j < biL; j++, count++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000337 if( ( ( X->p[i] >> j ) & 1 ) != 0 )
338 return( count );
339
340 return( 0 );
341}
342
343/*
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200344 * Return the number of bits
Paul Bakker5121ce52009-01-03 21:22:43 +0000345 */
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200346size_t mbedtls_mpi_bitlen( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000347{
Gabor Mezei89e31462022-08-12 15:36:56 +0200348 return( mbedtls_mpi_core_bitlen( X->p, X->n ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000349}
350
351/*
352 * Return the total size in bytes
353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354size_t mbedtls_mpi_size( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000355{
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200356 return( ( mbedtls_mpi_bitlen( X ) + 7 ) >> 3 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000357}
358
359/*
360 * Convert an ASCII character to digit value
361 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200362static int mpi_get_digit( mbedtls_mpi_uint *d, int radix, char c )
Paul Bakker5121ce52009-01-03 21:22:43 +0000363{
364 *d = 255;
365
366 if( c >= 0x30 && c <= 0x39 ) *d = c - 0x30;
367 if( c >= 0x41 && c <= 0x46 ) *d = c - 0x37;
368 if( c >= 0x61 && c <= 0x66 ) *d = c - 0x57;
369
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200370 if( *d >= (mbedtls_mpi_uint) radix )
371 return( MBEDTLS_ERR_MPI_INVALID_CHARACTER );
Paul Bakker5121ce52009-01-03 21:22:43 +0000372
373 return( 0 );
374}
375
376/*
377 * Import from an ASCII string
378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200379int mbedtls_mpi_read_string( mbedtls_mpi *X, int radix, const char *s )
Paul Bakker5121ce52009-01-03 21:22:43 +0000380{
Janos Follath24eed8d2019-11-22 13:21:35 +0000381 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000382 size_t i, j, slen, n;
Gilles Peskine80f56732021-04-03 18:26:13 +0200383 int sign = 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384 mbedtls_mpi_uint d;
385 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000386 MPI_VALIDATE_RET( X != NULL );
387 MPI_VALIDATE_RET( s != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000388
389 if( radix < 2 || radix > 16 )
Hanno Becker54c91dd2018-12-12 13:37:06 +0000390 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000391
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392 mbedtls_mpi_init( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000393
Gilles Peskine7cba8592021-06-08 18:32:34 +0200394 if( s[0] == 0 )
395 {
396 mbedtls_mpi_free( X );
397 return( 0 );
398 }
399
Gilles Peskine80f56732021-04-03 18:26:13 +0200400 if( s[0] == '-' )
401 {
402 ++s;
403 sign = -1;
404 }
405
Paul Bakkerff60ee62010-03-16 21:09:09 +0000406 slen = strlen( s );
407
Paul Bakker5121ce52009-01-03 21:22:43 +0000408 if( radix == 16 )
409 {
Manuel Pégourié-Gonnard2d708342015-10-05 15:23:11 +0100410 if( slen > MPI_SIZE_T_MAX >> 2 )
Manuel Pégourié-Gonnard58fb4952015-09-28 13:48:04 +0200411 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
412
Paul Bakkerff60ee62010-03-16 21:09:09 +0000413 n = BITS_TO_LIMBS( slen << 2 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000414
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200415 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, n ) );
416 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000417
Paul Bakker23986e52011-04-24 08:57:21 +0000418 for( i = slen, j = 0; i > 0; i--, j++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000419 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420 MBEDTLS_MPI_CHK( mpi_get_digit( &d, radix, s[i - 1] ) );
Paul Bakker66d5d072014-06-17 16:39:18 +0200421 X->p[j / ( 2 * ciL )] |= d << ( ( j % ( 2 * ciL ) ) << 2 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000422 }
423 }
424 else
425 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200426 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000427
Paul Bakkerff60ee62010-03-16 21:09:09 +0000428 for( i = 0; i < slen; i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000429 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200430 MBEDTLS_MPI_CHK( mpi_get_digit( &d, radix, s[i] ) );
431 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T, X, radix ) );
Gilles Peskine80f56732021-04-03 18:26:13 +0200432 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, &T, d ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000433 }
434 }
435
Gilles Peskine80f56732021-04-03 18:26:13 +0200436 if( sign < 0 && mbedtls_mpi_bitlen( X ) != 0 )
437 X->s = -1;
438
Paul Bakker5121ce52009-01-03 21:22:43 +0000439cleanup:
440
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200441 mbedtls_mpi_free( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000442
443 return( ret );
444}
445
446/*
Ron Eldora16fa292018-11-20 14:07:01 +0200447 * Helper to write the digits high-order first.
Paul Bakker5121ce52009-01-03 21:22:43 +0000448 */
Ron Eldora16fa292018-11-20 14:07:01 +0200449static int mpi_write_hlp( mbedtls_mpi *X, int radix,
450 char **p, const size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000451{
Janos Follath24eed8d2019-11-22 13:21:35 +0000452 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200453 mbedtls_mpi_uint r;
Ron Eldora16fa292018-11-20 14:07:01 +0200454 size_t length = 0;
455 char *p_end = *p + buflen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000456
Ron Eldora16fa292018-11-20 14:07:01 +0200457 do
458 {
459 if( length >= buflen )
460 {
461 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
462 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000463
Ron Eldora16fa292018-11-20 14:07:01 +0200464 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, radix ) );
465 MBEDTLS_MPI_CHK( mbedtls_mpi_div_int( X, NULL, X, radix ) );
466 /*
467 * Write the residue in the current position, as an ASCII character.
468 */
469 if( r < 0xA )
470 *(--p_end) = (char)( '0' + r );
471 else
472 *(--p_end) = (char)( 'A' + ( r - 0xA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000473
Ron Eldora16fa292018-11-20 14:07:01 +0200474 length++;
475 } while( mbedtls_mpi_cmp_int( X, 0 ) != 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000476
Ron Eldora16fa292018-11-20 14:07:01 +0200477 memmove( *p, p_end, length );
478 *p += length;
Paul Bakker5121ce52009-01-03 21:22:43 +0000479
480cleanup:
481
482 return( ret );
483}
484
485/*
486 * Export into an ASCII string
487 */
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100488int mbedtls_mpi_write_string( const mbedtls_mpi *X, int radix,
489 char *buf, size_t buflen, size_t *olen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000490{
Paul Bakker23986e52011-04-24 08:57:21 +0000491 int ret = 0;
492 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +0000493 char *p;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200494 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000495 MPI_VALIDATE_RET( X != NULL );
496 MPI_VALIDATE_RET( olen != NULL );
497 MPI_VALIDATE_RET( buflen == 0 || buf != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000498
499 if( radix < 2 || radix > 16 )
Hanno Becker54c91dd2018-12-12 13:37:06 +0000500 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000501
Hanno Becker23cfea02019-02-04 09:45:07 +0000502 n = mbedtls_mpi_bitlen( X ); /* Number of bits necessary to present `n`. */
503 if( radix >= 4 ) n >>= 1; /* Number of 4-adic digits necessary to present
504 * `n`. If radix > 4, this might be a strict
505 * overapproximation of the number of
506 * radix-adic digits needed to present `n`. */
507 if( radix >= 16 ) n >>= 1; /* Number of hexadecimal digits necessary to
508 * present `n`. */
509
Janos Follath80470622019-03-06 13:43:02 +0000510 n += 1; /* Terminating null byte */
Hanno Becker23cfea02019-02-04 09:45:07 +0000511 n += 1; /* Compensate for the divisions above, which round down `n`
512 * in case it's not even. */
513 n += 1; /* Potential '-'-sign. */
514 n += ( n & 1 ); /* Make n even to have enough space for hexadecimal writing,
515 * which always uses an even number of hex-digits. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000516
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100517 if( buflen < n )
Paul Bakker5121ce52009-01-03 21:22:43 +0000518 {
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100519 *olen = n;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200520 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000521 }
522
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100523 p = buf;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200524 mbedtls_mpi_init( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000525
526 if( X->s == -1 )
Hanno Beckerc983c812019-02-01 16:41:30 +0000527 {
Paul Bakker5121ce52009-01-03 21:22:43 +0000528 *p++ = '-';
Hanno Beckerc983c812019-02-01 16:41:30 +0000529 buflen--;
530 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000531
532 if( radix == 16 )
533 {
Paul Bakker23986e52011-04-24 08:57:21 +0000534 int c;
535 size_t i, j, k;
Paul Bakker5121ce52009-01-03 21:22:43 +0000536
Paul Bakker23986e52011-04-24 08:57:21 +0000537 for( i = X->n, k = 0; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +0000538 {
Paul Bakker23986e52011-04-24 08:57:21 +0000539 for( j = ciL; j > 0; j-- )
Paul Bakker5121ce52009-01-03 21:22:43 +0000540 {
Paul Bakker23986e52011-04-24 08:57:21 +0000541 c = ( X->p[i - 1] >> ( ( j - 1 ) << 3) ) & 0xFF;
Paul Bakker5121ce52009-01-03 21:22:43 +0000542
Paul Bakker6c343d72014-07-10 14:36:19 +0200543 if( c == 0 && k == 0 && ( i + j ) != 2 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000544 continue;
545
Paul Bakker98fe5ea2012-10-24 11:17:48 +0000546 *(p++) = "0123456789ABCDEF" [c / 16];
Paul Bakkerd2c167e2012-10-30 07:49:19 +0000547 *(p++) = "0123456789ABCDEF" [c % 16];
Paul Bakker5121ce52009-01-03 21:22:43 +0000548 k = 1;
549 }
550 }
551 }
552 else
553 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &T, X ) );
Paul Bakkerce40a6d2009-06-23 19:46:08 +0000555
556 if( T.s == -1 )
557 T.s = 1;
558
Ron Eldora16fa292018-11-20 14:07:01 +0200559 MBEDTLS_MPI_CHK( mpi_write_hlp( &T, radix, &p, buflen ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000560 }
561
562 *p++ = '\0';
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100563 *olen = p - buf;
Paul Bakker5121ce52009-01-03 21:22:43 +0000564
565cleanup:
566
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 mbedtls_mpi_free( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000568
569 return( ret );
570}
571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572#if defined(MBEDTLS_FS_IO)
Paul Bakker5121ce52009-01-03 21:22:43 +0000573/*
574 * Read X from an opened file
575 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576int mbedtls_mpi_read_file( mbedtls_mpi *X, int radix, FILE *fin )
Paul Bakker5121ce52009-01-03 21:22:43 +0000577{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578 mbedtls_mpi_uint d;
Paul Bakker23986e52011-04-24 08:57:21 +0000579 size_t slen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000580 char *p;
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000581 /*
Paul Bakkercb37aa52011-11-30 16:00:20 +0000582 * Buffer should have space for (short) label and decimal formatted MPI,
583 * newline characters and '\0'
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200585 char s[ MBEDTLS_MPI_RW_BUFFER_SIZE ];
Paul Bakker5121ce52009-01-03 21:22:43 +0000586
Hanno Becker73d7d792018-12-11 10:35:51 +0000587 MPI_VALIDATE_RET( X != NULL );
588 MPI_VALIDATE_RET( fin != NULL );
589
590 if( radix < 2 || radix > 16 )
591 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
592
Paul Bakker5121ce52009-01-03 21:22:43 +0000593 memset( s, 0, sizeof( s ) );
594 if( fgets( s, sizeof( s ) - 1, fin ) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200595 return( MBEDTLS_ERR_MPI_FILE_IO_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +0000596
597 slen = strlen( s );
Paul Bakkercb37aa52011-11-30 16:00:20 +0000598 if( slen == sizeof( s ) - 2 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200599 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
Paul Bakkercb37aa52011-11-30 16:00:20 +0000600
Hanno Beckerb2034b72017-04-26 11:46:46 +0100601 if( slen > 0 && s[slen - 1] == '\n' ) { slen--; s[slen] = '\0'; }
602 if( slen > 0 && s[slen - 1] == '\r' ) { slen--; s[slen] = '\0'; }
Paul Bakker5121ce52009-01-03 21:22:43 +0000603
604 p = s + slen;
Hanno Beckerb2034b72017-04-26 11:46:46 +0100605 while( p-- > s )
Paul Bakker5121ce52009-01-03 21:22:43 +0000606 if( mpi_get_digit( &d, radix, *p ) != 0 )
607 break;
608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200609 return( mbedtls_mpi_read_string( X, radix, p + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000610}
611
612/*
613 * Write X into an opened file (or stdout if fout == NULL)
614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200615int mbedtls_mpi_write_file( const char *p, const mbedtls_mpi *X, int radix, FILE *fout )
Paul Bakker5121ce52009-01-03 21:22:43 +0000616{
Janos Follath24eed8d2019-11-22 13:21:35 +0000617 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000618 size_t n, slen, plen;
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000619 /*
Paul Bakker5531c6d2012-09-26 19:20:46 +0000620 * Buffer should have space for (short) label and decimal formatted MPI,
621 * newline characters and '\0'
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000622 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623 char s[ MBEDTLS_MPI_RW_BUFFER_SIZE ];
Hanno Becker73d7d792018-12-11 10:35:51 +0000624 MPI_VALIDATE_RET( X != NULL );
625
626 if( radix < 2 || radix > 16 )
627 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000628
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100629 memset( s, 0, sizeof( s ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000630
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100631 MBEDTLS_MPI_CHK( mbedtls_mpi_write_string( X, radix, s, sizeof( s ) - 2, &n ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000632
633 if( p == NULL ) p = "";
634
635 plen = strlen( p );
636 slen = strlen( s );
637 s[slen++] = '\r';
638 s[slen++] = '\n';
639
640 if( fout != NULL )
641 {
642 if( fwrite( p, 1, plen, fout ) != plen ||
643 fwrite( s, 1, slen, fout ) != slen )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200644 return( MBEDTLS_ERR_MPI_FILE_IO_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +0000645 }
646 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200647 mbedtls_printf( "%s%s", p, s );
Paul Bakker5121ce52009-01-03 21:22:43 +0000648
649cleanup:
650
651 return( ret );
652}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653#endif /* MBEDTLS_FS_IO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000654
655/*
Janos Follatha778a942019-02-13 10:28:28 +0000656 * Import X from unsigned binary data, little endian
Przemyslaw Stekiel76960a72022-02-21 13:42:09 +0100657 *
658 * This function is guaranteed to return an MPI with exactly the necessary
659 * number of limbs (in particular, it does not skip 0s in the input).
Janos Follatha778a942019-02-13 10:28:28 +0000660 */
661int mbedtls_mpi_read_binary_le( mbedtls_mpi *X,
662 const unsigned char *buf, size_t buflen )
663{
Janos Follath24eed8d2019-11-22 13:21:35 +0000664 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Janos Follath620c58c2022-08-15 11:58:42 +0100665 const size_t limbs = CHARS_TO_LIMBS( buflen );
Janos Follatha778a942019-02-13 10:28:28 +0000666
667 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskineed32b572021-06-02 22:17:52 +0200668 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Janos Follatha778a942019-02-13 10:28:28 +0000669
Janos Follath5f016652022-07-22 16:18:41 +0100670 MBEDTLS_MPI_CHK( mbedtls_mpi_core_read_le( X->p, X->n, buf, buflen ) );
Janos Follatha778a942019-02-13 10:28:28 +0000671
672cleanup:
673
Janos Follath171a7ef2019-02-15 16:17:45 +0000674 /*
675 * This function is also used to import keys. However, wiping the buffers
676 * upon failure is not necessary because failure only can happen before any
677 * input is copied.
678 */
Janos Follatha778a942019-02-13 10:28:28 +0000679 return( ret );
680}
681
682/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000683 * Import X from unsigned binary data, big endian
Przemyslaw Stekiel76960a72022-02-21 13:42:09 +0100684 *
685 * This function is guaranteed to return an MPI with exactly the necessary
686 * number of limbs (in particular, it does not skip 0s in the input).
Paul Bakker5121ce52009-01-03 21:22:43 +0000687 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688int mbedtls_mpi_read_binary( mbedtls_mpi *X, const unsigned char *buf, size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000689{
Janos Follath24eed8d2019-11-22 13:21:35 +0000690 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Janos Follath620c58c2022-08-15 11:58:42 +0100691 const size_t limbs = CHARS_TO_LIMBS( buflen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000692
Hanno Becker8ce11a32018-12-19 16:18:52 +0000693 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +0000694 MPI_VALIDATE_RET( buflen == 0 || buf != NULL );
695
Hanno Becker073c1992017-10-17 15:17:27 +0100696 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskineed32b572021-06-02 22:17:52 +0200697 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000698
Janos Follath5f016652022-07-22 16:18:41 +0100699 MBEDTLS_MPI_CHK( mbedtls_mpi_core_read_be( X->p, X->n, buf, buflen ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000700
701cleanup:
702
Janos Follath171a7ef2019-02-15 16:17:45 +0000703 /*
704 * This function is also used to import keys. However, wiping the buffers
705 * upon failure is not necessary because failure only can happen before any
706 * input is copied.
707 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000708 return( ret );
709}
710
711/*
Janos Follathe344d0f2019-02-19 16:17:40 +0000712 * Export X into unsigned binary data, little endian
713 */
714int mbedtls_mpi_write_binary_le( const mbedtls_mpi *X,
715 unsigned char *buf, size_t buflen )
716{
Janos Follathca5688e2022-08-19 12:05:28 +0100717 return( mbedtls_mpi_core_write_le( X->p, X->n, buf, buflen ) );
Janos Follathe344d0f2019-02-19 16:17:40 +0000718}
719
720/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000721 * Export X into unsigned binary data, big endian
722 */
Gilles Peskine11cdb052018-11-20 16:47:47 +0100723int mbedtls_mpi_write_binary( const mbedtls_mpi *X,
724 unsigned char *buf, size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000725{
Janos Follath5f016652022-07-22 16:18:41 +0100726 return( mbedtls_mpi_core_write_be( X->p, X->n, buf, buflen ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000727}
728
729/*
730 * Left-shift: X <<= count
731 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200732int mbedtls_mpi_shift_l( mbedtls_mpi *X, size_t count )
Paul Bakker5121ce52009-01-03 21:22:43 +0000733{
Janos Follath24eed8d2019-11-22 13:21:35 +0000734 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000735 size_t i, v0, t1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736 mbedtls_mpi_uint r0 = 0, r1;
Hanno Becker73d7d792018-12-11 10:35:51 +0000737 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000738
739 v0 = count / (biL );
740 t1 = count & (biL - 1);
741
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200742 i = mbedtls_mpi_bitlen( X ) + count;
Paul Bakker5121ce52009-01-03 21:22:43 +0000743
Paul Bakkerf9688572011-05-05 10:00:45 +0000744 if( X->n * biL < i )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, BITS_TO_LIMBS( i ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000746
747 ret = 0;
748
749 /*
750 * shift by count / limb_size
751 */
752 if( v0 > 0 )
753 {
Paul Bakker23986e52011-04-24 08:57:21 +0000754 for( i = X->n; i > v0; i-- )
755 X->p[i - 1] = X->p[i - v0 - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +0000756
Paul Bakker23986e52011-04-24 08:57:21 +0000757 for( ; i > 0; i-- )
758 X->p[i - 1] = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +0000759 }
760
761 /*
762 * shift by count % limb_size
763 */
764 if( t1 > 0 )
765 {
766 for( i = v0; i < X->n; i++ )
767 {
768 r1 = X->p[i] >> (biL - t1);
769 X->p[i] <<= t1;
770 X->p[i] |= r0;
771 r0 = r1;
772 }
773 }
774
775cleanup:
776
777 return( ret );
778}
779
780/*
781 * Right-shift: X >>= count
782 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783int mbedtls_mpi_shift_r( mbedtls_mpi *X, size_t count )
Paul Bakker5121ce52009-01-03 21:22:43 +0000784{
Gilles Peskine66414202022-09-21 15:36:16 +0200785 MPI_VALIDATE_RET( X != NULL );
786 if( X->n != 0 )
787 mbedtls_mpi_core_shift_r( X->p, X->n, count );
788 return( 0 );
789}
790
Paul Bakker5121ce52009-01-03 21:22:43 +0000791/*
792 * Compare unsigned values
793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200794int mbedtls_mpi_cmp_abs( const mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +0000795{
Paul Bakker23986e52011-04-24 08:57:21 +0000796 size_t i, j;
Hanno Becker73d7d792018-12-11 10:35:51 +0000797 MPI_VALIDATE_RET( X != NULL );
798 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000799
Paul Bakker23986e52011-04-24 08:57:21 +0000800 for( i = X->n; i > 0; i-- )
801 if( X->p[i - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000802 break;
803
Paul Bakker23986e52011-04-24 08:57:21 +0000804 for( j = Y->n; j > 0; j-- )
805 if( Y->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000806 break;
807
Paul Bakker23986e52011-04-24 08:57:21 +0000808 if( i == 0 && j == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000809 return( 0 );
810
811 if( i > j ) return( 1 );
812 if( j > i ) return( -1 );
813
Paul Bakker23986e52011-04-24 08:57:21 +0000814 for( ; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +0000815 {
Paul Bakker23986e52011-04-24 08:57:21 +0000816 if( X->p[i - 1] > Y->p[i - 1] ) return( 1 );
817 if( X->p[i - 1] < Y->p[i - 1] ) return( -1 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000818 }
819
820 return( 0 );
821}
822
823/*
824 * Compare signed values
825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200826int mbedtls_mpi_cmp_mpi( const mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +0000827{
Paul Bakker23986e52011-04-24 08:57:21 +0000828 size_t i, j;
Hanno Becker73d7d792018-12-11 10:35:51 +0000829 MPI_VALIDATE_RET( X != NULL );
830 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000831
Paul Bakker23986e52011-04-24 08:57:21 +0000832 for( i = X->n; i > 0; i-- )
833 if( X->p[i - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000834 break;
835
Paul Bakker23986e52011-04-24 08:57:21 +0000836 for( j = Y->n; j > 0; j-- )
837 if( Y->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000838 break;
839
Paul Bakker23986e52011-04-24 08:57:21 +0000840 if( i == 0 && j == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000841 return( 0 );
842
843 if( i > j ) return( X->s );
Paul Bakker0c8f73b2012-03-22 14:08:57 +0000844 if( j > i ) return( -Y->s );
Paul Bakker5121ce52009-01-03 21:22:43 +0000845
846 if( X->s > 0 && Y->s < 0 ) return( 1 );
847 if( Y->s > 0 && X->s < 0 ) return( -1 );
848
Paul Bakker23986e52011-04-24 08:57:21 +0000849 for( ; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +0000850 {
Paul Bakker23986e52011-04-24 08:57:21 +0000851 if( X->p[i - 1] > Y->p[i - 1] ) return( X->s );
852 if( X->p[i - 1] < Y->p[i - 1] ) return( -X->s );
Paul Bakker5121ce52009-01-03 21:22:43 +0000853 }
854
855 return( 0 );
856}
857
Janos Follathee6abce2019-09-05 14:47:19 +0100858/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000859 * Compare signed values
860 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200861int mbedtls_mpi_cmp_int( const mbedtls_mpi *X, mbedtls_mpi_sint z )
Paul Bakker5121ce52009-01-03 21:22:43 +0000862{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200863 mbedtls_mpi Y;
864 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +0000865 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000866
Gilles Peskineef7f4e42022-11-15 23:25:27 +0100867 *p = mpi_sint_abs( z );
Paul Bakker5121ce52009-01-03 21:22:43 +0000868 Y.s = ( z < 0 ) ? -1 : 1;
869 Y.n = 1;
870 Y.p = p;
871
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 return( mbedtls_mpi_cmp_mpi( X, &Y ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000873}
874
875/*
876 * Unsigned addition: X = |A| + |B| (HAC 14.7)
877 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200878int mbedtls_mpi_add_abs( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +0000879{
Janos Follath24eed8d2019-11-22 13:21:35 +0000880 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Tom Cosgroveaf7d44b2022-08-24 14:05:26 +0100881 size_t j;
Hanno Becker73d7d792018-12-11 10:35:51 +0000882 MPI_VALIDATE_RET( X != NULL );
883 MPI_VALIDATE_RET( A != NULL );
884 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000885
886 if( X == B )
887 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 const mbedtls_mpi *T = A; A = X; B = T;
Paul Bakker5121ce52009-01-03 21:22:43 +0000889 }
890
891 if( X != A )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, A ) );
Paul Bakker9af723c2014-05-01 13:03:14 +0200893
Paul Bakkerf7ca7b92009-06-20 10:31:06 +0000894 /*
Tom Cosgroveaf7d44b2022-08-24 14:05:26 +0100895 * X must always be positive as a result of unsigned additions.
Paul Bakkerf7ca7b92009-06-20 10:31:06 +0000896 */
897 X->s = 1;
Paul Bakker5121ce52009-01-03 21:22:43 +0000898
Paul Bakker23986e52011-04-24 08:57:21 +0000899 for( j = B->n; j > 0; j-- )
900 if( B->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000901 break;
902
Gilles Peskinedb14a9d2022-11-15 22:59:00 +0100903 /* Exit early to avoid undefined behavior on NULL+0 when X->n == 0
904 * and B is 0 (of any size). */
905 if( j == 0 )
906 return( 0 );
907
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, j ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000909
Tom Cosgroveaf7d44b2022-08-24 14:05:26 +0100910 /* j is the number of non-zero limbs of B. Add those to X. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000911
Tom Cosgroveaf7d44b2022-08-24 14:05:26 +0100912 mbedtls_mpi_uint *p = X->p;
913
Tom Cosgrove6469fdf2022-10-25 12:46:13 +0100914 mbedtls_mpi_uint c = mbedtls_mpi_core_add( p, p, B->p, j );
Tom Cosgroveaf7d44b2022-08-24 14:05:26 +0100915
916 p += j;
917
918 /* Now propagate any carry */
Paul Bakker5121ce52009-01-03 21:22:43 +0000919
920 while( c != 0 )
921 {
Tom Cosgroveaf7d44b2022-08-24 14:05:26 +0100922 if( j >= X->n )
Paul Bakker5121ce52009-01-03 21:22:43 +0000923 {
Tom Cosgroveaf7d44b2022-08-24 14:05:26 +0100924 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, j + 1 ) );
925 p = X->p + j;
Paul Bakker5121ce52009-01-03 21:22:43 +0000926 }
927
Tom Cosgroveaf7d44b2022-08-24 14:05:26 +0100928 *p += c; c = ( *p < c ); j++; p++;
Paul Bakker5121ce52009-01-03 21:22:43 +0000929 }
930
931cleanup:
932
933 return( ret );
934}
935
Paul Bakker5121ce52009-01-03 21:22:43 +0000936/*
Gilles Peskine0e5faf62020-06-08 22:50:35 +0200937 * Unsigned subtraction: X = |A| - |B| (HAC 14.9, 14.10)
Paul Bakker5121ce52009-01-03 21:22:43 +0000938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939int mbedtls_mpi_sub_abs( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +0000940{
Janos Follath24eed8d2019-11-22 13:21:35 +0000941 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000942 size_t n;
Gilles Peskine0e5faf62020-06-08 22:50:35 +0200943 mbedtls_mpi_uint carry;
Hanno Becker73d7d792018-12-11 10:35:51 +0000944 MPI_VALIDATE_RET( X != NULL );
945 MPI_VALIDATE_RET( A != NULL );
946 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000947
Paul Bakker23986e52011-04-24 08:57:21 +0000948 for( n = B->n; n > 0; n-- )
949 if( B->p[n - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000950 break;
Gilles Peskinec8a91772021-01-27 22:30:43 +0100951 if( n > A->n )
952 {
953 /* B >= (2^ciL)^n > A */
954 ret = MBEDTLS_ERR_MPI_NEGATIVE_VALUE;
955 goto cleanup;
956 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000957
Gilles Peskine1acf7cb2020-07-23 01:03:22 +0200958 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, A->n ) );
959
960 /* Set the high limbs of X to match A. Don't touch the lower limbs
961 * because X might be aliased to B, and we must not overwrite the
962 * significant digits of B. */
963 if( A->n > n )
964 memcpy( X->p + n, A->p + n, ( A->n - n ) * ciL );
965 if( X->n > A->n )
966 memset( X->p + A->n, 0, ( X->n - A->n ) * ciL );
967
Tom Cosgrove7e655f72022-07-20 14:02:11 +0100968 carry = mbedtls_mpi_core_sub( X->p, A->p, B->p, n );
Gilles Peskine0e5faf62020-06-08 22:50:35 +0200969 if( carry != 0 )
Gilles Peskinec097e9e2020-06-08 21:58:22 +0200970 {
Tom Cosgrove452c99c2022-08-25 10:07:07 +0100971 /* Propagate the carry through the rest of X. */
972 carry = mbedtls_mpi_core_sub_int( X->p + n, X->p + n, carry, X->n - n );
973
974 /* If we have further carry/borrow, the result is negative. */
975 if( carry != 0 )
Gilles Peskine89b41302020-07-23 01:16:46 +0200976 {
977 ret = MBEDTLS_ERR_MPI_NEGATIVE_VALUE;
978 goto cleanup;
979 }
Gilles Peskinec097e9e2020-06-08 21:58:22 +0200980 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000981
Gilles Peskine1acf7cb2020-07-23 01:03:22 +0200982 /* X should always be positive as a result of unsigned subtractions. */
983 X->s = 1;
984
Paul Bakker5121ce52009-01-03 21:22:43 +0000985cleanup:
Paul Bakker5121ce52009-01-03 21:22:43 +0000986 return( ret );
987}
988
Gilles Peskine72ee1e32022-11-09 21:34:09 +0100989/* Common function for signed addition and subtraction.
990 * Calculate A + B * flip_B where flip_B is 1 or -1.
Paul Bakker5121ce52009-01-03 21:22:43 +0000991 */
Gilles Peskine72ee1e32022-11-09 21:34:09 +0100992static int add_sub_mpi( mbedtls_mpi *X,
993 const mbedtls_mpi *A, const mbedtls_mpi *B,
994 int flip_B )
Paul Bakker5121ce52009-01-03 21:22:43 +0000995{
Hanno Becker73d7d792018-12-11 10:35:51 +0000996 int ret, s;
997 MPI_VALIDATE_RET( X != NULL );
998 MPI_VALIDATE_RET( A != NULL );
999 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001000
Hanno Becker73d7d792018-12-11 10:35:51 +00001001 s = A->s;
Gilles Peskine72ee1e32022-11-09 21:34:09 +01001002 if( A->s * B->s * flip_B < 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001003 {
Gilles Peskine4a768dd2022-11-09 22:02:16 +01001004 int cmp = mbedtls_mpi_cmp_abs( A, B );
1005 if( cmp >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001006 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, A, B ) );
Gilles Peskine4a768dd2022-11-09 22:02:16 +01001008 /* If |A| = |B|, the result is 0 and we must set the sign bit
1009 * to +1 regardless of which of A or B was negative. Otherwise,
1010 * since |A| > |B|, the sign is the sign of A. */
1011 X->s = cmp == 0 ? 1 : s;
Paul Bakker5121ce52009-01-03 21:22:43 +00001012 }
1013 else
1014 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, B, A ) );
Gilles Peskine4a768dd2022-11-09 22:02:16 +01001016 /* Since |A| < |B|, the sign is the opposite of A. */
Paul Bakker5121ce52009-01-03 21:22:43 +00001017 X->s = -s;
1018 }
1019 }
1020 else
1021 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001022 MBEDTLS_MPI_CHK( mbedtls_mpi_add_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001023 X->s = s;
1024 }
1025
1026cleanup:
1027
1028 return( ret );
1029}
1030
1031/*
Gilles Peskine72ee1e32022-11-09 21:34:09 +01001032 * Signed addition: X = A + B
1033 */
1034int mbedtls_mpi_add_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
1035{
1036 return( add_sub_mpi( X, A, B, 1 ) );
1037}
1038
1039/*
Paul Bakker60b1d102013-10-29 10:02:51 +01001040 * Signed subtraction: X = A - B
Paul Bakker5121ce52009-01-03 21:22:43 +00001041 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042int mbedtls_mpi_sub_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001043{
Gilles Peskine72ee1e32022-11-09 21:34:09 +01001044 return( add_sub_mpi( X, A, B, -1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001045}
1046
1047/*
1048 * Signed addition: X = A + b
1049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050int mbedtls_mpi_add_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001051{
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001052 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001054 MPI_VALIDATE_RET( X != NULL );
1055 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001056
Gilles Peskineef7f4e42022-11-15 23:25:27 +01001057 p[0] = mpi_sint_abs( b );
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001058 B.s = ( b < 0 ) ? -1 : 1;
1059 B.n = 1;
1060 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001061
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001062 return( mbedtls_mpi_add_mpi( X, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001063}
1064
1065/*
Paul Bakker60b1d102013-10-29 10:02:51 +01001066 * Signed subtraction: X = A - b
Paul Bakker5121ce52009-01-03 21:22:43 +00001067 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068int mbedtls_mpi_sub_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001069{
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001070 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001071 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001072 MPI_VALIDATE_RET( X != NULL );
1073 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001074
Gilles Peskineef7f4e42022-11-15 23:25:27 +01001075 p[0] = mpi_sint_abs( b );
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001076 B.s = ( b < 0 ) ? -1 : 1;
1077 B.n = 1;
1078 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001079
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001080 return( mbedtls_mpi_sub_mpi( X, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001081}
1082
Paul Bakker5121ce52009-01-03 21:22:43 +00001083/*
1084 * Baseline multiplication: X = A * B (HAC 14.12)
1085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086int mbedtls_mpi_mul_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001087{
Janos Follath24eed8d2019-11-22 13:21:35 +00001088 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker1772e052022-04-13 06:51:40 +01001089 size_t i, j;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090 mbedtls_mpi TA, TB;
Hanno Beckerda763de2022-04-13 06:50:02 +01001091 int result_is_zero = 0;
Hanno Becker73d7d792018-12-11 10:35:51 +00001092 MPI_VALIDATE_RET( X != NULL );
1093 MPI_VALIDATE_RET( A != NULL );
1094 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00001097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 if( X == A ) { MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TA, A ) ); A = &TA; }
1099 if( X == B ) { MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, B ) ); B = &TB; }
Paul Bakker5121ce52009-01-03 21:22:43 +00001100
Hanno Beckerda763de2022-04-13 06:50:02 +01001101 for( i = A->n; i > 0; i-- )
1102 if( A->p[i - 1] != 0 )
1103 break;
1104 if( i == 0 )
1105 result_is_zero = 1;
1106
1107 for( j = B->n; j > 0; j-- )
1108 if( B->p[j - 1] != 0 )
1109 break;
1110 if( j == 0 )
1111 result_is_zero = 1;
1112
1113 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, i + j ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001115
Hanno Becker1772e052022-04-13 06:51:40 +01001116 for( size_t k = 0; k < j; k++ )
Hanno Beckerfee261a2022-04-06 06:20:22 +01001117 {
1118 /* We know that there cannot be any carry-out since we're
1119 * iterating from bottom to top. */
Hanno Beckerda763de2022-04-13 06:50:02 +01001120 (void) mbedtls_mpi_core_mla( X->p + k, i + 1,
1121 A->p, i,
Hanno Beckeraef9cc42022-04-11 06:36:29 +01001122 B->p[k] );
Hanno Beckerfee261a2022-04-06 06:20:22 +01001123 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001124
Hanno Beckerda763de2022-04-13 06:50:02 +01001125 /* If the result is 0, we don't shortcut the operation, which reduces
1126 * but does not eliminate side channels leaking the zero-ness. We do
1127 * need to take care to set the sign bit properly since the library does
1128 * not fully support an MPI object with a value of 0 and s == -1. */
1129 if( result_is_zero )
1130 X->s = 1;
1131 else
1132 X->s = A->s * B->s;
Paul Bakker5121ce52009-01-03 21:22:43 +00001133
1134cleanup:
1135
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136 mbedtls_mpi_free( &TB ); mbedtls_mpi_free( &TA );
Paul Bakker5121ce52009-01-03 21:22:43 +00001137
1138 return( ret );
1139}
1140
1141/*
1142 * Baseline multiplication: X = A * b
1143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144int mbedtls_mpi_mul_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_uint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001145{
Hanno Becker73d7d792018-12-11 10:35:51 +00001146 MPI_VALIDATE_RET( X != NULL );
1147 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001148
Hanno Becker35771312022-04-14 11:52:11 +01001149 size_t n = A->n;
1150 while( n > 0 && A->p[n - 1] == 0 )
1151 --n;
1152
Hanno Becker74a11a32022-04-06 06:27:00 +01001153 /* The general method below doesn't work if b==0. */
Hanno Becker35771312022-04-14 11:52:11 +01001154 if( b == 0 || n == 0 )
Paul Elliott986b55a2021-04-20 21:46:29 +01001155 return( mbedtls_mpi_lset( X, 0 ) );
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001156
Hanno Beckeraef9cc42022-04-11 06:36:29 +01001157 /* Calculate A*b as A + A*(b-1) to take advantage of mbedtls_mpi_core_mla */
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinecd0dbf32020-07-24 00:09:04 +02001159 /* In general, A * b requires 1 limb more than b. If
1160 * A->p[n - 1] * b / b == A->p[n - 1], then A * b fits in the same
1161 * number of limbs as A and the call to grow() is not required since
Gilles Peskinee1bba7c2021-03-10 23:44:10 +01001162 * copy() will take care of the growth if needed. However, experimentally,
1163 * making the call to grow() unconditional causes slightly fewer
Gilles Peskinecd0dbf32020-07-24 00:09:04 +02001164 * calls to calloc() in ECP code, presumably because it reuses the
1165 * same mpi for a while and this way the mpi is more likely to directly
Hanno Becker9137b9c2022-04-12 10:51:54 +01001166 * grow to its final size.
1167 *
1168 * Note that calculating A*b as 0 + A*b doesn't work as-is because
1169 * A,X can be the same. */
Hanno Becker35771312022-04-14 11:52:11 +01001170 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, n + 1 ) );
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001171 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, A ) );
Hanno Becker35771312022-04-14 11:52:11 +01001172 mbedtls_mpi_core_mla( X->p, X->n, A->p, n, b - 1 );
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001173
1174cleanup:
1175 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001176}
1177
1178/*
Simon Butcherf5ba0452015-12-27 23:01:55 +00001179 * Unsigned integer divide - double mbedtls_mpi_uint dividend, u1/u0, and
1180 * mbedtls_mpi_uint divisor, d
Simon Butcher15b15d12015-11-26 19:35:03 +00001181 */
Simon Butcherf5ba0452015-12-27 23:01:55 +00001182static mbedtls_mpi_uint mbedtls_int_div_int( mbedtls_mpi_uint u1,
1183 mbedtls_mpi_uint u0, mbedtls_mpi_uint d, mbedtls_mpi_uint *r )
Simon Butcher15b15d12015-11-26 19:35:03 +00001184{
Manuel Pégourié-Gonnard16308882015-12-01 10:27:00 +01001185#if defined(MBEDTLS_HAVE_UDBL)
1186 mbedtls_t_udbl dividend, quotient;
Simon Butcherf5ba0452015-12-27 23:01:55 +00001187#else
Simon Butcher9803d072016-01-03 00:24:34 +00001188 const mbedtls_mpi_uint radix = (mbedtls_mpi_uint) 1 << biH;
1189 const mbedtls_mpi_uint uint_halfword_mask = ( (mbedtls_mpi_uint) 1 << biH ) - 1;
Simon Butcherf5ba0452015-12-27 23:01:55 +00001190 mbedtls_mpi_uint d0, d1, q0, q1, rAX, r0, quotient;
1191 mbedtls_mpi_uint u0_msw, u0_lsw;
Simon Butcher9803d072016-01-03 00:24:34 +00001192 size_t s;
Manuel Pégourié-Gonnard16308882015-12-01 10:27:00 +01001193#endif
1194
Simon Butcher15b15d12015-11-26 19:35:03 +00001195 /*
1196 * Check for overflow
1197 */
Simon Butcherf5ba0452015-12-27 23:01:55 +00001198 if( 0 == d || u1 >= d )
Simon Butcher15b15d12015-11-26 19:35:03 +00001199 {
Simon Butcherf5ba0452015-12-27 23:01:55 +00001200 if (r != NULL) *r = ~0;
Simon Butcher15b15d12015-11-26 19:35:03 +00001201
Simon Butcherf5ba0452015-12-27 23:01:55 +00001202 return ( ~0 );
Simon Butcher15b15d12015-11-26 19:35:03 +00001203 }
1204
1205#if defined(MBEDTLS_HAVE_UDBL)
Simon Butcher15b15d12015-11-26 19:35:03 +00001206 dividend = (mbedtls_t_udbl) u1 << biL;
1207 dividend |= (mbedtls_t_udbl) u0;
1208 quotient = dividend / d;
1209 if( quotient > ( (mbedtls_t_udbl) 1 << biL ) - 1 )
1210 quotient = ( (mbedtls_t_udbl) 1 << biL ) - 1;
1211
1212 if( r != NULL )
Simon Butcher9803d072016-01-03 00:24:34 +00001213 *r = (mbedtls_mpi_uint)( dividend - (quotient * d ) );
Simon Butcher15b15d12015-11-26 19:35:03 +00001214
1215 return (mbedtls_mpi_uint) quotient;
1216#else
Simon Butcher15b15d12015-11-26 19:35:03 +00001217
1218 /*
1219 * Algorithm D, Section 4.3.1 - The Art of Computer Programming
1220 * Vol. 2 - Seminumerical Algorithms, Knuth
1221 */
1222
1223 /*
1224 * Normalize the divisor, d, and dividend, u0, u1
1225 */
Janos Follath4670f882022-07-21 18:25:42 +01001226 s = mbedtls_mpi_core_clz( d );
Simon Butcher15b15d12015-11-26 19:35:03 +00001227 d = d << s;
1228
1229 u1 = u1 << s;
Simon Butcher9803d072016-01-03 00:24:34 +00001230 u1 |= ( u0 >> ( biL - s ) ) & ( -(mbedtls_mpi_sint)s >> ( biL - 1 ) );
Simon Butcher15b15d12015-11-26 19:35:03 +00001231 u0 = u0 << s;
1232
1233 d1 = d >> biH;
Simon Butcher9803d072016-01-03 00:24:34 +00001234 d0 = d & uint_halfword_mask;
Simon Butcher15b15d12015-11-26 19:35:03 +00001235
1236 u0_msw = u0 >> biH;
Simon Butcher9803d072016-01-03 00:24:34 +00001237 u0_lsw = u0 & uint_halfword_mask;
Simon Butcher15b15d12015-11-26 19:35:03 +00001238
1239 /*
1240 * Find the first quotient and remainder
1241 */
1242 q1 = u1 / d1;
1243 r0 = u1 - d1 * q1;
1244
1245 while( q1 >= radix || ( q1 * d0 > radix * r0 + u0_msw ) )
1246 {
1247 q1 -= 1;
1248 r0 += d1;
1249
1250 if ( r0 >= radix ) break;
1251 }
1252
Simon Butcherf5ba0452015-12-27 23:01:55 +00001253 rAX = ( u1 * radix ) + ( u0_msw - q1 * d );
Simon Butcher15b15d12015-11-26 19:35:03 +00001254 q0 = rAX / d1;
1255 r0 = rAX - q0 * d1;
1256
1257 while( q0 >= radix || ( q0 * d0 > radix * r0 + u0_lsw ) )
1258 {
1259 q0 -= 1;
1260 r0 += d1;
1261
1262 if ( r0 >= radix ) break;
1263 }
1264
1265 if (r != NULL)
Simon Butcherf5ba0452015-12-27 23:01:55 +00001266 *r = ( rAX * radix + u0_lsw - q0 * d ) >> s;
Simon Butcher15b15d12015-11-26 19:35:03 +00001267
1268 quotient = q1 * radix + q0;
1269
1270 return quotient;
1271#endif
1272}
1273
1274/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001275 * Division by mbedtls_mpi: A = Q * B + R (HAC 14.20)
Paul Bakker5121ce52009-01-03 21:22:43 +00001276 */
Hanno Becker73d7d792018-12-11 10:35:51 +00001277int mbedtls_mpi_div_mpi( mbedtls_mpi *Q, mbedtls_mpi *R, const mbedtls_mpi *A,
1278 const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001279{
Janos Follath24eed8d2019-11-22 13:21:35 +00001280 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001281 size_t i, n, t, k;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001282 mbedtls_mpi X, Y, Z, T1, T2;
Alexander Kd19a1932019-11-01 18:20:42 +03001283 mbedtls_mpi_uint TP2[3];
Hanno Becker73d7d792018-12-11 10:35:51 +00001284 MPI_VALIDATE_RET( A != NULL );
1285 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001286
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001287 if( mbedtls_mpi_cmp_int( B, 0 ) == 0 )
1288 return( MBEDTLS_ERR_MPI_DIVISION_BY_ZERO );
Paul Bakker5121ce52009-01-03 21:22:43 +00001289
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001290 mbedtls_mpi_init( &X ); mbedtls_mpi_init( &Y ); mbedtls_mpi_init( &Z );
Alexander K35d6d462019-10-31 14:46:45 +03001291 mbedtls_mpi_init( &T1 );
Alexander Kd19a1932019-11-01 18:20:42 +03001292 /*
1293 * Avoid dynamic memory allocations for constant-size T2.
1294 *
1295 * T2 is used for comparison only and the 3 limbs are assigned explicitly,
1296 * so nobody increase the size of the MPI and we're safe to use an on-stack
1297 * buffer.
1298 */
Alexander K35d6d462019-10-31 14:46:45 +03001299 T2.s = 1;
Alexander Kd19a1932019-11-01 18:20:42 +03001300 T2.n = sizeof( TP2 ) / sizeof( *TP2 );
1301 T2.p = TP2;
Paul Bakker5121ce52009-01-03 21:22:43 +00001302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303 if( mbedtls_mpi_cmp_abs( A, B ) < 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001304 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305 if( Q != NULL ) MBEDTLS_MPI_CHK( mbedtls_mpi_lset( Q, 0 ) );
1306 if( R != NULL ) MBEDTLS_MPI_CHK( mbedtls_mpi_copy( R, A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001307 return( 0 );
1308 }
1309
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &X, A ) );
1311 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Y, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001312 X.s = Y.s = 1;
1313
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &Z, A->n + 2 ) );
1315 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &Z, 0 ) );
Gilles Peskine2536aa72020-07-24 00:12:59 +02001316 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &T1, A->n + 2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001317
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02001318 k = mbedtls_mpi_bitlen( &Y ) % biL;
Paul Bakkerf9688572011-05-05 10:00:45 +00001319 if( k < biL - 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001320 {
1321 k = biL - 1 - k;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &X, k ) );
1323 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &Y, k ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001324 }
1325 else k = 0;
1326
1327 n = X.n - 1;
1328 t = Y.n - 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001329 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &Y, biL * ( n - t ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001330
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001331 while( mbedtls_mpi_cmp_mpi( &X, &Y ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001332 {
1333 Z.p[n - t]++;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001334 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &X, &X, &Y ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001335 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001336 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &Y, biL * ( n - t ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001337
1338 for( i = n; i > t ; i-- )
1339 {
1340 if( X.p[i] >= Y.p[t] )
1341 Z.p[i - t - 1] = ~0;
1342 else
1343 {
Simon Butcher15b15d12015-11-26 19:35:03 +00001344 Z.p[i - t - 1] = mbedtls_int_div_int( X.p[i], X.p[i - 1],
1345 Y.p[t], NULL);
Paul Bakker5121ce52009-01-03 21:22:43 +00001346 }
1347
Alexander K35d6d462019-10-31 14:46:45 +03001348 T2.p[0] = ( i < 2 ) ? 0 : X.p[i - 2];
1349 T2.p[1] = ( i < 1 ) ? 0 : X.p[i - 1];
1350 T2.p[2] = X.p[i];
1351
Paul Bakker5121ce52009-01-03 21:22:43 +00001352 Z.p[i - t - 1]++;
1353 do
1354 {
1355 Z.p[i - t - 1]--;
1356
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001357 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &T1, 0 ) );
Paul Bakker66d5d072014-06-17 16:39:18 +02001358 T1.p[0] = ( t < 1 ) ? 0 : Y.p[t - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +00001359 T1.p[1] = Y.p[t];
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T1, &T1, Z.p[i - t - 1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001361 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001362 while( mbedtls_mpi_cmp_mpi( &T1, &T2 ) > 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001363
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001364 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T1, &Y, Z.p[i - t - 1] ) );
1365 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &T1, biL * ( i - t - 1 ) ) );
1366 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &X, &X, &T1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001368 if( mbedtls_mpi_cmp_int( &X, 0 ) < 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001369 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001370 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &T1, &Y ) );
1371 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &T1, biL * ( i - t - 1 ) ) );
1372 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &X, &X, &T1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001373 Z.p[i - t - 1]--;
1374 }
1375 }
1376
1377 if( Q != NULL )
1378 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001379 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( Q, &Z ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001380 Q->s = A->s * B->s;
1381 }
1382
1383 if( R != NULL )
1384 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001385 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &X, k ) );
Paul Bakkerf02c5642012-11-13 10:25:21 +00001386 X.s = A->s;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001387 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( R, &X ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389 if( mbedtls_mpi_cmp_int( R, 0 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001390 R->s = 1;
1391 }
1392
1393cleanup:
1394
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001395 mbedtls_mpi_free( &X ); mbedtls_mpi_free( &Y ); mbedtls_mpi_free( &Z );
Alexander K35d6d462019-10-31 14:46:45 +03001396 mbedtls_mpi_free( &T1 );
Alexander Kd19a1932019-11-01 18:20:42 +03001397 mbedtls_platform_zeroize( TP2, sizeof( TP2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001398
1399 return( ret );
1400}
1401
1402/*
1403 * Division by int: A = Q * b + R
Paul Bakker5121ce52009-01-03 21:22:43 +00001404 */
Hanno Becker73d7d792018-12-11 10:35:51 +00001405int mbedtls_mpi_div_int( mbedtls_mpi *Q, mbedtls_mpi *R,
1406 const mbedtls_mpi *A,
1407 mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001408{
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001409 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001410 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001411 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001412
Gilles Peskineef7f4e42022-11-15 23:25:27 +01001413 p[0] = mpi_sint_abs( b );
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001414 B.s = ( b < 0 ) ? -1 : 1;
1415 B.n = 1;
1416 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001417
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001418 return( mbedtls_mpi_div_mpi( Q, R, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001419}
1420
1421/*
1422 * Modulo: R = A mod B
1423 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001424int mbedtls_mpi_mod_mpi( mbedtls_mpi *R, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001425{
Janos Follath24eed8d2019-11-22 13:21:35 +00001426 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker73d7d792018-12-11 10:35:51 +00001427 MPI_VALIDATE_RET( R != NULL );
1428 MPI_VALIDATE_RET( A != NULL );
1429 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001431 if( mbedtls_mpi_cmp_int( B, 0 ) < 0 )
1432 return( MBEDTLS_ERR_MPI_NEGATIVE_VALUE );
Paul Bakkerce40a6d2009-06-23 19:46:08 +00001433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001434 MBEDTLS_MPI_CHK( mbedtls_mpi_div_mpi( NULL, R, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001435
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001436 while( mbedtls_mpi_cmp_int( R, 0 ) < 0 )
1437 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( R, R, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001438
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001439 while( mbedtls_mpi_cmp_mpi( R, B ) >= 0 )
1440 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( R, R, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001441
1442cleanup:
1443
1444 return( ret );
1445}
1446
1447/*
1448 * Modulo: r = A mod b
1449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450int mbedtls_mpi_mod_int( mbedtls_mpi_uint *r, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001451{
Paul Bakker23986e52011-04-24 08:57:21 +00001452 size_t i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001453 mbedtls_mpi_uint x, y, z;
Hanno Becker73d7d792018-12-11 10:35:51 +00001454 MPI_VALIDATE_RET( r != NULL );
1455 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001456
1457 if( b == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001458 return( MBEDTLS_ERR_MPI_DIVISION_BY_ZERO );
Paul Bakker5121ce52009-01-03 21:22:43 +00001459
1460 if( b < 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001461 return( MBEDTLS_ERR_MPI_NEGATIVE_VALUE );
Paul Bakker5121ce52009-01-03 21:22:43 +00001462
1463 /*
1464 * handle trivial cases
1465 */
Gilles Peskineae25bb02022-06-09 19:32:46 +02001466 if( b == 1 || A->n == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001467 {
1468 *r = 0;
1469 return( 0 );
1470 }
1471
1472 if( b == 2 )
1473 {
1474 *r = A->p[0] & 1;
1475 return( 0 );
1476 }
1477
1478 /*
1479 * general case
1480 */
Paul Bakker23986e52011-04-24 08:57:21 +00001481 for( i = A->n, y = 0; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001482 {
Paul Bakker23986e52011-04-24 08:57:21 +00001483 x = A->p[i - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +00001484 y = ( y << biH ) | ( x >> biH );
1485 z = y / b;
1486 y -= z * b;
1487
1488 x <<= biH;
1489 y = ( y << biH ) | ( x >> biH );
1490 z = y / b;
1491 y -= z * b;
1492 }
1493
Paul Bakkerce40a6d2009-06-23 19:46:08 +00001494 /*
1495 * If A is negative, then the current y represents a negative value.
1496 * Flipping it to the positive side.
1497 */
1498 if( A->s < 0 && y != 0 )
1499 y = b - y;
1500
Paul Bakker5121ce52009-01-03 21:22:43 +00001501 *r = y;
1502
1503 return( 0 );
1504}
1505
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001506static void mpi_montg_init( mbedtls_mpi_uint *mm, const mbedtls_mpi *N )
Paul Bakker5121ce52009-01-03 21:22:43 +00001507{
Tom Cosgroveb7438d12022-09-15 15:05:59 +01001508 *mm = mbedtls_mpi_core_montmul_init( N->p );
Paul Bakker5121ce52009-01-03 21:22:43 +00001509}
1510
Tom Cosgrove93842842022-08-05 16:59:43 +01001511/** Montgomery multiplication: A = A * B * R^-1 mod N (HAC 14.36)
1512 *
1513 * \param[in,out] A One of the numbers to multiply.
1514 * It must have at least as many limbs as N
1515 * (A->n >= N->n), and any limbs beyond n are ignored.
1516 * On successful completion, A contains the result of
1517 * the multiplication A * B * R^-1 mod N where
1518 * R = (2^ciL)^n.
1519 * \param[in] B One of the numbers to multiply.
1520 * It must be nonzero and must not have more limbs than N
1521 * (B->n <= N->n).
Tom Cosgrove40d22942022-08-17 06:42:44 +01001522 * \param[in] N The modulus. \p N must be odd.
Tom Cosgrove93842842022-08-05 16:59:43 +01001523 * \param mm The value calculated by `mpi_montg_init(&mm, N)`.
1524 * This is -N^-1 mod 2^ciL.
1525 * \param[in,out] T A bignum for temporary storage.
1526 * It must be at least twice the limb size of N plus 1
1527 * (T->n >= 2 * N->n + 1).
1528 * Its initial content is unused and
1529 * its final content is indeterminate.
Tom Cosgrove5dd97e62022-08-30 14:31:49 +01001530 * It does not get reallocated.
Tom Cosgrove93842842022-08-05 16:59:43 +01001531 */
1532static void mpi_montmul( mbedtls_mpi *A, const mbedtls_mpi *B,
1533 const mbedtls_mpi *N, mbedtls_mpi_uint mm,
Tom Cosgrovef88b47e2022-08-17 08:42:58 +01001534 mbedtls_mpi *T )
Paul Bakker5121ce52009-01-03 21:22:43 +00001535{
Tom Cosgrove93842842022-08-05 16:59:43 +01001536 mbedtls_mpi_core_montmul( A->p, A->p, B->p, B->n, N->p, N->n, mm, T->p );
Paul Bakker5121ce52009-01-03 21:22:43 +00001537}
1538
1539/*
1540 * Montgomery reduction: A = A * R^-1 mod N
Gilles Peskine2a82f722020-06-04 15:00:49 +02001541 *
Tom Cosgrove93842842022-08-05 16:59:43 +01001542 * See mpi_montmul() regarding constraints and guarantees on the parameters.
Paul Bakker5121ce52009-01-03 21:22:43 +00001543 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02001544static void mpi_montred( mbedtls_mpi *A, const mbedtls_mpi *N,
Tom Cosgrovef88b47e2022-08-17 08:42:58 +01001545 mbedtls_mpi_uint mm, mbedtls_mpi *T )
Paul Bakker5121ce52009-01-03 21:22:43 +00001546{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001547 mbedtls_mpi_uint z = 1;
1548 mbedtls_mpi U;
Paul Bakker5121ce52009-01-03 21:22:43 +00001549
Paul Bakker8ddb6452013-02-27 14:56:33 +01001550 U.n = U.s = (int) z;
Paul Bakker5121ce52009-01-03 21:22:43 +00001551 U.p = &z;
1552
Tom Cosgrove93842842022-08-05 16:59:43 +01001553 mpi_montmul( A, &U, N, mm, T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001554}
1555
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01001556/**
1557 * Select an MPI from a table without leaking the index.
1558 *
1559 * This is functionally equivalent to mbedtls_mpi_copy(R, T[idx]) except it
1560 * reads the entire table in order to avoid leaking the value of idx to an
1561 * attacker able to observe memory access patterns.
1562 *
1563 * \param[out] R Where to write the selected MPI.
1564 * \param[in] T The table to read from.
1565 * \param[in] T_size The number of elements in the table.
1566 * \param[in] idx The index of the element to select;
1567 * this must satisfy 0 <= idx < T_size.
1568 *
1569 * \return \c 0 on success, or a negative error code.
1570 */
1571static int mpi_select( mbedtls_mpi *R, const mbedtls_mpi *T, size_t T_size, size_t idx )
1572{
1573 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1574
1575 for( size_t i = 0; i < T_size; i++ )
Manuel Pégourié-Gonnard92413ef2021-06-03 10:42:46 +02001576 {
1577 MBEDTLS_MPI_CHK( mbedtls_mpi_safe_cond_assign( R, &T[i],
Gabor Mezei90437e32021-10-20 11:59:27 +02001578 (unsigned char) mbedtls_ct_size_bool_eq( i, idx ) ) );
Manuel Pégourié-Gonnard92413ef2021-06-03 10:42:46 +02001579 }
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01001580
1581cleanup:
1582 return( ret );
1583}
1584
Paul Bakker5121ce52009-01-03 21:22:43 +00001585/*
1586 * Sliding-window exponentiation: X = A^E mod N (HAC 14.85)
1587 */
Hanno Becker73d7d792018-12-11 10:35:51 +00001588int mbedtls_mpi_exp_mod( mbedtls_mpi *X, const mbedtls_mpi *A,
1589 const mbedtls_mpi *E, const mbedtls_mpi *N,
Yuto Takano538a0cb2021-07-14 10:20:09 +01001590 mbedtls_mpi *prec_RR )
Paul Bakker5121ce52009-01-03 21:22:43 +00001591{
Janos Follath24eed8d2019-11-22 13:21:35 +00001592 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001593 size_t wbits, wsize, one = 1;
1594 size_t i, j, nblimbs;
1595 size_t bufsize, nbits;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001596 mbedtls_mpi_uint ei, mm, state;
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01001597 mbedtls_mpi RR, T, W[ 1 << MBEDTLS_MPI_WINDOW_SIZE ], WW, Apos;
Paul Bakkerf6198c12012-05-16 08:02:29 +00001598 int neg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001599
Hanno Becker73d7d792018-12-11 10:35:51 +00001600 MPI_VALIDATE_RET( X != NULL );
1601 MPI_VALIDATE_RET( A != NULL );
1602 MPI_VALIDATE_RET( E != NULL );
1603 MPI_VALIDATE_RET( N != NULL );
1604
Hanno Becker8d1dd1b2017-09-28 11:02:24 +01001605 if( mbedtls_mpi_cmp_int( N, 0 ) <= 0 || ( N->p[0] & 1 ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001606 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00001607
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608 if( mbedtls_mpi_cmp_int( E, 0 ) < 0 )
1609 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakkerf6198c12012-05-16 08:02:29 +00001610
Chris Jones9246d042020-11-25 15:12:39 +00001611 if( mbedtls_mpi_bitlen( E ) > MBEDTLS_MPI_MAX_BITS ||
1612 mbedtls_mpi_bitlen( N ) > MBEDTLS_MPI_MAX_BITS )
1613 return ( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
1614
Paul Bakkerf6198c12012-05-16 08:02:29 +00001615 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001616 * Init temps and window size
1617 */
1618 mpi_montg_init( &mm, N );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001619 mbedtls_mpi_init( &RR ); mbedtls_mpi_init( &T );
1620 mbedtls_mpi_init( &Apos );
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01001621 mbedtls_mpi_init( &WW );
Paul Bakker5121ce52009-01-03 21:22:43 +00001622 memset( W, 0, sizeof( W ) );
1623
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02001624 i = mbedtls_mpi_bitlen( E );
Paul Bakker5121ce52009-01-03 21:22:43 +00001625
1626 wsize = ( i > 671 ) ? 6 : ( i > 239 ) ? 5 :
1627 ( i > 79 ) ? 4 : ( i > 23 ) ? 3 : 1;
1628
Peter Kolbuse6bcad32018-12-11 14:01:44 -06001629#if( MBEDTLS_MPI_WINDOW_SIZE < 6 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001630 if( wsize > MBEDTLS_MPI_WINDOW_SIZE )
1631 wsize = MBEDTLS_MPI_WINDOW_SIZE;
Peter Kolbuse6bcad32018-12-11 14:01:44 -06001632#endif
Paul Bakkerb6d5f082011-11-25 11:52:11 +00001633
Paul Bakker5121ce52009-01-03 21:22:43 +00001634 j = N->n + 1;
Tom Cosgrove93842842022-08-05 16:59:43 +01001635 /* All W[i] and X must have at least N->n limbs for the mpi_montmul()
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02001636 * and mpi_montred() calls later. Here we ensure that W[1] and X are
1637 * large enough, and later we'll grow other W[i] to the same length.
1638 * They must not be shrunk midway through this function!
1639 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, j ) );
1641 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[1], j ) );
1642 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &T, j * 2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001643
1644 /*
Paul Bakker50546922012-05-19 08:40:49 +00001645 * Compensate for negative A (and correct at the end)
1646 */
1647 neg = ( A->s == -1 );
Paul Bakker50546922012-05-19 08:40:49 +00001648 if( neg )
1649 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Apos, A ) );
Paul Bakker50546922012-05-19 08:40:49 +00001651 Apos.s = 1;
1652 A = &Apos;
1653 }
1654
1655 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001656 * If 1st call, pre-compute R^2 mod N
1657 */
Yuto Takano538a0cb2021-07-14 10:20:09 +01001658 if( prec_RR == NULL || prec_RR->p == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001659 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001660 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &RR, 1 ) );
1661 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &RR, N->n * 2 * biL ) );
1662 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &RR, &RR, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001663
Yuto Takano538a0cb2021-07-14 10:20:09 +01001664 if( prec_RR != NULL )
1665 memcpy( prec_RR, &RR, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001666 }
1667 else
Yuto Takano538a0cb2021-07-14 10:20:09 +01001668 memcpy( &RR, prec_RR, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001669
1670 /*
1671 * W[1] = A * R^2 * R^-1 mod N = A * R mod N
1672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673 if( mbedtls_mpi_cmp_mpi( A, N ) >= 0 )
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02001674 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001675 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &W[1], A, N ) );
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02001676 /* This should be a no-op because W[1] is already that large before
1677 * mbedtls_mpi_mod_mpi(), but it's necessary to avoid an overflow
Tom Cosgrove93842842022-08-05 16:59:43 +01001678 * in mpi_montmul() below, so let's make sure. */
Gilles Peskine2aa3f162021-06-15 21:22:48 +02001679 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[1], N->n + 1 ) );
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02001680 }
Paul Bakkerc2024f42014-01-23 20:38:35 +01001681 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001682 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[1], A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001683
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02001684 /* Note that this is safe because W[1] always has at least N->n limbs
1685 * (it grew above and was preserved by mbedtls_mpi_copy()). */
Tom Cosgrove93842842022-08-05 16:59:43 +01001686 mpi_montmul( &W[1], &RR, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001687
1688 /*
1689 * X = R^2 * R^-1 mod N = R mod N
1690 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001691 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, &RR ) );
Gilles Peskine4e91d472020-06-04 20:55:15 +02001692 mpi_montred( X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001693
1694 if( wsize > 1 )
1695 {
1696 /*
1697 * W[1 << (wsize - 1)] = W[1] ^ (wsize - 1)
1698 */
Paul Bakker66d5d072014-06-17 16:39:18 +02001699 j = one << ( wsize - 1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001701 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[j], N->n + 1 ) );
1702 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[j], &W[1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001703
1704 for( i = 0; i < wsize - 1; i++ )
Tom Cosgrove93842842022-08-05 16:59:43 +01001705 mpi_montmul( &W[j], &W[j], N, mm, &T );
Paul Bakker0d7702c2013-10-29 16:18:35 +01001706
Paul Bakker5121ce52009-01-03 21:22:43 +00001707 /*
1708 * W[i] = W[i - 1] * W[1]
1709 */
Paul Bakker66d5d072014-06-17 16:39:18 +02001710 for( i = j + 1; i < ( one << wsize ); i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001711 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[i], N->n + 1 ) );
1713 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[i], &W[i - 1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001714
Tom Cosgrove93842842022-08-05 16:59:43 +01001715 mpi_montmul( &W[i], &W[1], N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001716 }
1717 }
1718
1719 nblimbs = E->n;
1720 bufsize = 0;
1721 nbits = 0;
1722 wbits = 0;
1723 state = 0;
1724
1725 while( 1 )
1726 {
1727 if( bufsize == 0 )
1728 {
Paul Bakker0d7702c2013-10-29 16:18:35 +01001729 if( nblimbs == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001730 break;
1731
Paul Bakker0d7702c2013-10-29 16:18:35 +01001732 nblimbs--;
1733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734 bufsize = sizeof( mbedtls_mpi_uint ) << 3;
Paul Bakker5121ce52009-01-03 21:22:43 +00001735 }
1736
1737 bufsize--;
1738
1739 ei = (E->p[nblimbs] >> bufsize) & 1;
1740
1741 /*
1742 * skip leading 0s
1743 */
1744 if( ei == 0 && state == 0 )
1745 continue;
1746
1747 if( ei == 0 && state == 1 )
1748 {
1749 /*
1750 * out of window, square X
1751 */
Tom Cosgrove93842842022-08-05 16:59:43 +01001752 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001753 continue;
1754 }
1755
1756 /*
1757 * add ei to current window
1758 */
1759 state = 2;
1760
1761 nbits++;
Paul Bakker66d5d072014-06-17 16:39:18 +02001762 wbits |= ( ei << ( wsize - nbits ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001763
1764 if( nbits == wsize )
1765 {
1766 /*
1767 * X = X^wsize R^-1 mod N
1768 */
1769 for( i = 0; i < wsize; i++ )
Tom Cosgrove93842842022-08-05 16:59:43 +01001770 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001771
1772 /*
1773 * X = X * W[wbits] R^-1 mod N
1774 */
Manuel Pégourié-Gonnarde22176e2021-06-10 09:34:00 +02001775 MBEDTLS_MPI_CHK( mpi_select( &WW, W, (size_t) 1 << wsize, wbits ) );
Tom Cosgrove93842842022-08-05 16:59:43 +01001776 mpi_montmul( X, &WW, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001777
1778 state--;
1779 nbits = 0;
1780 wbits = 0;
1781 }
1782 }
1783
1784 /*
1785 * process the remaining bits
1786 */
1787 for( i = 0; i < nbits; i++ )
1788 {
Tom Cosgrove93842842022-08-05 16:59:43 +01001789 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001790
1791 wbits <<= 1;
1792
Paul Bakker66d5d072014-06-17 16:39:18 +02001793 if( ( wbits & ( one << wsize ) ) != 0 )
Tom Cosgrove93842842022-08-05 16:59:43 +01001794 mpi_montmul( X, &W[1], N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001795 }
1796
1797 /*
1798 * X = A^E * R * R^-1 mod N = A^E mod N
1799 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02001800 mpi_montred( X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001801
Hanno Beckera4af1c42017-04-18 09:07:45 +01001802 if( neg && E->n != 0 && ( E->p[0] & 1 ) != 0 )
Paul Bakkerf6198c12012-05-16 08:02:29 +00001803 {
1804 X->s = -1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( X, N, X ) );
Paul Bakkerf6198c12012-05-16 08:02:29 +00001806 }
1807
Paul Bakker5121ce52009-01-03 21:22:43 +00001808cleanup:
1809
Paul Bakker66d5d072014-06-17 16:39:18 +02001810 for( i = ( one << ( wsize - 1 ) ); i < ( one << wsize ); i++ )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811 mbedtls_mpi_free( &W[i] );
Paul Bakker5121ce52009-01-03 21:22:43 +00001812
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813 mbedtls_mpi_free( &W[1] ); mbedtls_mpi_free( &T ); mbedtls_mpi_free( &Apos );
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01001814 mbedtls_mpi_free( &WW );
Paul Bakker6c591fa2011-05-05 11:49:20 +00001815
Yuto Takano538a0cb2021-07-14 10:20:09 +01001816 if( prec_RR == NULL || prec_RR->p == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817 mbedtls_mpi_free( &RR );
Paul Bakker5121ce52009-01-03 21:22:43 +00001818
1819 return( ret );
1820}
1821
Paul Bakker5121ce52009-01-03 21:22:43 +00001822/*
1823 * Greatest common divisor: G = gcd(A, B) (HAC 14.54)
1824 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825int mbedtls_mpi_gcd( mbedtls_mpi *G, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001826{
Janos Follath24eed8d2019-11-22 13:21:35 +00001827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001828 size_t lz, lzt;
Alexander Ke8ad49f2019-08-16 16:16:07 +03001829 mbedtls_mpi TA, TB;
Paul Bakker5121ce52009-01-03 21:22:43 +00001830
Hanno Becker73d7d792018-12-11 10:35:51 +00001831 MPI_VALIDATE_RET( G != NULL );
1832 MPI_VALIDATE_RET( A != NULL );
1833 MPI_VALIDATE_RET( B != NULL );
1834
Alexander Ke8ad49f2019-08-16 16:16:07 +03001835 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00001836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TA, A ) );
1838 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001840 lz = mbedtls_mpi_lsb( &TA );
1841 lzt = mbedtls_mpi_lsb( &TB );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00001842
Gilles Peskine27253bc2021-06-09 13:26:43 +02001843 /* The loop below gives the correct result when A==0 but not when B==0.
1844 * So have a special case for B==0. Leverage the fact that we just
1845 * calculated the lsb and lsb(B)==0 iff B is odd or 0 to make the test
1846 * slightly more efficient than cmp_int(). */
1847 if( lzt == 0 && mbedtls_mpi_get_bit( &TB, 0 ) == 0 )
1848 {
1849 ret = mbedtls_mpi_copy( G, A );
1850 goto cleanup;
1851 }
1852
Paul Bakker66d5d072014-06-17 16:39:18 +02001853 if( lzt < lz )
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00001854 lz = lzt;
1855
Paul Bakker5121ce52009-01-03 21:22:43 +00001856 TA.s = TB.s = 1;
1857
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02001858 /* We mostly follow the procedure described in HAC 14.54, but with some
1859 * minor differences:
1860 * - Sequences of multiplications or divisions by 2 are grouped into a
1861 * single shift operation.
Gilles Peskineb09c7ee2021-06-21 18:58:39 +02001862 * - The procedure in HAC assumes that 0 < TB <= TA.
1863 * - The condition TB <= TA is not actually necessary for correctness.
1864 * TA and TB have symmetric roles except for the loop termination
1865 * condition, and the shifts at the beginning of the loop body
1866 * remove any significance from the ordering of TA vs TB before
1867 * the shifts.
1868 * - If TA = 0, the loop goes through 0 iterations and the result is
1869 * correctly TB.
1870 * - The case TB = 0 was short-circuited above.
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02001871 *
1872 * For the correctness proof below, decompose the original values of
1873 * A and B as
1874 * A = sa * 2^a * A' with A'=0 or A' odd, and sa = +-1
1875 * B = sb * 2^b * B' with B'=0 or B' odd, and sb = +-1
1876 * Then gcd(A, B) = 2^{min(a,b)} * gcd(A',B'),
1877 * and gcd(A',B') is odd or 0.
1878 *
1879 * At the beginning, we have TA = |A| and TB = |B| so gcd(A,B) = gcd(TA,TB).
1880 * The code maintains the following invariant:
1881 * gcd(A,B) = 2^k * gcd(TA,TB) for some k (I)
Gilles Peskine4df3f1f2021-06-15 22:09:39 +02001882 */
1883
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02001884 /* Proof that the loop terminates:
1885 * At each iteration, either the right-shift by 1 is made on a nonzero
1886 * value and the nonnegative integer bitlen(TA) + bitlen(TB) decreases
1887 * by at least 1, or the right-shift by 1 is made on zero and then
1888 * TA becomes 0 which ends the loop (TB cannot be 0 if it is right-shifted
1889 * since in that case TB is calculated from TB-TA with the condition TB>TA).
1890 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001891 while( mbedtls_mpi_cmp_int( &TA, 0 ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001892 {
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02001893 /* Divisions by 2 preserve the invariant (I). */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TA, mbedtls_mpi_lsb( &TA ) ) );
1895 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TB, mbedtls_mpi_lsb( &TB ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001896
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02001897 /* Set either TA or TB to |TA-TB|/2. Since TA and TB are both odd,
1898 * TA-TB is even so the division by 2 has an integer result.
1899 * Invariant (I) is preserved since any odd divisor of both TA and TB
1900 * also divides |TA-TB|/2, and any odd divisor of both TA and |TA-TB|/2
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001901 * also divides TB, and any odd divisor of both TB and |TA-TB|/2 also
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02001902 * divides TA.
1903 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001904 if( mbedtls_mpi_cmp_mpi( &TA, &TB ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001905 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( &TA, &TA, &TB ) );
1907 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TA, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001908 }
1909 else
1910 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( &TB, &TB, &TA ) );
1912 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TB, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001913 }
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02001914 /* Note that one of TA or TB is still odd. */
Paul Bakker5121ce52009-01-03 21:22:43 +00001915 }
1916
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02001917 /* By invariant (I), gcd(A,B) = 2^k * gcd(TA,TB) for some k.
1918 * At the loop exit, TA = 0, so gcd(TA,TB) = TB.
1919 * - If there was at least one loop iteration, then one of TA or TB is odd,
1920 * and TA = 0, so TB is odd and gcd(TA,TB) = gcd(A',B'). In this case,
1921 * lz = min(a,b) so gcd(A,B) = 2^lz * TB.
1922 * - If there was no loop iteration, then A was 0, and gcd(A,B) = B.
Gilles Peskine4d3fd362021-06-21 11:40:38 +02001923 * In this case, lz = 0 and B = TB so gcd(A,B) = B = 2^lz * TB as well.
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02001924 */
1925
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001926 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &TB, lz ) );
1927 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( G, &TB ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001928
1929cleanup:
1930
Alexander Ke8ad49f2019-08-16 16:16:07 +03001931 mbedtls_mpi_free( &TA ); mbedtls_mpi_free( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00001932
1933 return( ret );
1934}
1935
Paul Bakker33dc46b2014-04-30 16:11:39 +02001936/*
1937 * Fill X with size bytes of random.
Gilles Peskine22cdd0c2022-10-27 20:15:13 +02001938 * The bytes returned from the RNG are used in a specific order which
1939 * is suitable for deterministic ECDSA (see the specification of
1940 * mbedtls_mpi_random() and the implementation in mbedtls_mpi_fill_random()).
Paul Bakker33dc46b2014-04-30 16:11:39 +02001941 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001942int mbedtls_mpi_fill_random( mbedtls_mpi *X, size_t size,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001943 int (*f_rng)(void *, unsigned char *, size_t),
1944 void *p_rng )
Paul Bakker287781a2011-03-26 13:18:49 +00001945{
Janos Follath24eed8d2019-11-22 13:21:35 +00001946 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Janos Follath620c58c2022-08-15 11:58:42 +01001947 const size_t limbs = CHARS_TO_LIMBS( size );
Hanno Beckerda1655a2017-10-18 14:21:44 +01001948
Hanno Becker8ce11a32018-12-19 16:18:52 +00001949 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00001950 MPI_VALIDATE_RET( f_rng != NULL );
Paul Bakker33dc46b2014-04-30 16:11:39 +02001951
Hanno Beckerda1655a2017-10-18 14:21:44 +01001952 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskineed32b572021-06-02 22:17:52 +02001953 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02001954 if( size == 0 )
1955 return( 0 );
Paul Bakker287781a2011-03-26 13:18:49 +00001956
Gilles Peskine5980f2b2022-09-09 20:55:53 +02001957 ret = mbedtls_mpi_core_fill_random( X->p, X->n, size, f_rng, p_rng );
Paul Bakker287781a2011-03-26 13:18:49 +00001958
1959cleanup:
1960 return( ret );
1961}
1962
Gilles Peskine02ac93a2021-03-29 22:02:55 +02001963int mbedtls_mpi_random( mbedtls_mpi *X,
1964 mbedtls_mpi_sint min,
1965 const mbedtls_mpi *N,
1966 int (*f_rng)(void *, unsigned char *, size_t),
1967 void *p_rng )
1968{
Gilles Peskine1e918f42021-03-29 22:14:51 +02001969 if( min < 0 )
1970 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
1971 if( mbedtls_mpi_cmp_int( N, min ) <= 0 )
1972 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
1973
Gilles Peskine26be89b2022-09-21 13:43:30 +02001974 /* Ensure that target MPI has exactly the same number of limbs
1975 * as the upper bound, even if the upper bound has leading zeros.
1976 * This is necessary for the mbedtls_mpi_lt_mpi_ct() check. */
1977 int ret = mbedtls_mpi_resize_clear( X, N->n );
1978 if( ret != 0 )
1979 return( ret );
1980
1981 unsigned ge_lower = 1, lt_upper = 0;
1982 size_t n_bits = mbedtls_mpi_bitlen( N );
1983 size_t n_bytes = ( n_bits + 7 ) / 8;
1984
1985 ret = MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
1986
Gilles Peskinee5381682021-04-13 21:23:25 +02001987 /*
1988 * When min == 0, each try has at worst a probability 1/2 of failing
1989 * (the msb has a probability 1/2 of being 0, and then the result will
1990 * be < N), so after 30 tries failure probability is a most 2**(-30).
1991 *
1992 * When N is just below a power of 2, as is the case when generating
Gilles Peskinee842e582021-04-15 11:45:19 +02001993 * a random scalar on most elliptic curves, 1 try is enough with
Gilles Peskinee5381682021-04-13 21:23:25 +02001994 * overwhelming probability. When N is just above a power of 2,
Gilles Peskinee842e582021-04-15 11:45:19 +02001995 * as when generating a random scalar on secp224k1, each try has
Gilles Peskinee5381682021-04-13 21:23:25 +02001996 * a probability of failing that is almost 1/2.
1997 *
1998 * The probabilities are almost the same if min is nonzero but negligible
1999 * compared to N. This is always the case when N is crypto-sized, but
2000 * it's convenient to support small N for testing purposes. When N
2001 * is small, use a higher repeat count, otherwise the probability of
2002 * failure is macroscopic.
2003 */
Gilles Peskine26be89b2022-09-21 13:43:30 +02002004 int count = ( n_bytes > 4 ? 30 : 250 );
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002005
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002006 /*
2007 * Match the procedure given in RFC 6979 §3.3 (deterministic ECDSA)
2008 * when f_rng is a suitably parametrized instance of HMAC_DRBG:
2009 * - use the same byte ordering;
2010 * - keep the leftmost n_bits bits of the generated octet string;
2011 * - try until result is in the desired range.
2012 * This also avoids any bias, which is especially important for ECDSA.
2013 */
2014 do
2015 {
Gilles Peskine5980f2b2022-09-09 20:55:53 +02002016 MBEDTLS_MPI_CHK( mbedtls_mpi_core_fill_random( X->p, X->n,
2017 n_bytes,
2018 f_rng, p_rng ) );
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002019 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( X, 8 * n_bytes - n_bits ) );
2020
Gilles Peskinee5381682021-04-13 21:23:25 +02002021 if( --count == 0 )
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002022 {
2023 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
2024 goto cleanup;
2025 }
2026
Gilles Peskine8a32a752022-09-09 23:19:04 +02002027 ge_lower = mbedtls_mpi_core_uint_le_mpi( min, X->p, X->n );
2028 lt_upper = mbedtls_mpi_core_lt_ct( X->p, N->p, N->n );
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002029 }
Gilles Peskine8a32a752022-09-09 23:19:04 +02002030 while( ge_lower == 0 || lt_upper == 0 );
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002031
2032cleanup:
2033 return( ret );
2034}
2035
Paul Bakker5121ce52009-01-03 21:22:43 +00002036/*
2037 * Modular inverse: X = A^-1 mod N (HAC 14.61 / 14.64)
2038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039int mbedtls_mpi_inv_mod( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *N )
Paul Bakker5121ce52009-01-03 21:22:43 +00002040{
Janos Follath24eed8d2019-11-22 13:21:35 +00002041 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002042 mbedtls_mpi G, TA, TU, U1, U2, TB, TV, V1, V2;
Hanno Becker73d7d792018-12-11 10:35:51 +00002043 MPI_VALIDATE_RET( X != NULL );
2044 MPI_VALIDATE_RET( A != NULL );
2045 MPI_VALIDATE_RET( N != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00002046
Hanno Becker4bcb4912017-04-18 15:49:39 +01002047 if( mbedtls_mpi_cmp_int( N, 1 ) <= 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002048 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00002049
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TU ); mbedtls_mpi_init( &U1 ); mbedtls_mpi_init( &U2 );
2051 mbedtls_mpi_init( &G ); mbedtls_mpi_init( &TB ); mbedtls_mpi_init( &TV );
2052 mbedtls_mpi_init( &V1 ); mbedtls_mpi_init( &V2 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054 MBEDTLS_MPI_CHK( mbedtls_mpi_gcd( &G, A, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002056 if( mbedtls_mpi_cmp_int( &G, 1 ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002057 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002058 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker5121ce52009-01-03 21:22:43 +00002059 goto cleanup;
2060 }
2061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002062 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &TA, A, N ) );
2063 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TU, &TA ) );
2064 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, N ) );
2065 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TV, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002066
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002067 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &U1, 1 ) );
2068 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &U2, 0 ) );
2069 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &V1, 0 ) );
2070 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &V2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002071
2072 do
2073 {
2074 while( ( TU.p[0] & 1 ) == 0 )
2075 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TU, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002077
2078 if( ( U1.p[0] & 1 ) != 0 || ( U2.p[0] & 1 ) != 0 )
2079 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &U1, &U1, &TB ) );
2081 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U2, &U2, &TA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002082 }
2083
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &U1, 1 ) );
2085 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &U2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002086 }
2087
2088 while( ( TV.p[0] & 1 ) == 0 )
2089 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002090 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TV, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002091
2092 if( ( V1.p[0] & 1 ) != 0 || ( V2.p[0] & 1 ) != 0 )
2093 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002094 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &V1, &V1, &TB ) );
2095 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V2, &V2, &TA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002096 }
2097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002098 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &V1, 1 ) );
2099 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &V2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002100 }
2101
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002102 if( mbedtls_mpi_cmp_mpi( &TU, &TV ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002103 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002104 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &TU, &TU, &TV ) );
2105 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U1, &U1, &V1 ) );
2106 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U2, &U2, &V2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002107 }
2108 else
2109 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &TV, &TV, &TU ) );
2111 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V1, &V1, &U1 ) );
2112 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V2, &V2, &U2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002113 }
2114 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002115 while( mbedtls_mpi_cmp_int( &TU, 0 ) != 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002117 while( mbedtls_mpi_cmp_int( &V1, 0 ) < 0 )
2118 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &V1, &V1, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120 while( mbedtls_mpi_cmp_mpi( &V1, N ) >= 0 )
2121 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V1, &V1, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002122
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002123 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, &V1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002124
2125cleanup:
2126
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002127 mbedtls_mpi_free( &TA ); mbedtls_mpi_free( &TU ); mbedtls_mpi_free( &U1 ); mbedtls_mpi_free( &U2 );
2128 mbedtls_mpi_free( &G ); mbedtls_mpi_free( &TB ); mbedtls_mpi_free( &TV );
2129 mbedtls_mpi_free( &V1 ); mbedtls_mpi_free( &V2 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002130
2131 return( ret );
2132}
2133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002134#if defined(MBEDTLS_GENPRIME)
Paul Bakkerd9374b02012-11-02 11:02:58 +00002135
Paul Bakker5121ce52009-01-03 21:22:43 +00002136static const int small_prime[] =
2137{
2138 3, 5, 7, 11, 13, 17, 19, 23,
2139 29, 31, 37, 41, 43, 47, 53, 59,
2140 61, 67, 71, 73, 79, 83, 89, 97,
2141 101, 103, 107, 109, 113, 127, 131, 137,
2142 139, 149, 151, 157, 163, 167, 173, 179,
2143 181, 191, 193, 197, 199, 211, 223, 227,
2144 229, 233, 239, 241, 251, 257, 263, 269,
2145 271, 277, 281, 283, 293, 307, 311, 313,
2146 317, 331, 337, 347, 349, 353, 359, 367,
2147 373, 379, 383, 389, 397, 401, 409, 419,
2148 421, 431, 433, 439, 443, 449, 457, 461,
2149 463, 467, 479, 487, 491, 499, 503, 509,
2150 521, 523, 541, 547, 557, 563, 569, 571,
2151 577, 587, 593, 599, 601, 607, 613, 617,
2152 619, 631, 641, 643, 647, 653, 659, 661,
2153 673, 677, 683, 691, 701, 709, 719, 727,
2154 733, 739, 743, 751, 757, 761, 769, 773,
2155 787, 797, 809, 811, 821, 823, 827, 829,
2156 839, 853, 857, 859, 863, 877, 881, 883,
2157 887, 907, 911, 919, 929, 937, 941, 947,
2158 953, 967, 971, 977, 983, 991, 997, -103
2159};
2160
2161/*
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002162 * Small divisors test (X must be positive)
2163 *
2164 * Return values:
2165 * 0: no small factor (possible prime, more tests needed)
2166 * 1: certain prime
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167 * MBEDTLS_ERR_MPI_NOT_ACCEPTABLE: certain non-prime
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002168 * other negative: error
Paul Bakker5121ce52009-01-03 21:22:43 +00002169 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170static int mpi_check_small_factors( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +00002171{
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002172 int ret = 0;
2173 size_t i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002174 mbedtls_mpi_uint r;
Paul Bakker5121ce52009-01-03 21:22:43 +00002175
Paul Bakker5121ce52009-01-03 21:22:43 +00002176 if( ( X->p[0] & 1 ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002177 return( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE );
Paul Bakker5121ce52009-01-03 21:22:43 +00002178
2179 for( i = 0; small_prime[i] > 0; i++ )
2180 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181 if( mbedtls_mpi_cmp_int( X, small_prime[i] ) <= 0 )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002182 return( 1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002184 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, small_prime[i] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002185
2186 if( r == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002187 return( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE );
Paul Bakker5121ce52009-01-03 21:22:43 +00002188 }
2189
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002190cleanup:
2191 return( ret );
2192}
2193
2194/*
2195 * Miller-Rabin pseudo-primality test (HAC 4.24)
2196 */
Janos Follathda31fa12018-09-03 14:45:23 +01002197static int mpi_miller_rabin( const mbedtls_mpi *X, size_t rounds,
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002198 int (*f_rng)(void *, unsigned char *, size_t),
2199 void *p_rng )
2200{
Pascal Junodb99183d2015-03-11 16:49:45 +01002201 int ret, count;
Janos Follathda31fa12018-09-03 14:45:23 +01002202 size_t i, j, k, s;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203 mbedtls_mpi W, R, T, A, RR;
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002204
Hanno Becker8ce11a32018-12-19 16:18:52 +00002205 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002206 MPI_VALIDATE_RET( f_rng != NULL );
2207
2208 mbedtls_mpi_init( &W ); mbedtls_mpi_init( &R );
2209 mbedtls_mpi_init( &T ); mbedtls_mpi_init( &A );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210 mbedtls_mpi_init( &RR );
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002211
Paul Bakker5121ce52009-01-03 21:22:43 +00002212 /*
2213 * W = |X| - 1
2214 * R = W >> lsb( W )
2215 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002216 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_int( &W, X, 1 ) );
2217 s = mbedtls_mpi_lsb( &W );
2218 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &R, &W ) );
2219 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &R, s ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002220
Janos Follathda31fa12018-09-03 14:45:23 +01002221 for( i = 0; i < rounds; i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00002222 {
2223 /*
2224 * pick a random A, 1 < A < |X| - 1
2225 */
Pascal Junodb99183d2015-03-11 16:49:45 +01002226 count = 0;
2227 do {
Manuel Pégourié-Gonnard53c76c02015-04-17 20:15:36 +02002228 MBEDTLS_MPI_CHK( mbedtls_mpi_fill_random( &A, X->n * ciL, f_rng, p_rng ) );
Pascal Junodb99183d2015-03-11 16:49:45 +01002229
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02002230 j = mbedtls_mpi_bitlen( &A );
2231 k = mbedtls_mpi_bitlen( &W );
Pascal Junodb99183d2015-03-11 16:49:45 +01002232 if (j > k) {
Darryl Greene3f95ed2018-10-02 13:21:35 +01002233 A.p[A.n - 1] &= ( (mbedtls_mpi_uint) 1 << ( k - ( A.n - 1 ) * biL - 1 ) ) - 1;
Pascal Junodb99183d2015-03-11 16:49:45 +01002234 }
2235
2236 if (count++ > 30) {
Jens Wiklanderf08aa3e2019-01-17 13:30:57 +01002237 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
2238 goto cleanup;
Pascal Junodb99183d2015-03-11 16:49:45 +01002239 }
2240
Manuel Pégourié-Gonnard53c76c02015-04-17 20:15:36 +02002241 } while ( mbedtls_mpi_cmp_mpi( &A, &W ) >= 0 ||
2242 mbedtls_mpi_cmp_int( &A, 1 ) <= 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002243
2244 /*
2245 * A = A^R mod |X|
2246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002247 MBEDTLS_MPI_CHK( mbedtls_mpi_exp_mod( &A, &A, &R, X, &RR ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249 if( mbedtls_mpi_cmp_mpi( &A, &W ) == 0 ||
2250 mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002251 continue;
2252
2253 j = 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002254 while( j < s && mbedtls_mpi_cmp_mpi( &A, &W ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002255 {
2256 /*
2257 * A = A * A mod |X|
2258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002259 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_mpi( &T, &A, &A ) );
2260 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &A, &T, X ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002261
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002262 if( mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002263 break;
2264
2265 j++;
2266 }
2267
2268 /*
2269 * not prime if A != |X| - 1 or A == 1
2270 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002271 if( mbedtls_mpi_cmp_mpi( &A, &W ) != 0 ||
2272 mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002273 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002274 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker5121ce52009-01-03 21:22:43 +00002275 break;
2276 }
2277 }
2278
2279cleanup:
Hanno Becker73d7d792018-12-11 10:35:51 +00002280 mbedtls_mpi_free( &W ); mbedtls_mpi_free( &R );
2281 mbedtls_mpi_free( &T ); mbedtls_mpi_free( &A );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002282 mbedtls_mpi_free( &RR );
Paul Bakker5121ce52009-01-03 21:22:43 +00002283
2284 return( ret );
2285}
2286
2287/*
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002288 * Pseudo-primality test: small factors, then Miller-Rabin
2289 */
Janos Follatha0b67c22018-09-18 14:48:23 +01002290int mbedtls_mpi_is_prime_ext( const mbedtls_mpi *X, int rounds,
2291 int (*f_rng)(void *, unsigned char *, size_t),
2292 void *p_rng )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002293{
Janos Follath24eed8d2019-11-22 13:21:35 +00002294 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295 mbedtls_mpi XX;
Hanno Becker8ce11a32018-12-19 16:18:52 +00002296 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002297 MPI_VALIDATE_RET( f_rng != NULL );
Manuel Pégourié-Gonnard7f4ed672014-10-14 20:56:02 +02002298
2299 XX.s = 1;
2300 XX.n = X->n;
2301 XX.p = X->p;
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002303 if( mbedtls_mpi_cmp_int( &XX, 0 ) == 0 ||
2304 mbedtls_mpi_cmp_int( &XX, 1 ) == 0 )
2305 return( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE );
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002307 if( mbedtls_mpi_cmp_int( &XX, 2 ) == 0 )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002308 return( 0 );
2309
2310 if( ( ret = mpi_check_small_factors( &XX ) ) != 0 )
2311 {
2312 if( ret == 1 )
2313 return( 0 );
2314
2315 return( ret );
2316 }
2317
Janos Follathda31fa12018-09-03 14:45:23 +01002318 return( mpi_miller_rabin( &XX, rounds, f_rng, p_rng ) );
Janos Follathf301d232018-08-14 13:34:01 +01002319}
2320
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002321/*
Paul Bakker5121ce52009-01-03 21:22:43 +00002322 * Prime number generation
Jethro Beekman66689272018-02-14 19:24:10 -08002323 *
Janos Follathf301d232018-08-14 13:34:01 +01002324 * To generate an RSA key in a way recommended by FIPS 186-4, both primes must
2325 * be either 1024 bits or 1536 bits long, and flags must contain
2326 * MBEDTLS_MPI_GEN_PRIME_FLAG_LOW_ERR.
Paul Bakker5121ce52009-01-03 21:22:43 +00002327 */
Janos Follath7c025a92018-08-14 11:08:41 +01002328int mbedtls_mpi_gen_prime( mbedtls_mpi *X, size_t nbits, int flags,
Paul Bakkera3d195c2011-11-27 21:07:34 +00002329 int (*f_rng)(void *, unsigned char *, size_t),
2330 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +00002331{
Jethro Beekman66689272018-02-14 19:24:10 -08002332#ifdef MBEDTLS_HAVE_INT64
2333// ceil(2^63.5)
2334#define CEIL_MAXUINT_DIV_SQRT2 0xb504f333f9de6485ULL
2335#else
2336// ceil(2^31.5)
2337#define CEIL_MAXUINT_DIV_SQRT2 0xb504f334U
2338#endif
2339 int ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker23986e52011-04-24 08:57:21 +00002340 size_t k, n;
Janos Follathda31fa12018-09-03 14:45:23 +01002341 int rounds;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342 mbedtls_mpi_uint r;
2343 mbedtls_mpi Y;
Paul Bakker5121ce52009-01-03 21:22:43 +00002344
Hanno Becker8ce11a32018-12-19 16:18:52 +00002345 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002346 MPI_VALIDATE_RET( f_rng != NULL );
2347
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002348 if( nbits < 3 || nbits > MBEDTLS_MPI_MAX_BITS )
2349 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00002350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351 mbedtls_mpi_init( &Y );
Paul Bakker5121ce52009-01-03 21:22:43 +00002352
2353 n = BITS_TO_LIMBS( nbits );
2354
Janos Follathda31fa12018-09-03 14:45:23 +01002355 if( ( flags & MBEDTLS_MPI_GEN_PRIME_FLAG_LOW_ERR ) == 0 )
2356 {
2357 /*
2358 * 2^-80 error probability, number of rounds chosen per HAC, table 4.4
2359 */
2360 rounds = ( ( nbits >= 1300 ) ? 2 : ( nbits >= 850 ) ? 3 :
2361 ( nbits >= 650 ) ? 4 : ( nbits >= 350 ) ? 8 :
2362 ( nbits >= 250 ) ? 12 : ( nbits >= 150 ) ? 18 : 27 );
2363 }
2364 else
2365 {
2366 /*
2367 * 2^-100 error probability, number of rounds computed based on HAC,
2368 * fact 4.48
2369 */
2370 rounds = ( ( nbits >= 1450 ) ? 4 : ( nbits >= 1150 ) ? 5 :
2371 ( nbits >= 1000 ) ? 6 : ( nbits >= 850 ) ? 7 :
2372 ( nbits >= 750 ) ? 8 : ( nbits >= 500 ) ? 13 :
2373 ( nbits >= 250 ) ? 28 : ( nbits >= 150 ) ? 40 : 51 );
2374 }
2375
Jethro Beekman66689272018-02-14 19:24:10 -08002376 while( 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002377 {
Jethro Beekman66689272018-02-14 19:24:10 -08002378 MBEDTLS_MPI_CHK( mbedtls_mpi_fill_random( X, n * ciL, f_rng, p_rng ) );
2379 /* make sure generated number is at least (nbits-1)+0.5 bits (FIPS 186-4 §B.3.3 steps 4.4, 5.5) */
2380 if( X->p[n-1] < CEIL_MAXUINT_DIV_SQRT2 ) continue;
2381
2382 k = n * biL;
2383 if( k > nbits ) MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( X, k - nbits ) );
2384 X->p[0] |= 1;
2385
Janos Follath7c025a92018-08-14 11:08:41 +01002386 if( ( flags & MBEDTLS_MPI_GEN_PRIME_FLAG_DH ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002387 {
Janos Follatha0b67c22018-09-18 14:48:23 +01002388 ret = mbedtls_mpi_is_prime_ext( X, rounds, f_rng, p_rng );
Jethro Beekman66689272018-02-14 19:24:10 -08002389
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002390 if( ret != MBEDTLS_ERR_MPI_NOT_ACCEPTABLE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002391 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002392 }
Jethro Beekman66689272018-02-14 19:24:10 -08002393 else
Paul Bakker5121ce52009-01-03 21:22:43 +00002394 {
Manuel Pégourié-Gonnardddf76152013-11-22 19:58:22 +01002395 /*
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01002396 * A necessary condition for Y and X = 2Y + 1 to be prime
Jethro Beekman66689272018-02-14 19:24:10 -08002397 * is X = 2 mod 3 (which is equivalent to Y = 2 mod 3).
2398 * Make sure it is satisfied, while keeping X = 3 mod 4
Manuel Pégourié-Gonnardddf76152013-11-22 19:58:22 +01002399 */
Jethro Beekman66689272018-02-14 19:24:10 -08002400
2401 X->p[0] |= 2;
2402
2403 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, 3 ) );
2404 if( r == 0 )
2405 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 8 ) );
2406 else if( r == 1 )
2407 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 4 ) );
2408
2409 /* Set Y = (X-1) / 2, which is X / 2 because X is odd */
2410 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Y, X ) );
2411 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &Y, 1 ) );
2412
2413 while( 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002414 {
Jethro Beekman66689272018-02-14 19:24:10 -08002415 /*
2416 * First, check small factors for X and Y
2417 * before doing Miller-Rabin on any of them
2418 */
2419 if( ( ret = mpi_check_small_factors( X ) ) == 0 &&
2420 ( ret = mpi_check_small_factors( &Y ) ) == 0 &&
Janos Follathda31fa12018-09-03 14:45:23 +01002421 ( ret = mpi_miller_rabin( X, rounds, f_rng, p_rng ) )
Janos Follathf301d232018-08-14 13:34:01 +01002422 == 0 &&
Janos Follathda31fa12018-09-03 14:45:23 +01002423 ( ret = mpi_miller_rabin( &Y, rounds, f_rng, p_rng ) )
Janos Follathf301d232018-08-14 13:34:01 +01002424 == 0 )
Jethro Beekman66689272018-02-14 19:24:10 -08002425 goto cleanup;
2426
2427 if( ret != MBEDTLS_ERR_MPI_NOT_ACCEPTABLE )
2428 goto cleanup;
2429
2430 /*
2431 * Next candidates. We want to preserve Y = (X-1) / 2 and
2432 * Y = 1 mod 2 and Y = 2 mod 3 (eq X = 3 mod 4 and X = 2 mod 3)
2433 * so up Y by 6 and X by 12.
2434 */
2435 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 12 ) );
2436 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( &Y, &Y, 6 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002437 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002438 }
2439 }
2440
2441cleanup:
2442
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443 mbedtls_mpi_free( &Y );
Paul Bakker5121ce52009-01-03 21:22:43 +00002444
2445 return( ret );
2446}
2447
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002448#endif /* MBEDTLS_GENPRIME */
Paul Bakker5121ce52009-01-03 21:22:43 +00002449
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002450#if defined(MBEDTLS_SELF_TEST)
Paul Bakker5121ce52009-01-03 21:22:43 +00002451
Paul Bakker23986e52011-04-24 08:57:21 +00002452#define GCD_PAIR_COUNT 3
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002453
2454static const int gcd_pairs[GCD_PAIR_COUNT][3] =
2455{
2456 { 693, 609, 21 },
2457 { 1764, 868, 28 },
2458 { 768454923, 542167814, 1 }
2459};
2460
Paul Bakker5121ce52009-01-03 21:22:43 +00002461/*
2462 * Checkup routine
2463 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002464int mbedtls_mpi_self_test( int verbose )
Paul Bakker5121ce52009-01-03 21:22:43 +00002465{
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002466 int ret, i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002467 mbedtls_mpi A, E, N, X, Y, U, V;
Paul Bakker5121ce52009-01-03 21:22:43 +00002468
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002469 mbedtls_mpi_init( &A ); mbedtls_mpi_init( &E ); mbedtls_mpi_init( &N ); mbedtls_mpi_init( &X );
2470 mbedtls_mpi_init( &Y ); mbedtls_mpi_init( &U ); mbedtls_mpi_init( &V );
Paul Bakker5121ce52009-01-03 21:22:43 +00002471
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002472 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &A, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002473 "EFE021C2645FD1DC586E69184AF4A31E" \
2474 "D5F53E93B5F123FA41680867BA110131" \
2475 "944FE7952E2517337780CB0DB80E61AA" \
2476 "E7C8DDC6C5C6AADEB34EB38A2F40D5E6" ) );
2477
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &E, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002479 "B2E7EFD37075B9F03FF989C7C5051C20" \
2480 "34D2A323810251127E7BF8625A4F49A5" \
2481 "F3E27F4DA8BD59C47D6DAABA4C8127BD" \
2482 "5B5C25763222FEFCCFC38B832366C29E" ) );
2483
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002484 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &N, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002485 "0066A198186C18C10B2F5ED9B522752A" \
2486 "9830B69916E535C8F047518A889A43A5" \
2487 "94B6BED27A168D31D4A52F88925AA8F5" ) );
2488
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002489 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_mpi( &X, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002490
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002492 "602AB7ECA597A3D6B56FF9829A5E8B85" \
2493 "9E857EA95A03512E2BAE7391688D264A" \
2494 "A5663B0341DB9CCFD2C4C5F421FEC814" \
2495 "8001B72E848A38CAE1C65F78E56ABDEF" \
2496 "E12D3C039B8A02D6BE593F0BBBDA56F1" \
2497 "ECF677152EF804370C1A305CAF3B5BF1" \
2498 "30879B56C61DE584A0F53A2447A51E" ) );
2499
2500 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002501 mbedtls_printf( " MPI test #1 (mul_mpi): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00002502
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002504 {
2505 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002507
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01002508 ret = 1;
2509 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002510 }
2511
2512 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002513 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002514
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515 MBEDTLS_MPI_CHK( mbedtls_mpi_div_mpi( &X, &Y, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002517 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002518 "256567336059E52CAE22925474705F39A94" ) );
2519
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002520 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &V, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002521 "6613F26162223DF488E9CD48CC132C7A" \
2522 "0AC93C701B001B092E4E5B9F73BCD27B" \
2523 "9EE50D0657C77F374E903CDFA4C642" ) );
2524
2525 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526 mbedtls_printf( " MPI test #2 (div_mpi): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00002527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002528 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 ||
2529 mbedtls_mpi_cmp_mpi( &Y, &V ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002530 {
2531 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002533
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01002534 ret = 1;
2535 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002536 }
2537
2538 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002540
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 MBEDTLS_MPI_CHK( mbedtls_mpi_exp_mod( &X, &A, &E, &N, NULL ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002544 "36E139AEA55215609D2816998ED020BB" \
2545 "BD96C37890F65171D948E9BC7CBAA4D9" \
2546 "325D24D6A3C12710F10A09FA08AB87" ) );
2547
2548 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549 mbedtls_printf( " MPI test #3 (exp_mod): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00002550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002552 {
2553 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002555
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01002556 ret = 1;
2557 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002558 }
2559
2560 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002561 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002562
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563 MBEDTLS_MPI_CHK( mbedtls_mpi_inv_mod( &X, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002566 "003A0AAEDD7E784FC07D8F9EC6E3BFD5" \
2567 "C3DBA76456363A10869622EAC2DD84EC" \
2568 "C5B8A74DAC4D09E03B5E0BE779F2DF61" ) );
2569
2570 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571 mbedtls_printf( " MPI test #4 (inv_mod): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00002572
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002574 {
2575 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002577
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01002578 ret = 1;
2579 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002580 }
2581
2582 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002584
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002585 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586 mbedtls_printf( " MPI test #5 (simple gcd): " );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002587
Paul Bakker66d5d072014-06-17 16:39:18 +02002588 for( i = 0; i < GCD_PAIR_COUNT; i++ )
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002590 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &X, gcd_pairs[i][0] ) );
2591 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &Y, gcd_pairs[i][1] ) );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002592
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593 MBEDTLS_MPI_CHK( mbedtls_mpi_gcd( &A, &X, &Y ) );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002594
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595 if( mbedtls_mpi_cmp_int( &A, gcd_pairs[i][2] ) != 0 )
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01002596 {
2597 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598 mbedtls_printf( "failed at %d\n", i );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002599
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01002600 ret = 1;
2601 goto cleanup;
2602 }
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002603 }
2604
2605 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002606 mbedtls_printf( "passed\n" );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002607
Paul Bakker5121ce52009-01-03 21:22:43 +00002608cleanup:
2609
2610 if( ret != 0 && verbose != 0 )
Kenneth Soerensen518d4352020-04-01 17:22:45 +02002611 mbedtls_printf( "Unexpected error, return code = %08X\n", (unsigned int) ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002612
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 mbedtls_mpi_free( &A ); mbedtls_mpi_free( &E ); mbedtls_mpi_free( &N ); mbedtls_mpi_free( &X );
2614 mbedtls_mpi_free( &Y ); mbedtls_mpi_free( &U ); mbedtls_mpi_free( &V );
Paul Bakker5121ce52009-01-03 21:22:43 +00002615
2616 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617 mbedtls_printf( "\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002618
2619 return( ret );
2620}
2621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622#endif /* MBEDTLS_SELF_TEST */
Paul Bakker5121ce52009-01-03 21:22:43 +00002623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624#endif /* MBEDTLS_BIGNUM_C */