blob: 8ed9804f9151bb0984cf955407ee37e6a93aa7eb [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"
41#include "mbedtls/bn_mul.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050042#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000043#include "mbedtls/error.h"
Gabor Mezeic0ae1cf2021-10-20 12:09:35 +020044#include "constant_time_internal.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000045
Tom Cosgrove58efe612021-11-15 09:59:53 +000046#include <limits.h>
Rich Evans00ab4702015-02-06 13:43:58 +000047#include <string.h>
48
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000049#include "mbedtls/platform.h"
Paul Bakker6e339b52013-07-03 13:37:05 +020050
Hanno Becker73d7d792018-12-11 10:35:51 +000051#define MPI_VALIDATE_RET( cond ) \
52 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA )
53#define MPI_VALIDATE( cond ) \
54 MBEDTLS_INTERNAL_VALIDATE( cond )
55
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020056#define ciL (sizeof(mbedtls_mpi_uint)) /* chars in limb */
Paul Bakker5121ce52009-01-03 21:22:43 +000057#define biL (ciL << 3) /* bits in limb */
58#define biH (ciL << 2) /* half limb size */
59
Manuel Pégourié-Gonnard2d708342015-10-05 15:23:11 +010060#define MPI_SIZE_T_MAX ( (size_t) -1 ) /* SIZE_T_MAX is not standard */
61
Paul Bakker5121ce52009-01-03 21:22:43 +000062/*
63 * Convert between bits/chars and number of limbs
Manuel Pégourié-Gonnard58fb4952015-09-28 13:48:04 +020064 * Divide first in order to avoid potential overflows
Paul Bakker5121ce52009-01-03 21:22:43 +000065 */
Manuel Pégourié-Gonnard58fb4952015-09-28 13:48:04 +020066#define BITS_TO_LIMBS(i) ( (i) / biL + ( (i) % biL != 0 ) )
67#define CHARS_TO_LIMBS(i) ( (i) / ciL + ( (i) % ciL != 0 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +000068
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050069/* Implementation that should never be optimized out by the compiler */
Andres Amaya Garcia6698d2f2018-04-24 08:39:07 -050070static void mbedtls_mpi_zeroize( mbedtls_mpi_uint *v, size_t n )
71{
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050072 mbedtls_platform_zeroize( v, ciL * n );
73}
74
Paul Bakker5121ce52009-01-03 21:22:43 +000075/*
Paul Bakker6c591fa2011-05-05 11:49:20 +000076 * Initialize one MPI
Paul Bakker5121ce52009-01-03 21:22:43 +000077 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020078void mbedtls_mpi_init( mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +000079{
Hanno Becker73d7d792018-12-11 10:35:51 +000080 MPI_VALIDATE( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +000081
Paul Bakker6c591fa2011-05-05 11:49:20 +000082 X->s = 1;
83 X->n = 0;
84 X->p = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +000085}
86
87/*
Paul Bakker6c591fa2011-05-05 11:49:20 +000088 * Unallocate one MPI
Paul Bakker5121ce52009-01-03 21:22:43 +000089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020090void mbedtls_mpi_free( mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +000091{
Paul Bakker6c591fa2011-05-05 11:49:20 +000092 if( X == NULL )
93 return;
Paul Bakker5121ce52009-01-03 21:22:43 +000094
Paul Bakker6c591fa2011-05-05 11:49:20 +000095 if( X->p != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +000096 {
Alexey Skalozube17a8da2016-01-13 17:19:33 +020097 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020098 mbedtls_free( X->p );
Paul Bakker5121ce52009-01-03 21:22:43 +000099 }
100
Paul Bakker6c591fa2011-05-05 11:49:20 +0000101 X->s = 1;
102 X->n = 0;
103 X->p = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +0000104}
105
106/*
107 * Enlarge to the specified number of limbs
108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109int mbedtls_mpi_grow( mbedtls_mpi *X, size_t nblimbs )
Paul Bakker5121ce52009-01-03 21:22:43 +0000110{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200111 mbedtls_mpi_uint *p;
Hanno Becker73d7d792018-12-11 10:35:51 +0000112 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200114 if( nblimbs > MBEDTLS_MPI_MAX_LIMBS )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200115 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Paul Bakkerf9688572011-05-05 10:00:45 +0000116
Paul Bakker5121ce52009-01-03 21:22:43 +0000117 if( X->n < nblimbs )
118 {
Simon Butcher29176892016-05-20 00:19:09 +0100119 if( ( p = (mbedtls_mpi_uint*)mbedtls_calloc( nblimbs, ciL ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200120 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Paul Bakker5121ce52009-01-03 21:22:43 +0000121
Paul Bakker5121ce52009-01-03 21:22:43 +0000122 if( X->p != NULL )
123 {
124 memcpy( p, X->p, X->n * ciL );
Alexey Skalozube17a8da2016-01-13 17:19:33 +0200125 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126 mbedtls_free( X->p );
Paul Bakker5121ce52009-01-03 21:22:43 +0000127 }
128
129 X->n = nblimbs;
130 X->p = p;
131 }
132
133 return( 0 );
134}
135
136/*
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100137 * Resize down as much as possible,
138 * while keeping at least the specified number of limbs
139 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200140int mbedtls_mpi_shrink( mbedtls_mpi *X, size_t nblimbs )
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100141{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200142 mbedtls_mpi_uint *p;
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100143 size_t i;
Hanno Becker73d7d792018-12-11 10:35:51 +0000144 MPI_VALIDATE_RET( X != NULL );
145
146 if( nblimbs > MBEDTLS_MPI_MAX_LIMBS )
147 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100148
Gilles Peskinee2f563e2020-01-20 21:17:43 +0100149 /* Actually resize up if there are currently fewer than nblimbs limbs. */
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100150 if( X->n <= nblimbs )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200151 return( mbedtls_mpi_grow( X, nblimbs ) );
Gilles Peskine322752b2020-01-21 13:59:51 +0100152 /* After this point, then X->n > nblimbs and in particular X->n > 0. */
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100153
154 for( i = X->n - 1; i > 0; i-- )
155 if( X->p[i] != 0 )
156 break;
157 i++;
158
159 if( i < nblimbs )
160 i = nblimbs;
161
Simon Butcher29176892016-05-20 00:19:09 +0100162 if( ( p = (mbedtls_mpi_uint*)mbedtls_calloc( i, ciL ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200163 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100164
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100165 if( X->p != NULL )
166 {
167 memcpy( p, X->p, i * ciL );
Alexey Skalozube17a8da2016-01-13 17:19:33 +0200168 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169 mbedtls_free( X->p );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100170 }
171
172 X->n = i;
173 X->p = p;
174
175 return( 0 );
176}
177
Gilles Peskine3130ce22021-06-02 22:17:52 +0200178/* Resize X to have exactly n limbs and set it to 0. */
179static int mbedtls_mpi_resize_clear( mbedtls_mpi *X, size_t limbs )
180{
181 if( limbs == 0 )
182 {
183 mbedtls_mpi_free( X );
184 return( 0 );
185 }
186 else if( X->n == limbs )
187 {
188 memset( X->p, 0, limbs * ciL );
189 X->s = 1;
190 return( 0 );
191 }
192 else
193 {
194 mbedtls_mpi_free( X );
195 return( mbedtls_mpi_grow( X, limbs ) );
196 }
197}
198
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100199/*
Gilles Peskinef643e8e2021-06-08 23:17:42 +0200200 * Copy the contents of Y into X.
201 *
202 * This function is not constant-time. Leading zeros in Y may be removed.
203 *
204 * Ensure that X does not shrink. This is not guaranteed by the public API,
205 * but some code in the bignum module relies on this property, for example
206 * in mbedtls_mpi_exp_mod().
Paul Bakker5121ce52009-01-03 21:22:43 +0000207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208int mbedtls_mpi_copy( mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +0000209{
Gilles Peskine4e4be7c2018-03-21 16:29:03 +0100210 int ret = 0;
Paul Bakker23986e52011-04-24 08:57:21 +0000211 size_t i;
Hanno Becker73d7d792018-12-11 10:35:51 +0000212 MPI_VALIDATE_RET( X != NULL );
213 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000214
215 if( X == Y )
216 return( 0 );
217
Gilles Peskinedb420622020-01-20 21:12:50 +0100218 if( Y->n == 0 )
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200219 {
Gilles Peskinef643e8e2021-06-08 23:17:42 +0200220 if( X->n != 0 )
221 {
222 X->s = 1;
223 memset( X->p, 0, X->n * ciL );
224 }
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200225 return( 0 );
226 }
227
Paul Bakker5121ce52009-01-03 21:22:43 +0000228 for( i = Y->n - 1; i > 0; i-- )
229 if( Y->p[i] != 0 )
230 break;
231 i++;
232
233 X->s = Y->s;
234
Gilles Peskine4e4be7c2018-03-21 16:29:03 +0100235 if( X->n < i )
236 {
237 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, i ) );
238 }
239 else
240 {
241 memset( X->p + i, 0, ( X->n - i ) * ciL );
242 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000243
Paul Bakker5121ce52009-01-03 21:22:43 +0000244 memcpy( X->p, Y->p, i * ciL );
245
246cleanup:
247
248 return( ret );
249}
250
251/*
252 * Swap the contents of X and Y
253 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254void mbedtls_mpi_swap( mbedtls_mpi *X, mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +0000255{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000257 MPI_VALIDATE( X != NULL );
258 MPI_VALIDATE( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200260 memcpy( &T, X, sizeof( mbedtls_mpi ) );
261 memcpy( X, Y, sizeof( mbedtls_mpi ) );
262 memcpy( Y, &T, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000263}
264
265/*
266 * Set value from integer
267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200268int mbedtls_mpi_lset( mbedtls_mpi *X, mbedtls_mpi_sint z )
Paul Bakker5121ce52009-01-03 21:22:43 +0000269{
Janos Follath24eed8d2019-11-22 13:21:35 +0000270 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker73d7d792018-12-11 10:35:51 +0000271 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000272
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200273 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000274 memset( X->p, 0, X->n * ciL );
275
Gilles Peskinede1629a2022-11-15 23:02:14 +0100276 X->p[0] = ( z < 0 ) ? -(mbedtls_mpi_uint)z : z;
Paul Bakker5121ce52009-01-03 21:22:43 +0000277 X->s = ( z < 0 ) ? -1 : 1;
278
279cleanup:
280
281 return( ret );
282}
283
284/*
Paul Bakker2f5947e2011-05-18 15:47:11 +0000285 * Get a specific bit
286 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200287int mbedtls_mpi_get_bit( const mbedtls_mpi *X, size_t pos )
Paul Bakker2f5947e2011-05-18 15:47:11 +0000288{
Hanno Becker73d7d792018-12-11 10:35:51 +0000289 MPI_VALIDATE_RET( X != NULL );
290
Paul Bakker2f5947e2011-05-18 15:47:11 +0000291 if( X->n * biL <= pos )
292 return( 0 );
293
Paul Bakkerd8bb8262014-06-17 14:06:49 +0200294 return( ( X->p[pos / biL] >> ( pos % biL ) ) & 0x01 );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000295}
296
Gilles Peskine11cdb052018-11-20 16:47:47 +0100297/* Get a specific byte, without range checks. */
298#define GET_BYTE( X, i ) \
299 ( ( ( X )->p[( i ) / ciL] >> ( ( ( i ) % ciL ) * 8 ) ) & 0xff )
300
Paul Bakker2f5947e2011-05-18 15:47:11 +0000301/*
302 * Set a bit to a specific value of 0 or 1
303 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304int mbedtls_mpi_set_bit( mbedtls_mpi *X, size_t pos, unsigned char val )
Paul Bakker2f5947e2011-05-18 15:47:11 +0000305{
306 int ret = 0;
307 size_t off = pos / biL;
308 size_t idx = pos % biL;
Hanno Becker73d7d792018-12-11 10:35:51 +0000309 MPI_VALIDATE_RET( X != NULL );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000310
311 if( val != 0 && val != 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker9af723c2014-05-01 13:03:14 +0200313
Paul Bakker2f5947e2011-05-18 15:47:11 +0000314 if( X->n * biL <= pos )
315 {
316 if( val == 0 )
Paul Bakkerd8bb8262014-06-17 14:06:49 +0200317 return( 0 );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, off + 1 ) );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000320 }
321
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200322 X->p[off] &= ~( (mbedtls_mpi_uint) 0x01 << idx );
323 X->p[off] |= (mbedtls_mpi_uint) val << idx;
Paul Bakker2f5947e2011-05-18 15:47:11 +0000324
325cleanup:
Paul Bakker9af723c2014-05-01 13:03:14 +0200326
Paul Bakker2f5947e2011-05-18 15:47:11 +0000327 return( ret );
328}
329
330/*
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200331 * Return the number of less significant zero-bits
Paul Bakker5121ce52009-01-03 21:22:43 +0000332 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200333size_t mbedtls_mpi_lsb( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000334{
Paul Bakker23986e52011-04-24 08:57:21 +0000335 size_t i, j, count = 0;
Hanno Beckerf25ee7f2018-12-19 16:51:02 +0000336 MBEDTLS_INTERNAL_VALIDATE_RET( X != NULL, 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000337
338 for( i = 0; i < X->n; i++ )
Paul Bakkerf9688572011-05-05 10:00:45 +0000339 for( j = 0; j < biL; j++, count++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000340 if( ( ( X->p[i] >> j ) & 1 ) != 0 )
341 return( count );
342
343 return( 0 );
344}
345
346/*
Simon Butcher15b15d12015-11-26 19:35:03 +0000347 * Count leading zero bits in a given integer
348 */
349static size_t mbedtls_clz( const mbedtls_mpi_uint x )
350{
351 size_t j;
Manuel Pégourié-Gonnarde3e8edf2015-12-01 09:31:52 +0100352 mbedtls_mpi_uint mask = (mbedtls_mpi_uint) 1 << (biL - 1);
Simon Butcher15b15d12015-11-26 19:35:03 +0000353
354 for( j = 0; j < biL; j++ )
355 {
356 if( x & mask ) break;
357
358 mask >>= 1;
359 }
360
361 return j;
362}
363
364/*
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200365 * Return the number of bits
Paul Bakker5121ce52009-01-03 21:22:43 +0000366 */
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200367size_t mbedtls_mpi_bitlen( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000368{
Paul Bakker23986e52011-04-24 08:57:21 +0000369 size_t i, j;
Paul Bakker5121ce52009-01-03 21:22:43 +0000370
Manuel Pégourié-Gonnard770b5e12015-04-29 17:02:01 +0200371 if( X->n == 0 )
372 return( 0 );
373
Paul Bakker5121ce52009-01-03 21:22:43 +0000374 for( i = X->n - 1; i > 0; i-- )
375 if( X->p[i] != 0 )
376 break;
377
Simon Butcher15b15d12015-11-26 19:35:03 +0000378 j = biL - mbedtls_clz( X->p[i] );
Paul Bakker5121ce52009-01-03 21:22:43 +0000379
Paul Bakker23986e52011-04-24 08:57:21 +0000380 return( ( i * biL ) + j );
Paul Bakker5121ce52009-01-03 21:22:43 +0000381}
382
383/*
384 * Return the total size in bytes
385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386size_t mbedtls_mpi_size( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000387{
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200388 return( ( mbedtls_mpi_bitlen( X ) + 7 ) >> 3 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000389}
390
391/*
392 * Convert an ASCII character to digit value
393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394static int mpi_get_digit( mbedtls_mpi_uint *d, int radix, char c )
Paul Bakker5121ce52009-01-03 21:22:43 +0000395{
396 *d = 255;
397
398 if( c >= 0x30 && c <= 0x39 ) *d = c - 0x30;
399 if( c >= 0x41 && c <= 0x46 ) *d = c - 0x37;
400 if( c >= 0x61 && c <= 0x66 ) *d = c - 0x57;
401
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200402 if( *d >= (mbedtls_mpi_uint) radix )
403 return( MBEDTLS_ERR_MPI_INVALID_CHARACTER );
Paul Bakker5121ce52009-01-03 21:22:43 +0000404
405 return( 0 );
406}
407
408/*
409 * Import from an ASCII string
410 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200411int mbedtls_mpi_read_string( mbedtls_mpi *X, int radix, const char *s )
Paul Bakker5121ce52009-01-03 21:22:43 +0000412{
Janos Follath24eed8d2019-11-22 13:21:35 +0000413 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000414 size_t i, j, slen, n;
Gilles Peskine80f56732021-04-03 18:26:13 +0200415 int sign = 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200416 mbedtls_mpi_uint d;
417 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000418 MPI_VALIDATE_RET( X != NULL );
419 MPI_VALIDATE_RET( s != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000420
421 if( radix < 2 || radix > 16 )
Hanno Becker54c91dd2018-12-12 13:37:06 +0000422 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000423
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200424 mbedtls_mpi_init( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000425
Gilles Peskined4876132021-06-08 18:32:34 +0200426 if( s[0] == 0 )
427 {
428 mbedtls_mpi_free( X );
429 return( 0 );
430 }
431
Gilles Peskine80f56732021-04-03 18:26:13 +0200432 if( s[0] == '-' )
433 {
434 ++s;
435 sign = -1;
436 }
437
Paul Bakkerff60ee62010-03-16 21:09:09 +0000438 slen = strlen( s );
439
Paul Bakker5121ce52009-01-03 21:22:43 +0000440 if( radix == 16 )
441 {
Manuel Pégourié-Gonnard2d708342015-10-05 15:23:11 +0100442 if( slen > MPI_SIZE_T_MAX >> 2 )
Manuel Pégourié-Gonnard58fb4952015-09-28 13:48:04 +0200443 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
444
Paul Bakkerff60ee62010-03-16 21:09:09 +0000445 n = BITS_TO_LIMBS( slen << 2 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000446
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200447 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, n ) );
448 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000449
Paul Bakker23986e52011-04-24 08:57:21 +0000450 for( i = slen, j = 0; i > 0; i--, j++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000451 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200452 MBEDTLS_MPI_CHK( mpi_get_digit( &d, radix, s[i - 1] ) );
Paul Bakker66d5d072014-06-17 16:39:18 +0200453 X->p[j / ( 2 * ciL )] |= d << ( ( j % ( 2 * ciL ) ) << 2 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000454 }
455 }
456 else
457 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200458 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000459
Paul Bakkerff60ee62010-03-16 21:09:09 +0000460 for( i = 0; i < slen; i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000461 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200462 MBEDTLS_MPI_CHK( mpi_get_digit( &d, radix, s[i] ) );
463 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T, X, radix ) );
Gilles Peskine80f56732021-04-03 18:26:13 +0200464 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, &T, d ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000465 }
466 }
467
Gilles Peskine80f56732021-04-03 18:26:13 +0200468 if( sign < 0 && mbedtls_mpi_bitlen( X ) != 0 )
469 X->s = -1;
470
Paul Bakker5121ce52009-01-03 21:22:43 +0000471cleanup:
472
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200473 mbedtls_mpi_free( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000474
475 return( ret );
476}
477
478/*
Ron Eldora16fa292018-11-20 14:07:01 +0200479 * Helper to write the digits high-order first.
Paul Bakker5121ce52009-01-03 21:22:43 +0000480 */
Ron Eldora16fa292018-11-20 14:07:01 +0200481static int mpi_write_hlp( mbedtls_mpi *X, int radix,
482 char **p, const size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000483{
Janos Follath24eed8d2019-11-22 13:21:35 +0000484 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200485 mbedtls_mpi_uint r;
Ron Eldora16fa292018-11-20 14:07:01 +0200486 size_t length = 0;
487 char *p_end = *p + buflen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000488
Ron Eldora16fa292018-11-20 14:07:01 +0200489 do
490 {
491 if( length >= buflen )
492 {
493 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
494 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000495
Ron Eldora16fa292018-11-20 14:07:01 +0200496 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, radix ) );
497 MBEDTLS_MPI_CHK( mbedtls_mpi_div_int( X, NULL, X, radix ) );
498 /*
499 * Write the residue in the current position, as an ASCII character.
500 */
501 if( r < 0xA )
502 *(--p_end) = (char)( '0' + r );
503 else
504 *(--p_end) = (char)( 'A' + ( r - 0xA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000505
Ron Eldora16fa292018-11-20 14:07:01 +0200506 length++;
507 } while( mbedtls_mpi_cmp_int( X, 0 ) != 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000508
Ron Eldora16fa292018-11-20 14:07:01 +0200509 memmove( *p, p_end, length );
510 *p += length;
Paul Bakker5121ce52009-01-03 21:22:43 +0000511
512cleanup:
513
514 return( ret );
515}
516
517/*
518 * Export into an ASCII string
519 */
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100520int mbedtls_mpi_write_string( const mbedtls_mpi *X, int radix,
521 char *buf, size_t buflen, size_t *olen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000522{
Paul Bakker23986e52011-04-24 08:57:21 +0000523 int ret = 0;
524 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +0000525 char *p;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000527 MPI_VALIDATE_RET( X != NULL );
528 MPI_VALIDATE_RET( olen != NULL );
529 MPI_VALIDATE_RET( buflen == 0 || buf != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000530
531 if( radix < 2 || radix > 16 )
Hanno Becker54c91dd2018-12-12 13:37:06 +0000532 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000533
Hanno Becker23cfea02019-02-04 09:45:07 +0000534 n = mbedtls_mpi_bitlen( X ); /* Number of bits necessary to present `n`. */
535 if( radix >= 4 ) n >>= 1; /* Number of 4-adic digits necessary to present
536 * `n`. If radix > 4, this might be a strict
537 * overapproximation of the number of
538 * radix-adic digits needed to present `n`. */
539 if( radix >= 16 ) n >>= 1; /* Number of hexadecimal digits necessary to
540 * present `n`. */
541
Janos Follath80470622019-03-06 13:43:02 +0000542 n += 1; /* Terminating null byte */
Hanno Becker23cfea02019-02-04 09:45:07 +0000543 n += 1; /* Compensate for the divisions above, which round down `n`
544 * in case it's not even. */
545 n += 1; /* Potential '-'-sign. */
546 n += ( n & 1 ); /* Make n even to have enough space for hexadecimal writing,
547 * which always uses an even number of hex-digits. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000548
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100549 if( buflen < n )
Paul Bakker5121ce52009-01-03 21:22:43 +0000550 {
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100551 *olen = n;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200552 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000553 }
554
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100555 p = buf;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556 mbedtls_mpi_init( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000557
558 if( X->s == -1 )
Hanno Beckerc983c812019-02-01 16:41:30 +0000559 {
Paul Bakker5121ce52009-01-03 21:22:43 +0000560 *p++ = '-';
Hanno Beckerc983c812019-02-01 16:41:30 +0000561 buflen--;
562 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000563
564 if( radix == 16 )
565 {
Paul Bakker23986e52011-04-24 08:57:21 +0000566 int c;
567 size_t i, j, k;
Paul Bakker5121ce52009-01-03 21:22:43 +0000568
Paul Bakker23986e52011-04-24 08:57:21 +0000569 for( i = X->n, k = 0; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +0000570 {
Paul Bakker23986e52011-04-24 08:57:21 +0000571 for( j = ciL; j > 0; j-- )
Paul Bakker5121ce52009-01-03 21:22:43 +0000572 {
Paul Bakker23986e52011-04-24 08:57:21 +0000573 c = ( X->p[i - 1] >> ( ( j - 1 ) << 3) ) & 0xFF;
Paul Bakker5121ce52009-01-03 21:22:43 +0000574
Paul Bakker6c343d72014-07-10 14:36:19 +0200575 if( c == 0 && k == 0 && ( i + j ) != 2 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000576 continue;
577
Paul Bakker98fe5ea2012-10-24 11:17:48 +0000578 *(p++) = "0123456789ABCDEF" [c / 16];
Paul Bakkerd2c167e2012-10-30 07:49:19 +0000579 *(p++) = "0123456789ABCDEF" [c % 16];
Paul Bakker5121ce52009-01-03 21:22:43 +0000580 k = 1;
581 }
582 }
583 }
584 else
585 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200586 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &T, X ) );
Paul Bakkerce40a6d2009-06-23 19:46:08 +0000587
588 if( T.s == -1 )
589 T.s = 1;
590
Ron Eldora16fa292018-11-20 14:07:01 +0200591 MBEDTLS_MPI_CHK( mpi_write_hlp( &T, radix, &p, buflen ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000592 }
593
594 *p++ = '\0';
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100595 *olen = p - buf;
Paul Bakker5121ce52009-01-03 21:22:43 +0000596
597cleanup:
598
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200599 mbedtls_mpi_free( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000600
601 return( ret );
602}
603
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200604#if defined(MBEDTLS_FS_IO)
Paul Bakker5121ce52009-01-03 21:22:43 +0000605/*
606 * Read X from an opened file
607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200608int mbedtls_mpi_read_file( mbedtls_mpi *X, int radix, FILE *fin )
Paul Bakker5121ce52009-01-03 21:22:43 +0000609{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610 mbedtls_mpi_uint d;
Paul Bakker23986e52011-04-24 08:57:21 +0000611 size_t slen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000612 char *p;
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000613 /*
Paul Bakkercb37aa52011-11-30 16:00:20 +0000614 * Buffer should have space for (short) label and decimal formatted MPI,
615 * newline characters and '\0'
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617 char s[ MBEDTLS_MPI_RW_BUFFER_SIZE ];
Paul Bakker5121ce52009-01-03 21:22:43 +0000618
Hanno Becker73d7d792018-12-11 10:35:51 +0000619 MPI_VALIDATE_RET( X != NULL );
620 MPI_VALIDATE_RET( fin != NULL );
621
622 if( radix < 2 || radix > 16 )
623 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
624
Paul Bakker5121ce52009-01-03 21:22:43 +0000625 memset( s, 0, sizeof( s ) );
626 if( fgets( s, sizeof( s ) - 1, fin ) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627 return( MBEDTLS_ERR_MPI_FILE_IO_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +0000628
629 slen = strlen( s );
Paul Bakkercb37aa52011-11-30 16:00:20 +0000630 if( slen == sizeof( s ) - 2 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200631 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
Paul Bakkercb37aa52011-11-30 16:00:20 +0000632
Hanno Beckerb2034b72017-04-26 11:46:46 +0100633 if( slen > 0 && s[slen - 1] == '\n' ) { slen--; s[slen] = '\0'; }
634 if( slen > 0 && s[slen - 1] == '\r' ) { slen--; s[slen] = '\0'; }
Paul Bakker5121ce52009-01-03 21:22:43 +0000635
636 p = s + slen;
Hanno Beckerb2034b72017-04-26 11:46:46 +0100637 while( p-- > s )
Paul Bakker5121ce52009-01-03 21:22:43 +0000638 if( mpi_get_digit( &d, radix, *p ) != 0 )
639 break;
640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200641 return( mbedtls_mpi_read_string( X, radix, p + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000642}
643
644/*
645 * Write X into an opened file (or stdout if fout == NULL)
646 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200647int mbedtls_mpi_write_file( const char *p, const mbedtls_mpi *X, int radix, FILE *fout )
Paul Bakker5121ce52009-01-03 21:22:43 +0000648{
Janos Follath24eed8d2019-11-22 13:21:35 +0000649 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000650 size_t n, slen, plen;
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000651 /*
Paul Bakker5531c6d2012-09-26 19:20:46 +0000652 * Buffer should have space for (short) label and decimal formatted MPI,
653 * newline characters and '\0'
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655 char s[ MBEDTLS_MPI_RW_BUFFER_SIZE ];
Hanno Becker73d7d792018-12-11 10:35:51 +0000656 MPI_VALIDATE_RET( X != NULL );
657
658 if( radix < 2 || radix > 16 )
659 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000660
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100661 memset( s, 0, sizeof( s ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000662
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100663 MBEDTLS_MPI_CHK( mbedtls_mpi_write_string( X, radix, s, sizeof( s ) - 2, &n ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000664
665 if( p == NULL ) p = "";
666
667 plen = strlen( p );
668 slen = strlen( s );
669 s[slen++] = '\r';
670 s[slen++] = '\n';
671
672 if( fout != NULL )
673 {
674 if( fwrite( p, 1, plen, fout ) != plen ||
675 fwrite( s, 1, slen, fout ) != slen )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200676 return( MBEDTLS_ERR_MPI_FILE_IO_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +0000677 }
678 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 mbedtls_printf( "%s%s", p, s );
Paul Bakker5121ce52009-01-03 21:22:43 +0000680
681cleanup:
682
683 return( ret );
684}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200685#endif /* MBEDTLS_FS_IO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000686
Hanno Beckerda1655a2017-10-18 14:21:44 +0100687
688/* Convert a big-endian byte array aligned to the size of mbedtls_mpi_uint
689 * into the storage form used by mbedtls_mpi. */
Hanno Beckerf8720072018-11-08 11:53:49 +0000690
691static mbedtls_mpi_uint mpi_uint_bigendian_to_host_c( mbedtls_mpi_uint x )
692{
693 uint8_t i;
Hanno Becker031d6332019-05-01 17:09:11 +0100694 unsigned char *x_ptr;
Hanno Beckerf8720072018-11-08 11:53:49 +0000695 mbedtls_mpi_uint tmp = 0;
Hanno Becker031d6332019-05-01 17:09:11 +0100696
697 for( i = 0, x_ptr = (unsigned char*) &x; i < ciL; i++, x_ptr++ )
698 {
699 tmp <<= CHAR_BIT;
700 tmp |= (mbedtls_mpi_uint) *x_ptr;
701 }
702
Hanno Beckerf8720072018-11-08 11:53:49 +0000703 return( tmp );
704}
705
706static mbedtls_mpi_uint mpi_uint_bigendian_to_host( mbedtls_mpi_uint x )
707{
708#if defined(__BYTE_ORDER__)
709
710/* Nothing to do on bigendian systems. */
711#if ( __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ )
712 return( x );
713#endif /* __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ */
714
715#if ( __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ )
716
717/* For GCC and Clang, have builtins for byte swapping. */
Hanno Becker9f6d16a2019-01-02 17:15:06 +0000718#if defined(__GNUC__) && defined(__GNUC_PREREQ)
719#if __GNUC_PREREQ(4,3)
Hanno Beckerf8720072018-11-08 11:53:49 +0000720#define have_bswap
721#endif
Hanno Becker9f6d16a2019-01-02 17:15:06 +0000722#endif
723
724#if defined(__clang__) && defined(__has_builtin)
725#if __has_builtin(__builtin_bswap32) && \
726 __has_builtin(__builtin_bswap64)
727#define have_bswap
728#endif
729#endif
730
Hanno Beckerf8720072018-11-08 11:53:49 +0000731#if defined(have_bswap)
732 /* The compiler is hopefully able to statically evaluate this! */
733 switch( sizeof(mbedtls_mpi_uint) )
734 {
735 case 4:
736 return( __builtin_bswap32(x) );
737 case 8:
738 return( __builtin_bswap64(x) );
739 }
740#endif
741#endif /* __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ */
742#endif /* __BYTE_ORDER__ */
743
744 /* Fall back to C-based reordering if we don't know the byte order
745 * or we couldn't use a compiler-specific builtin. */
746 return( mpi_uint_bigendian_to_host_c( x ) );
747}
748
Hanno Becker2be8a552018-10-25 12:40:09 +0100749static void mpi_bigendian_to_host( mbedtls_mpi_uint * const p, size_t limbs )
Hanno Beckerda1655a2017-10-18 14:21:44 +0100750{
Hanno Beckerda1655a2017-10-18 14:21:44 +0100751 mbedtls_mpi_uint *cur_limb_left;
752 mbedtls_mpi_uint *cur_limb_right;
Hanno Becker2be8a552018-10-25 12:40:09 +0100753 if( limbs == 0 )
754 return;
Hanno Beckerda1655a2017-10-18 14:21:44 +0100755
756 /*
757 * Traverse limbs and
758 * - adapt byte-order in each limb
759 * - swap the limbs themselves.
760 * For that, simultaneously traverse the limbs from left to right
761 * and from right to left, as long as the left index is not bigger
762 * than the right index (it's not a problem if limbs is odd and the
763 * indices coincide in the last iteration).
764 */
Hanno Beckerda1655a2017-10-18 14:21:44 +0100765 for( cur_limb_left = p, cur_limb_right = p + ( limbs - 1 );
766 cur_limb_left <= cur_limb_right;
767 cur_limb_left++, cur_limb_right-- )
768 {
Hanno Beckerf8720072018-11-08 11:53:49 +0000769 mbedtls_mpi_uint tmp;
770 /* Note that if cur_limb_left == cur_limb_right,
771 * this code effectively swaps the bytes only once. */
772 tmp = mpi_uint_bigendian_to_host( *cur_limb_left );
773 *cur_limb_left = mpi_uint_bigendian_to_host( *cur_limb_right );
774 *cur_limb_right = tmp;
Hanno Beckerda1655a2017-10-18 14:21:44 +0100775 }
Hanno Beckerda1655a2017-10-18 14:21:44 +0100776}
777
Paul Bakker5121ce52009-01-03 21:22:43 +0000778/*
Janos Follatha778a942019-02-13 10:28:28 +0000779 * Import X from unsigned binary data, little endian
780 */
781int mbedtls_mpi_read_binary_le( mbedtls_mpi *X,
782 const unsigned char *buf, size_t buflen )
783{
Janos Follath24eed8d2019-11-22 13:21:35 +0000784 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Janos Follatha778a942019-02-13 10:28:28 +0000785 size_t i;
786 size_t const limbs = CHARS_TO_LIMBS( buflen );
787
788 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskine3130ce22021-06-02 22:17:52 +0200789 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Janos Follatha778a942019-02-13 10:28:28 +0000790
791 for( i = 0; i < buflen; i++ )
792 X->p[i / ciL] |= ((mbedtls_mpi_uint) buf[i]) << ((i % ciL) << 3);
793
794cleanup:
795
Janos Follath171a7ef2019-02-15 16:17:45 +0000796 /*
797 * This function is also used to import keys. However, wiping the buffers
798 * upon failure is not necessary because failure only can happen before any
799 * input is copied.
800 */
Janos Follatha778a942019-02-13 10:28:28 +0000801 return( ret );
802}
803
804/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000805 * Import X from unsigned binary data, big endian
806 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807int mbedtls_mpi_read_binary( mbedtls_mpi *X, const unsigned char *buf, size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000808{
Janos Follath24eed8d2019-11-22 13:21:35 +0000809 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerda1655a2017-10-18 14:21:44 +0100810 size_t const limbs = CHARS_TO_LIMBS( buflen );
811 size_t const overhead = ( limbs * ciL ) - buflen;
812 unsigned char *Xp;
Paul Bakker5121ce52009-01-03 21:22:43 +0000813
Hanno Becker8ce11a32018-12-19 16:18:52 +0000814 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +0000815 MPI_VALIDATE_RET( buflen == 0 || buf != NULL );
816
Hanno Becker073c1992017-10-17 15:17:27 +0100817 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskine3130ce22021-06-02 22:17:52 +0200818 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000819
Gilles Peskine3130ce22021-06-02 22:17:52 +0200820 /* Avoid calling `memcpy` with NULL source or destination argument,
Hanno Becker0e810b92019-01-03 17:13:11 +0000821 * even if buflen is 0. */
Gilles Peskine3130ce22021-06-02 22:17:52 +0200822 if( buflen != 0 )
Hanno Becker0e810b92019-01-03 17:13:11 +0000823 {
824 Xp = (unsigned char*) X->p;
825 memcpy( Xp + overhead, buf, buflen );
Hanno Beckerda1655a2017-10-18 14:21:44 +0100826
Hanno Becker0e810b92019-01-03 17:13:11 +0000827 mpi_bigendian_to_host( X->p, limbs );
828 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000829
830cleanup:
831
Janos Follath171a7ef2019-02-15 16:17:45 +0000832 /*
833 * This function is also used to import keys. However, wiping the buffers
834 * upon failure is not necessary because failure only can happen before any
835 * input is copied.
836 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000837 return( ret );
838}
839
840/*
Janos Follathe344d0f2019-02-19 16:17:40 +0000841 * Export X into unsigned binary data, little endian
842 */
843int mbedtls_mpi_write_binary_le( const mbedtls_mpi *X,
844 unsigned char *buf, size_t buflen )
845{
846 size_t stored_bytes = X->n * ciL;
847 size_t bytes_to_copy;
848 size_t i;
849
850 if( stored_bytes < buflen )
851 {
852 bytes_to_copy = stored_bytes;
853 }
854 else
855 {
856 bytes_to_copy = buflen;
857
858 /* The output buffer is smaller than the allocated size of X.
859 * However X may fit if its leading bytes are zero. */
860 for( i = bytes_to_copy; i < stored_bytes; i++ )
861 {
862 if( GET_BYTE( X, i ) != 0 )
863 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
864 }
865 }
866
867 for( i = 0; i < bytes_to_copy; i++ )
868 buf[i] = GET_BYTE( X, i );
869
870 if( stored_bytes < buflen )
871 {
872 /* Write trailing 0 bytes */
873 memset( buf + stored_bytes, 0, buflen - stored_bytes );
874 }
875
876 return( 0 );
877}
878
879/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000880 * Export X into unsigned binary data, big endian
881 */
Gilles Peskine11cdb052018-11-20 16:47:47 +0100882int mbedtls_mpi_write_binary( const mbedtls_mpi *X,
883 unsigned char *buf, size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000884{
Hanno Becker73d7d792018-12-11 10:35:51 +0000885 size_t stored_bytes;
Gilles Peskine11cdb052018-11-20 16:47:47 +0100886 size_t bytes_to_copy;
887 unsigned char *p;
888 size_t i;
Paul Bakker5121ce52009-01-03 21:22:43 +0000889
Hanno Becker73d7d792018-12-11 10:35:51 +0000890 MPI_VALIDATE_RET( X != NULL );
891 MPI_VALIDATE_RET( buflen == 0 || buf != NULL );
892
893 stored_bytes = X->n * ciL;
894
Gilles Peskine11cdb052018-11-20 16:47:47 +0100895 if( stored_bytes < buflen )
896 {
897 /* There is enough space in the output buffer. Write initial
898 * null bytes and record the position at which to start
899 * writing the significant bytes. In this case, the execution
900 * trace of this function does not depend on the value of the
901 * number. */
902 bytes_to_copy = stored_bytes;
903 p = buf + buflen - stored_bytes;
904 memset( buf, 0, buflen - stored_bytes );
905 }
906 else
907 {
908 /* The output buffer is smaller than the allocated size of X.
909 * However X may fit if its leading bytes are zero. */
910 bytes_to_copy = buflen;
911 p = buf;
912 for( i = bytes_to_copy; i < stored_bytes; i++ )
913 {
914 if( GET_BYTE( X, i ) != 0 )
915 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
916 }
917 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000918
Gilles Peskine11cdb052018-11-20 16:47:47 +0100919 for( i = 0; i < bytes_to_copy; i++ )
920 p[bytes_to_copy - i - 1] = GET_BYTE( X, i );
Paul Bakker5121ce52009-01-03 21:22:43 +0000921
922 return( 0 );
923}
924
925/*
926 * Left-shift: X <<= count
927 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928int mbedtls_mpi_shift_l( mbedtls_mpi *X, size_t count )
Paul Bakker5121ce52009-01-03 21:22:43 +0000929{
Janos Follath24eed8d2019-11-22 13:21:35 +0000930 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000931 size_t i, v0, t1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932 mbedtls_mpi_uint r0 = 0, r1;
Hanno Becker73d7d792018-12-11 10:35:51 +0000933 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000934
935 v0 = count / (biL );
936 t1 = count & (biL - 1);
937
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200938 i = mbedtls_mpi_bitlen( X ) + count;
Paul Bakker5121ce52009-01-03 21:22:43 +0000939
Paul Bakkerf9688572011-05-05 10:00:45 +0000940 if( X->n * biL < i )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200941 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, BITS_TO_LIMBS( i ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000942
943 ret = 0;
944
945 /*
946 * shift by count / limb_size
947 */
948 if( v0 > 0 )
949 {
Paul Bakker23986e52011-04-24 08:57:21 +0000950 for( i = X->n; i > v0; i-- )
951 X->p[i - 1] = X->p[i - v0 - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +0000952
Paul Bakker23986e52011-04-24 08:57:21 +0000953 for( ; i > 0; i-- )
954 X->p[i - 1] = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +0000955 }
956
957 /*
958 * shift by count % limb_size
959 */
960 if( t1 > 0 )
961 {
962 for( i = v0; i < X->n; i++ )
963 {
964 r1 = X->p[i] >> (biL - t1);
965 X->p[i] <<= t1;
966 X->p[i] |= r0;
967 r0 = r1;
968 }
969 }
970
971cleanup:
972
973 return( ret );
974}
975
976/*
977 * Right-shift: X >>= count
978 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200979int mbedtls_mpi_shift_r( mbedtls_mpi *X, size_t count )
Paul Bakker5121ce52009-01-03 21:22:43 +0000980{
Paul Bakker23986e52011-04-24 08:57:21 +0000981 size_t i, v0, v1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982 mbedtls_mpi_uint r0 = 0, r1;
Hanno Becker73d7d792018-12-11 10:35:51 +0000983 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000984
985 v0 = count / biL;
986 v1 = count & (biL - 1);
987
Manuel Pégourié-Gonnarde44ec102012-11-17 12:42:51 +0100988 if( v0 > X->n || ( v0 == X->n && v1 > 0 ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989 return mbedtls_mpi_lset( X, 0 );
Manuel Pégourié-Gonnarde44ec102012-11-17 12:42:51 +0100990
Paul Bakker5121ce52009-01-03 21:22:43 +0000991 /*
992 * shift by count / limb_size
993 */
994 if( v0 > 0 )
995 {
996 for( i = 0; i < X->n - v0; i++ )
997 X->p[i] = X->p[i + v0];
998
999 for( ; i < X->n; i++ )
1000 X->p[i] = 0;
1001 }
1002
1003 /*
1004 * shift by count % limb_size
1005 */
1006 if( v1 > 0 )
1007 {
Paul Bakker23986e52011-04-24 08:57:21 +00001008 for( i = X->n; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001009 {
Paul Bakker23986e52011-04-24 08:57:21 +00001010 r1 = X->p[i - 1] << (biL - v1);
1011 X->p[i - 1] >>= v1;
1012 X->p[i - 1] |= r0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001013 r0 = r1;
1014 }
1015 }
1016
1017 return( 0 );
1018}
1019
1020/*
1021 * Compare unsigned values
1022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023int mbedtls_mpi_cmp_abs( const mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +00001024{
Paul Bakker23986e52011-04-24 08:57:21 +00001025 size_t i, j;
Hanno Becker73d7d792018-12-11 10:35:51 +00001026 MPI_VALIDATE_RET( X != NULL );
1027 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001028
Paul Bakker23986e52011-04-24 08:57:21 +00001029 for( i = X->n; i > 0; i-- )
1030 if( X->p[i - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001031 break;
1032
Paul Bakker23986e52011-04-24 08:57:21 +00001033 for( j = Y->n; j > 0; j-- )
1034 if( Y->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001035 break;
1036
Paul Bakker23986e52011-04-24 08:57:21 +00001037 if( i == 0 && j == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001038 return( 0 );
1039
1040 if( i > j ) return( 1 );
1041 if( j > i ) return( -1 );
1042
Paul Bakker23986e52011-04-24 08:57:21 +00001043 for( ; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001044 {
Paul Bakker23986e52011-04-24 08:57:21 +00001045 if( X->p[i - 1] > Y->p[i - 1] ) return( 1 );
1046 if( X->p[i - 1] < Y->p[i - 1] ) return( -1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001047 }
1048
1049 return( 0 );
1050}
1051
1052/*
1053 * Compare signed values
1054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055int mbedtls_mpi_cmp_mpi( const mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +00001056{
Paul Bakker23986e52011-04-24 08:57:21 +00001057 size_t i, j;
Hanno Becker73d7d792018-12-11 10:35:51 +00001058 MPI_VALIDATE_RET( X != NULL );
1059 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001060
Paul Bakker23986e52011-04-24 08:57:21 +00001061 for( i = X->n; i > 0; i-- )
1062 if( X->p[i - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001063 break;
1064
Paul Bakker23986e52011-04-24 08:57:21 +00001065 for( j = Y->n; j > 0; j-- )
1066 if( Y->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001067 break;
1068
Paul Bakker23986e52011-04-24 08:57:21 +00001069 if( i == 0 && j == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001070 return( 0 );
1071
1072 if( i > j ) return( X->s );
Paul Bakker0c8f73b2012-03-22 14:08:57 +00001073 if( j > i ) return( -Y->s );
Paul Bakker5121ce52009-01-03 21:22:43 +00001074
1075 if( X->s > 0 && Y->s < 0 ) return( 1 );
1076 if( Y->s > 0 && X->s < 0 ) return( -1 );
1077
Paul Bakker23986e52011-04-24 08:57:21 +00001078 for( ; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001079 {
Paul Bakker23986e52011-04-24 08:57:21 +00001080 if( X->p[i - 1] > Y->p[i - 1] ) return( X->s );
1081 if( X->p[i - 1] < Y->p[i - 1] ) return( -X->s );
Paul Bakker5121ce52009-01-03 21:22:43 +00001082 }
1083
1084 return( 0 );
1085}
1086
Janos Follathee6abce2019-09-05 14:47:19 +01001087/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001088 * Compare signed values
1089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090int mbedtls_mpi_cmp_int( const mbedtls_mpi *X, mbedtls_mpi_sint z )
Paul Bakker5121ce52009-01-03 21:22:43 +00001091{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 mbedtls_mpi Y;
1093 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001094 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001095
Gilles Peskinede1629a2022-11-15 23:02:14 +01001096 *p = ( z < 0 ) ? -(mbedtls_mpi_uint)z : z;
Paul Bakker5121ce52009-01-03 21:22:43 +00001097 Y.s = ( z < 0 ) ? -1 : 1;
1098 Y.n = 1;
1099 Y.p = p;
1100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 return( mbedtls_mpi_cmp_mpi( X, &Y ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001102}
1103
1104/*
1105 * Unsigned addition: X = |A| + |B| (HAC 14.7)
1106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107int mbedtls_mpi_add_abs( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001108{
Janos Follath24eed8d2019-11-22 13:21:35 +00001109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001110 size_t i, j;
Janos Follath6c922682015-10-30 17:43:11 +01001111 mbedtls_mpi_uint *o, *p, c, tmp;
Hanno Becker73d7d792018-12-11 10:35:51 +00001112 MPI_VALIDATE_RET( X != NULL );
1113 MPI_VALIDATE_RET( A != NULL );
1114 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001115
1116 if( X == B )
1117 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001118 const mbedtls_mpi *T = A; A = X; B = T;
Paul Bakker5121ce52009-01-03 21:22:43 +00001119 }
1120
1121 if( X != A )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, A ) );
Paul Bakker9af723c2014-05-01 13:03:14 +02001123
Paul Bakkerf7ca7b92009-06-20 10:31:06 +00001124 /*
1125 * X should always be positive as a result of unsigned additions.
1126 */
1127 X->s = 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001128
Paul Bakker23986e52011-04-24 08:57:21 +00001129 for( j = B->n; j > 0; j-- )
1130 if( B->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001131 break;
1132
Gilles Peskine103cf592022-11-15 22:59:00 +01001133 /* Exit early to avoid undefined behavior on NULL+0 when X->n == 0
1134 * and B is 0 (of any size). */
1135 if( j == 0 )
1136 return( 0 );
1137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001138 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, j ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001139
1140 o = B->p; p = X->p; c = 0;
1141
Janos Follath6c922682015-10-30 17:43:11 +01001142 /*
1143 * tmp is used because it might happen that p == o
1144 */
Paul Bakker23986e52011-04-24 08:57:21 +00001145 for( i = 0; i < j; i++, o++, p++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001146 {
Janos Follath6c922682015-10-30 17:43:11 +01001147 tmp= *o;
Paul Bakker5121ce52009-01-03 21:22:43 +00001148 *p += c; c = ( *p < c );
Janos Follath6c922682015-10-30 17:43:11 +01001149 *p += tmp; c += ( *p < tmp );
Paul Bakker5121ce52009-01-03 21:22:43 +00001150 }
1151
1152 while( c != 0 )
1153 {
1154 if( i >= X->n )
1155 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, i + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001157 p = X->p + i;
1158 }
1159
Paul Bakker2d319fd2012-09-16 21:34:26 +00001160 *p += c; c = ( *p < c ); i++; p++;
Paul Bakker5121ce52009-01-03 21:22:43 +00001161 }
1162
1163cleanup:
1164
1165 return( ret );
1166}
1167
Gilles Peskine09ec10a2020-06-09 10:39:38 +02001168/**
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001169 * Helper for mbedtls_mpi subtraction.
1170 *
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001171 * Calculate l - r where l and r have the same size.
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001172 * This function operates modulo (2^ciL)^n and returns the carry
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001173 * (1 if there was a wraparound, i.e. if `l < r`, and 0 otherwise).
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001174 *
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001175 * d may be aliased to l or r.
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001176 *
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001177 * \param n Number of limbs of \p d, \p l and \p r.
1178 * \param[out] d The result of the subtraction.
1179 * \param[in] l The left operand.
1180 * \param[in] r The right operand.
1181 *
1182 * \return 1 if `l < r`.
1183 * 0 if `l >= r`.
Paul Bakker5121ce52009-01-03 21:22:43 +00001184 */
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001185static mbedtls_mpi_uint mpi_sub_hlp( size_t n,
1186 mbedtls_mpi_uint *d,
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001187 const mbedtls_mpi_uint *l,
1188 const mbedtls_mpi_uint *r )
Paul Bakker5121ce52009-01-03 21:22:43 +00001189{
Paul Bakker23986e52011-04-24 08:57:21 +00001190 size_t i;
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001191 mbedtls_mpi_uint c = 0, t, z;
Paul Bakker5121ce52009-01-03 21:22:43 +00001192
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001193 for( i = 0; i < n; i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001194 {
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001195 z = ( l[i] < c ); t = l[i] - c;
1196 c = ( t < r[i] ) + z; d[i] = t - r[i];
Paul Bakker5121ce52009-01-03 21:22:43 +00001197 }
1198
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001199 return( c );
Paul Bakker5121ce52009-01-03 21:22:43 +00001200}
1201
1202/*
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001203 * Unsigned subtraction: X = |A| - |B| (HAC 14.9, 14.10)
Paul Bakker5121ce52009-01-03 21:22:43 +00001204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001205int mbedtls_mpi_sub_abs( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001206{
Janos Follath24eed8d2019-11-22 13:21:35 +00001207 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001208 size_t n;
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001209 mbedtls_mpi_uint carry;
Hanno Becker73d7d792018-12-11 10:35:51 +00001210 MPI_VALIDATE_RET( X != NULL );
1211 MPI_VALIDATE_RET( A != NULL );
1212 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001213
Paul Bakker23986e52011-04-24 08:57:21 +00001214 for( n = B->n; n > 0; n-- )
1215 if( B->p[n - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001216 break;
Gilles Peskinec8a91772021-01-27 22:30:43 +01001217 if( n > A->n )
1218 {
1219 /* B >= (2^ciL)^n > A */
1220 ret = MBEDTLS_ERR_MPI_NEGATIVE_VALUE;
1221 goto cleanup;
1222 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001223
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001224 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, A->n ) );
1225
1226 /* Set the high limbs of X to match A. Don't touch the lower limbs
1227 * because X might be aliased to B, and we must not overwrite the
1228 * significant digits of B. */
1229 if( A->n > n )
1230 memcpy( X->p + n, A->p + n, ( A->n - n ) * ciL );
1231 if( X->n > A->n )
1232 memset( X->p + A->n, 0, ( X->n - A->n ) * ciL );
1233
1234 carry = mpi_sub_hlp( n, X->p, A->p, B->p );
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001235 if( carry != 0 )
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001236 {
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001237 /* Propagate the carry to the first nonzero limb of X. */
1238 for( ; n < X->n && X->p[n] == 0; n++ )
1239 --X->p[n];
1240 /* If we ran out of space for the carry, it means that the result
1241 * is negative. */
1242 if( n == X->n )
Gilles Peskine89b41302020-07-23 01:16:46 +02001243 {
1244 ret = MBEDTLS_ERR_MPI_NEGATIVE_VALUE;
1245 goto cleanup;
1246 }
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001247 --X->p[n];
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001248 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001249
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001250 /* X should always be positive as a result of unsigned subtractions. */
1251 X->s = 1;
1252
Paul Bakker5121ce52009-01-03 21:22:43 +00001253cleanup:
Paul Bakker5121ce52009-01-03 21:22:43 +00001254 return( ret );
1255}
1256
1257/*
1258 * Signed addition: X = A + B
1259 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001260int mbedtls_mpi_add_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001261{
Hanno Becker73d7d792018-12-11 10:35:51 +00001262 int ret, s;
1263 MPI_VALIDATE_RET( X != NULL );
1264 MPI_VALIDATE_RET( A != NULL );
1265 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001266
Hanno Becker73d7d792018-12-11 10:35:51 +00001267 s = A->s;
Paul Bakker5121ce52009-01-03 21:22:43 +00001268 if( A->s * B->s < 0 )
1269 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001270 if( mbedtls_mpi_cmp_abs( A, B ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001271 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001272 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001273 X->s = s;
1274 }
1275 else
1276 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, B, A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001278 X->s = -s;
1279 }
1280 }
1281 else
1282 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001283 MBEDTLS_MPI_CHK( mbedtls_mpi_add_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001284 X->s = s;
1285 }
1286
1287cleanup:
1288
1289 return( ret );
1290}
1291
1292/*
Paul Bakker60b1d102013-10-29 10:02:51 +01001293 * Signed subtraction: X = A - B
Paul Bakker5121ce52009-01-03 21:22:43 +00001294 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001295int mbedtls_mpi_sub_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001296{
Hanno Becker73d7d792018-12-11 10:35:51 +00001297 int ret, s;
1298 MPI_VALIDATE_RET( X != NULL );
1299 MPI_VALIDATE_RET( A != NULL );
1300 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001301
Hanno Becker73d7d792018-12-11 10:35:51 +00001302 s = A->s;
Paul Bakker5121ce52009-01-03 21:22:43 +00001303 if( A->s * B->s > 0 )
1304 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305 if( mbedtls_mpi_cmp_abs( A, B ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001306 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001307 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001308 X->s = s;
1309 }
1310 else
1311 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, B, A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001313 X->s = -s;
1314 }
1315 }
1316 else
1317 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318 MBEDTLS_MPI_CHK( mbedtls_mpi_add_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001319 X->s = s;
1320 }
1321
1322cleanup:
1323
1324 return( ret );
1325}
1326
1327/*
1328 * Signed addition: X = A + b
1329 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330int mbedtls_mpi_add_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001331{
Yuto Takanobc6eaf72021-07-05 09:10:52 +01001332 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001334 MPI_VALIDATE_RET( X != NULL );
1335 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001336
Gilles Peskinede1629a2022-11-15 23:02:14 +01001337 p[0] = ( b < 0 ) ? -(mbedtls_mpi_uint)b : b;
Yuto Takanobc6eaf72021-07-05 09:10:52 +01001338 B.s = ( b < 0 ) ? -1 : 1;
1339 B.n = 1;
1340 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001341
Yuto Takanobc6eaf72021-07-05 09:10:52 +01001342 return( mbedtls_mpi_add_mpi( X, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001343}
1344
1345/*
Paul Bakker60b1d102013-10-29 10:02:51 +01001346 * Signed subtraction: X = A - b
Paul Bakker5121ce52009-01-03 21:22:43 +00001347 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348int mbedtls_mpi_sub_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001349{
Yuto Takanobc6eaf72021-07-05 09:10:52 +01001350 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001352 MPI_VALIDATE_RET( X != NULL );
1353 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001354
Gilles Peskinede1629a2022-11-15 23:02:14 +01001355 p[0] = ( b < 0 ) ? -(mbedtls_mpi_uint)b : b;
Yuto Takanobc6eaf72021-07-05 09:10:52 +01001356 B.s = ( b < 0 ) ? -1 : 1;
1357 B.n = 1;
1358 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001359
Yuto Takanobc6eaf72021-07-05 09:10:52 +01001360 return( mbedtls_mpi_sub_mpi( X, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001361}
1362
Gilles Peskinea5d8d892020-07-23 21:27:15 +02001363/** Helper for mbedtls_mpi multiplication.
1364 *
1365 * Add \p b * \p s to \p d.
1366 *
1367 * \param i The number of limbs of \p s.
1368 * \param[in] s A bignum to multiply, of size \p i.
1369 * It may overlap with \p d, but only if
1370 * \p d <= \p s.
1371 * Its leading limb must not be \c 0.
1372 * \param[in,out] d The bignum to add to.
1373 * It must be sufficiently large to store the
1374 * result of the multiplication. This means
1375 * \p i + 1 limbs if \p d[\p i - 1] started as 0 and \p b
1376 * is not known a priori.
1377 * \param b A scalar to multiply.
Paul Bakkerfc4f46f2013-06-24 19:23:56 +02001378 */
1379static
1380#if defined(__APPLE__) && defined(__arm__)
1381/*
1382 * Apple LLVM version 4.2 (clang-425.0.24) (based on LLVM 3.2svn)
1383 * appears to need this to prevent bad ARM code generation at -O3.
1384 */
1385__attribute__ ((noinline))
1386#endif
Gilles Peskinea5d8d892020-07-23 21:27:15 +02001387void mpi_mul_hlp( size_t i,
1388 const mbedtls_mpi_uint *s,
1389 mbedtls_mpi_uint *d,
1390 mbedtls_mpi_uint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001391{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392 mbedtls_mpi_uint c = 0, t = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001393
1394#if defined(MULADDC_HUIT)
1395 for( ; i >= 8; i -= 8 )
1396 {
1397 MULADDC_INIT
1398 MULADDC_HUIT
1399 MULADDC_STOP
1400 }
1401
1402 for( ; i > 0; i-- )
1403 {
1404 MULADDC_INIT
1405 MULADDC_CORE
1406 MULADDC_STOP
1407 }
Paul Bakker9af723c2014-05-01 13:03:14 +02001408#else /* MULADDC_HUIT */
Paul Bakker5121ce52009-01-03 21:22:43 +00001409 for( ; i >= 16; i -= 16 )
1410 {
1411 MULADDC_INIT
1412 MULADDC_CORE MULADDC_CORE
1413 MULADDC_CORE MULADDC_CORE
1414 MULADDC_CORE MULADDC_CORE
1415 MULADDC_CORE MULADDC_CORE
1416
1417 MULADDC_CORE MULADDC_CORE
1418 MULADDC_CORE MULADDC_CORE
1419 MULADDC_CORE MULADDC_CORE
1420 MULADDC_CORE MULADDC_CORE
1421 MULADDC_STOP
1422 }
1423
1424 for( ; i >= 8; i -= 8 )
1425 {
1426 MULADDC_INIT
1427 MULADDC_CORE MULADDC_CORE
1428 MULADDC_CORE MULADDC_CORE
1429
1430 MULADDC_CORE MULADDC_CORE
1431 MULADDC_CORE MULADDC_CORE
1432 MULADDC_STOP
1433 }
1434
1435 for( ; i > 0; i-- )
1436 {
1437 MULADDC_INIT
1438 MULADDC_CORE
1439 MULADDC_STOP
1440 }
Paul Bakker9af723c2014-05-01 13:03:14 +02001441#endif /* MULADDC_HUIT */
Paul Bakker5121ce52009-01-03 21:22:43 +00001442
1443 t++;
1444
Gilles Peskine8e464c42020-07-24 00:08:38 +02001445 while( c != 0 )
1446 {
Paul Bakker5121ce52009-01-03 21:22:43 +00001447 *d += c; c = ( *d < c ); d++;
1448 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001449}
1450
1451/*
1452 * Baseline multiplication: X = A * B (HAC 14.12)
1453 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001454int mbedtls_mpi_mul_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001455{
Janos Follath24eed8d2019-11-22 13:21:35 +00001456 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001457 size_t i, j;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001458 mbedtls_mpi TA, TB;
Gilles Peskined65b5002021-06-15 21:44:32 +02001459 int result_is_zero = 0;
Hanno Becker73d7d792018-12-11 10:35:51 +00001460 MPI_VALIDATE_RET( X != NULL );
1461 MPI_VALIDATE_RET( A != NULL );
1462 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001463
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001464 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00001465
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466 if( X == A ) { MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TA, A ) ); A = &TA; }
1467 if( X == B ) { MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, B ) ); B = &TB; }
Paul Bakker5121ce52009-01-03 21:22:43 +00001468
Paul Bakker23986e52011-04-24 08:57:21 +00001469 for( i = A->n; i > 0; i-- )
1470 if( A->p[i - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001471 break;
Gilles Peskine38a384d2021-06-17 14:35:25 +02001472 if( i == 0 )
Gilles Peskined65b5002021-06-15 21:44:32 +02001473 result_is_zero = 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001474
Paul Bakker23986e52011-04-24 08:57:21 +00001475 for( j = B->n; j > 0; j-- )
1476 if( B->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001477 break;
Gilles Peskine38a384d2021-06-17 14:35:25 +02001478 if( j == 0 )
Gilles Peskined65b5002021-06-15 21:44:32 +02001479 result_is_zero = 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001480
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001481 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, i + j ) );
1482 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001483
Alexey Skalozub8e75e682016-01-13 21:59:27 +02001484 for( ; j > 0; j-- )
1485 mpi_mul_hlp( i, A->p, X->p + j - 1, B->p[j - 1] );
Paul Bakker5121ce52009-01-03 21:22:43 +00001486
Gilles Peskine70a7dcd2021-06-10 15:51:54 +02001487 /* If the result is 0, we don't shortcut the operation, which reduces
1488 * but does not eliminate side channels leaking the zero-ness. We do
1489 * need to take care to set the sign bit properly since the library does
1490 * not fully support an MPI object with a value of 0 and s == -1. */
Gilles Peskined65b5002021-06-15 21:44:32 +02001491 if( result_is_zero )
Gilles Peskine70a7dcd2021-06-10 15:51:54 +02001492 X->s = 1;
Gilles Peskine70a7dcd2021-06-10 15:51:54 +02001493 else
1494 X->s = A->s * B->s;
Paul Bakker5121ce52009-01-03 21:22:43 +00001495
1496cleanup:
1497
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498 mbedtls_mpi_free( &TB ); mbedtls_mpi_free( &TA );
Paul Bakker5121ce52009-01-03 21:22:43 +00001499
1500 return( ret );
1501}
1502
1503/*
1504 * Baseline multiplication: X = A * b
1505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001506int mbedtls_mpi_mul_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_uint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001507{
Hanno Becker73d7d792018-12-11 10:35:51 +00001508 MPI_VALIDATE_RET( X != NULL );
1509 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001510
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001511 /* mpi_mul_hlp can't deal with a leading 0. */
1512 size_t n = A->n;
1513 while( n > 0 && A->p[n - 1] == 0 )
1514 --n;
Paul Bakker5121ce52009-01-03 21:22:43 +00001515
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001516 /* The general method below doesn't work if n==0 or b==0. By chance
1517 * calculating the result is trivial in those cases. */
1518 if( b == 0 || n == 0 )
1519 {
Paul Elliott986b55a2021-04-20 21:46:29 +01001520 return( mbedtls_mpi_lset( X, 0 ) );
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001521 }
1522
Gilles Peskinee1bba7c2021-03-10 23:44:10 +01001523 /* Calculate A*b as A + A*(b-1) to take advantage of mpi_mul_hlp */
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001524 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinecd0dbf32020-07-24 00:09:04 +02001525 /* In general, A * b requires 1 limb more than b. If
1526 * A->p[n - 1] * b / b == A->p[n - 1], then A * b fits in the same
1527 * number of limbs as A and the call to grow() is not required since
Gilles Peskinee1bba7c2021-03-10 23:44:10 +01001528 * copy() will take care of the growth if needed. However, experimentally,
1529 * making the call to grow() unconditional causes slightly fewer
Gilles Peskinecd0dbf32020-07-24 00:09:04 +02001530 * calls to calloc() in ECP code, presumably because it reuses the
1531 * same mpi for a while and this way the mpi is more likely to directly
1532 * grow to its final size. */
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001533 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, n + 1 ) );
1534 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, A ) );
1535 mpi_mul_hlp( n, A->p, X->p, b - 1 );
1536
1537cleanup:
1538 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001539}
1540
1541/*
Simon Butcherf5ba0452015-12-27 23:01:55 +00001542 * Unsigned integer divide - double mbedtls_mpi_uint dividend, u1/u0, and
1543 * mbedtls_mpi_uint divisor, d
Simon Butcher15b15d12015-11-26 19:35:03 +00001544 */
Simon Butcherf5ba0452015-12-27 23:01:55 +00001545static mbedtls_mpi_uint mbedtls_int_div_int( mbedtls_mpi_uint u1,
1546 mbedtls_mpi_uint u0, mbedtls_mpi_uint d, mbedtls_mpi_uint *r )
Simon Butcher15b15d12015-11-26 19:35:03 +00001547{
Manuel Pégourié-Gonnard16308882015-12-01 10:27:00 +01001548#if defined(MBEDTLS_HAVE_UDBL)
1549 mbedtls_t_udbl dividend, quotient;
Simon Butcherf5ba0452015-12-27 23:01:55 +00001550#else
Simon Butcher9803d072016-01-03 00:24:34 +00001551 const mbedtls_mpi_uint radix = (mbedtls_mpi_uint) 1 << biH;
1552 const mbedtls_mpi_uint uint_halfword_mask = ( (mbedtls_mpi_uint) 1 << biH ) - 1;
Simon Butcherf5ba0452015-12-27 23:01:55 +00001553 mbedtls_mpi_uint d0, d1, q0, q1, rAX, r0, quotient;
1554 mbedtls_mpi_uint u0_msw, u0_lsw;
Simon Butcher9803d072016-01-03 00:24:34 +00001555 size_t s;
Manuel Pégourié-Gonnard16308882015-12-01 10:27:00 +01001556#endif
1557
Simon Butcher15b15d12015-11-26 19:35:03 +00001558 /*
1559 * Check for overflow
1560 */
Simon Butcherf5ba0452015-12-27 23:01:55 +00001561 if( 0 == d || u1 >= d )
Simon Butcher15b15d12015-11-26 19:35:03 +00001562 {
Simon Butcherf5ba0452015-12-27 23:01:55 +00001563 if (r != NULL) *r = ~0;
Simon Butcher15b15d12015-11-26 19:35:03 +00001564
Simon Butcherf5ba0452015-12-27 23:01:55 +00001565 return ( ~0 );
Simon Butcher15b15d12015-11-26 19:35:03 +00001566 }
1567
1568#if defined(MBEDTLS_HAVE_UDBL)
Simon Butcher15b15d12015-11-26 19:35:03 +00001569 dividend = (mbedtls_t_udbl) u1 << biL;
1570 dividend |= (mbedtls_t_udbl) u0;
1571 quotient = dividend / d;
1572 if( quotient > ( (mbedtls_t_udbl) 1 << biL ) - 1 )
1573 quotient = ( (mbedtls_t_udbl) 1 << biL ) - 1;
1574
1575 if( r != NULL )
Simon Butcher9803d072016-01-03 00:24:34 +00001576 *r = (mbedtls_mpi_uint)( dividend - (quotient * d ) );
Simon Butcher15b15d12015-11-26 19:35:03 +00001577
1578 return (mbedtls_mpi_uint) quotient;
1579#else
Simon Butcher15b15d12015-11-26 19:35:03 +00001580
1581 /*
1582 * Algorithm D, Section 4.3.1 - The Art of Computer Programming
1583 * Vol. 2 - Seminumerical Algorithms, Knuth
1584 */
1585
1586 /*
1587 * Normalize the divisor, d, and dividend, u0, u1
1588 */
1589 s = mbedtls_clz( d );
1590 d = d << s;
1591
1592 u1 = u1 << s;
Simon Butcher9803d072016-01-03 00:24:34 +00001593 u1 |= ( u0 >> ( biL - s ) ) & ( -(mbedtls_mpi_sint)s >> ( biL - 1 ) );
Simon Butcher15b15d12015-11-26 19:35:03 +00001594 u0 = u0 << s;
1595
1596 d1 = d >> biH;
Simon Butcher9803d072016-01-03 00:24:34 +00001597 d0 = d & uint_halfword_mask;
Simon Butcher15b15d12015-11-26 19:35:03 +00001598
1599 u0_msw = u0 >> biH;
Simon Butcher9803d072016-01-03 00:24:34 +00001600 u0_lsw = u0 & uint_halfword_mask;
Simon Butcher15b15d12015-11-26 19:35:03 +00001601
1602 /*
1603 * Find the first quotient and remainder
1604 */
1605 q1 = u1 / d1;
1606 r0 = u1 - d1 * q1;
1607
1608 while( q1 >= radix || ( q1 * d0 > radix * r0 + u0_msw ) )
1609 {
1610 q1 -= 1;
1611 r0 += d1;
1612
1613 if ( r0 >= radix ) break;
1614 }
1615
Simon Butcherf5ba0452015-12-27 23:01:55 +00001616 rAX = ( u1 * radix ) + ( u0_msw - q1 * d );
Simon Butcher15b15d12015-11-26 19:35:03 +00001617 q0 = rAX / d1;
1618 r0 = rAX - q0 * d1;
1619
1620 while( q0 >= radix || ( q0 * d0 > radix * r0 + u0_lsw ) )
1621 {
1622 q0 -= 1;
1623 r0 += d1;
1624
1625 if ( r0 >= radix ) break;
1626 }
1627
1628 if (r != NULL)
Simon Butcherf5ba0452015-12-27 23:01:55 +00001629 *r = ( rAX * radix + u0_lsw - q0 * d ) >> s;
Simon Butcher15b15d12015-11-26 19:35:03 +00001630
1631 quotient = q1 * radix + q0;
1632
1633 return quotient;
1634#endif
1635}
1636
1637/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001638 * Division by mbedtls_mpi: A = Q * B + R (HAC 14.20)
Paul Bakker5121ce52009-01-03 21:22:43 +00001639 */
Hanno Becker73d7d792018-12-11 10:35:51 +00001640int mbedtls_mpi_div_mpi( mbedtls_mpi *Q, mbedtls_mpi *R, const mbedtls_mpi *A,
1641 const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001642{
Janos Follath24eed8d2019-11-22 13:21:35 +00001643 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001644 size_t i, n, t, k;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001645 mbedtls_mpi X, Y, Z, T1, T2;
Alexander Kd19a1932019-11-01 18:20:42 +03001646 mbedtls_mpi_uint TP2[3];
Hanno Becker73d7d792018-12-11 10:35:51 +00001647 MPI_VALIDATE_RET( A != NULL );
1648 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650 if( mbedtls_mpi_cmp_int( B, 0 ) == 0 )
1651 return( MBEDTLS_ERR_MPI_DIVISION_BY_ZERO );
Paul Bakker5121ce52009-01-03 21:22:43 +00001652
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653 mbedtls_mpi_init( &X ); mbedtls_mpi_init( &Y ); mbedtls_mpi_init( &Z );
Alexander K35d6d462019-10-31 14:46:45 +03001654 mbedtls_mpi_init( &T1 );
Alexander Kd19a1932019-11-01 18:20:42 +03001655 /*
1656 * Avoid dynamic memory allocations for constant-size T2.
1657 *
1658 * T2 is used for comparison only and the 3 limbs are assigned explicitly,
1659 * so nobody increase the size of the MPI and we're safe to use an on-stack
1660 * buffer.
1661 */
Alexander K35d6d462019-10-31 14:46:45 +03001662 T2.s = 1;
Alexander Kd19a1932019-11-01 18:20:42 +03001663 T2.n = sizeof( TP2 ) / sizeof( *TP2 );
1664 T2.p = TP2;
Paul Bakker5121ce52009-01-03 21:22:43 +00001665
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666 if( mbedtls_mpi_cmp_abs( A, B ) < 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001667 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668 if( Q != NULL ) MBEDTLS_MPI_CHK( mbedtls_mpi_lset( Q, 0 ) );
1669 if( R != NULL ) MBEDTLS_MPI_CHK( mbedtls_mpi_copy( R, A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001670 return( 0 );
1671 }
1672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &X, A ) );
1674 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Y, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001675 X.s = Y.s = 1;
1676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &Z, A->n + 2 ) );
1678 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &Z, 0 ) );
Gilles Peskine2536aa72020-07-24 00:12:59 +02001679 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &T1, A->n + 2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001680
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02001681 k = mbedtls_mpi_bitlen( &Y ) % biL;
Paul Bakkerf9688572011-05-05 10:00:45 +00001682 if( k < biL - 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001683 {
1684 k = biL - 1 - k;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001685 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &X, k ) );
1686 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &Y, k ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001687 }
1688 else k = 0;
1689
1690 n = X.n - 1;
1691 t = Y.n - 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001692 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &Y, biL * ( n - t ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 while( mbedtls_mpi_cmp_mpi( &X, &Y ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001695 {
1696 Z.p[n - t]++;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001697 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &X, &X, &Y ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001698 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &Y, biL * ( n - t ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001700
1701 for( i = n; i > t ; i-- )
1702 {
1703 if( X.p[i] >= Y.p[t] )
1704 Z.p[i - t - 1] = ~0;
1705 else
1706 {
Simon Butcher15b15d12015-11-26 19:35:03 +00001707 Z.p[i - t - 1] = mbedtls_int_div_int( X.p[i], X.p[i - 1],
1708 Y.p[t], NULL);
Paul Bakker5121ce52009-01-03 21:22:43 +00001709 }
1710
Alexander K35d6d462019-10-31 14:46:45 +03001711 T2.p[0] = ( i < 2 ) ? 0 : X.p[i - 2];
1712 T2.p[1] = ( i < 1 ) ? 0 : X.p[i - 1];
1713 T2.p[2] = X.p[i];
1714
Paul Bakker5121ce52009-01-03 21:22:43 +00001715 Z.p[i - t - 1]++;
1716 do
1717 {
1718 Z.p[i - t - 1]--;
1719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &T1, 0 ) );
Paul Bakker66d5d072014-06-17 16:39:18 +02001721 T1.p[0] = ( t < 1 ) ? 0 : Y.p[t - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +00001722 T1.p[1] = Y.p[t];
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T1, &T1, Z.p[i - t - 1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001724 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725 while( mbedtls_mpi_cmp_mpi( &T1, &T2 ) > 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001726
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T1, &Y, Z.p[i - t - 1] ) );
1728 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &T1, biL * ( i - t - 1 ) ) );
1729 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &X, &X, &T1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001730
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731 if( mbedtls_mpi_cmp_int( &X, 0 ) < 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001732 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &T1, &Y ) );
1734 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &T1, biL * ( i - t - 1 ) ) );
1735 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &X, &X, &T1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001736 Z.p[i - t - 1]--;
1737 }
1738 }
1739
1740 if( Q != NULL )
1741 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( Q, &Z ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001743 Q->s = A->s * B->s;
1744 }
1745
1746 if( R != NULL )
1747 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001748 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &X, k ) );
Paul Bakkerf02c5642012-11-13 10:25:21 +00001749 X.s = A->s;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( R, &X ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752 if( mbedtls_mpi_cmp_int( R, 0 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001753 R->s = 1;
1754 }
1755
1756cleanup:
1757
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758 mbedtls_mpi_free( &X ); mbedtls_mpi_free( &Y ); mbedtls_mpi_free( &Z );
Alexander K35d6d462019-10-31 14:46:45 +03001759 mbedtls_mpi_free( &T1 );
Alexander Kd19a1932019-11-01 18:20:42 +03001760 mbedtls_platform_zeroize( TP2, sizeof( TP2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001761
1762 return( ret );
1763}
1764
1765/*
1766 * Division by int: A = Q * b + R
Paul Bakker5121ce52009-01-03 21:22:43 +00001767 */
Hanno Becker73d7d792018-12-11 10:35:51 +00001768int mbedtls_mpi_div_int( mbedtls_mpi *Q, mbedtls_mpi *R,
1769 const mbedtls_mpi *A,
1770 mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001771{
Yuto Takanobc6eaf72021-07-05 09:10:52 +01001772 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001773 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001774 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001775
Gilles Peskinede1629a2022-11-15 23:02:14 +01001776 p[0] = ( b < 0 ) ? -(mbedtls_mpi_uint)b : b;
Yuto Takanobc6eaf72021-07-05 09:10:52 +01001777 B.s = ( b < 0 ) ? -1 : 1;
1778 B.n = 1;
1779 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001780
Yuto Takanobc6eaf72021-07-05 09:10:52 +01001781 return( mbedtls_mpi_div_mpi( Q, R, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001782}
1783
1784/*
1785 * Modulo: R = A mod B
1786 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787int mbedtls_mpi_mod_mpi( mbedtls_mpi *R, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001788{
Janos Follath24eed8d2019-11-22 13:21:35 +00001789 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker73d7d792018-12-11 10:35:51 +00001790 MPI_VALIDATE_RET( R != NULL );
1791 MPI_VALIDATE_RET( A != NULL );
1792 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001793
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794 if( mbedtls_mpi_cmp_int( B, 0 ) < 0 )
1795 return( MBEDTLS_ERR_MPI_NEGATIVE_VALUE );
Paul Bakkerce40a6d2009-06-23 19:46:08 +00001796
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797 MBEDTLS_MPI_CHK( mbedtls_mpi_div_mpi( NULL, R, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 while( mbedtls_mpi_cmp_int( R, 0 ) < 0 )
1800 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( R, R, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802 while( mbedtls_mpi_cmp_mpi( R, B ) >= 0 )
1803 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( R, R, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001804
1805cleanup:
1806
1807 return( ret );
1808}
1809
1810/*
1811 * Modulo: r = A mod b
1812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813int mbedtls_mpi_mod_int( mbedtls_mpi_uint *r, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001814{
Paul Bakker23986e52011-04-24 08:57:21 +00001815 size_t i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 mbedtls_mpi_uint x, y, z;
Hanno Becker73d7d792018-12-11 10:35:51 +00001817 MPI_VALIDATE_RET( r != NULL );
1818 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001819
1820 if( b == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821 return( MBEDTLS_ERR_MPI_DIVISION_BY_ZERO );
Paul Bakker5121ce52009-01-03 21:22:43 +00001822
1823 if( b < 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824 return( MBEDTLS_ERR_MPI_NEGATIVE_VALUE );
Paul Bakker5121ce52009-01-03 21:22:43 +00001825
1826 /*
1827 * handle trivial cases
1828 */
Gilles Peskinec9529f92022-06-09 19:32:46 +02001829 if( b == 1 || A->n == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001830 {
1831 *r = 0;
1832 return( 0 );
1833 }
1834
1835 if( b == 2 )
1836 {
1837 *r = A->p[0] & 1;
1838 return( 0 );
1839 }
1840
1841 /*
1842 * general case
1843 */
Paul Bakker23986e52011-04-24 08:57:21 +00001844 for( i = A->n, y = 0; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001845 {
Paul Bakker23986e52011-04-24 08:57:21 +00001846 x = A->p[i - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +00001847 y = ( y << biH ) | ( x >> biH );
1848 z = y / b;
1849 y -= z * b;
1850
1851 x <<= biH;
1852 y = ( y << biH ) | ( x >> biH );
1853 z = y / b;
1854 y -= z * b;
1855 }
1856
Paul Bakkerce40a6d2009-06-23 19:46:08 +00001857 /*
1858 * If A is negative, then the current y represents a negative value.
1859 * Flipping it to the positive side.
1860 */
1861 if( A->s < 0 && y != 0 )
1862 y = b - y;
1863
Paul Bakker5121ce52009-01-03 21:22:43 +00001864 *r = y;
1865
1866 return( 0 );
1867}
1868
1869/*
1870 * Fast Montgomery initialization (thanks to Tom St Denis)
1871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872static void mpi_montg_init( mbedtls_mpi_uint *mm, const mbedtls_mpi *N )
Paul Bakker5121ce52009-01-03 21:22:43 +00001873{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874 mbedtls_mpi_uint x, m0 = N->p[0];
Manuel Pégourié-Gonnardfdf3f0e2014-03-11 13:47:05 +01001875 unsigned int i;
Paul Bakker5121ce52009-01-03 21:22:43 +00001876
1877 x = m0;
1878 x += ( ( m0 + 2 ) & 4 ) << 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001879
Manuel Pégourié-Gonnardfdf3f0e2014-03-11 13:47:05 +01001880 for( i = biL; i >= 8; i /= 2 )
1881 x *= ( 2 - ( m0 * x ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001882
1883 *mm = ~x + 1;
1884}
1885
Gilles Peskine2a82f722020-06-04 15:00:49 +02001886/** Montgomery multiplication: A = A * B * R^-1 mod N (HAC 14.36)
1887 *
1888 * \param[in,out] A One of the numbers to multiply.
Gilles Peskine221626f2020-06-08 22:37:50 +02001889 * It must have at least as many limbs as N
1890 * (A->n >= N->n), and any limbs beyond n are ignored.
Gilles Peskine2a82f722020-06-04 15:00:49 +02001891 * On successful completion, A contains the result of
1892 * the multiplication A * B * R^-1 mod N where
1893 * R = (2^ciL)^n.
1894 * \param[in] B One of the numbers to multiply.
1895 * It must be nonzero and must not have more limbs than N
1896 * (B->n <= N->n).
1897 * \param[in] N The modulo. N must be odd.
1898 * \param mm The value calculated by `mpi_montg_init(&mm, N)`.
1899 * This is -N^-1 mod 2^ciL.
1900 * \param[in,out] T A bignum for temporary storage.
1901 * It must be at least twice the limb size of N plus 2
1902 * (T->n >= 2 * (N->n + 1)).
1903 * Its initial content is unused and
1904 * its final content is indeterminate.
1905 * Note that unlike the usual convention in the library
1906 * for `const mbedtls_mpi*`, the content of T can change.
Paul Bakker5121ce52009-01-03 21:22:43 +00001907 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02001908static void mpi_montmul( mbedtls_mpi *A, const mbedtls_mpi *B, const mbedtls_mpi *N, mbedtls_mpi_uint mm,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909 const mbedtls_mpi *T )
Paul Bakker5121ce52009-01-03 21:22:43 +00001910{
Paul Bakker23986e52011-04-24 08:57:21 +00001911 size_t i, n, m;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 mbedtls_mpi_uint u0, u1, *d;
Paul Bakker5121ce52009-01-03 21:22:43 +00001913
1914 memset( T->p, 0, T->n * ciL );
1915
1916 d = T->p;
1917 n = N->n;
1918 m = ( B->n < n ) ? B->n : n;
1919
1920 for( i = 0; i < n; i++ )
1921 {
1922 /*
1923 * T = (T + u0*B + u1*N) / 2^biL
1924 */
1925 u0 = A->p[i];
1926 u1 = ( d[0] + u0 * B->p[0] ) * mm;
1927
1928 mpi_mul_hlp( m, B->p, d, u0 );
1929 mpi_mul_hlp( n, N->p, d, u1 );
1930
1931 *d++ = u0; d[n + 1] = 0;
1932 }
1933
Gilles Peskine221626f2020-06-08 22:37:50 +02001934 /* At this point, d is either the desired result or the desired result
1935 * plus N. We now potentially subtract N, avoiding leaking whether the
1936 * subtraction is performed through side channels. */
Paul Bakker5121ce52009-01-03 21:22:43 +00001937
Gilles Peskine221626f2020-06-08 22:37:50 +02001938 /* Copy the n least significant limbs of d to A, so that
1939 * A = d if d < N (recall that N has n limbs). */
1940 memcpy( A->p, d, n * ciL );
Gilles Peskine09ec10a2020-06-09 10:39:38 +02001941 /* If d >= N then we want to set A to d - N. To prevent timing attacks,
Gilles Peskine221626f2020-06-08 22:37:50 +02001942 * do the calculation without using conditional tests. */
1943 /* Set d to d0 + (2^biL)^n - N where d0 is the current value of d. */
Gilles Peskine132c0972020-06-04 21:05:24 +02001944 d[n] += 1;
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001945 d[n] -= mpi_sub_hlp( n, d, d, N->p );
Gilles Peskine221626f2020-06-08 22:37:50 +02001946 /* If d0 < N then d < (2^biL)^n
1947 * so d[n] == 0 and we want to keep A as it is.
1948 * If d0 >= N then d >= (2^biL)^n, and d <= (2^biL)^n + N < 2 * (2^biL)^n
1949 * so d[n] == 1 and we want to set A to the result of the subtraction
1950 * which is d - (2^biL)^n, i.e. the n least significant limbs of d.
1951 * This exactly corresponds to a conditional assignment. */
Gabor Mezei18a44942021-10-20 11:59:27 +02001952 mbedtls_ct_mpi_uint_cond_assign( n, A->p, d, (unsigned char) d[n] );
Paul Bakker5121ce52009-01-03 21:22:43 +00001953}
1954
1955/*
1956 * Montgomery reduction: A = A * R^-1 mod N
Gilles Peskine2a82f722020-06-04 15:00:49 +02001957 *
1958 * See mpi_montmul() regarding constraints and guarantees on the parameters.
Paul Bakker5121ce52009-01-03 21:22:43 +00001959 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02001960static void mpi_montred( mbedtls_mpi *A, const mbedtls_mpi *N,
1961 mbedtls_mpi_uint mm, const mbedtls_mpi *T )
Paul Bakker5121ce52009-01-03 21:22:43 +00001962{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001963 mbedtls_mpi_uint z = 1;
1964 mbedtls_mpi U;
Paul Bakker5121ce52009-01-03 21:22:43 +00001965
Paul Bakker8ddb6452013-02-27 14:56:33 +01001966 U.n = U.s = (int) z;
Paul Bakker5121ce52009-01-03 21:22:43 +00001967 U.p = &z;
1968
Gilles Peskine4e91d472020-06-04 20:55:15 +02001969 mpi_montmul( A, &U, N, mm, T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001970}
1971
Manuel Pégourié-Gonnarde10e8db2021-03-09 11:22:20 +01001972/**
1973 * Select an MPI from a table without leaking the index.
1974 *
1975 * This is functionally equivalent to mbedtls_mpi_copy(R, T[idx]) except it
1976 * reads the entire table in order to avoid leaking the value of idx to an
1977 * attacker able to observe memory access patterns.
1978 *
1979 * \param[out] R Where to write the selected MPI.
1980 * \param[in] T The table to read from.
1981 * \param[in] T_size The number of elements in the table.
1982 * \param[in] idx The index of the element to select;
1983 * this must satisfy 0 <= idx < T_size.
1984 *
1985 * \return \c 0 on success, or a negative error code.
1986 */
1987static int mpi_select( mbedtls_mpi *R, const mbedtls_mpi *T, size_t T_size, size_t idx )
1988{
1989 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1990
1991 for( size_t i = 0; i < T_size; i++ )
Manuel Pégourié-Gonnardeaafa492021-06-03 10:42:46 +02001992 {
1993 MBEDTLS_MPI_CHK( mbedtls_mpi_safe_cond_assign( R, &T[i],
Gabor Mezei18a44942021-10-20 11:59:27 +02001994 (unsigned char) mbedtls_ct_size_bool_eq( i, idx ) ) );
Manuel Pégourié-Gonnardeaafa492021-06-03 10:42:46 +02001995 }
Manuel Pégourié-Gonnarde10e8db2021-03-09 11:22:20 +01001996
1997cleanup:
1998 return( ret );
1999}
2000
Paul Bakker5121ce52009-01-03 21:22:43 +00002001/*
2002 * Sliding-window exponentiation: X = A^E mod N (HAC 14.85)
2003 */
Hanno Becker73d7d792018-12-11 10:35:51 +00002004int mbedtls_mpi_exp_mod( mbedtls_mpi *X, const mbedtls_mpi *A,
2005 const mbedtls_mpi *E, const mbedtls_mpi *N,
Yuto Takano284857e2021-07-14 10:20:09 +01002006 mbedtls_mpi *prec_RR )
Paul Bakker5121ce52009-01-03 21:22:43 +00002007{
Janos Follath24eed8d2019-11-22 13:21:35 +00002008 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002009 size_t wbits, wsize, one = 1;
2010 size_t i, j, nblimbs;
2011 size_t bufsize, nbits;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002012 mbedtls_mpi_uint ei, mm, state;
Manuel Pégourié-Gonnarde10e8db2021-03-09 11:22:20 +01002013 mbedtls_mpi RR, T, W[ 1 << MBEDTLS_MPI_WINDOW_SIZE ], WW, Apos;
Paul Bakkerf6198c12012-05-16 08:02:29 +00002014 int neg;
Paul Bakker5121ce52009-01-03 21:22:43 +00002015
Hanno Becker73d7d792018-12-11 10:35:51 +00002016 MPI_VALIDATE_RET( X != NULL );
2017 MPI_VALIDATE_RET( A != NULL );
2018 MPI_VALIDATE_RET( E != NULL );
2019 MPI_VALIDATE_RET( N != NULL );
2020
Hanno Becker8d1dd1b2017-09-28 11:02:24 +01002021 if( mbedtls_mpi_cmp_int( N, 0 ) <= 0 || ( N->p[0] & 1 ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002022 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00002023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002024 if( mbedtls_mpi_cmp_int( E, 0 ) < 0 )
2025 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakkerf6198c12012-05-16 08:02:29 +00002026
Chris Jones9246d042020-11-25 15:12:39 +00002027 if( mbedtls_mpi_bitlen( E ) > MBEDTLS_MPI_MAX_BITS ||
2028 mbedtls_mpi_bitlen( N ) > MBEDTLS_MPI_MAX_BITS )
2029 return ( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
2030
Paul Bakkerf6198c12012-05-16 08:02:29 +00002031 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00002032 * Init temps and window size
2033 */
2034 mpi_montg_init( &mm, N );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035 mbedtls_mpi_init( &RR ); mbedtls_mpi_init( &T );
2036 mbedtls_mpi_init( &Apos );
Manuel Pégourié-Gonnarde10e8db2021-03-09 11:22:20 +01002037 mbedtls_mpi_init( &WW );
Paul Bakker5121ce52009-01-03 21:22:43 +00002038 memset( W, 0, sizeof( W ) );
2039
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02002040 i = mbedtls_mpi_bitlen( E );
Paul Bakker5121ce52009-01-03 21:22:43 +00002041
2042 wsize = ( i > 671 ) ? 6 : ( i > 239 ) ? 5 :
2043 ( i > 79 ) ? 4 : ( i > 23 ) ? 3 : 1;
2044
Peter Kolbuse6bcad32018-12-11 14:01:44 -06002045#if( MBEDTLS_MPI_WINDOW_SIZE < 6 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046 if( wsize > MBEDTLS_MPI_WINDOW_SIZE )
2047 wsize = MBEDTLS_MPI_WINDOW_SIZE;
Peter Kolbuse6bcad32018-12-11 14:01:44 -06002048#endif
Paul Bakkerb6d5f082011-11-25 11:52:11 +00002049
Paul Bakker5121ce52009-01-03 21:22:43 +00002050 j = N->n + 1;
Gilles Peskinef643e8e2021-06-08 23:17:42 +02002051 /* All W[i] and X must have at least N->n limbs for the mpi_montmul()
2052 * and mpi_montred() calls later. Here we ensure that W[1] and X are
2053 * large enough, and later we'll grow other W[i] to the same length.
2054 * They must not be shrunk midway through this function!
2055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002056 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, j ) );
2057 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[1], j ) );
2058 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &T, j * 2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002059
2060 /*
Paul Bakker50546922012-05-19 08:40:49 +00002061 * Compensate for negative A (and correct at the end)
2062 */
2063 neg = ( A->s == -1 );
Paul Bakker50546922012-05-19 08:40:49 +00002064 if( neg )
2065 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Apos, A ) );
Paul Bakker50546922012-05-19 08:40:49 +00002067 Apos.s = 1;
2068 A = &Apos;
2069 }
2070
2071 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00002072 * If 1st call, pre-compute R^2 mod N
2073 */
Yuto Takano284857e2021-07-14 10:20:09 +01002074 if( prec_RR == NULL || prec_RR->p == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002075 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &RR, 1 ) );
2077 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &RR, N->n * 2 * biL ) );
2078 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &RR, &RR, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002079
Yuto Takano284857e2021-07-14 10:20:09 +01002080 if( prec_RR != NULL )
2081 memcpy( prec_RR, &RR, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002082 }
2083 else
Yuto Takano284857e2021-07-14 10:20:09 +01002084 memcpy( &RR, prec_RR, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002085
2086 /*
2087 * W[1] = A * R^2 * R^-1 mod N = A * R mod N
2088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002089 if( mbedtls_mpi_cmp_mpi( A, N ) >= 0 )
Gilles Peskinef643e8e2021-06-08 23:17:42 +02002090 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &W[1], A, N ) );
Gilles Peskinef643e8e2021-06-08 23:17:42 +02002092 /* This should be a no-op because W[1] is already that large before
2093 * mbedtls_mpi_mod_mpi(), but it's necessary to avoid an overflow
2094 * in mpi_montmul() below, so let's make sure. */
Gilles Peskine0759cad2021-06-15 21:22:48 +02002095 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[1], N->n + 1 ) );
Gilles Peskinef643e8e2021-06-08 23:17:42 +02002096 }
Paul Bakkerc2024f42014-01-23 20:38:35 +01002097 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002098 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[1], A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002099
Gilles Peskinef643e8e2021-06-08 23:17:42 +02002100 /* Note that this is safe because W[1] always has at least N->n limbs
2101 * (it grew above and was preserved by mbedtls_mpi_copy()). */
Gilles Peskine4e91d472020-06-04 20:55:15 +02002102 mpi_montmul( &W[1], &RR, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002103
2104 /*
2105 * X = R^2 * R^-1 mod N = R mod N
2106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002107 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, &RR ) );
Gilles Peskine4e91d472020-06-04 20:55:15 +02002108 mpi_montred( X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002109
2110 if( wsize > 1 )
2111 {
2112 /*
2113 * W[1 << (wsize - 1)] = W[1] ^ (wsize - 1)
2114 */
Paul Bakker66d5d072014-06-17 16:39:18 +02002115 j = one << ( wsize - 1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002117 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[j], N->n + 1 ) );
2118 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[j], &W[1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002119
2120 for( i = 0; i < wsize - 1; i++ )
Gilles Peskine4e91d472020-06-04 20:55:15 +02002121 mpi_montmul( &W[j], &W[j], N, mm, &T );
Paul Bakker0d7702c2013-10-29 16:18:35 +01002122
Paul Bakker5121ce52009-01-03 21:22:43 +00002123 /*
2124 * W[i] = W[i - 1] * W[1]
2125 */
Paul Bakker66d5d072014-06-17 16:39:18 +02002126 for( i = j + 1; i < ( one << wsize ); i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00002127 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002128 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[i], N->n + 1 ) );
2129 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[i], &W[i - 1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002130
Gilles Peskine4e91d472020-06-04 20:55:15 +02002131 mpi_montmul( &W[i], &W[1], N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002132 }
2133 }
2134
2135 nblimbs = E->n;
2136 bufsize = 0;
2137 nbits = 0;
2138 wbits = 0;
2139 state = 0;
2140
2141 while( 1 )
2142 {
2143 if( bufsize == 0 )
2144 {
Paul Bakker0d7702c2013-10-29 16:18:35 +01002145 if( nblimbs == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002146 break;
2147
Paul Bakker0d7702c2013-10-29 16:18:35 +01002148 nblimbs--;
2149
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002150 bufsize = sizeof( mbedtls_mpi_uint ) << 3;
Paul Bakker5121ce52009-01-03 21:22:43 +00002151 }
2152
2153 bufsize--;
2154
2155 ei = (E->p[nblimbs] >> bufsize) & 1;
2156
2157 /*
2158 * skip leading 0s
2159 */
2160 if( ei == 0 && state == 0 )
2161 continue;
2162
2163 if( ei == 0 && state == 1 )
2164 {
2165 /*
2166 * out of window, square X
2167 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02002168 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002169 continue;
2170 }
2171
2172 /*
2173 * add ei to current window
2174 */
2175 state = 2;
2176
2177 nbits++;
Paul Bakker66d5d072014-06-17 16:39:18 +02002178 wbits |= ( ei << ( wsize - nbits ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002179
2180 if( nbits == wsize )
2181 {
2182 /*
2183 * X = X^wsize R^-1 mod N
2184 */
2185 for( i = 0; i < wsize; i++ )
Gilles Peskine4e91d472020-06-04 20:55:15 +02002186 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002187
2188 /*
2189 * X = X * W[wbits] R^-1 mod N
2190 */
Manuel Pégourié-Gonnard0b3bde52021-06-10 09:34:00 +02002191 MBEDTLS_MPI_CHK( mpi_select( &WW, W, (size_t) 1 << wsize, wbits ) );
Manuel Pégourié-Gonnarde10e8db2021-03-09 11:22:20 +01002192 mpi_montmul( X, &WW, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002193
2194 state--;
2195 nbits = 0;
2196 wbits = 0;
2197 }
2198 }
2199
2200 /*
2201 * process the remaining bits
2202 */
2203 for( i = 0; i < nbits; i++ )
2204 {
Gilles Peskine4e91d472020-06-04 20:55:15 +02002205 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002206
2207 wbits <<= 1;
2208
Paul Bakker66d5d072014-06-17 16:39:18 +02002209 if( ( wbits & ( one << wsize ) ) != 0 )
Gilles Peskine4e91d472020-06-04 20:55:15 +02002210 mpi_montmul( X, &W[1], N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002211 }
2212
2213 /*
2214 * X = A^E * R * R^-1 mod N = A^E mod N
2215 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02002216 mpi_montred( X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002217
Hanno Beckera4af1c42017-04-18 09:07:45 +01002218 if( neg && E->n != 0 && ( E->p[0] & 1 ) != 0 )
Paul Bakkerf6198c12012-05-16 08:02:29 +00002219 {
2220 X->s = -1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002221 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( X, N, X ) );
Paul Bakkerf6198c12012-05-16 08:02:29 +00002222 }
2223
Paul Bakker5121ce52009-01-03 21:22:43 +00002224cleanup:
2225
Paul Bakker66d5d072014-06-17 16:39:18 +02002226 for( i = ( one << ( wsize - 1 ) ); i < ( one << wsize ); i++ )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227 mbedtls_mpi_free( &W[i] );
Paul Bakker5121ce52009-01-03 21:22:43 +00002228
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002229 mbedtls_mpi_free( &W[1] ); mbedtls_mpi_free( &T ); mbedtls_mpi_free( &Apos );
Manuel Pégourié-Gonnarde10e8db2021-03-09 11:22:20 +01002230 mbedtls_mpi_free( &WW );
Paul Bakker6c591fa2011-05-05 11:49:20 +00002231
Yuto Takano284857e2021-07-14 10:20:09 +01002232 if( prec_RR == NULL || prec_RR->p == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002233 mbedtls_mpi_free( &RR );
Paul Bakker5121ce52009-01-03 21:22:43 +00002234
2235 return( ret );
2236}
2237
Paul Bakker5121ce52009-01-03 21:22:43 +00002238/*
2239 * Greatest common divisor: G = gcd(A, B) (HAC 14.54)
2240 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241int mbedtls_mpi_gcd( mbedtls_mpi *G, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00002242{
Janos Follath24eed8d2019-11-22 13:21:35 +00002243 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002244 size_t lz, lzt;
Alexander Ke8ad49f2019-08-16 16:16:07 +03002245 mbedtls_mpi TA, TB;
Paul Bakker5121ce52009-01-03 21:22:43 +00002246
Hanno Becker73d7d792018-12-11 10:35:51 +00002247 MPI_VALIDATE_RET( G != NULL );
2248 MPI_VALIDATE_RET( A != NULL );
2249 MPI_VALIDATE_RET( B != NULL );
2250
Alexander Ke8ad49f2019-08-16 16:16:07 +03002251 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00002252
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TA, A ) );
2254 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002255
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002256 lz = mbedtls_mpi_lsb( &TA );
2257 lzt = mbedtls_mpi_lsb( &TB );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002258
Gilles Peskineb5e56ec2021-06-09 13:26:43 +02002259 /* The loop below gives the correct result when A==0 but not when B==0.
2260 * So have a special case for B==0. Leverage the fact that we just
2261 * calculated the lsb and lsb(B)==0 iff B is odd or 0 to make the test
2262 * slightly more efficient than cmp_int(). */
2263 if( lzt == 0 && mbedtls_mpi_get_bit( &TB, 0 ) == 0 )
2264 {
2265 ret = mbedtls_mpi_copy( G, A );
2266 goto cleanup;
2267 }
2268
Paul Bakker66d5d072014-06-17 16:39:18 +02002269 if( lzt < lz )
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002270 lz = lzt;
2271
Paul Bakker5121ce52009-01-03 21:22:43 +00002272 TA.s = TB.s = 1;
2273
Gilles Peskineea9aa142021-06-16 13:42:04 +02002274 /* We mostly follow the procedure described in HAC 14.54, but with some
2275 * minor differences:
2276 * - Sequences of multiplications or divisions by 2 are grouped into a
2277 * single shift operation.
Gilles Peskine37d690c2021-06-21 18:58:39 +02002278 * - The procedure in HAC assumes that 0 < TB <= TA.
2279 * - The condition TB <= TA is not actually necessary for correctness.
2280 * TA and TB have symmetric roles except for the loop termination
2281 * condition, and the shifts at the beginning of the loop body
2282 * remove any significance from the ordering of TA vs TB before
2283 * the shifts.
2284 * - If TA = 0, the loop goes through 0 iterations and the result is
2285 * correctly TB.
2286 * - The case TB = 0 was short-circuited above.
Gilles Peskineea9aa142021-06-16 13:42:04 +02002287 *
2288 * For the correctness proof below, decompose the original values of
2289 * A and B as
2290 * A = sa * 2^a * A' with A'=0 or A' odd, and sa = +-1
2291 * B = sb * 2^b * B' with B'=0 or B' odd, and sb = +-1
2292 * Then gcd(A, B) = 2^{min(a,b)} * gcd(A',B'),
2293 * and gcd(A',B') is odd or 0.
2294 *
2295 * At the beginning, we have TA = |A| and TB = |B| so gcd(A,B) = gcd(TA,TB).
2296 * The code maintains the following invariant:
2297 * gcd(A,B) = 2^k * gcd(TA,TB) for some k (I)
Gilles Peskine6537bdb2021-06-15 22:09:39 +02002298 */
2299
Gilles Peskineea9aa142021-06-16 13:42:04 +02002300 /* Proof that the loop terminates:
2301 * At each iteration, either the right-shift by 1 is made on a nonzero
2302 * value and the nonnegative integer bitlen(TA) + bitlen(TB) decreases
2303 * by at least 1, or the right-shift by 1 is made on zero and then
2304 * TA becomes 0 which ends the loop (TB cannot be 0 if it is right-shifted
2305 * since in that case TB is calculated from TB-TA with the condition TB>TA).
2306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002307 while( mbedtls_mpi_cmp_int( &TA, 0 ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002308 {
Gilles Peskineea9aa142021-06-16 13:42:04 +02002309 /* Divisions by 2 preserve the invariant (I). */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TA, mbedtls_mpi_lsb( &TA ) ) );
2311 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TB, mbedtls_mpi_lsb( &TB ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002312
Gilles Peskineea9aa142021-06-16 13:42:04 +02002313 /* Set either TA or TB to |TA-TB|/2. Since TA and TB are both odd,
2314 * TA-TB is even so the division by 2 has an integer result.
2315 * Invariant (I) is preserved since any odd divisor of both TA and TB
2316 * also divides |TA-TB|/2, and any odd divisor of both TA and |TA-TB|/2
Shaun Case0e7791f2021-12-20 21:14:10 -08002317 * also divides TB, and any odd divisor of both TB and |TA-TB|/2 also
Gilles Peskineea9aa142021-06-16 13:42:04 +02002318 * divides TA.
2319 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002320 if( mbedtls_mpi_cmp_mpi( &TA, &TB ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002321 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( &TA, &TA, &TB ) );
2323 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TA, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002324 }
2325 else
2326 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( &TB, &TB, &TA ) );
2328 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TB, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002329 }
Gilles Peskineea9aa142021-06-16 13:42:04 +02002330 /* Note that one of TA or TB is still odd. */
Paul Bakker5121ce52009-01-03 21:22:43 +00002331 }
2332
Gilles Peskineea9aa142021-06-16 13:42:04 +02002333 /* By invariant (I), gcd(A,B) = 2^k * gcd(TA,TB) for some k.
2334 * At the loop exit, TA = 0, so gcd(TA,TB) = TB.
2335 * - If there was at least one loop iteration, then one of TA or TB is odd,
2336 * and TA = 0, so TB is odd and gcd(TA,TB) = gcd(A',B'). In this case,
2337 * lz = min(a,b) so gcd(A,B) = 2^lz * TB.
2338 * - If there was no loop iteration, then A was 0, and gcd(A,B) = B.
Gilles Peskineb798b352021-06-21 11:40:38 +02002339 * In this case, lz = 0 and B = TB so gcd(A,B) = B = 2^lz * TB as well.
Gilles Peskineea9aa142021-06-16 13:42:04 +02002340 */
2341
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &TB, lz ) );
2343 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( G, &TB ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002344
2345cleanup:
2346
Alexander Ke8ad49f2019-08-16 16:16:07 +03002347 mbedtls_mpi_free( &TA ); mbedtls_mpi_free( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00002348
2349 return( ret );
2350}
2351
Gilles Peskine8f454702021-04-01 15:57:18 +02002352/* Fill X with n_bytes random bytes.
2353 * X must already have room for those bytes.
Gilles Peskine23422e42021-06-03 11:51:09 +02002354 * The ordering of the bytes returned from the RNG is suitable for
2355 * deterministic ECDSA (see RFC 6979 §3.3 and mbedtls_mpi_random()).
Gilles Peskinea16001e2021-04-13 21:55:35 +02002356 * The size and sign of X are unchanged.
Gilles Peskine8f454702021-04-01 15:57:18 +02002357 * n_bytes must not be 0.
2358 */
2359static int mpi_fill_random_internal(
2360 mbedtls_mpi *X, size_t n_bytes,
2361 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng )
2362{
2363 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2364 const size_t limbs = CHARS_TO_LIMBS( n_bytes );
2365 const size_t overhead = ( limbs * ciL ) - n_bytes;
2366
2367 if( X->n < limbs )
2368 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Gilles Peskine8f454702021-04-01 15:57:18 +02002369
Gilles Peskinea16001e2021-04-13 21:55:35 +02002370 memset( X->p, 0, overhead );
2371 memset( (unsigned char *) X->p + limbs * ciL, 0, ( X->n - limbs ) * ciL );
Gilles Peskine8f454702021-04-01 15:57:18 +02002372 MBEDTLS_MPI_CHK( f_rng( p_rng, (unsigned char *) X->p + overhead, n_bytes ) );
2373 mpi_bigendian_to_host( X->p, limbs );
2374
2375cleanup:
2376 return( ret );
2377}
2378
Paul Bakker33dc46b2014-04-30 16:11:39 +02002379/*
2380 * Fill X with size bytes of random.
2381 *
2382 * Use a temporary bytes representation to make sure the result is the same
Paul Bakkerc37b0ac2014-05-01 14:19:23 +02002383 * regardless of the platform endianness (useful when f_rng is actually
Paul Bakker33dc46b2014-04-30 16:11:39 +02002384 * deterministic, eg for tests).
2385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002386int mbedtls_mpi_fill_random( mbedtls_mpi *X, size_t size,
Paul Bakkera3d195c2011-11-27 21:07:34 +00002387 int (*f_rng)(void *, unsigned char *, size_t),
2388 void *p_rng )
Paul Bakker287781a2011-03-26 13:18:49 +00002389{
Janos Follath24eed8d2019-11-22 13:21:35 +00002390 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker6dab6202019-01-02 16:42:29 +00002391 size_t const limbs = CHARS_TO_LIMBS( size );
Hanno Beckerda1655a2017-10-18 14:21:44 +01002392
Hanno Becker8ce11a32018-12-19 16:18:52 +00002393 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002394 MPI_VALIDATE_RET( f_rng != NULL );
Paul Bakker33dc46b2014-04-30 16:11:39 +02002395
Hanno Beckerda1655a2017-10-18 14:21:44 +01002396 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskine3130ce22021-06-02 22:17:52 +02002397 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Gilles Peskine8f454702021-04-01 15:57:18 +02002398 if( size == 0 )
2399 return( 0 );
Paul Bakker287781a2011-03-26 13:18:49 +00002400
Gilles Peskine8f454702021-04-01 15:57:18 +02002401 ret = mpi_fill_random_internal( X, size, f_rng, p_rng );
Paul Bakker287781a2011-03-26 13:18:49 +00002402
2403cleanup:
2404 return( ret );
2405}
2406
Gilles Peskine4699fa42021-03-29 22:02:55 +02002407int mbedtls_mpi_random( mbedtls_mpi *X,
2408 mbedtls_mpi_sint min,
2409 const mbedtls_mpi *N,
2410 int (*f_rng)(void *, unsigned char *, size_t),
2411 void *p_rng )
2412{
Gilles Peskine4699fa42021-03-29 22:02:55 +02002413 int ret = MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
Gilles Peskinee39ee8e2021-04-13 21:23:25 +02002414 int count;
Gilles Peskine74f66bb2021-04-13 21:09:10 +02002415 unsigned lt_lower = 1, lt_upper = 0;
Gilles Peskine4699fa42021-03-29 22:02:55 +02002416 size_t n_bits = mbedtls_mpi_bitlen( N );
2417 size_t n_bytes = ( n_bits + 7 ) / 8;
Gilles Peskine74f66bb2021-04-13 21:09:10 +02002418 mbedtls_mpi lower_bound;
Gilles Peskine4699fa42021-03-29 22:02:55 +02002419
Gilles Peskine9312ba52021-03-29 22:14:51 +02002420 if( min < 0 )
2421 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
2422 if( mbedtls_mpi_cmp_int( N, min ) <= 0 )
2423 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
2424
Gilles Peskinee39ee8e2021-04-13 21:23:25 +02002425 /*
2426 * When min == 0, each try has at worst a probability 1/2 of failing
2427 * (the msb has a probability 1/2 of being 0, and then the result will
2428 * be < N), so after 30 tries failure probability is a most 2**(-30).
2429 *
2430 * When N is just below a power of 2, as is the case when generating
Gilles Peskine3f613632021-04-15 11:45:19 +02002431 * a random scalar on most elliptic curves, 1 try is enough with
Gilles Peskinee39ee8e2021-04-13 21:23:25 +02002432 * overwhelming probability. When N is just above a power of 2,
Gilles Peskine3f613632021-04-15 11:45:19 +02002433 * as when generating a random scalar on secp224k1, each try has
Gilles Peskinee39ee8e2021-04-13 21:23:25 +02002434 * a probability of failing that is almost 1/2.
2435 *
2436 * The probabilities are almost the same if min is nonzero but negligible
2437 * compared to N. This is always the case when N is crypto-sized, but
2438 * it's convenient to support small N for testing purposes. When N
2439 * is small, use a higher repeat count, otherwise the probability of
2440 * failure is macroscopic.
2441 */
Gilles Peskine11779072021-06-02 21:18:59 +02002442 count = ( n_bytes > 4 ? 30 : 250 );
Gilles Peskinee39ee8e2021-04-13 21:23:25 +02002443
Gilles Peskine74f66bb2021-04-13 21:09:10 +02002444 mbedtls_mpi_init( &lower_bound );
2445
Gilles Peskine8f454702021-04-01 15:57:18 +02002446 /* Ensure that target MPI has exactly the same number of limbs
2447 * as the upper bound, even if the upper bound has leading zeros.
2448 * This is necessary for the mbedtls_mpi_lt_mpi_ct() check. */
Gilles Peskine3130ce22021-06-02 22:17:52 +02002449 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, N->n ) );
Gilles Peskine74f66bb2021-04-13 21:09:10 +02002450 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &lower_bound, N->n ) );
2451 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &lower_bound, min ) );
Gilles Peskine8f454702021-04-01 15:57:18 +02002452
Gilles Peskine4699fa42021-03-29 22:02:55 +02002453 /*
2454 * Match the procedure given in RFC 6979 §3.3 (deterministic ECDSA)
2455 * when f_rng is a suitably parametrized instance of HMAC_DRBG:
2456 * - use the same byte ordering;
2457 * - keep the leftmost n_bits bits of the generated octet string;
2458 * - try until result is in the desired range.
2459 * This also avoids any bias, which is especially important for ECDSA.
2460 */
2461 do
2462 {
Gilles Peskine8f454702021-04-01 15:57:18 +02002463 MBEDTLS_MPI_CHK( mpi_fill_random_internal( X, n_bytes, f_rng, p_rng ) );
Gilles Peskine4699fa42021-03-29 22:02:55 +02002464 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( X, 8 * n_bytes - n_bits ) );
2465
Gilles Peskinee39ee8e2021-04-13 21:23:25 +02002466 if( --count == 0 )
Gilles Peskine4699fa42021-03-29 22:02:55 +02002467 {
2468 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
2469 goto cleanup;
2470 }
2471
Gilles Peskine74f66bb2021-04-13 21:09:10 +02002472 MBEDTLS_MPI_CHK( mbedtls_mpi_lt_mpi_ct( X, &lower_bound, &lt_lower ) );
2473 MBEDTLS_MPI_CHK( mbedtls_mpi_lt_mpi_ct( X, N, &lt_upper ) );
Gilles Peskine4699fa42021-03-29 22:02:55 +02002474 }
Gilles Peskine74f66bb2021-04-13 21:09:10 +02002475 while( lt_lower != 0 || lt_upper == 0 );
Gilles Peskine4699fa42021-03-29 22:02:55 +02002476
2477cleanup:
Gilles Peskine74f66bb2021-04-13 21:09:10 +02002478 mbedtls_mpi_free( &lower_bound );
Gilles Peskine4699fa42021-03-29 22:02:55 +02002479 return( ret );
2480}
2481
Paul Bakker5121ce52009-01-03 21:22:43 +00002482/*
2483 * Modular inverse: X = A^-1 mod N (HAC 14.61 / 14.64)
2484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485int mbedtls_mpi_inv_mod( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *N )
Paul Bakker5121ce52009-01-03 21:22:43 +00002486{
Janos Follath24eed8d2019-11-22 13:21:35 +00002487 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488 mbedtls_mpi G, TA, TU, U1, U2, TB, TV, V1, V2;
Hanno Becker73d7d792018-12-11 10:35:51 +00002489 MPI_VALIDATE_RET( X != NULL );
2490 MPI_VALIDATE_RET( A != NULL );
2491 MPI_VALIDATE_RET( N != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00002492
Hanno Becker4bcb4912017-04-18 15:49:39 +01002493 if( mbedtls_mpi_cmp_int( N, 1 ) <= 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00002495
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TU ); mbedtls_mpi_init( &U1 ); mbedtls_mpi_init( &U2 );
2497 mbedtls_mpi_init( &G ); mbedtls_mpi_init( &TB ); mbedtls_mpi_init( &TV );
2498 mbedtls_mpi_init( &V1 ); mbedtls_mpi_init( &V2 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002500 MBEDTLS_MPI_CHK( mbedtls_mpi_gcd( &G, A, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002501
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502 if( mbedtls_mpi_cmp_int( &G, 1 ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002503 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002504 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker5121ce52009-01-03 21:22:43 +00002505 goto cleanup;
2506 }
2507
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002508 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &TA, A, N ) );
2509 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TU, &TA ) );
2510 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, N ) );
2511 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TV, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002512
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002513 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &U1, 1 ) );
2514 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &U2, 0 ) );
2515 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &V1, 0 ) );
2516 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &V2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002517
2518 do
2519 {
2520 while( ( TU.p[0] & 1 ) == 0 )
2521 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002522 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TU, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002523
2524 if( ( U1.p[0] & 1 ) != 0 || ( U2.p[0] & 1 ) != 0 )
2525 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &U1, &U1, &TB ) );
2527 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U2, &U2, &TA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002528 }
2529
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002530 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &U1, 1 ) );
2531 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &U2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002532 }
2533
2534 while( ( TV.p[0] & 1 ) == 0 )
2535 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002536 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TV, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002537
2538 if( ( V1.p[0] & 1 ) != 0 || ( V2.p[0] & 1 ) != 0 )
2539 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &V1, &V1, &TB ) );
2541 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V2, &V2, &TA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002542 }
2543
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002544 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &V1, 1 ) );
2545 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &V2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002546 }
2547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 if( mbedtls_mpi_cmp_mpi( &TU, &TV ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002549 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002550 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &TU, &TU, &TV ) );
2551 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U1, &U1, &V1 ) );
2552 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U2, &U2, &V2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002553 }
2554 else
2555 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &TV, &TV, &TU ) );
2557 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V1, &V1, &U1 ) );
2558 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V2, &V2, &U2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002559 }
2560 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002561 while( mbedtls_mpi_cmp_int( &TU, 0 ) != 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002562
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563 while( mbedtls_mpi_cmp_int( &V1, 0 ) < 0 )
2564 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &V1, &V1, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002565
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002566 while( mbedtls_mpi_cmp_mpi( &V1, N ) >= 0 )
2567 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V1, &V1, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002568
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, &V1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002570
2571cleanup:
2572
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573 mbedtls_mpi_free( &TA ); mbedtls_mpi_free( &TU ); mbedtls_mpi_free( &U1 ); mbedtls_mpi_free( &U2 );
2574 mbedtls_mpi_free( &G ); mbedtls_mpi_free( &TB ); mbedtls_mpi_free( &TV );
2575 mbedtls_mpi_free( &V1 ); mbedtls_mpi_free( &V2 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002576
2577 return( ret );
2578}
2579
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580#if defined(MBEDTLS_GENPRIME)
Paul Bakkerd9374b02012-11-02 11:02:58 +00002581
Paul Bakker5121ce52009-01-03 21:22:43 +00002582static const int small_prime[] =
2583{
2584 3, 5, 7, 11, 13, 17, 19, 23,
2585 29, 31, 37, 41, 43, 47, 53, 59,
2586 61, 67, 71, 73, 79, 83, 89, 97,
2587 101, 103, 107, 109, 113, 127, 131, 137,
2588 139, 149, 151, 157, 163, 167, 173, 179,
2589 181, 191, 193, 197, 199, 211, 223, 227,
2590 229, 233, 239, 241, 251, 257, 263, 269,
2591 271, 277, 281, 283, 293, 307, 311, 313,
2592 317, 331, 337, 347, 349, 353, 359, 367,
2593 373, 379, 383, 389, 397, 401, 409, 419,
2594 421, 431, 433, 439, 443, 449, 457, 461,
2595 463, 467, 479, 487, 491, 499, 503, 509,
2596 521, 523, 541, 547, 557, 563, 569, 571,
2597 577, 587, 593, 599, 601, 607, 613, 617,
2598 619, 631, 641, 643, 647, 653, 659, 661,
2599 673, 677, 683, 691, 701, 709, 719, 727,
2600 733, 739, 743, 751, 757, 761, 769, 773,
2601 787, 797, 809, 811, 821, 823, 827, 829,
2602 839, 853, 857, 859, 863, 877, 881, 883,
2603 887, 907, 911, 919, 929, 937, 941, 947,
2604 953, 967, 971, 977, 983, 991, 997, -103
2605};
2606
2607/*
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002608 * Small divisors test (X must be positive)
2609 *
2610 * Return values:
2611 * 0: no small factor (possible prime, more tests needed)
2612 * 1: certain prime
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 * MBEDTLS_ERR_MPI_NOT_ACCEPTABLE: certain non-prime
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002614 * other negative: error
Paul Bakker5121ce52009-01-03 21:22:43 +00002615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002616static int mpi_check_small_factors( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +00002617{
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002618 int ret = 0;
2619 size_t i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620 mbedtls_mpi_uint r;
Paul Bakker5121ce52009-01-03 21:22:43 +00002621
Paul Bakker5121ce52009-01-03 21:22:43 +00002622 if( ( X->p[0] & 1 ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623 return( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE );
Paul Bakker5121ce52009-01-03 21:22:43 +00002624
2625 for( i = 0; small_prime[i] > 0; i++ )
2626 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002627 if( mbedtls_mpi_cmp_int( X, small_prime[i] ) <= 0 )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002628 return( 1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002629
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002630 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, small_prime[i] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002631
2632 if( r == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002633 return( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE );
Paul Bakker5121ce52009-01-03 21:22:43 +00002634 }
2635
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002636cleanup:
2637 return( ret );
2638}
2639
2640/*
2641 * Miller-Rabin pseudo-primality test (HAC 4.24)
2642 */
Janos Follathda31fa12018-09-03 14:45:23 +01002643static int mpi_miller_rabin( const mbedtls_mpi *X, size_t rounds,
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002644 int (*f_rng)(void *, unsigned char *, size_t),
2645 void *p_rng )
2646{
Pascal Junodb99183d2015-03-11 16:49:45 +01002647 int ret, count;
Janos Follathda31fa12018-09-03 14:45:23 +01002648 size_t i, j, k, s;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649 mbedtls_mpi W, R, T, A, RR;
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002650
Hanno Becker8ce11a32018-12-19 16:18:52 +00002651 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002652 MPI_VALIDATE_RET( f_rng != NULL );
2653
2654 mbedtls_mpi_init( &W ); mbedtls_mpi_init( &R );
2655 mbedtls_mpi_init( &T ); mbedtls_mpi_init( &A );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656 mbedtls_mpi_init( &RR );
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002657
Paul Bakker5121ce52009-01-03 21:22:43 +00002658 /*
2659 * W = |X| - 1
2660 * R = W >> lsb( W )
2661 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002662 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_int( &W, X, 1 ) );
2663 s = mbedtls_mpi_lsb( &W );
2664 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &R, &W ) );
2665 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &R, s ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002666
Janos Follathda31fa12018-09-03 14:45:23 +01002667 for( i = 0; i < rounds; i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00002668 {
2669 /*
2670 * pick a random A, 1 < A < |X| - 1
2671 */
Pascal Junodb99183d2015-03-11 16:49:45 +01002672 count = 0;
2673 do {
Manuel Pégourié-Gonnard53c76c02015-04-17 20:15:36 +02002674 MBEDTLS_MPI_CHK( mbedtls_mpi_fill_random( &A, X->n * ciL, f_rng, p_rng ) );
Pascal Junodb99183d2015-03-11 16:49:45 +01002675
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02002676 j = mbedtls_mpi_bitlen( &A );
2677 k = mbedtls_mpi_bitlen( &W );
Pascal Junodb99183d2015-03-11 16:49:45 +01002678 if (j > k) {
Darryl Greene3f95ed2018-10-02 13:21:35 +01002679 A.p[A.n - 1] &= ( (mbedtls_mpi_uint) 1 << ( k - ( A.n - 1 ) * biL - 1 ) ) - 1;
Pascal Junodb99183d2015-03-11 16:49:45 +01002680 }
2681
2682 if (count++ > 30) {
Jens Wiklanderf08aa3e2019-01-17 13:30:57 +01002683 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
2684 goto cleanup;
Pascal Junodb99183d2015-03-11 16:49:45 +01002685 }
2686
Manuel Pégourié-Gonnard53c76c02015-04-17 20:15:36 +02002687 } while ( mbedtls_mpi_cmp_mpi( &A, &W ) >= 0 ||
2688 mbedtls_mpi_cmp_int( &A, 1 ) <= 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002689
2690 /*
2691 * A = A^R mod |X|
2692 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693 MBEDTLS_MPI_CHK( mbedtls_mpi_exp_mod( &A, &A, &R, X, &RR ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695 if( mbedtls_mpi_cmp_mpi( &A, &W ) == 0 ||
2696 mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002697 continue;
2698
2699 j = 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700 while( j < s && mbedtls_mpi_cmp_mpi( &A, &W ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002701 {
2702 /*
2703 * A = A * A mod |X|
2704 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_mpi( &T, &A, &A ) );
2706 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &A, &T, X ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002707
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708 if( mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002709 break;
2710
2711 j++;
2712 }
2713
2714 /*
2715 * not prime if A != |X| - 1 or A == 1
2716 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002717 if( mbedtls_mpi_cmp_mpi( &A, &W ) != 0 ||
2718 mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002719 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002720 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker5121ce52009-01-03 21:22:43 +00002721 break;
2722 }
2723 }
2724
2725cleanup:
Hanno Becker73d7d792018-12-11 10:35:51 +00002726 mbedtls_mpi_free( &W ); mbedtls_mpi_free( &R );
2727 mbedtls_mpi_free( &T ); mbedtls_mpi_free( &A );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728 mbedtls_mpi_free( &RR );
Paul Bakker5121ce52009-01-03 21:22:43 +00002729
2730 return( ret );
2731}
2732
2733/*
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002734 * Pseudo-primality test: small factors, then Miller-Rabin
2735 */
Janos Follatha0b67c22018-09-18 14:48:23 +01002736int mbedtls_mpi_is_prime_ext( const mbedtls_mpi *X, int rounds,
2737 int (*f_rng)(void *, unsigned char *, size_t),
2738 void *p_rng )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002739{
Janos Follath24eed8d2019-11-22 13:21:35 +00002740 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741 mbedtls_mpi XX;
Hanno Becker8ce11a32018-12-19 16:18:52 +00002742 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002743 MPI_VALIDATE_RET( f_rng != NULL );
Manuel Pégourié-Gonnard7f4ed672014-10-14 20:56:02 +02002744
2745 XX.s = 1;
2746 XX.n = X->n;
2747 XX.p = X->p;
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002748
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749 if( mbedtls_mpi_cmp_int( &XX, 0 ) == 0 ||
2750 mbedtls_mpi_cmp_int( &XX, 1 ) == 0 )
2751 return( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE );
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002752
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002753 if( mbedtls_mpi_cmp_int( &XX, 2 ) == 0 )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002754 return( 0 );
2755
2756 if( ( ret = mpi_check_small_factors( &XX ) ) != 0 )
2757 {
2758 if( ret == 1 )
2759 return( 0 );
2760
2761 return( ret );
2762 }
2763
Janos Follathda31fa12018-09-03 14:45:23 +01002764 return( mpi_miller_rabin( &XX, rounds, f_rng, p_rng ) );
Janos Follathf301d232018-08-14 13:34:01 +01002765}
2766
Janos Follatha0b67c22018-09-18 14:48:23 +01002767#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Janos Follathf301d232018-08-14 13:34:01 +01002768/*
2769 * Pseudo-primality test, error probability 2^-80
2770 */
2771int mbedtls_mpi_is_prime( const mbedtls_mpi *X,
2772 int (*f_rng)(void *, unsigned char *, size_t),
2773 void *p_rng )
2774{
Hanno Becker8ce11a32018-12-19 16:18:52 +00002775 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002776 MPI_VALIDATE_RET( f_rng != NULL );
2777
Janos Follatha0b67c22018-09-18 14:48:23 +01002778 /*
2779 * In the past our key generation aimed for an error rate of at most
2780 * 2^-80. Since this function is deprecated, aim for the same certainty
2781 * here as well.
2782 */
Hanno Becker73d7d792018-12-11 10:35:51 +00002783 return( mbedtls_mpi_is_prime_ext( X, 40, f_rng, p_rng ) );
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002784}
Janos Follatha0b67c22018-09-18 14:48:23 +01002785#endif
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002786
2787/*
Paul Bakker5121ce52009-01-03 21:22:43 +00002788 * Prime number generation
Jethro Beekman66689272018-02-14 19:24:10 -08002789 *
Janos Follathf301d232018-08-14 13:34:01 +01002790 * To generate an RSA key in a way recommended by FIPS 186-4, both primes must
2791 * be either 1024 bits or 1536 bits long, and flags must contain
2792 * MBEDTLS_MPI_GEN_PRIME_FLAG_LOW_ERR.
Paul Bakker5121ce52009-01-03 21:22:43 +00002793 */
Janos Follath7c025a92018-08-14 11:08:41 +01002794int mbedtls_mpi_gen_prime( mbedtls_mpi *X, size_t nbits, int flags,
Paul Bakkera3d195c2011-11-27 21:07:34 +00002795 int (*f_rng)(void *, unsigned char *, size_t),
2796 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +00002797{
Jethro Beekman66689272018-02-14 19:24:10 -08002798#ifdef MBEDTLS_HAVE_INT64
2799// ceil(2^63.5)
2800#define CEIL_MAXUINT_DIV_SQRT2 0xb504f333f9de6485ULL
2801#else
2802// ceil(2^31.5)
2803#define CEIL_MAXUINT_DIV_SQRT2 0xb504f334U
2804#endif
2805 int ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker23986e52011-04-24 08:57:21 +00002806 size_t k, n;
Janos Follathda31fa12018-09-03 14:45:23 +01002807 int rounds;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808 mbedtls_mpi_uint r;
2809 mbedtls_mpi Y;
Paul Bakker5121ce52009-01-03 21:22:43 +00002810
Hanno Becker8ce11a32018-12-19 16:18:52 +00002811 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002812 MPI_VALIDATE_RET( f_rng != NULL );
2813
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814 if( nbits < 3 || nbits > MBEDTLS_MPI_MAX_BITS )
2815 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00002816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002817 mbedtls_mpi_init( &Y );
Paul Bakker5121ce52009-01-03 21:22:43 +00002818
2819 n = BITS_TO_LIMBS( nbits );
2820
Janos Follathda31fa12018-09-03 14:45:23 +01002821 if( ( flags & MBEDTLS_MPI_GEN_PRIME_FLAG_LOW_ERR ) == 0 )
2822 {
2823 /*
2824 * 2^-80 error probability, number of rounds chosen per HAC, table 4.4
2825 */
2826 rounds = ( ( nbits >= 1300 ) ? 2 : ( nbits >= 850 ) ? 3 :
2827 ( nbits >= 650 ) ? 4 : ( nbits >= 350 ) ? 8 :
2828 ( nbits >= 250 ) ? 12 : ( nbits >= 150 ) ? 18 : 27 );
2829 }
2830 else
2831 {
2832 /*
2833 * 2^-100 error probability, number of rounds computed based on HAC,
2834 * fact 4.48
2835 */
2836 rounds = ( ( nbits >= 1450 ) ? 4 : ( nbits >= 1150 ) ? 5 :
2837 ( nbits >= 1000 ) ? 6 : ( nbits >= 850 ) ? 7 :
2838 ( nbits >= 750 ) ? 8 : ( nbits >= 500 ) ? 13 :
2839 ( nbits >= 250 ) ? 28 : ( nbits >= 150 ) ? 40 : 51 );
2840 }
2841
Jethro Beekman66689272018-02-14 19:24:10 -08002842 while( 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002843 {
Jethro Beekman66689272018-02-14 19:24:10 -08002844 MBEDTLS_MPI_CHK( mbedtls_mpi_fill_random( X, n * ciL, f_rng, p_rng ) );
2845 /* make sure generated number is at least (nbits-1)+0.5 bits (FIPS 186-4 §B.3.3 steps 4.4, 5.5) */
2846 if( X->p[n-1] < CEIL_MAXUINT_DIV_SQRT2 ) continue;
2847
2848 k = n * biL;
2849 if( k > nbits ) MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( X, k - nbits ) );
2850 X->p[0] |= 1;
2851
Janos Follath7c025a92018-08-14 11:08:41 +01002852 if( ( flags & MBEDTLS_MPI_GEN_PRIME_FLAG_DH ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002853 {
Janos Follatha0b67c22018-09-18 14:48:23 +01002854 ret = mbedtls_mpi_is_prime_ext( X, rounds, f_rng, p_rng );
Jethro Beekman66689272018-02-14 19:24:10 -08002855
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856 if( ret != MBEDTLS_ERR_MPI_NOT_ACCEPTABLE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002857 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002858 }
Jethro Beekman66689272018-02-14 19:24:10 -08002859 else
Paul Bakker5121ce52009-01-03 21:22:43 +00002860 {
Manuel Pégourié-Gonnardddf76152013-11-22 19:58:22 +01002861 /*
Tom Cosgrove5205c972022-07-28 06:12:08 +01002862 * A necessary condition for Y and X = 2Y + 1 to be prime
Jethro Beekman66689272018-02-14 19:24:10 -08002863 * is X = 2 mod 3 (which is equivalent to Y = 2 mod 3).
2864 * Make sure it is satisfied, while keeping X = 3 mod 4
Manuel Pégourié-Gonnardddf76152013-11-22 19:58:22 +01002865 */
Jethro Beekman66689272018-02-14 19:24:10 -08002866
2867 X->p[0] |= 2;
2868
2869 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, 3 ) );
2870 if( r == 0 )
2871 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 8 ) );
2872 else if( r == 1 )
2873 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 4 ) );
2874
2875 /* Set Y = (X-1) / 2, which is X / 2 because X is odd */
2876 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Y, X ) );
2877 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &Y, 1 ) );
2878
2879 while( 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002880 {
Jethro Beekman66689272018-02-14 19:24:10 -08002881 /*
2882 * First, check small factors for X and Y
2883 * before doing Miller-Rabin on any of them
2884 */
2885 if( ( ret = mpi_check_small_factors( X ) ) == 0 &&
2886 ( ret = mpi_check_small_factors( &Y ) ) == 0 &&
Janos Follathda31fa12018-09-03 14:45:23 +01002887 ( ret = mpi_miller_rabin( X, rounds, f_rng, p_rng ) )
Janos Follathf301d232018-08-14 13:34:01 +01002888 == 0 &&
Janos Follathda31fa12018-09-03 14:45:23 +01002889 ( ret = mpi_miller_rabin( &Y, rounds, f_rng, p_rng ) )
Janos Follathf301d232018-08-14 13:34:01 +01002890 == 0 )
Jethro Beekman66689272018-02-14 19:24:10 -08002891 goto cleanup;
2892
2893 if( ret != MBEDTLS_ERR_MPI_NOT_ACCEPTABLE )
2894 goto cleanup;
2895
2896 /*
2897 * Next candidates. We want to preserve Y = (X-1) / 2 and
2898 * Y = 1 mod 2 and Y = 2 mod 3 (eq X = 3 mod 4 and X = 2 mod 3)
2899 * so up Y by 6 and X by 12.
2900 */
2901 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 12 ) );
2902 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( &Y, &Y, 6 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002903 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002904 }
2905 }
2906
2907cleanup:
2908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002909 mbedtls_mpi_free( &Y );
Paul Bakker5121ce52009-01-03 21:22:43 +00002910
2911 return( ret );
2912}
2913
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914#endif /* MBEDTLS_GENPRIME */
Paul Bakker5121ce52009-01-03 21:22:43 +00002915
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916#if defined(MBEDTLS_SELF_TEST)
Paul Bakker5121ce52009-01-03 21:22:43 +00002917
Paul Bakker23986e52011-04-24 08:57:21 +00002918#define GCD_PAIR_COUNT 3
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002919
2920static const int gcd_pairs[GCD_PAIR_COUNT][3] =
2921{
2922 { 693, 609, 21 },
2923 { 1764, 868, 28 },
2924 { 768454923, 542167814, 1 }
2925};
2926
Paul Bakker5121ce52009-01-03 21:22:43 +00002927/*
2928 * Checkup routine
2929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930int mbedtls_mpi_self_test( int verbose )
Paul Bakker5121ce52009-01-03 21:22:43 +00002931{
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002932 int ret, i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933 mbedtls_mpi A, E, N, X, Y, U, V;
Paul Bakker5121ce52009-01-03 21:22:43 +00002934
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002935 mbedtls_mpi_init( &A ); mbedtls_mpi_init( &E ); mbedtls_mpi_init( &N ); mbedtls_mpi_init( &X );
2936 mbedtls_mpi_init( &Y ); mbedtls_mpi_init( &U ); mbedtls_mpi_init( &V );
Paul Bakker5121ce52009-01-03 21:22:43 +00002937
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &A, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002939 "EFE021C2645FD1DC586E69184AF4A31E" \
2940 "D5F53E93B5F123FA41680867BA110131" \
2941 "944FE7952E2517337780CB0DB80E61AA" \
2942 "E7C8DDC6C5C6AADEB34EB38A2F40D5E6" ) );
2943
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002944 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &E, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002945 "B2E7EFD37075B9F03FF989C7C5051C20" \
2946 "34D2A323810251127E7BF8625A4F49A5" \
2947 "F3E27F4DA8BD59C47D6DAABA4C8127BD" \
2948 "5B5C25763222FEFCCFC38B832366C29E" ) );
2949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002950 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &N, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002951 "0066A198186C18C10B2F5ED9B522752A" \
2952 "9830B69916E535C8F047518A889A43A5" \
2953 "94B6BED27A168D31D4A52F88925AA8F5" ) );
2954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_mpi( &X, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002956
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002958 "602AB7ECA597A3D6B56FF9829A5E8B85" \
2959 "9E857EA95A03512E2BAE7391688D264A" \
2960 "A5663B0341DB9CCFD2C4C5F421FEC814" \
2961 "8001B72E848A38CAE1C65F78E56ABDEF" \
2962 "E12D3C039B8A02D6BE593F0BBBDA56F1" \
2963 "ECF677152EF804370C1A305CAF3B5BF1" \
2964 "30879B56C61DE584A0F53A2447A51E" ) );
2965
2966 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967 mbedtls_printf( " MPI test #1 (mul_mpi): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00002968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002970 {
2971 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002972 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002973
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01002974 ret = 1;
2975 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002976 }
2977
2978 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981 MBEDTLS_MPI_CHK( mbedtls_mpi_div_mpi( &X, &Y, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002982
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002984 "256567336059E52CAE22925474705F39A94" ) );
2985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &V, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002987 "6613F26162223DF488E9CD48CC132C7A" \
2988 "0AC93C701B001B092E4E5B9F73BCD27B" \
2989 "9EE50D0657C77F374E903CDFA4C642" ) );
2990
2991 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992 mbedtls_printf( " MPI test #2 (div_mpi): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00002993
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002994 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 ||
2995 mbedtls_mpi_cmp_mpi( &Y, &V ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002996 {
2997 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002999
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003000 ret = 1;
3001 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00003002 }
3003
3004 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007 MBEDTLS_MPI_CHK( mbedtls_mpi_exp_mod( &X, &A, &E, &N, NULL ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00003010 "36E139AEA55215609D2816998ED020BB" \
3011 "BD96C37890F65171D948E9BC7CBAA4D9" \
3012 "325D24D6A3C12710F10A09FA08AB87" ) );
3013
3014 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015 mbedtls_printf( " MPI test #3 (exp_mod): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00003016
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003018 {
3019 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003021
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003022 ret = 1;
3023 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00003024 }
3025
3026 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029 MBEDTLS_MPI_CHK( mbedtls_mpi_inv_mod( &X, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00003032 "003A0AAEDD7E784FC07D8F9EC6E3BFD5" \
3033 "C3DBA76456363A10869622EAC2DD84EC" \
3034 "C5B8A74DAC4D09E03B5E0BE779F2DF61" ) );
3035
3036 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037 mbedtls_printf( " MPI test #4 (inv_mod): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00003038
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003040 {
3041 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003043
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003044 ret = 1;
3045 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00003046 }
3047
3048 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003050
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003051 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052 mbedtls_printf( " MPI test #5 (simple gcd): " );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003053
Paul Bakker66d5d072014-06-17 16:39:18 +02003054 for( i = 0; i < GCD_PAIR_COUNT; i++ )
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003055 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &X, gcd_pairs[i][0] ) );
3057 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &Y, gcd_pairs[i][1] ) );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059 MBEDTLS_MPI_CHK( mbedtls_mpi_gcd( &A, &X, &Y ) );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061 if( mbedtls_mpi_cmp_int( &A, gcd_pairs[i][2] ) != 0 )
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003062 {
3063 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064 mbedtls_printf( "failed at %d\n", i );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003065
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003066 ret = 1;
3067 goto cleanup;
3068 }
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003069 }
3070
3071 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072 mbedtls_printf( "passed\n" );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003073
Paul Bakker5121ce52009-01-03 21:22:43 +00003074cleanup:
3075
3076 if( ret != 0 && verbose != 0 )
Kenneth Soerensen518d4352020-04-01 17:22:45 +02003077 mbedtls_printf( "Unexpected error, return code = %08X\n", (unsigned int) ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00003078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079 mbedtls_mpi_free( &A ); mbedtls_mpi_free( &E ); mbedtls_mpi_free( &N ); mbedtls_mpi_free( &X );
3080 mbedtls_mpi_free( &Y ); mbedtls_mpi_free( &U ); mbedtls_mpi_free( &V );
Paul Bakker5121ce52009-01-03 21:22:43 +00003081
3082 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003083 mbedtls_printf( "\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003084
3085 return( ret );
3086}
3087
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088#endif /* MBEDTLS_SELF_TEST */
Paul Bakker5121ce52009-01-03 21:22:43 +00003089
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090#endif /* MBEDTLS_BIGNUM_C */