blob: ee5f27d706956ce192132382398b9cdb1f1647e2 [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"
Chris Jones4c5819c2021-03-03 17:45:34 +000041#include "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-mezei-arm8d1d5fd2021-09-27 12:15:19 +020044#include "constant_time.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000045
Rich Evans00ab4702015-02-06 13:43:58 +000046#include <string.h>
47
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020048#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000049#include "mbedtls/platform.h"
Paul Bakker6e339b52013-07-03 13:37:05 +020050#else
Rich Evans00ab4702015-02-06 13:43:58 +000051#include <stdio.h>
52#include <stdlib.h>
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020053#define mbedtls_printf printf
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +020054#define mbedtls_calloc calloc
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020055#define mbedtls_free free
Paul Bakker6e339b52013-07-03 13:37:05 +020056#endif
57
Hanno Becker73d7d792018-12-11 10:35:51 +000058#define MPI_VALIDATE_RET( cond ) \
59 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA )
60#define MPI_VALIDATE( cond ) \
61 MBEDTLS_INTERNAL_VALIDATE( cond )
62
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020063#define ciL (sizeof(mbedtls_mpi_uint)) /* chars in limb */
Paul Bakker5121ce52009-01-03 21:22:43 +000064#define biL (ciL << 3) /* bits in limb */
65#define biH (ciL << 2) /* half limb size */
66
Manuel Pégourié-Gonnard2d708342015-10-05 15:23:11 +010067#define MPI_SIZE_T_MAX ( (size_t) -1 ) /* SIZE_T_MAX is not standard */
68
Paul Bakker5121ce52009-01-03 21:22:43 +000069/*
70 * Convert between bits/chars and number of limbs
Manuel Pégourié-Gonnard58fb4952015-09-28 13:48:04 +020071 * Divide first in order to avoid potential overflows
Paul Bakker5121ce52009-01-03 21:22:43 +000072 */
Manuel Pégourié-Gonnard58fb4952015-09-28 13:48:04 +020073#define BITS_TO_LIMBS(i) ( (i) / biL + ( (i) % biL != 0 ) )
74#define CHARS_TO_LIMBS(i) ( (i) / ciL + ( (i) % ciL != 0 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +000075
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050076/* Implementation that should never be optimized out by the compiler */
Andres Amaya Garcia6698d2f2018-04-24 08:39:07 -050077static void mbedtls_mpi_zeroize( mbedtls_mpi_uint *v, size_t n )
78{
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050079 mbedtls_platform_zeroize( v, ciL * n );
80}
81
Paul Bakker5121ce52009-01-03 21:22:43 +000082/*
Paul Bakker6c591fa2011-05-05 11:49:20 +000083 * Initialize one MPI
Paul Bakker5121ce52009-01-03 21:22:43 +000084 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020085void mbedtls_mpi_init( mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +000086{
Hanno Becker73d7d792018-12-11 10:35:51 +000087 MPI_VALIDATE( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +000088
Paul Bakker6c591fa2011-05-05 11:49:20 +000089 X->s = 1;
90 X->n = 0;
91 X->p = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +000092}
93
94/*
Paul Bakker6c591fa2011-05-05 11:49:20 +000095 * Unallocate one MPI
Paul Bakker5121ce52009-01-03 21:22:43 +000096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020097void mbedtls_mpi_free( mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +000098{
Paul Bakker6c591fa2011-05-05 11:49:20 +000099 if( X == NULL )
100 return;
Paul Bakker5121ce52009-01-03 21:22:43 +0000101
Paul Bakker6c591fa2011-05-05 11:49:20 +0000102 if( X->p != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000103 {
Alexey Skalozube17a8da2016-01-13 17:19:33 +0200104 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200105 mbedtls_free( X->p );
Paul Bakker5121ce52009-01-03 21:22:43 +0000106 }
107
Paul Bakker6c591fa2011-05-05 11:49:20 +0000108 X->s = 1;
109 X->n = 0;
110 X->p = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +0000111}
112
113/*
114 * Enlarge to the specified number of limbs
115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200116int mbedtls_mpi_grow( mbedtls_mpi *X, size_t nblimbs )
Paul Bakker5121ce52009-01-03 21:22:43 +0000117{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118 mbedtls_mpi_uint *p;
Hanno Becker73d7d792018-12-11 10:35:51 +0000119 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000120
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200121 if( nblimbs > MBEDTLS_MPI_MAX_LIMBS )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200122 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Paul Bakkerf9688572011-05-05 10:00:45 +0000123
Paul Bakker5121ce52009-01-03 21:22:43 +0000124 if( X->n < nblimbs )
125 {
Simon Butcher29176892016-05-20 00:19:09 +0100126 if( ( p = (mbedtls_mpi_uint*)mbedtls_calloc( nblimbs, ciL ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200127 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Paul Bakker5121ce52009-01-03 21:22:43 +0000128
Paul Bakker5121ce52009-01-03 21:22:43 +0000129 if( X->p != NULL )
130 {
131 memcpy( p, X->p, X->n * ciL );
Alexey Skalozube17a8da2016-01-13 17:19:33 +0200132 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133 mbedtls_free( X->p );
Paul Bakker5121ce52009-01-03 21:22:43 +0000134 }
135
136 X->n = nblimbs;
137 X->p = p;
138 }
139
140 return( 0 );
141}
142
143/*
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100144 * Resize down as much as possible,
145 * while keeping at least the specified number of limbs
146 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200147int mbedtls_mpi_shrink( mbedtls_mpi *X, size_t nblimbs )
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100148{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200149 mbedtls_mpi_uint *p;
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100150 size_t i;
Hanno Becker73d7d792018-12-11 10:35:51 +0000151 MPI_VALIDATE_RET( X != NULL );
152
153 if( nblimbs > MBEDTLS_MPI_MAX_LIMBS )
154 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100155
Gilles Peskinee2f563e2020-01-20 21:17:43 +0100156 /* Actually resize up if there are currently fewer than nblimbs limbs. */
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100157 if( X->n <= nblimbs )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200158 return( mbedtls_mpi_grow( X, nblimbs ) );
Gilles Peskine322752b2020-01-21 13:59:51 +0100159 /* After this point, then X->n > nblimbs and in particular X->n > 0. */
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100160
161 for( i = X->n - 1; i > 0; i-- )
162 if( X->p[i] != 0 )
163 break;
164 i++;
165
166 if( i < nblimbs )
167 i = nblimbs;
168
Simon Butcher29176892016-05-20 00:19:09 +0100169 if( ( p = (mbedtls_mpi_uint*)mbedtls_calloc( i, ciL ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200170 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100171
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100172 if( X->p != NULL )
173 {
174 memcpy( p, X->p, i * ciL );
Alexey Skalozube17a8da2016-01-13 17:19:33 +0200175 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176 mbedtls_free( X->p );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100177 }
178
179 X->n = i;
180 X->p = p;
181
182 return( 0 );
183}
184
Gilles Peskineed32b572021-06-02 22:17:52 +0200185/* Resize X to have exactly n limbs and set it to 0. */
186static int mbedtls_mpi_resize_clear( mbedtls_mpi *X, size_t limbs )
187{
188 if( limbs == 0 )
189 {
190 mbedtls_mpi_free( X );
191 return( 0 );
192 }
193 else if( X->n == limbs )
194 {
195 memset( X->p, 0, limbs * ciL );
196 X->s = 1;
197 return( 0 );
198 }
199 else
200 {
201 mbedtls_mpi_free( X );
202 return( mbedtls_mpi_grow( X, limbs ) );
203 }
204}
205
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100206/*
Gilles Peskine3da1a8f2021-06-08 23:17:42 +0200207 * Copy the contents of Y into X.
208 *
209 * This function is not constant-time. Leading zeros in Y may be removed.
210 *
211 * Ensure that X does not shrink. This is not guaranteed by the public API,
212 * but some code in the bignum module relies on this property, for example
213 * in mbedtls_mpi_exp_mod().
Paul Bakker5121ce52009-01-03 21:22:43 +0000214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215int mbedtls_mpi_copy( mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +0000216{
Gilles Peskine4e4be7c2018-03-21 16:29:03 +0100217 int ret = 0;
Paul Bakker23986e52011-04-24 08:57:21 +0000218 size_t i;
Hanno Becker73d7d792018-12-11 10:35:51 +0000219 MPI_VALIDATE_RET( X != NULL );
220 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000221
222 if( X == Y )
223 return( 0 );
224
Gilles Peskinedb420622020-01-20 21:12:50 +0100225 if( Y->n == 0 )
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200226 {
Gilles Peskine3da1a8f2021-06-08 23:17:42 +0200227 if( X->n != 0 )
228 {
229 X->s = 1;
230 memset( X->p, 0, X->n * ciL );
231 }
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200232 return( 0 );
233 }
234
Paul Bakker5121ce52009-01-03 21:22:43 +0000235 for( i = Y->n - 1; i > 0; i-- )
236 if( Y->p[i] != 0 )
237 break;
238 i++;
239
240 X->s = Y->s;
241
Gilles Peskine4e4be7c2018-03-21 16:29:03 +0100242 if( X->n < i )
243 {
244 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, i ) );
245 }
246 else
247 {
248 memset( X->p + i, 0, ( X->n - i ) * ciL );
249 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000250
Paul Bakker5121ce52009-01-03 21:22:43 +0000251 memcpy( X->p, Y->p, i * ciL );
252
253cleanup:
254
255 return( ret );
256}
257
258/*
259 * Swap the contents of X and Y
260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261void mbedtls_mpi_swap( mbedtls_mpi *X, mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +0000262{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200263 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000264 MPI_VALIDATE( X != NULL );
265 MPI_VALIDATE( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000266
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200267 memcpy( &T, X, sizeof( mbedtls_mpi ) );
268 memcpy( X, Y, sizeof( mbedtls_mpi ) );
269 memcpy( Y, &T, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000270}
271
272/*
273 * Set value from integer
274 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275int mbedtls_mpi_lset( mbedtls_mpi *X, mbedtls_mpi_sint z )
Paul Bakker5121ce52009-01-03 21:22:43 +0000276{
Janos Follath24eed8d2019-11-22 13:21:35 +0000277 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker73d7d792018-12-11 10:35:51 +0000278 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000279
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200280 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000281 memset( X->p, 0, X->n * ciL );
282
283 X->p[0] = ( z < 0 ) ? -z : z;
284 X->s = ( z < 0 ) ? -1 : 1;
285
286cleanup:
287
288 return( ret );
289}
290
291/*
Paul Bakker2f5947e2011-05-18 15:47:11 +0000292 * Get a specific bit
293 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200294int mbedtls_mpi_get_bit( const mbedtls_mpi *X, size_t pos )
Paul Bakker2f5947e2011-05-18 15:47:11 +0000295{
Hanno Becker73d7d792018-12-11 10:35:51 +0000296 MPI_VALIDATE_RET( X != NULL );
297
Paul Bakker2f5947e2011-05-18 15:47:11 +0000298 if( X->n * biL <= pos )
299 return( 0 );
300
Paul Bakkerd8bb8262014-06-17 14:06:49 +0200301 return( ( X->p[pos / biL] >> ( pos % biL ) ) & 0x01 );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000302}
303
Gilles Peskine11cdb052018-11-20 16:47:47 +0100304/* Get a specific byte, without range checks. */
305#define GET_BYTE( X, i ) \
306 ( ( ( X )->p[( i ) / ciL] >> ( ( ( i ) % ciL ) * 8 ) ) & 0xff )
307
Paul Bakker2f5947e2011-05-18 15:47:11 +0000308/*
309 * Set a bit to a specific value of 0 or 1
310 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200311int mbedtls_mpi_set_bit( mbedtls_mpi *X, size_t pos, unsigned char val )
Paul Bakker2f5947e2011-05-18 15:47:11 +0000312{
313 int ret = 0;
314 size_t off = pos / biL;
315 size_t idx = pos % biL;
Hanno Becker73d7d792018-12-11 10:35:51 +0000316 MPI_VALIDATE_RET( X != NULL );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000317
318 if( val != 0 && val != 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker9af723c2014-05-01 13:03:14 +0200320
Paul Bakker2f5947e2011-05-18 15:47:11 +0000321 if( X->n * biL <= pos )
322 {
323 if( val == 0 )
Paul Bakkerd8bb8262014-06-17 14:06:49 +0200324 return( 0 );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200326 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, off + 1 ) );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000327 }
328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329 X->p[off] &= ~( (mbedtls_mpi_uint) 0x01 << idx );
330 X->p[off] |= (mbedtls_mpi_uint) val << idx;
Paul Bakker2f5947e2011-05-18 15:47:11 +0000331
332cleanup:
Paul Bakker9af723c2014-05-01 13:03:14 +0200333
Paul Bakker2f5947e2011-05-18 15:47:11 +0000334 return( ret );
335}
336
337/*
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200338 * Return the number of less significant zero-bits
Paul Bakker5121ce52009-01-03 21:22:43 +0000339 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200340size_t mbedtls_mpi_lsb( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000341{
Paul Bakker23986e52011-04-24 08:57:21 +0000342 size_t i, j, count = 0;
Hanno Beckerf25ee7f2018-12-19 16:51:02 +0000343 MBEDTLS_INTERNAL_VALIDATE_RET( X != NULL, 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000344
345 for( i = 0; i < X->n; i++ )
Paul Bakkerf9688572011-05-05 10:00:45 +0000346 for( j = 0; j < biL; j++, count++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000347 if( ( ( X->p[i] >> j ) & 1 ) != 0 )
348 return( count );
349
350 return( 0 );
351}
352
353/*
Simon Butcher15b15d12015-11-26 19:35:03 +0000354 * Count leading zero bits in a given integer
355 */
356static size_t mbedtls_clz( const mbedtls_mpi_uint x )
357{
358 size_t j;
Manuel Pégourié-Gonnarde3e8edf2015-12-01 09:31:52 +0100359 mbedtls_mpi_uint mask = (mbedtls_mpi_uint) 1 << (biL - 1);
Simon Butcher15b15d12015-11-26 19:35:03 +0000360
361 for( j = 0; j < biL; j++ )
362 {
363 if( x & mask ) break;
364
365 mask >>= 1;
366 }
367
368 return j;
369}
370
371/*
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200372 * Return the number of bits
Paul Bakker5121ce52009-01-03 21:22:43 +0000373 */
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200374size_t mbedtls_mpi_bitlen( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000375{
Paul Bakker23986e52011-04-24 08:57:21 +0000376 size_t i, j;
Paul Bakker5121ce52009-01-03 21:22:43 +0000377
Manuel Pégourié-Gonnard770b5e12015-04-29 17:02:01 +0200378 if( X->n == 0 )
379 return( 0 );
380
Paul Bakker5121ce52009-01-03 21:22:43 +0000381 for( i = X->n - 1; i > 0; i-- )
382 if( X->p[i] != 0 )
383 break;
384
Simon Butcher15b15d12015-11-26 19:35:03 +0000385 j = biL - mbedtls_clz( X->p[i] );
Paul Bakker5121ce52009-01-03 21:22:43 +0000386
Paul Bakker23986e52011-04-24 08:57:21 +0000387 return( ( i * biL ) + j );
Paul Bakker5121ce52009-01-03 21:22:43 +0000388}
389
390/*
391 * Return the total size in bytes
392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200393size_t mbedtls_mpi_size( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000394{
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200395 return( ( mbedtls_mpi_bitlen( X ) + 7 ) >> 3 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000396}
397
398/*
399 * Convert an ASCII character to digit value
400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401static int mpi_get_digit( mbedtls_mpi_uint *d, int radix, char c )
Paul Bakker5121ce52009-01-03 21:22:43 +0000402{
403 *d = 255;
404
405 if( c >= 0x30 && c <= 0x39 ) *d = c - 0x30;
406 if( c >= 0x41 && c <= 0x46 ) *d = c - 0x37;
407 if( c >= 0x61 && c <= 0x66 ) *d = c - 0x57;
408
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200409 if( *d >= (mbedtls_mpi_uint) radix )
410 return( MBEDTLS_ERR_MPI_INVALID_CHARACTER );
Paul Bakker5121ce52009-01-03 21:22:43 +0000411
412 return( 0 );
413}
414
415/*
416 * Import from an ASCII string
417 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418int mbedtls_mpi_read_string( mbedtls_mpi *X, int radix, const char *s )
Paul Bakker5121ce52009-01-03 21:22:43 +0000419{
Janos Follath24eed8d2019-11-22 13:21:35 +0000420 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000421 size_t i, j, slen, n;
Gilles Peskine80f56732021-04-03 18:26:13 +0200422 int sign = 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200423 mbedtls_mpi_uint d;
424 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000425 MPI_VALIDATE_RET( X != NULL );
426 MPI_VALIDATE_RET( s != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000427
428 if( radix < 2 || radix > 16 )
Hanno Becker54c91dd2018-12-12 13:37:06 +0000429 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431 mbedtls_mpi_init( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000432
Gilles Peskine7cba8592021-06-08 18:32:34 +0200433 if( s[0] == 0 )
434 {
435 mbedtls_mpi_free( X );
436 return( 0 );
437 }
438
Gilles Peskine80f56732021-04-03 18:26:13 +0200439 if( s[0] == '-' )
440 {
441 ++s;
442 sign = -1;
443 }
444
Paul Bakkerff60ee62010-03-16 21:09:09 +0000445 slen = strlen( s );
446
Paul Bakker5121ce52009-01-03 21:22:43 +0000447 if( radix == 16 )
448 {
Manuel Pégourié-Gonnard2d708342015-10-05 15:23:11 +0100449 if( slen > MPI_SIZE_T_MAX >> 2 )
Manuel Pégourié-Gonnard58fb4952015-09-28 13:48:04 +0200450 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
451
Paul Bakkerff60ee62010-03-16 21:09:09 +0000452 n = BITS_TO_LIMBS( slen << 2 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000453
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200454 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, n ) );
455 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000456
Paul Bakker23986e52011-04-24 08:57:21 +0000457 for( i = slen, j = 0; i > 0; i--, j++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000458 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200459 MBEDTLS_MPI_CHK( mpi_get_digit( &d, radix, s[i - 1] ) );
Paul Bakker66d5d072014-06-17 16:39:18 +0200460 X->p[j / ( 2 * ciL )] |= d << ( ( j % ( 2 * ciL ) ) << 2 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000461 }
462 }
463 else
464 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200465 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000466
Paul Bakkerff60ee62010-03-16 21:09:09 +0000467 for( i = 0; i < slen; i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000468 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200469 MBEDTLS_MPI_CHK( mpi_get_digit( &d, radix, s[i] ) );
470 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T, X, radix ) );
Gilles Peskine80f56732021-04-03 18:26:13 +0200471 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, &T, d ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000472 }
473 }
474
Gilles Peskine80f56732021-04-03 18:26:13 +0200475 if( sign < 0 && mbedtls_mpi_bitlen( X ) != 0 )
476 X->s = -1;
477
Paul Bakker5121ce52009-01-03 21:22:43 +0000478cleanup:
479
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200480 mbedtls_mpi_free( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000481
482 return( ret );
483}
484
485/*
Ron Eldora16fa292018-11-20 14:07:01 +0200486 * Helper to write the digits high-order first.
Paul Bakker5121ce52009-01-03 21:22:43 +0000487 */
Ron Eldora16fa292018-11-20 14:07:01 +0200488static int mpi_write_hlp( mbedtls_mpi *X, int radix,
489 char **p, const size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000490{
Janos Follath24eed8d2019-11-22 13:21:35 +0000491 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200492 mbedtls_mpi_uint r;
Ron Eldora16fa292018-11-20 14:07:01 +0200493 size_t length = 0;
494 char *p_end = *p + buflen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000495
Ron Eldora16fa292018-11-20 14:07:01 +0200496 do
497 {
498 if( length >= buflen )
499 {
500 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
501 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000502
Ron Eldora16fa292018-11-20 14:07:01 +0200503 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, radix ) );
504 MBEDTLS_MPI_CHK( mbedtls_mpi_div_int( X, NULL, X, radix ) );
505 /*
506 * Write the residue in the current position, as an ASCII character.
507 */
508 if( r < 0xA )
509 *(--p_end) = (char)( '0' + r );
510 else
511 *(--p_end) = (char)( 'A' + ( r - 0xA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000512
Ron Eldora16fa292018-11-20 14:07:01 +0200513 length++;
514 } while( mbedtls_mpi_cmp_int( X, 0 ) != 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000515
Ron Eldora16fa292018-11-20 14:07:01 +0200516 memmove( *p, p_end, length );
517 *p += length;
Paul Bakker5121ce52009-01-03 21:22:43 +0000518
519cleanup:
520
521 return( ret );
522}
523
524/*
525 * Export into an ASCII string
526 */
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100527int mbedtls_mpi_write_string( const mbedtls_mpi *X, int radix,
528 char *buf, size_t buflen, size_t *olen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000529{
Paul Bakker23986e52011-04-24 08:57:21 +0000530 int ret = 0;
531 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +0000532 char *p;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000534 MPI_VALIDATE_RET( X != NULL );
535 MPI_VALIDATE_RET( olen != NULL );
536 MPI_VALIDATE_RET( buflen == 0 || buf != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000537
538 if( radix < 2 || radix > 16 )
Hanno Becker54c91dd2018-12-12 13:37:06 +0000539 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000540
Hanno Becker23cfea02019-02-04 09:45:07 +0000541 n = mbedtls_mpi_bitlen( X ); /* Number of bits necessary to present `n`. */
542 if( radix >= 4 ) n >>= 1; /* Number of 4-adic digits necessary to present
543 * `n`. If radix > 4, this might be a strict
544 * overapproximation of the number of
545 * radix-adic digits needed to present `n`. */
546 if( radix >= 16 ) n >>= 1; /* Number of hexadecimal digits necessary to
547 * present `n`. */
548
Janos Follath80470622019-03-06 13:43:02 +0000549 n += 1; /* Terminating null byte */
Hanno Becker23cfea02019-02-04 09:45:07 +0000550 n += 1; /* Compensate for the divisions above, which round down `n`
551 * in case it's not even. */
552 n += 1; /* Potential '-'-sign. */
553 n += ( n & 1 ); /* Make n even to have enough space for hexadecimal writing,
554 * which always uses an even number of hex-digits. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000555
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100556 if( buflen < n )
Paul Bakker5121ce52009-01-03 21:22:43 +0000557 {
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100558 *olen = n;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200559 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000560 }
561
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100562 p = buf;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563 mbedtls_mpi_init( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000564
565 if( X->s == -1 )
Hanno Beckerc983c812019-02-01 16:41:30 +0000566 {
Paul Bakker5121ce52009-01-03 21:22:43 +0000567 *p++ = '-';
Hanno Beckerc983c812019-02-01 16:41:30 +0000568 buflen--;
569 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000570
571 if( radix == 16 )
572 {
Paul Bakker23986e52011-04-24 08:57:21 +0000573 int c;
574 size_t i, j, k;
Paul Bakker5121ce52009-01-03 21:22:43 +0000575
Paul Bakker23986e52011-04-24 08:57:21 +0000576 for( i = X->n, k = 0; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +0000577 {
Paul Bakker23986e52011-04-24 08:57:21 +0000578 for( j = ciL; j > 0; j-- )
Paul Bakker5121ce52009-01-03 21:22:43 +0000579 {
Paul Bakker23986e52011-04-24 08:57:21 +0000580 c = ( X->p[i - 1] >> ( ( j - 1 ) << 3) ) & 0xFF;
Paul Bakker5121ce52009-01-03 21:22:43 +0000581
Paul Bakker6c343d72014-07-10 14:36:19 +0200582 if( c == 0 && k == 0 && ( i + j ) != 2 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000583 continue;
584
Paul Bakker98fe5ea2012-10-24 11:17:48 +0000585 *(p++) = "0123456789ABCDEF" [c / 16];
Paul Bakkerd2c167e2012-10-30 07:49:19 +0000586 *(p++) = "0123456789ABCDEF" [c % 16];
Paul Bakker5121ce52009-01-03 21:22:43 +0000587 k = 1;
588 }
589 }
590 }
591 else
592 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200593 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &T, X ) );
Paul Bakkerce40a6d2009-06-23 19:46:08 +0000594
595 if( T.s == -1 )
596 T.s = 1;
597
Ron Eldora16fa292018-11-20 14:07:01 +0200598 MBEDTLS_MPI_CHK( mpi_write_hlp( &T, radix, &p, buflen ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000599 }
600
601 *p++ = '\0';
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100602 *olen = p - buf;
Paul Bakker5121ce52009-01-03 21:22:43 +0000603
604cleanup:
605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606 mbedtls_mpi_free( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000607
608 return( ret );
609}
610
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200611#if defined(MBEDTLS_FS_IO)
Paul Bakker5121ce52009-01-03 21:22:43 +0000612/*
613 * Read X from an opened file
614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200615int mbedtls_mpi_read_file( mbedtls_mpi *X, int radix, FILE *fin )
Paul Bakker5121ce52009-01-03 21:22:43 +0000616{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617 mbedtls_mpi_uint d;
Paul Bakker23986e52011-04-24 08:57:21 +0000618 size_t slen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000619 char *p;
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000620 /*
Paul Bakkercb37aa52011-11-30 16:00:20 +0000621 * Buffer should have space for (short) label and decimal formatted MPI,
622 * newline characters and '\0'
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624 char s[ MBEDTLS_MPI_RW_BUFFER_SIZE ];
Paul Bakker5121ce52009-01-03 21:22:43 +0000625
Hanno Becker73d7d792018-12-11 10:35:51 +0000626 MPI_VALIDATE_RET( X != NULL );
627 MPI_VALIDATE_RET( fin != NULL );
628
629 if( radix < 2 || radix > 16 )
630 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
631
Paul Bakker5121ce52009-01-03 21:22:43 +0000632 memset( s, 0, sizeof( s ) );
633 if( fgets( s, sizeof( s ) - 1, fin ) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200634 return( MBEDTLS_ERR_MPI_FILE_IO_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +0000635
636 slen = strlen( s );
Paul Bakkercb37aa52011-11-30 16:00:20 +0000637 if( slen == sizeof( s ) - 2 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200638 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
Paul Bakkercb37aa52011-11-30 16:00:20 +0000639
Hanno Beckerb2034b72017-04-26 11:46:46 +0100640 if( slen > 0 && s[slen - 1] == '\n' ) { slen--; s[slen] = '\0'; }
641 if( slen > 0 && s[slen - 1] == '\r' ) { slen--; s[slen] = '\0'; }
Paul Bakker5121ce52009-01-03 21:22:43 +0000642
643 p = s + slen;
Hanno Beckerb2034b72017-04-26 11:46:46 +0100644 while( p-- > s )
Paul Bakker5121ce52009-01-03 21:22:43 +0000645 if( mpi_get_digit( &d, radix, *p ) != 0 )
646 break;
647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648 return( mbedtls_mpi_read_string( X, radix, p + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000649}
650
651/*
652 * Write X into an opened file (or stdout if fout == NULL)
653 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654int mbedtls_mpi_write_file( const char *p, const mbedtls_mpi *X, int radix, FILE *fout )
Paul Bakker5121ce52009-01-03 21:22:43 +0000655{
Janos Follath24eed8d2019-11-22 13:21:35 +0000656 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000657 size_t n, slen, plen;
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000658 /*
Paul Bakker5531c6d2012-09-26 19:20:46 +0000659 * Buffer should have space for (short) label and decimal formatted MPI,
660 * newline characters and '\0'
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000661 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200662 char s[ MBEDTLS_MPI_RW_BUFFER_SIZE ];
Hanno Becker73d7d792018-12-11 10:35:51 +0000663 MPI_VALIDATE_RET( X != NULL );
664
665 if( radix < 2 || radix > 16 )
666 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000667
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100668 memset( s, 0, sizeof( s ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000669
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100670 MBEDTLS_MPI_CHK( mbedtls_mpi_write_string( X, radix, s, sizeof( s ) - 2, &n ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000671
672 if( p == NULL ) p = "";
673
674 plen = strlen( p );
675 slen = strlen( s );
676 s[slen++] = '\r';
677 s[slen++] = '\n';
678
679 if( fout != NULL )
680 {
681 if( fwrite( p, 1, plen, fout ) != plen ||
682 fwrite( s, 1, slen, fout ) != slen )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200683 return( MBEDTLS_ERR_MPI_FILE_IO_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +0000684 }
685 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 mbedtls_printf( "%s%s", p, s );
Paul Bakker5121ce52009-01-03 21:22:43 +0000687
688cleanup:
689
690 return( ret );
691}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200692#endif /* MBEDTLS_FS_IO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000693
Hanno Beckerda1655a2017-10-18 14:21:44 +0100694
695/* Convert a big-endian byte array aligned to the size of mbedtls_mpi_uint
696 * into the storage form used by mbedtls_mpi. */
Hanno Beckerf8720072018-11-08 11:53:49 +0000697
698static mbedtls_mpi_uint mpi_uint_bigendian_to_host_c( mbedtls_mpi_uint x )
699{
700 uint8_t i;
Hanno Becker031d6332019-05-01 17:09:11 +0100701 unsigned char *x_ptr;
Hanno Beckerf8720072018-11-08 11:53:49 +0000702 mbedtls_mpi_uint tmp = 0;
Hanno Becker031d6332019-05-01 17:09:11 +0100703
704 for( i = 0, x_ptr = (unsigned char*) &x; i < ciL; i++, x_ptr++ )
705 {
706 tmp <<= CHAR_BIT;
707 tmp |= (mbedtls_mpi_uint) *x_ptr;
708 }
709
Hanno Beckerf8720072018-11-08 11:53:49 +0000710 return( tmp );
711}
712
713static mbedtls_mpi_uint mpi_uint_bigendian_to_host( mbedtls_mpi_uint x )
714{
715#if defined(__BYTE_ORDER__)
716
717/* Nothing to do on bigendian systems. */
718#if ( __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ )
719 return( x );
720#endif /* __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ */
721
722#if ( __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ )
723
724/* For GCC and Clang, have builtins for byte swapping. */
Hanno Becker9f6d16a2019-01-02 17:15:06 +0000725#if defined(__GNUC__) && defined(__GNUC_PREREQ)
726#if __GNUC_PREREQ(4,3)
Hanno Beckerf8720072018-11-08 11:53:49 +0000727#define have_bswap
728#endif
Hanno Becker9f6d16a2019-01-02 17:15:06 +0000729#endif
730
731#if defined(__clang__) && defined(__has_builtin)
732#if __has_builtin(__builtin_bswap32) && \
733 __has_builtin(__builtin_bswap64)
734#define have_bswap
735#endif
736#endif
737
Hanno Beckerf8720072018-11-08 11:53:49 +0000738#if defined(have_bswap)
739 /* The compiler is hopefully able to statically evaluate this! */
740 switch( sizeof(mbedtls_mpi_uint) )
741 {
742 case 4:
743 return( __builtin_bswap32(x) );
744 case 8:
745 return( __builtin_bswap64(x) );
746 }
747#endif
748#endif /* __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ */
749#endif /* __BYTE_ORDER__ */
750
751 /* Fall back to C-based reordering if we don't know the byte order
752 * or we couldn't use a compiler-specific builtin. */
753 return( mpi_uint_bigendian_to_host_c( x ) );
754}
755
Hanno Becker2be8a552018-10-25 12:40:09 +0100756static void mpi_bigendian_to_host( mbedtls_mpi_uint * const p, size_t limbs )
Hanno Beckerda1655a2017-10-18 14:21:44 +0100757{
Hanno Beckerda1655a2017-10-18 14:21:44 +0100758 mbedtls_mpi_uint *cur_limb_left;
759 mbedtls_mpi_uint *cur_limb_right;
Hanno Becker2be8a552018-10-25 12:40:09 +0100760 if( limbs == 0 )
761 return;
Hanno Beckerda1655a2017-10-18 14:21:44 +0100762
763 /*
764 * Traverse limbs and
765 * - adapt byte-order in each limb
766 * - swap the limbs themselves.
767 * For that, simultaneously traverse the limbs from left to right
768 * and from right to left, as long as the left index is not bigger
769 * than the right index (it's not a problem if limbs is odd and the
770 * indices coincide in the last iteration).
771 */
Hanno Beckerda1655a2017-10-18 14:21:44 +0100772 for( cur_limb_left = p, cur_limb_right = p + ( limbs - 1 );
773 cur_limb_left <= cur_limb_right;
774 cur_limb_left++, cur_limb_right-- )
775 {
Hanno Beckerf8720072018-11-08 11:53:49 +0000776 mbedtls_mpi_uint tmp;
777 /* Note that if cur_limb_left == cur_limb_right,
778 * this code effectively swaps the bytes only once. */
779 tmp = mpi_uint_bigendian_to_host( *cur_limb_left );
780 *cur_limb_left = mpi_uint_bigendian_to_host( *cur_limb_right );
781 *cur_limb_right = tmp;
Hanno Beckerda1655a2017-10-18 14:21:44 +0100782 }
Hanno Beckerda1655a2017-10-18 14:21:44 +0100783}
784
Paul Bakker5121ce52009-01-03 21:22:43 +0000785/*
Janos Follatha778a942019-02-13 10:28:28 +0000786 * Import X from unsigned binary data, little endian
787 */
788int mbedtls_mpi_read_binary_le( mbedtls_mpi *X,
789 const unsigned char *buf, size_t buflen )
790{
Janos Follath24eed8d2019-11-22 13:21:35 +0000791 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Janos Follatha778a942019-02-13 10:28:28 +0000792 size_t i;
793 size_t const limbs = CHARS_TO_LIMBS( buflen );
794
795 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskineed32b572021-06-02 22:17:52 +0200796 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Janos Follatha778a942019-02-13 10:28:28 +0000797
798 for( i = 0; i < buflen; i++ )
799 X->p[i / ciL] |= ((mbedtls_mpi_uint) buf[i]) << ((i % ciL) << 3);
800
801cleanup:
802
Janos Follath171a7ef2019-02-15 16:17:45 +0000803 /*
804 * This function is also used to import keys. However, wiping the buffers
805 * upon failure is not necessary because failure only can happen before any
806 * input is copied.
807 */
Janos Follatha778a942019-02-13 10:28:28 +0000808 return( ret );
809}
810
811/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000812 * Import X from unsigned binary data, big endian
813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814int mbedtls_mpi_read_binary( mbedtls_mpi *X, const unsigned char *buf, size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000815{
Janos Follath24eed8d2019-11-22 13:21:35 +0000816 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerda1655a2017-10-18 14:21:44 +0100817 size_t const limbs = CHARS_TO_LIMBS( buflen );
818 size_t const overhead = ( limbs * ciL ) - buflen;
819 unsigned char *Xp;
Paul Bakker5121ce52009-01-03 21:22:43 +0000820
Hanno Becker8ce11a32018-12-19 16:18:52 +0000821 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +0000822 MPI_VALIDATE_RET( buflen == 0 || buf != NULL );
823
Hanno Becker073c1992017-10-17 15:17:27 +0100824 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskineed32b572021-06-02 22:17:52 +0200825 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000826
Gilles Peskineed32b572021-06-02 22:17:52 +0200827 /* Avoid calling `memcpy` with NULL source or destination argument,
Hanno Becker0e810b92019-01-03 17:13:11 +0000828 * even if buflen is 0. */
Gilles Peskineed32b572021-06-02 22:17:52 +0200829 if( buflen != 0 )
Hanno Becker0e810b92019-01-03 17:13:11 +0000830 {
831 Xp = (unsigned char*) X->p;
832 memcpy( Xp + overhead, buf, buflen );
Hanno Beckerda1655a2017-10-18 14:21:44 +0100833
Hanno Becker0e810b92019-01-03 17:13:11 +0000834 mpi_bigendian_to_host( X->p, limbs );
835 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000836
837cleanup:
838
Janos Follath171a7ef2019-02-15 16:17:45 +0000839 /*
840 * This function is also used to import keys. However, wiping the buffers
841 * upon failure is not necessary because failure only can happen before any
842 * input is copied.
843 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000844 return( ret );
845}
846
847/*
Janos Follathe344d0f2019-02-19 16:17:40 +0000848 * Export X into unsigned binary data, little endian
849 */
850int mbedtls_mpi_write_binary_le( const mbedtls_mpi *X,
851 unsigned char *buf, size_t buflen )
852{
853 size_t stored_bytes = X->n * ciL;
854 size_t bytes_to_copy;
855 size_t i;
856
857 if( stored_bytes < buflen )
858 {
859 bytes_to_copy = stored_bytes;
860 }
861 else
862 {
863 bytes_to_copy = buflen;
864
865 /* The output buffer is smaller than the allocated size of X.
866 * However X may fit if its leading bytes are zero. */
867 for( i = bytes_to_copy; i < stored_bytes; i++ )
868 {
869 if( GET_BYTE( X, i ) != 0 )
870 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
871 }
872 }
873
874 for( i = 0; i < bytes_to_copy; i++ )
875 buf[i] = GET_BYTE( X, i );
876
877 if( stored_bytes < buflen )
878 {
879 /* Write trailing 0 bytes */
880 memset( buf + stored_bytes, 0, buflen - stored_bytes );
881 }
882
883 return( 0 );
884}
885
886/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000887 * Export X into unsigned binary data, big endian
888 */
Gilles Peskine11cdb052018-11-20 16:47:47 +0100889int mbedtls_mpi_write_binary( const mbedtls_mpi *X,
890 unsigned char *buf, size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000891{
Hanno Becker73d7d792018-12-11 10:35:51 +0000892 size_t stored_bytes;
Gilles Peskine11cdb052018-11-20 16:47:47 +0100893 size_t bytes_to_copy;
894 unsigned char *p;
895 size_t i;
Paul Bakker5121ce52009-01-03 21:22:43 +0000896
Hanno Becker73d7d792018-12-11 10:35:51 +0000897 MPI_VALIDATE_RET( X != NULL );
898 MPI_VALIDATE_RET( buflen == 0 || buf != NULL );
899
900 stored_bytes = X->n * ciL;
901
Gilles Peskine11cdb052018-11-20 16:47:47 +0100902 if( stored_bytes < buflen )
903 {
904 /* There is enough space in the output buffer. Write initial
905 * null bytes and record the position at which to start
906 * writing the significant bytes. In this case, the execution
907 * trace of this function does not depend on the value of the
908 * number. */
909 bytes_to_copy = stored_bytes;
910 p = buf + buflen - stored_bytes;
911 memset( buf, 0, buflen - stored_bytes );
912 }
913 else
914 {
915 /* The output buffer is smaller than the allocated size of X.
916 * However X may fit if its leading bytes are zero. */
917 bytes_to_copy = buflen;
918 p = buf;
919 for( i = bytes_to_copy; i < stored_bytes; i++ )
920 {
921 if( GET_BYTE( X, i ) != 0 )
922 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
923 }
924 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000925
Gilles Peskine11cdb052018-11-20 16:47:47 +0100926 for( i = 0; i < bytes_to_copy; i++ )
927 p[bytes_to_copy - i - 1] = GET_BYTE( X, i );
Paul Bakker5121ce52009-01-03 21:22:43 +0000928
929 return( 0 );
930}
931
932/*
933 * Left-shift: X <<= count
934 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935int mbedtls_mpi_shift_l( mbedtls_mpi *X, size_t count )
Paul Bakker5121ce52009-01-03 21:22:43 +0000936{
Janos Follath24eed8d2019-11-22 13:21:35 +0000937 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000938 size_t i, v0, t1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939 mbedtls_mpi_uint r0 = 0, r1;
Hanno Becker73d7d792018-12-11 10:35:51 +0000940 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000941
942 v0 = count / (biL );
943 t1 = count & (biL - 1);
944
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200945 i = mbedtls_mpi_bitlen( X ) + count;
Paul Bakker5121ce52009-01-03 21:22:43 +0000946
Paul Bakkerf9688572011-05-05 10:00:45 +0000947 if( X->n * biL < i )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, BITS_TO_LIMBS( i ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000949
950 ret = 0;
951
952 /*
953 * shift by count / limb_size
954 */
955 if( v0 > 0 )
956 {
Paul Bakker23986e52011-04-24 08:57:21 +0000957 for( i = X->n; i > v0; i-- )
958 X->p[i - 1] = X->p[i - v0 - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +0000959
Paul Bakker23986e52011-04-24 08:57:21 +0000960 for( ; i > 0; i-- )
961 X->p[i - 1] = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +0000962 }
963
964 /*
965 * shift by count % limb_size
966 */
967 if( t1 > 0 )
968 {
969 for( i = v0; i < X->n; i++ )
970 {
971 r1 = X->p[i] >> (biL - t1);
972 X->p[i] <<= t1;
973 X->p[i] |= r0;
974 r0 = r1;
975 }
976 }
977
978cleanup:
979
980 return( ret );
981}
982
983/*
984 * Right-shift: X >>= count
985 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986int mbedtls_mpi_shift_r( mbedtls_mpi *X, size_t count )
Paul Bakker5121ce52009-01-03 21:22:43 +0000987{
Paul Bakker23986e52011-04-24 08:57:21 +0000988 size_t i, v0, v1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989 mbedtls_mpi_uint r0 = 0, r1;
Hanno Becker73d7d792018-12-11 10:35:51 +0000990 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000991
992 v0 = count / biL;
993 v1 = count & (biL - 1);
994
Manuel Pégourié-Gonnarde44ec102012-11-17 12:42:51 +0100995 if( v0 > X->n || ( v0 == X->n && v1 > 0 ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996 return mbedtls_mpi_lset( X, 0 );
Manuel Pégourié-Gonnarde44ec102012-11-17 12:42:51 +0100997
Paul Bakker5121ce52009-01-03 21:22:43 +0000998 /*
999 * shift by count / limb_size
1000 */
1001 if( v0 > 0 )
1002 {
1003 for( i = 0; i < X->n - v0; i++ )
1004 X->p[i] = X->p[i + v0];
1005
1006 for( ; i < X->n; i++ )
1007 X->p[i] = 0;
1008 }
1009
1010 /*
1011 * shift by count % limb_size
1012 */
1013 if( v1 > 0 )
1014 {
Paul Bakker23986e52011-04-24 08:57:21 +00001015 for( i = X->n; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001016 {
Paul Bakker23986e52011-04-24 08:57:21 +00001017 r1 = X->p[i - 1] << (biL - v1);
1018 X->p[i - 1] >>= v1;
1019 X->p[i - 1] |= r0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001020 r0 = r1;
1021 }
1022 }
1023
1024 return( 0 );
1025}
1026
1027/*
1028 * Compare unsigned values
1029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030int mbedtls_mpi_cmp_abs( const mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +00001031{
Paul Bakker23986e52011-04-24 08:57:21 +00001032 size_t i, j;
Hanno Becker73d7d792018-12-11 10:35:51 +00001033 MPI_VALIDATE_RET( X != NULL );
1034 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001035
Paul Bakker23986e52011-04-24 08:57:21 +00001036 for( i = X->n; i > 0; i-- )
1037 if( X->p[i - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001038 break;
1039
Paul Bakker23986e52011-04-24 08:57:21 +00001040 for( j = Y->n; j > 0; j-- )
1041 if( Y->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001042 break;
1043
Paul Bakker23986e52011-04-24 08:57:21 +00001044 if( i == 0 && j == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001045 return( 0 );
1046
1047 if( i > j ) return( 1 );
1048 if( j > i ) return( -1 );
1049
Paul Bakker23986e52011-04-24 08:57:21 +00001050 for( ; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001051 {
Paul Bakker23986e52011-04-24 08:57:21 +00001052 if( X->p[i - 1] > Y->p[i - 1] ) return( 1 );
1053 if( X->p[i - 1] < Y->p[i - 1] ) return( -1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001054 }
1055
1056 return( 0 );
1057}
1058
1059/*
1060 * Compare signed values
1061 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062int mbedtls_mpi_cmp_mpi( const mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +00001063{
Paul Bakker23986e52011-04-24 08:57:21 +00001064 size_t i, j;
Hanno Becker73d7d792018-12-11 10:35:51 +00001065 MPI_VALIDATE_RET( X != NULL );
1066 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001067
Paul Bakker23986e52011-04-24 08:57:21 +00001068 for( i = X->n; i > 0; i-- )
1069 if( X->p[i - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001070 break;
1071
Paul Bakker23986e52011-04-24 08:57:21 +00001072 for( j = Y->n; j > 0; j-- )
1073 if( Y->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001074 break;
1075
Paul Bakker23986e52011-04-24 08:57:21 +00001076 if( i == 0 && j == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001077 return( 0 );
1078
1079 if( i > j ) return( X->s );
Paul Bakker0c8f73b2012-03-22 14:08:57 +00001080 if( j > i ) return( -Y->s );
Paul Bakker5121ce52009-01-03 21:22:43 +00001081
1082 if( X->s > 0 && Y->s < 0 ) return( 1 );
1083 if( Y->s > 0 && X->s < 0 ) return( -1 );
1084
Paul Bakker23986e52011-04-24 08:57:21 +00001085 for( ; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001086 {
Paul Bakker23986e52011-04-24 08:57:21 +00001087 if( X->p[i - 1] > Y->p[i - 1] ) return( X->s );
1088 if( X->p[i - 1] < Y->p[i - 1] ) return( -X->s );
Paul Bakker5121ce52009-01-03 21:22:43 +00001089 }
1090
1091 return( 0 );
1092}
1093
Janos Follathee6abce2019-09-05 14:47:19 +01001094/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001095 * Compare signed values
1096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097int mbedtls_mpi_cmp_int( const mbedtls_mpi *X, mbedtls_mpi_sint z )
Paul Bakker5121ce52009-01-03 21:22:43 +00001098{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001099 mbedtls_mpi Y;
1100 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001101 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001102
1103 *p = ( z < 0 ) ? -z : z;
1104 Y.s = ( z < 0 ) ? -1 : 1;
1105 Y.n = 1;
1106 Y.p = p;
1107
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 return( mbedtls_mpi_cmp_mpi( X, &Y ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001109}
1110
1111/*
1112 * Unsigned addition: X = |A| + |B| (HAC 14.7)
1113 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114int mbedtls_mpi_add_abs( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001115{
Janos Follath24eed8d2019-11-22 13:21:35 +00001116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001117 size_t i, j;
Janos Follath6c922682015-10-30 17:43:11 +01001118 mbedtls_mpi_uint *o, *p, c, tmp;
Hanno Becker73d7d792018-12-11 10:35:51 +00001119 MPI_VALIDATE_RET( X != NULL );
1120 MPI_VALIDATE_RET( A != NULL );
1121 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001122
1123 if( X == B )
1124 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001125 const mbedtls_mpi *T = A; A = X; B = T;
Paul Bakker5121ce52009-01-03 21:22:43 +00001126 }
1127
1128 if( X != A )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, A ) );
Paul Bakker9af723c2014-05-01 13:03:14 +02001130
Paul Bakkerf7ca7b92009-06-20 10:31:06 +00001131 /*
1132 * X should always be positive as a result of unsigned additions.
1133 */
1134 X->s = 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001135
Paul Bakker23986e52011-04-24 08:57:21 +00001136 for( j = B->n; j > 0; j-- )
1137 if( B->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001138 break;
1139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, j ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001141
1142 o = B->p; p = X->p; c = 0;
1143
Janos Follath6c922682015-10-30 17:43:11 +01001144 /*
1145 * tmp is used because it might happen that p == o
1146 */
Paul Bakker23986e52011-04-24 08:57:21 +00001147 for( i = 0; i < j; i++, o++, p++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001148 {
Janos Follath6c922682015-10-30 17:43:11 +01001149 tmp= *o;
Paul Bakker5121ce52009-01-03 21:22:43 +00001150 *p += c; c = ( *p < c );
Janos Follath6c922682015-10-30 17:43:11 +01001151 *p += tmp; c += ( *p < tmp );
Paul Bakker5121ce52009-01-03 21:22:43 +00001152 }
1153
1154 while( c != 0 )
1155 {
1156 if( i >= X->n )
1157 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, i + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001159 p = X->p + i;
1160 }
1161
Paul Bakker2d319fd2012-09-16 21:34:26 +00001162 *p += c; c = ( *p < c ); i++; p++;
Paul Bakker5121ce52009-01-03 21:22:43 +00001163 }
1164
1165cleanup:
1166
1167 return( ret );
1168}
1169
Gilles Peskine09ec10a2020-06-09 10:39:38 +02001170/**
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001171 * Helper for mbedtls_mpi subtraction.
1172 *
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001173 * Calculate l - r where l and r have the same size.
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001174 * This function operates modulo (2^ciL)^n and returns the carry
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001175 * (1 if there was a wraparound, i.e. if `l < r`, and 0 otherwise).
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001176 *
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001177 * d may be aliased to l or r.
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001178 *
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001179 * \param n Number of limbs of \p d, \p l and \p r.
1180 * \param[out] d The result of the subtraction.
1181 * \param[in] l The left operand.
1182 * \param[in] r The right operand.
1183 *
1184 * \return 1 if `l < r`.
1185 * 0 if `l >= r`.
Paul Bakker5121ce52009-01-03 21:22:43 +00001186 */
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001187static mbedtls_mpi_uint mpi_sub_hlp( size_t n,
1188 mbedtls_mpi_uint *d,
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001189 const mbedtls_mpi_uint *l,
1190 const mbedtls_mpi_uint *r )
Paul Bakker5121ce52009-01-03 21:22:43 +00001191{
Paul Bakker23986e52011-04-24 08:57:21 +00001192 size_t i;
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001193 mbedtls_mpi_uint c = 0, t, z;
Paul Bakker5121ce52009-01-03 21:22:43 +00001194
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001195 for( i = 0; i < n; i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001196 {
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001197 z = ( l[i] < c ); t = l[i] - c;
1198 c = ( t < r[i] ) + z; d[i] = t - r[i];
Paul Bakker5121ce52009-01-03 21:22:43 +00001199 }
1200
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001201 return( c );
Paul Bakker5121ce52009-01-03 21:22:43 +00001202}
1203
1204/*
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001205 * Unsigned subtraction: X = |A| - |B| (HAC 14.9, 14.10)
Paul Bakker5121ce52009-01-03 21:22:43 +00001206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207int mbedtls_mpi_sub_abs( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001208{
Janos Follath24eed8d2019-11-22 13:21:35 +00001209 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001210 size_t n;
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001211 mbedtls_mpi_uint carry;
Hanno Becker73d7d792018-12-11 10:35:51 +00001212 MPI_VALIDATE_RET( X != NULL );
1213 MPI_VALIDATE_RET( A != NULL );
1214 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001215
Paul Bakker23986e52011-04-24 08:57:21 +00001216 for( n = B->n; n > 0; n-- )
1217 if( B->p[n - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001218 break;
Gilles Peskinec8a91772021-01-27 22:30:43 +01001219 if( n > A->n )
1220 {
1221 /* B >= (2^ciL)^n > A */
1222 ret = MBEDTLS_ERR_MPI_NEGATIVE_VALUE;
1223 goto cleanup;
1224 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001225
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001226 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, A->n ) );
1227
1228 /* Set the high limbs of X to match A. Don't touch the lower limbs
1229 * because X might be aliased to B, and we must not overwrite the
1230 * significant digits of B. */
1231 if( A->n > n )
1232 memcpy( X->p + n, A->p + n, ( A->n - n ) * ciL );
1233 if( X->n > A->n )
1234 memset( X->p + A->n, 0, ( X->n - A->n ) * ciL );
1235
1236 carry = mpi_sub_hlp( n, X->p, A->p, B->p );
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001237 if( carry != 0 )
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001238 {
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001239 /* Propagate the carry to the first nonzero limb of X. */
1240 for( ; n < X->n && X->p[n] == 0; n++ )
1241 --X->p[n];
1242 /* If we ran out of space for the carry, it means that the result
1243 * is negative. */
1244 if( n == X->n )
Gilles Peskine89b41302020-07-23 01:16:46 +02001245 {
1246 ret = MBEDTLS_ERR_MPI_NEGATIVE_VALUE;
1247 goto cleanup;
1248 }
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001249 --X->p[n];
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001250 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001251
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001252 /* X should always be positive as a result of unsigned subtractions. */
1253 X->s = 1;
1254
Paul Bakker5121ce52009-01-03 21:22:43 +00001255cleanup:
Paul Bakker5121ce52009-01-03 21:22:43 +00001256 return( ret );
1257}
1258
1259/*
1260 * Signed addition: X = A + B
1261 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001262int mbedtls_mpi_add_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001263{
Hanno Becker73d7d792018-12-11 10:35:51 +00001264 int ret, s;
1265 MPI_VALIDATE_RET( X != NULL );
1266 MPI_VALIDATE_RET( A != NULL );
1267 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001268
Hanno Becker73d7d792018-12-11 10:35:51 +00001269 s = A->s;
Paul Bakker5121ce52009-01-03 21:22:43 +00001270 if( A->s * B->s < 0 )
1271 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001272 if( mbedtls_mpi_cmp_abs( A, B ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001273 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001274 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001275 X->s = s;
1276 }
1277 else
1278 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, B, A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001280 X->s = -s;
1281 }
1282 }
1283 else
1284 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001285 MBEDTLS_MPI_CHK( mbedtls_mpi_add_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001286 X->s = s;
1287 }
1288
1289cleanup:
1290
1291 return( ret );
1292}
1293
1294/*
Paul Bakker60b1d102013-10-29 10:02:51 +01001295 * Signed subtraction: X = A - B
Paul Bakker5121ce52009-01-03 21:22:43 +00001296 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001297int mbedtls_mpi_sub_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001298{
Hanno Becker73d7d792018-12-11 10:35:51 +00001299 int ret, s;
1300 MPI_VALIDATE_RET( X != NULL );
1301 MPI_VALIDATE_RET( A != NULL );
1302 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001303
Hanno Becker73d7d792018-12-11 10:35:51 +00001304 s = A->s;
Paul Bakker5121ce52009-01-03 21:22:43 +00001305 if( A->s * B->s > 0 )
1306 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001307 if( mbedtls_mpi_cmp_abs( A, B ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001308 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001309 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001310 X->s = s;
1311 }
1312 else
1313 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, B, A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001315 X->s = -s;
1316 }
1317 }
1318 else
1319 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320 MBEDTLS_MPI_CHK( mbedtls_mpi_add_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001321 X->s = s;
1322 }
1323
1324cleanup:
1325
1326 return( ret );
1327}
1328
1329/*
1330 * Signed addition: X = A + b
1331 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001332int mbedtls_mpi_add_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001333{
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001334 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001336 MPI_VALIDATE_RET( X != NULL );
1337 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001338
1339 p[0] = ( b < 0 ) ? -b : b;
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001340 B.s = ( b < 0 ) ? -1 : 1;
1341 B.n = 1;
1342 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001343
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001344 return( mbedtls_mpi_add_mpi( X, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001345}
1346
1347/*
Paul Bakker60b1d102013-10-29 10:02:51 +01001348 * Signed subtraction: X = A - b
Paul Bakker5121ce52009-01-03 21:22:43 +00001349 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001350int mbedtls_mpi_sub_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001351{
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001352 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001353 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001354 MPI_VALIDATE_RET( X != NULL );
1355 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001356
1357 p[0] = ( b < 0 ) ? -b : b;
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001358 B.s = ( b < 0 ) ? -1 : 1;
1359 B.n = 1;
1360 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001361
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001362 return( mbedtls_mpi_sub_mpi( X, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001363}
1364
Gilles Peskinea5d8d892020-07-23 21:27:15 +02001365/** Helper for mbedtls_mpi multiplication.
1366 *
1367 * Add \p b * \p s to \p d.
1368 *
1369 * \param i The number of limbs of \p s.
1370 * \param[in] s A bignum to multiply, of size \p i.
1371 * It may overlap with \p d, but only if
1372 * \p d <= \p s.
1373 * Its leading limb must not be \c 0.
1374 * \param[in,out] d The bignum to add to.
1375 * It must be sufficiently large to store the
1376 * result of the multiplication. This means
1377 * \p i + 1 limbs if \p d[\p i - 1] started as 0 and \p b
1378 * is not known a priori.
1379 * \param b A scalar to multiply.
Paul Bakkerfc4f46f2013-06-24 19:23:56 +02001380 */
1381static
1382#if defined(__APPLE__) && defined(__arm__)
1383/*
1384 * Apple LLVM version 4.2 (clang-425.0.24) (based on LLVM 3.2svn)
1385 * appears to need this to prevent bad ARM code generation at -O3.
1386 */
1387__attribute__ ((noinline))
1388#endif
Gilles Peskinea5d8d892020-07-23 21:27:15 +02001389void mpi_mul_hlp( size_t i,
1390 const mbedtls_mpi_uint *s,
1391 mbedtls_mpi_uint *d,
1392 mbedtls_mpi_uint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001393{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001394 mbedtls_mpi_uint c = 0, t = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001395
1396#if defined(MULADDC_HUIT)
1397 for( ; i >= 8; i -= 8 )
1398 {
1399 MULADDC_INIT
1400 MULADDC_HUIT
1401 MULADDC_STOP
1402 }
1403
1404 for( ; i > 0; i-- )
1405 {
1406 MULADDC_INIT
1407 MULADDC_CORE
1408 MULADDC_STOP
1409 }
Paul Bakker9af723c2014-05-01 13:03:14 +02001410#else /* MULADDC_HUIT */
Paul Bakker5121ce52009-01-03 21:22:43 +00001411 for( ; i >= 16; i -= 16 )
1412 {
1413 MULADDC_INIT
1414 MULADDC_CORE MULADDC_CORE
1415 MULADDC_CORE MULADDC_CORE
1416 MULADDC_CORE MULADDC_CORE
1417 MULADDC_CORE MULADDC_CORE
1418
1419 MULADDC_CORE MULADDC_CORE
1420 MULADDC_CORE MULADDC_CORE
1421 MULADDC_CORE MULADDC_CORE
1422 MULADDC_CORE MULADDC_CORE
1423 MULADDC_STOP
1424 }
1425
1426 for( ; i >= 8; i -= 8 )
1427 {
1428 MULADDC_INIT
1429 MULADDC_CORE MULADDC_CORE
1430 MULADDC_CORE MULADDC_CORE
1431
1432 MULADDC_CORE MULADDC_CORE
1433 MULADDC_CORE MULADDC_CORE
1434 MULADDC_STOP
1435 }
1436
1437 for( ; i > 0; i-- )
1438 {
1439 MULADDC_INIT
1440 MULADDC_CORE
1441 MULADDC_STOP
1442 }
Paul Bakker9af723c2014-05-01 13:03:14 +02001443#endif /* MULADDC_HUIT */
Paul Bakker5121ce52009-01-03 21:22:43 +00001444
1445 t++;
1446
Gilles Peskine8e464c42020-07-24 00:08:38 +02001447 while( c != 0 )
1448 {
Paul Bakker5121ce52009-01-03 21:22:43 +00001449 *d += c; c = ( *d < c ); d++;
1450 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001451}
1452
1453/*
1454 * Baseline multiplication: X = A * B (HAC 14.12)
1455 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001456int mbedtls_mpi_mul_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001457{
Janos Follath24eed8d2019-11-22 13:21:35 +00001458 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001459 size_t i, j;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001460 mbedtls_mpi TA, TB;
Gilles Peskine997be0a2021-06-15 21:44:32 +02001461 int result_is_zero = 0;
Hanno Becker73d7d792018-12-11 10:35:51 +00001462 MPI_VALIDATE_RET( X != NULL );
1463 MPI_VALIDATE_RET( A != NULL );
1464 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001465
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00001467
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001468 if( X == A ) { MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TA, A ) ); A = &TA; }
1469 if( X == B ) { MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, B ) ); B = &TB; }
Paul Bakker5121ce52009-01-03 21:22:43 +00001470
Paul Bakker23986e52011-04-24 08:57:21 +00001471 for( i = A->n; i > 0; i-- )
1472 if( A->p[i - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001473 break;
Gilles Peskine4169c322021-06-17 14:35:25 +02001474 if( i == 0 )
Gilles Peskine997be0a2021-06-15 21:44:32 +02001475 result_is_zero = 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001476
Paul Bakker23986e52011-04-24 08:57:21 +00001477 for( j = B->n; j > 0; j-- )
1478 if( B->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001479 break;
Gilles Peskine4169c322021-06-17 14:35:25 +02001480 if( j == 0 )
Gilles Peskine997be0a2021-06-15 21:44:32 +02001481 result_is_zero = 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, i + j ) );
1484 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001485
Alexey Skalozub8e75e682016-01-13 21:59:27 +02001486 for( ; j > 0; j-- )
1487 mpi_mul_hlp( i, A->p, X->p + j - 1, B->p[j - 1] );
Paul Bakker5121ce52009-01-03 21:22:43 +00001488
Gilles Peskinef4998b02021-06-10 15:51:54 +02001489 /* If the result is 0, we don't shortcut the operation, which reduces
1490 * but does not eliminate side channels leaking the zero-ness. We do
1491 * need to take care to set the sign bit properly since the library does
1492 * not fully support an MPI object with a value of 0 and s == -1. */
Gilles Peskine997be0a2021-06-15 21:44:32 +02001493 if( result_is_zero )
Gilles Peskinef4998b02021-06-10 15:51:54 +02001494 X->s = 1;
Gilles Peskinef4998b02021-06-10 15:51:54 +02001495 else
1496 X->s = A->s * B->s;
Paul Bakker5121ce52009-01-03 21:22:43 +00001497
1498cleanup:
1499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001500 mbedtls_mpi_free( &TB ); mbedtls_mpi_free( &TA );
Paul Bakker5121ce52009-01-03 21:22:43 +00001501
1502 return( ret );
1503}
1504
1505/*
1506 * Baseline multiplication: X = A * b
1507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001508int mbedtls_mpi_mul_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_uint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001509{
Hanno Becker73d7d792018-12-11 10:35:51 +00001510 MPI_VALIDATE_RET( X != NULL );
1511 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001512
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001513 /* mpi_mul_hlp can't deal with a leading 0. */
1514 size_t n = A->n;
1515 while( n > 0 && A->p[n - 1] == 0 )
1516 --n;
Paul Bakker5121ce52009-01-03 21:22:43 +00001517
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001518 /* The general method below doesn't work if n==0 or b==0. By chance
1519 * calculating the result is trivial in those cases. */
1520 if( b == 0 || n == 0 )
1521 {
Paul Elliott986b55a2021-04-20 21:46:29 +01001522 return( mbedtls_mpi_lset( X, 0 ) );
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001523 }
1524
Gilles Peskinee1bba7c2021-03-10 23:44:10 +01001525 /* Calculate A*b as A + A*(b-1) to take advantage of mpi_mul_hlp */
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001526 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinecd0dbf32020-07-24 00:09:04 +02001527 /* In general, A * b requires 1 limb more than b. If
1528 * A->p[n - 1] * b / b == A->p[n - 1], then A * b fits in the same
1529 * number of limbs as A and the call to grow() is not required since
Gilles Peskinee1bba7c2021-03-10 23:44:10 +01001530 * copy() will take care of the growth if needed. However, experimentally,
1531 * making the call to grow() unconditional causes slightly fewer
Gilles Peskinecd0dbf32020-07-24 00:09:04 +02001532 * calls to calloc() in ECP code, presumably because it reuses the
1533 * same mpi for a while and this way the mpi is more likely to directly
1534 * grow to its final size. */
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001535 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, n + 1 ) );
1536 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, A ) );
1537 mpi_mul_hlp( n, A->p, X->p, b - 1 );
1538
1539cleanup:
1540 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001541}
1542
1543/*
Simon Butcherf5ba0452015-12-27 23:01:55 +00001544 * Unsigned integer divide - double mbedtls_mpi_uint dividend, u1/u0, and
1545 * mbedtls_mpi_uint divisor, d
Simon Butcher15b15d12015-11-26 19:35:03 +00001546 */
Simon Butcherf5ba0452015-12-27 23:01:55 +00001547static mbedtls_mpi_uint mbedtls_int_div_int( mbedtls_mpi_uint u1,
1548 mbedtls_mpi_uint u0, mbedtls_mpi_uint d, mbedtls_mpi_uint *r )
Simon Butcher15b15d12015-11-26 19:35:03 +00001549{
Manuel Pégourié-Gonnard16308882015-12-01 10:27:00 +01001550#if defined(MBEDTLS_HAVE_UDBL)
1551 mbedtls_t_udbl dividend, quotient;
Simon Butcherf5ba0452015-12-27 23:01:55 +00001552#else
Simon Butcher9803d072016-01-03 00:24:34 +00001553 const mbedtls_mpi_uint radix = (mbedtls_mpi_uint) 1 << biH;
1554 const mbedtls_mpi_uint uint_halfword_mask = ( (mbedtls_mpi_uint) 1 << biH ) - 1;
Simon Butcherf5ba0452015-12-27 23:01:55 +00001555 mbedtls_mpi_uint d0, d1, q0, q1, rAX, r0, quotient;
1556 mbedtls_mpi_uint u0_msw, u0_lsw;
Simon Butcher9803d072016-01-03 00:24:34 +00001557 size_t s;
Manuel Pégourié-Gonnard16308882015-12-01 10:27:00 +01001558#endif
1559
Simon Butcher15b15d12015-11-26 19:35:03 +00001560 /*
1561 * Check for overflow
1562 */
Simon Butcherf5ba0452015-12-27 23:01:55 +00001563 if( 0 == d || u1 >= d )
Simon Butcher15b15d12015-11-26 19:35:03 +00001564 {
Simon Butcherf5ba0452015-12-27 23:01:55 +00001565 if (r != NULL) *r = ~0;
Simon Butcher15b15d12015-11-26 19:35:03 +00001566
Simon Butcherf5ba0452015-12-27 23:01:55 +00001567 return ( ~0 );
Simon Butcher15b15d12015-11-26 19:35:03 +00001568 }
1569
1570#if defined(MBEDTLS_HAVE_UDBL)
Simon Butcher15b15d12015-11-26 19:35:03 +00001571 dividend = (mbedtls_t_udbl) u1 << biL;
1572 dividend |= (mbedtls_t_udbl) u0;
1573 quotient = dividend / d;
1574 if( quotient > ( (mbedtls_t_udbl) 1 << biL ) - 1 )
1575 quotient = ( (mbedtls_t_udbl) 1 << biL ) - 1;
1576
1577 if( r != NULL )
Simon Butcher9803d072016-01-03 00:24:34 +00001578 *r = (mbedtls_mpi_uint)( dividend - (quotient * d ) );
Simon Butcher15b15d12015-11-26 19:35:03 +00001579
1580 return (mbedtls_mpi_uint) quotient;
1581#else
Simon Butcher15b15d12015-11-26 19:35:03 +00001582
1583 /*
1584 * Algorithm D, Section 4.3.1 - The Art of Computer Programming
1585 * Vol. 2 - Seminumerical Algorithms, Knuth
1586 */
1587
1588 /*
1589 * Normalize the divisor, d, and dividend, u0, u1
1590 */
1591 s = mbedtls_clz( d );
1592 d = d << s;
1593
1594 u1 = u1 << s;
Simon Butcher9803d072016-01-03 00:24:34 +00001595 u1 |= ( u0 >> ( biL - s ) ) & ( -(mbedtls_mpi_sint)s >> ( biL - 1 ) );
Simon Butcher15b15d12015-11-26 19:35:03 +00001596 u0 = u0 << s;
1597
1598 d1 = d >> biH;
Simon Butcher9803d072016-01-03 00:24:34 +00001599 d0 = d & uint_halfword_mask;
Simon Butcher15b15d12015-11-26 19:35:03 +00001600
1601 u0_msw = u0 >> biH;
Simon Butcher9803d072016-01-03 00:24:34 +00001602 u0_lsw = u0 & uint_halfword_mask;
Simon Butcher15b15d12015-11-26 19:35:03 +00001603
1604 /*
1605 * Find the first quotient and remainder
1606 */
1607 q1 = u1 / d1;
1608 r0 = u1 - d1 * q1;
1609
1610 while( q1 >= radix || ( q1 * d0 > radix * r0 + u0_msw ) )
1611 {
1612 q1 -= 1;
1613 r0 += d1;
1614
1615 if ( r0 >= radix ) break;
1616 }
1617
Simon Butcherf5ba0452015-12-27 23:01:55 +00001618 rAX = ( u1 * radix ) + ( u0_msw - q1 * d );
Simon Butcher15b15d12015-11-26 19:35:03 +00001619 q0 = rAX / d1;
1620 r0 = rAX - q0 * d1;
1621
1622 while( q0 >= radix || ( q0 * d0 > radix * r0 + u0_lsw ) )
1623 {
1624 q0 -= 1;
1625 r0 += d1;
1626
1627 if ( r0 >= radix ) break;
1628 }
1629
1630 if (r != NULL)
Simon Butcherf5ba0452015-12-27 23:01:55 +00001631 *r = ( rAX * radix + u0_lsw - q0 * d ) >> s;
Simon Butcher15b15d12015-11-26 19:35:03 +00001632
1633 quotient = q1 * radix + q0;
1634
1635 return quotient;
1636#endif
1637}
1638
1639/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640 * Division by mbedtls_mpi: A = Q * B + R (HAC 14.20)
Paul Bakker5121ce52009-01-03 21:22:43 +00001641 */
Hanno Becker73d7d792018-12-11 10:35:51 +00001642int mbedtls_mpi_div_mpi( mbedtls_mpi *Q, mbedtls_mpi *R, const mbedtls_mpi *A,
1643 const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001644{
Janos Follath24eed8d2019-11-22 13:21:35 +00001645 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001646 size_t i, n, t, k;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647 mbedtls_mpi X, Y, Z, T1, T2;
Alexander Kd19a1932019-11-01 18:20:42 +03001648 mbedtls_mpi_uint TP2[3];
Hanno Becker73d7d792018-12-11 10:35:51 +00001649 MPI_VALIDATE_RET( A != NULL );
1650 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001651
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652 if( mbedtls_mpi_cmp_int( B, 0 ) == 0 )
1653 return( MBEDTLS_ERR_MPI_DIVISION_BY_ZERO );
Paul Bakker5121ce52009-01-03 21:22:43 +00001654
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655 mbedtls_mpi_init( &X ); mbedtls_mpi_init( &Y ); mbedtls_mpi_init( &Z );
Alexander K35d6d462019-10-31 14:46:45 +03001656 mbedtls_mpi_init( &T1 );
Alexander Kd19a1932019-11-01 18:20:42 +03001657 /*
1658 * Avoid dynamic memory allocations for constant-size T2.
1659 *
1660 * T2 is used for comparison only and the 3 limbs are assigned explicitly,
1661 * so nobody increase the size of the MPI and we're safe to use an on-stack
1662 * buffer.
1663 */
Alexander K35d6d462019-10-31 14:46:45 +03001664 T2.s = 1;
Alexander Kd19a1932019-11-01 18:20:42 +03001665 T2.n = sizeof( TP2 ) / sizeof( *TP2 );
1666 T2.p = TP2;
Paul Bakker5121ce52009-01-03 21:22:43 +00001667
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668 if( mbedtls_mpi_cmp_abs( A, B ) < 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001669 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001670 if( Q != NULL ) MBEDTLS_MPI_CHK( mbedtls_mpi_lset( Q, 0 ) );
1671 if( R != NULL ) MBEDTLS_MPI_CHK( mbedtls_mpi_copy( R, A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001672 return( 0 );
1673 }
1674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001675 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &X, A ) );
1676 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Y, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001677 X.s = Y.s = 1;
1678
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001679 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &Z, A->n + 2 ) );
1680 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &Z, 0 ) );
Gilles Peskine2536aa72020-07-24 00:12:59 +02001681 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &T1, A->n + 2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001682
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02001683 k = mbedtls_mpi_bitlen( &Y ) % biL;
Paul Bakkerf9688572011-05-05 10:00:45 +00001684 if( k < biL - 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001685 {
1686 k = biL - 1 - k;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &X, k ) );
1688 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &Y, k ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001689 }
1690 else k = 0;
1691
1692 n = X.n - 1;
1693 t = Y.n - 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &Y, biL * ( n - t ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001695
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001696 while( mbedtls_mpi_cmp_mpi( &X, &Y ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001697 {
1698 Z.p[n - t]++;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &X, &X, &Y ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001700 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001701 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &Y, biL * ( n - t ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001702
1703 for( i = n; i > t ; i-- )
1704 {
1705 if( X.p[i] >= Y.p[t] )
1706 Z.p[i - t - 1] = ~0;
1707 else
1708 {
Simon Butcher15b15d12015-11-26 19:35:03 +00001709 Z.p[i - t - 1] = mbedtls_int_div_int( X.p[i], X.p[i - 1],
1710 Y.p[t], NULL);
Paul Bakker5121ce52009-01-03 21:22:43 +00001711 }
1712
Alexander K35d6d462019-10-31 14:46:45 +03001713 T2.p[0] = ( i < 2 ) ? 0 : X.p[i - 2];
1714 T2.p[1] = ( i < 1 ) ? 0 : X.p[i - 1];
1715 T2.p[2] = X.p[i];
1716
Paul Bakker5121ce52009-01-03 21:22:43 +00001717 Z.p[i - t - 1]++;
1718 do
1719 {
1720 Z.p[i - t - 1]--;
1721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &T1, 0 ) );
Paul Bakker66d5d072014-06-17 16:39:18 +02001723 T1.p[0] = ( t < 1 ) ? 0 : Y.p[t - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +00001724 T1.p[1] = Y.p[t];
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T1, &T1, Z.p[i - t - 1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001726 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727 while( mbedtls_mpi_cmp_mpi( &T1, &T2 ) > 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T1, &Y, Z.p[i - t - 1] ) );
1730 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &T1, biL * ( i - t - 1 ) ) );
1731 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &X, &X, &T1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733 if( mbedtls_mpi_cmp_int( &X, 0 ) < 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001734 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &T1, &Y ) );
1736 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &T1, biL * ( i - t - 1 ) ) );
1737 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &X, &X, &T1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001738 Z.p[i - t - 1]--;
1739 }
1740 }
1741
1742 if( Q != NULL )
1743 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001744 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( Q, &Z ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001745 Q->s = A->s * B->s;
1746 }
1747
1748 if( R != NULL )
1749 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &X, k ) );
Paul Bakkerf02c5642012-11-13 10:25:21 +00001751 X.s = A->s;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( R, &X ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754 if( mbedtls_mpi_cmp_int( R, 0 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001755 R->s = 1;
1756 }
1757
1758cleanup:
1759
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760 mbedtls_mpi_free( &X ); mbedtls_mpi_free( &Y ); mbedtls_mpi_free( &Z );
Alexander K35d6d462019-10-31 14:46:45 +03001761 mbedtls_mpi_free( &T1 );
Alexander Kd19a1932019-11-01 18:20:42 +03001762 mbedtls_platform_zeroize( TP2, sizeof( TP2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001763
1764 return( ret );
1765}
1766
1767/*
1768 * Division by int: A = Q * b + R
Paul Bakker5121ce52009-01-03 21:22:43 +00001769 */
Hanno Becker73d7d792018-12-11 10:35:51 +00001770int mbedtls_mpi_div_int( mbedtls_mpi *Q, mbedtls_mpi *R,
1771 const mbedtls_mpi *A,
1772 mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001773{
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001774 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001776 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001777
1778 p[0] = ( b < 0 ) ? -b : b;
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001779 B.s = ( b < 0 ) ? -1 : 1;
1780 B.n = 1;
1781 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001782
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001783 return( mbedtls_mpi_div_mpi( Q, R, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001784}
1785
1786/*
1787 * Modulo: R = A mod B
1788 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001789int mbedtls_mpi_mod_mpi( mbedtls_mpi *R, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001790{
Janos Follath24eed8d2019-11-22 13:21:35 +00001791 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker73d7d792018-12-11 10:35:51 +00001792 MPI_VALIDATE_RET( R != NULL );
1793 MPI_VALIDATE_RET( A != NULL );
1794 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001795
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796 if( mbedtls_mpi_cmp_int( B, 0 ) < 0 )
1797 return( MBEDTLS_ERR_MPI_NEGATIVE_VALUE );
Paul Bakkerce40a6d2009-06-23 19:46:08 +00001798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 MBEDTLS_MPI_CHK( mbedtls_mpi_div_mpi( NULL, R, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001800
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 while( mbedtls_mpi_cmp_int( R, 0 ) < 0 )
1802 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( R, R, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804 while( mbedtls_mpi_cmp_mpi( R, B ) >= 0 )
1805 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( R, R, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001806
1807cleanup:
1808
1809 return( ret );
1810}
1811
1812/*
1813 * Modulo: r = A mod b
1814 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001815int mbedtls_mpi_mod_int( mbedtls_mpi_uint *r, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001816{
Paul Bakker23986e52011-04-24 08:57:21 +00001817 size_t i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818 mbedtls_mpi_uint x, y, z;
Hanno Becker73d7d792018-12-11 10:35:51 +00001819 MPI_VALIDATE_RET( r != NULL );
1820 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001821
1822 if( b == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823 return( MBEDTLS_ERR_MPI_DIVISION_BY_ZERO );
Paul Bakker5121ce52009-01-03 21:22:43 +00001824
1825 if( b < 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 return( MBEDTLS_ERR_MPI_NEGATIVE_VALUE );
Paul Bakker5121ce52009-01-03 21:22:43 +00001827
1828 /*
1829 * handle trivial cases
1830 */
1831 if( b == 1 )
1832 {
1833 *r = 0;
1834 return( 0 );
1835 }
1836
1837 if( b == 2 )
1838 {
1839 *r = A->p[0] & 1;
1840 return( 0 );
1841 }
1842
1843 /*
1844 * general case
1845 */
Paul Bakker23986e52011-04-24 08:57:21 +00001846 for( i = A->n, y = 0; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001847 {
Paul Bakker23986e52011-04-24 08:57:21 +00001848 x = A->p[i - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +00001849 y = ( y << biH ) | ( x >> biH );
1850 z = y / b;
1851 y -= z * b;
1852
1853 x <<= biH;
1854 y = ( y << biH ) | ( x >> biH );
1855 z = y / b;
1856 y -= z * b;
1857 }
1858
Paul Bakkerce40a6d2009-06-23 19:46:08 +00001859 /*
1860 * If A is negative, then the current y represents a negative value.
1861 * Flipping it to the positive side.
1862 */
1863 if( A->s < 0 && y != 0 )
1864 y = b - y;
1865
Paul Bakker5121ce52009-01-03 21:22:43 +00001866 *r = y;
1867
1868 return( 0 );
1869}
1870
1871/*
1872 * Fast Montgomery initialization (thanks to Tom St Denis)
1873 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874static void mpi_montg_init( mbedtls_mpi_uint *mm, const mbedtls_mpi *N )
Paul Bakker5121ce52009-01-03 21:22:43 +00001875{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876 mbedtls_mpi_uint x, m0 = N->p[0];
Manuel Pégourié-Gonnardfdf3f0e2014-03-11 13:47:05 +01001877 unsigned int i;
Paul Bakker5121ce52009-01-03 21:22:43 +00001878
1879 x = m0;
1880 x += ( ( m0 + 2 ) & 4 ) << 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001881
Manuel Pégourié-Gonnardfdf3f0e2014-03-11 13:47:05 +01001882 for( i = biL; i >= 8; i /= 2 )
1883 x *= ( 2 - ( m0 * x ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001884
1885 *mm = ~x + 1;
1886}
1887
Gilles Peskine2a82f722020-06-04 15:00:49 +02001888/** Montgomery multiplication: A = A * B * R^-1 mod N (HAC 14.36)
1889 *
1890 * \param[in,out] A One of the numbers to multiply.
Gilles Peskine221626f2020-06-08 22:37:50 +02001891 * It must have at least as many limbs as N
1892 * (A->n >= N->n), and any limbs beyond n are ignored.
Gilles Peskine2a82f722020-06-04 15:00:49 +02001893 * On successful completion, A contains the result of
1894 * the multiplication A * B * R^-1 mod N where
1895 * R = (2^ciL)^n.
1896 * \param[in] B One of the numbers to multiply.
1897 * It must be nonzero and must not have more limbs than N
1898 * (B->n <= N->n).
1899 * \param[in] N The modulo. N must be odd.
1900 * \param mm The value calculated by `mpi_montg_init(&mm, N)`.
1901 * This is -N^-1 mod 2^ciL.
1902 * \param[in,out] T A bignum for temporary storage.
1903 * It must be at least twice the limb size of N plus 2
1904 * (T->n >= 2 * (N->n + 1)).
1905 * Its initial content is unused and
1906 * its final content is indeterminate.
1907 * Note that unlike the usual convention in the library
1908 * for `const mbedtls_mpi*`, the content of T can change.
Paul Bakker5121ce52009-01-03 21:22:43 +00001909 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02001910static 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 +02001911 const mbedtls_mpi *T )
Paul Bakker5121ce52009-01-03 21:22:43 +00001912{
Paul Bakker23986e52011-04-24 08:57:21 +00001913 size_t i, n, m;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 mbedtls_mpi_uint u0, u1, *d;
Paul Bakker5121ce52009-01-03 21:22:43 +00001915
1916 memset( T->p, 0, T->n * ciL );
1917
1918 d = T->p;
1919 n = N->n;
1920 m = ( B->n < n ) ? B->n : n;
1921
1922 for( i = 0; i < n; i++ )
1923 {
1924 /*
1925 * T = (T + u0*B + u1*N) / 2^biL
1926 */
1927 u0 = A->p[i];
1928 u1 = ( d[0] + u0 * B->p[0] ) * mm;
1929
1930 mpi_mul_hlp( m, B->p, d, u0 );
1931 mpi_mul_hlp( n, N->p, d, u1 );
1932
1933 *d++ = u0; d[n + 1] = 0;
1934 }
1935
Gilles Peskine221626f2020-06-08 22:37:50 +02001936 /* At this point, d is either the desired result or the desired result
1937 * plus N. We now potentially subtract N, avoiding leaking whether the
1938 * subtraction is performed through side channels. */
Paul Bakker5121ce52009-01-03 21:22:43 +00001939
Gilles Peskine221626f2020-06-08 22:37:50 +02001940 /* Copy the n least significant limbs of d to A, so that
1941 * A = d if d < N (recall that N has n limbs). */
1942 memcpy( A->p, d, n * ciL );
Gilles Peskine09ec10a2020-06-09 10:39:38 +02001943 /* If d >= N then we want to set A to d - N. To prevent timing attacks,
Gilles Peskine221626f2020-06-08 22:37:50 +02001944 * do the calculation without using conditional tests. */
1945 /* Set d to d0 + (2^biL)^n - N where d0 is the current value of d. */
Gilles Peskine132c0972020-06-04 21:05:24 +02001946 d[n] += 1;
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001947 d[n] -= mpi_sub_hlp( n, d, d, N->p );
Gilles Peskine221626f2020-06-08 22:37:50 +02001948 /* If d0 < N then d < (2^biL)^n
1949 * so d[n] == 0 and we want to keep A as it is.
1950 * If d0 >= N then d >= (2^biL)^n, and d <= (2^biL)^n + N < 2 * (2^biL)^n
1951 * so d[n] == 1 and we want to set A to the result of the subtraction
1952 * which is d - (2^biL)^n, i.e. the n least significant limbs of d.
1953 * This exactly corresponds to a conditional assignment. */
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001954 mbedtls_cf_mpi_uint_cond_assign( n, A->p, d, (unsigned char) d[n] );
Paul Bakker5121ce52009-01-03 21:22:43 +00001955}
1956
1957/*
1958 * Montgomery reduction: A = A * R^-1 mod N
Gilles Peskine2a82f722020-06-04 15:00:49 +02001959 *
1960 * See mpi_montmul() regarding constraints and guarantees on the parameters.
Paul Bakker5121ce52009-01-03 21:22:43 +00001961 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02001962static void mpi_montred( mbedtls_mpi *A, const mbedtls_mpi *N,
1963 mbedtls_mpi_uint mm, const mbedtls_mpi *T )
Paul Bakker5121ce52009-01-03 21:22:43 +00001964{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001965 mbedtls_mpi_uint z = 1;
1966 mbedtls_mpi U;
Paul Bakker5121ce52009-01-03 21:22:43 +00001967
Paul Bakker8ddb6452013-02-27 14:56:33 +01001968 U.n = U.s = (int) z;
Paul Bakker5121ce52009-01-03 21:22:43 +00001969 U.p = &z;
1970
Gilles Peskine4e91d472020-06-04 20:55:15 +02001971 mpi_montmul( A, &U, N, mm, T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001972}
1973
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01001974/**
1975 * Select an MPI from a table without leaking the index.
1976 *
1977 * This is functionally equivalent to mbedtls_mpi_copy(R, T[idx]) except it
1978 * reads the entire table in order to avoid leaking the value of idx to an
1979 * attacker able to observe memory access patterns.
1980 *
1981 * \param[out] R Where to write the selected MPI.
1982 * \param[in] T The table to read from.
1983 * \param[in] T_size The number of elements in the table.
1984 * \param[in] idx The index of the element to select;
1985 * this must satisfy 0 <= idx < T_size.
1986 *
1987 * \return \c 0 on success, or a negative error code.
1988 */
1989static int mpi_select( mbedtls_mpi *R, const mbedtls_mpi *T, size_t T_size, size_t idx )
1990{
1991 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1992
1993 for( size_t i = 0; i < T_size; i++ )
Manuel Pégourié-Gonnard92413ef2021-06-03 10:42:46 +02001994 {
1995 MBEDTLS_MPI_CHK( mbedtls_mpi_safe_cond_assign( R, &T[i],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001996 (unsigned char) mbedtls_cf_size_bool_eq( i, idx ) ) );
Manuel Pégourié-Gonnard92413ef2021-06-03 10:42:46 +02001997 }
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01001998
1999cleanup:
2000 return( ret );
2001}
2002
Paul Bakker5121ce52009-01-03 21:22:43 +00002003/*
2004 * Sliding-window exponentiation: X = A^E mod N (HAC 14.85)
2005 */
Hanno Becker73d7d792018-12-11 10:35:51 +00002006int mbedtls_mpi_exp_mod( mbedtls_mpi *X, const mbedtls_mpi *A,
2007 const mbedtls_mpi *E, const mbedtls_mpi *N,
Yuto Takano538a0cb2021-07-14 10:20:09 +01002008 mbedtls_mpi *prec_RR )
Paul Bakker5121ce52009-01-03 21:22:43 +00002009{
Janos Follath24eed8d2019-11-22 13:21:35 +00002010 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002011 size_t wbits, wsize, one = 1;
2012 size_t i, j, nblimbs;
2013 size_t bufsize, nbits;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002014 mbedtls_mpi_uint ei, mm, state;
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01002015 mbedtls_mpi RR, T, W[ 1 << MBEDTLS_MPI_WINDOW_SIZE ], WW, Apos;
Paul Bakkerf6198c12012-05-16 08:02:29 +00002016 int neg;
Paul Bakker5121ce52009-01-03 21:22:43 +00002017
Hanno Becker73d7d792018-12-11 10:35:51 +00002018 MPI_VALIDATE_RET( X != NULL );
2019 MPI_VALIDATE_RET( A != NULL );
2020 MPI_VALIDATE_RET( E != NULL );
2021 MPI_VALIDATE_RET( N != NULL );
2022
Hanno Becker8d1dd1b2017-09-28 11:02:24 +01002023 if( mbedtls_mpi_cmp_int( N, 0 ) <= 0 || ( N->p[0] & 1 ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002024 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00002025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002026 if( mbedtls_mpi_cmp_int( E, 0 ) < 0 )
2027 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakkerf6198c12012-05-16 08:02:29 +00002028
Chris Jones9246d042020-11-25 15:12:39 +00002029 if( mbedtls_mpi_bitlen( E ) > MBEDTLS_MPI_MAX_BITS ||
2030 mbedtls_mpi_bitlen( N ) > MBEDTLS_MPI_MAX_BITS )
2031 return ( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
2032
Paul Bakkerf6198c12012-05-16 08:02:29 +00002033 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00002034 * Init temps and window size
2035 */
2036 mpi_montg_init( &mm, N );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037 mbedtls_mpi_init( &RR ); mbedtls_mpi_init( &T );
2038 mbedtls_mpi_init( &Apos );
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01002039 mbedtls_mpi_init( &WW );
Paul Bakker5121ce52009-01-03 21:22:43 +00002040 memset( W, 0, sizeof( W ) );
2041
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02002042 i = mbedtls_mpi_bitlen( E );
Paul Bakker5121ce52009-01-03 21:22:43 +00002043
2044 wsize = ( i > 671 ) ? 6 : ( i > 239 ) ? 5 :
2045 ( i > 79 ) ? 4 : ( i > 23 ) ? 3 : 1;
2046
Peter Kolbuse6bcad32018-12-11 14:01:44 -06002047#if( MBEDTLS_MPI_WINDOW_SIZE < 6 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002048 if( wsize > MBEDTLS_MPI_WINDOW_SIZE )
2049 wsize = MBEDTLS_MPI_WINDOW_SIZE;
Peter Kolbuse6bcad32018-12-11 14:01:44 -06002050#endif
Paul Bakkerb6d5f082011-11-25 11:52:11 +00002051
Paul Bakker5121ce52009-01-03 21:22:43 +00002052 j = N->n + 1;
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02002053 /* All W[i] and X must have at least N->n limbs for the mpi_montmul()
2054 * and mpi_montred() calls later. Here we ensure that W[1] and X are
2055 * large enough, and later we'll grow other W[i] to the same length.
2056 * They must not be shrunk midway through this function!
2057 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002058 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, j ) );
2059 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[1], j ) );
2060 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &T, j * 2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002061
2062 /*
Paul Bakker50546922012-05-19 08:40:49 +00002063 * Compensate for negative A (and correct at the end)
2064 */
2065 neg = ( A->s == -1 );
Paul Bakker50546922012-05-19 08:40:49 +00002066 if( neg )
2067 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002068 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Apos, A ) );
Paul Bakker50546922012-05-19 08:40:49 +00002069 Apos.s = 1;
2070 A = &Apos;
2071 }
2072
2073 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00002074 * If 1st call, pre-compute R^2 mod N
2075 */
Yuto Takano538a0cb2021-07-14 10:20:09 +01002076 if( prec_RR == NULL || prec_RR->p == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002077 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &RR, 1 ) );
2079 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &RR, N->n * 2 * biL ) );
2080 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &RR, &RR, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002081
Yuto Takano538a0cb2021-07-14 10:20:09 +01002082 if( prec_RR != NULL )
2083 memcpy( prec_RR, &RR, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002084 }
2085 else
Yuto Takano538a0cb2021-07-14 10:20:09 +01002086 memcpy( &RR, prec_RR, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002087
2088 /*
2089 * W[1] = A * R^2 * R^-1 mod N = A * R mod N
2090 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091 if( mbedtls_mpi_cmp_mpi( A, N ) >= 0 )
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02002092 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &W[1], A, N ) );
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02002094 /* This should be a no-op because W[1] is already that large before
2095 * mbedtls_mpi_mod_mpi(), but it's necessary to avoid an overflow
2096 * in mpi_montmul() below, so let's make sure. */
Gilles Peskine2aa3f162021-06-15 21:22:48 +02002097 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[1], N->n + 1 ) );
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02002098 }
Paul Bakkerc2024f42014-01-23 20:38:35 +01002099 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002100 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[1], A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002101
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02002102 /* Note that this is safe because W[1] always has at least N->n limbs
2103 * (it grew above and was preserved by mbedtls_mpi_copy()). */
Gilles Peskine4e91d472020-06-04 20:55:15 +02002104 mpi_montmul( &W[1], &RR, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002105
2106 /*
2107 * X = R^2 * R^-1 mod N = R mod N
2108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, &RR ) );
Gilles Peskine4e91d472020-06-04 20:55:15 +02002110 mpi_montred( X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002111
2112 if( wsize > 1 )
2113 {
2114 /*
2115 * W[1 << (wsize - 1)] = W[1] ^ (wsize - 1)
2116 */
Paul Bakker66d5d072014-06-17 16:39:18 +02002117 j = one << ( wsize - 1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002118
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[j], N->n + 1 ) );
2120 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[j], &W[1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002121
2122 for( i = 0; i < wsize - 1; i++ )
Gilles Peskine4e91d472020-06-04 20:55:15 +02002123 mpi_montmul( &W[j], &W[j], N, mm, &T );
Paul Bakker0d7702c2013-10-29 16:18:35 +01002124
Paul Bakker5121ce52009-01-03 21:22:43 +00002125 /*
2126 * W[i] = W[i - 1] * W[1]
2127 */
Paul Bakker66d5d072014-06-17 16:39:18 +02002128 for( i = j + 1; i < ( one << wsize ); i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00002129 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002130 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[i], N->n + 1 ) );
2131 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[i], &W[i - 1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002132
Gilles Peskine4e91d472020-06-04 20:55:15 +02002133 mpi_montmul( &W[i], &W[1], N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002134 }
2135 }
2136
2137 nblimbs = E->n;
2138 bufsize = 0;
2139 nbits = 0;
2140 wbits = 0;
2141 state = 0;
2142
2143 while( 1 )
2144 {
2145 if( bufsize == 0 )
2146 {
Paul Bakker0d7702c2013-10-29 16:18:35 +01002147 if( nblimbs == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002148 break;
2149
Paul Bakker0d7702c2013-10-29 16:18:35 +01002150 nblimbs--;
2151
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002152 bufsize = sizeof( mbedtls_mpi_uint ) << 3;
Paul Bakker5121ce52009-01-03 21:22:43 +00002153 }
2154
2155 bufsize--;
2156
2157 ei = (E->p[nblimbs] >> bufsize) & 1;
2158
2159 /*
2160 * skip leading 0s
2161 */
2162 if( ei == 0 && state == 0 )
2163 continue;
2164
2165 if( ei == 0 && state == 1 )
2166 {
2167 /*
2168 * out of window, square X
2169 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02002170 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002171 continue;
2172 }
2173
2174 /*
2175 * add ei to current window
2176 */
2177 state = 2;
2178
2179 nbits++;
Paul Bakker66d5d072014-06-17 16:39:18 +02002180 wbits |= ( ei << ( wsize - nbits ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002181
2182 if( nbits == wsize )
2183 {
2184 /*
2185 * X = X^wsize R^-1 mod N
2186 */
2187 for( i = 0; i < wsize; i++ )
Gilles Peskine4e91d472020-06-04 20:55:15 +02002188 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002189
2190 /*
2191 * X = X * W[wbits] R^-1 mod N
2192 */
Manuel Pégourié-Gonnarde22176e2021-06-10 09:34:00 +02002193 MBEDTLS_MPI_CHK( mpi_select( &WW, W, (size_t) 1 << wsize, wbits ) );
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01002194 mpi_montmul( X, &WW, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002195
2196 state--;
2197 nbits = 0;
2198 wbits = 0;
2199 }
2200 }
2201
2202 /*
2203 * process the remaining bits
2204 */
2205 for( i = 0; i < nbits; i++ )
2206 {
Gilles Peskine4e91d472020-06-04 20:55:15 +02002207 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002208
2209 wbits <<= 1;
2210
Paul Bakker66d5d072014-06-17 16:39:18 +02002211 if( ( wbits & ( one << wsize ) ) != 0 )
Gilles Peskine4e91d472020-06-04 20:55:15 +02002212 mpi_montmul( X, &W[1], N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002213 }
2214
2215 /*
2216 * X = A^E * R * R^-1 mod N = A^E mod N
2217 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02002218 mpi_montred( X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002219
Hanno Beckera4af1c42017-04-18 09:07:45 +01002220 if( neg && E->n != 0 && ( E->p[0] & 1 ) != 0 )
Paul Bakkerf6198c12012-05-16 08:02:29 +00002221 {
2222 X->s = -1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002223 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( X, N, X ) );
Paul Bakkerf6198c12012-05-16 08:02:29 +00002224 }
2225
Paul Bakker5121ce52009-01-03 21:22:43 +00002226cleanup:
2227
Paul Bakker66d5d072014-06-17 16:39:18 +02002228 for( i = ( one << ( wsize - 1 ) ); i < ( one << wsize ); i++ )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002229 mbedtls_mpi_free( &W[i] );
Paul Bakker5121ce52009-01-03 21:22:43 +00002230
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002231 mbedtls_mpi_free( &W[1] ); mbedtls_mpi_free( &T ); mbedtls_mpi_free( &Apos );
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01002232 mbedtls_mpi_free( &WW );
Paul Bakker6c591fa2011-05-05 11:49:20 +00002233
Yuto Takano538a0cb2021-07-14 10:20:09 +01002234 if( prec_RR == NULL || prec_RR->p == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002235 mbedtls_mpi_free( &RR );
Paul Bakker5121ce52009-01-03 21:22:43 +00002236
2237 return( ret );
2238}
2239
Paul Bakker5121ce52009-01-03 21:22:43 +00002240/*
2241 * Greatest common divisor: G = gcd(A, B) (HAC 14.54)
2242 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002243int mbedtls_mpi_gcd( mbedtls_mpi *G, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00002244{
Janos Follath24eed8d2019-11-22 13:21:35 +00002245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002246 size_t lz, lzt;
Alexander Ke8ad49f2019-08-16 16:16:07 +03002247 mbedtls_mpi TA, TB;
Paul Bakker5121ce52009-01-03 21:22:43 +00002248
Hanno Becker73d7d792018-12-11 10:35:51 +00002249 MPI_VALIDATE_RET( G != NULL );
2250 MPI_VALIDATE_RET( A != NULL );
2251 MPI_VALIDATE_RET( B != NULL );
2252
Alexander Ke8ad49f2019-08-16 16:16:07 +03002253 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00002254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TA, A ) );
2256 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002257
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002258 lz = mbedtls_mpi_lsb( &TA );
2259 lzt = mbedtls_mpi_lsb( &TB );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002260
Gilles Peskine27253bc2021-06-09 13:26:43 +02002261 /* The loop below gives the correct result when A==0 but not when B==0.
2262 * So have a special case for B==0. Leverage the fact that we just
2263 * calculated the lsb and lsb(B)==0 iff B is odd or 0 to make the test
2264 * slightly more efficient than cmp_int(). */
2265 if( lzt == 0 && mbedtls_mpi_get_bit( &TB, 0 ) == 0 )
2266 {
2267 ret = mbedtls_mpi_copy( G, A );
2268 goto cleanup;
2269 }
2270
Paul Bakker66d5d072014-06-17 16:39:18 +02002271 if( lzt < lz )
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002272 lz = lzt;
2273
Paul Bakker5121ce52009-01-03 21:22:43 +00002274 TA.s = TB.s = 1;
2275
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002276 /* We mostly follow the procedure described in HAC 14.54, but with some
2277 * minor differences:
2278 * - Sequences of multiplications or divisions by 2 are grouped into a
2279 * single shift operation.
Gilles Peskineb09c7ee2021-06-21 18:58:39 +02002280 * - The procedure in HAC assumes that 0 < TB <= TA.
2281 * - The condition TB <= TA is not actually necessary for correctness.
2282 * TA and TB have symmetric roles except for the loop termination
2283 * condition, and the shifts at the beginning of the loop body
2284 * remove any significance from the ordering of TA vs TB before
2285 * the shifts.
2286 * - If TA = 0, the loop goes through 0 iterations and the result is
2287 * correctly TB.
2288 * - The case TB = 0 was short-circuited above.
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002289 *
2290 * For the correctness proof below, decompose the original values of
2291 * A and B as
2292 * A = sa * 2^a * A' with A'=0 or A' odd, and sa = +-1
2293 * B = sb * 2^b * B' with B'=0 or B' odd, and sb = +-1
2294 * Then gcd(A, B) = 2^{min(a,b)} * gcd(A',B'),
2295 * and gcd(A',B') is odd or 0.
2296 *
2297 * At the beginning, we have TA = |A| and TB = |B| so gcd(A,B) = gcd(TA,TB).
2298 * The code maintains the following invariant:
2299 * gcd(A,B) = 2^k * gcd(TA,TB) for some k (I)
Gilles Peskine4df3f1f2021-06-15 22:09:39 +02002300 */
2301
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002302 /* Proof that the loop terminates:
2303 * At each iteration, either the right-shift by 1 is made on a nonzero
2304 * value and the nonnegative integer bitlen(TA) + bitlen(TB) decreases
2305 * by at least 1, or the right-shift by 1 is made on zero and then
2306 * TA becomes 0 which ends the loop (TB cannot be 0 if it is right-shifted
2307 * since in that case TB is calculated from TB-TA with the condition TB>TA).
2308 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002309 while( mbedtls_mpi_cmp_int( &TA, 0 ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002310 {
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002311 /* Divisions by 2 preserve the invariant (I). */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TA, mbedtls_mpi_lsb( &TA ) ) );
2313 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TB, mbedtls_mpi_lsb( &TB ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002314
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002315 /* Set either TA or TB to |TA-TB|/2. Since TA and TB are both odd,
2316 * TA-TB is even so the division by 2 has an integer result.
2317 * Invariant (I) is preserved since any odd divisor of both TA and TB
2318 * also divides |TA-TB|/2, and any odd divisor of both TA and |TA-TB|/2
2319 * also divides TB, and any odd divisior of both TB and |TA-TB|/2 also
2320 * divides TA.
2321 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322 if( mbedtls_mpi_cmp_mpi( &TA, &TB ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002323 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( &TA, &TA, &TB ) );
2325 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TA, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002326 }
2327 else
2328 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002329 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( &TB, &TB, &TA ) );
2330 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TB, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002331 }
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002332 /* Note that one of TA or TB is still odd. */
Paul Bakker5121ce52009-01-03 21:22:43 +00002333 }
2334
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002335 /* By invariant (I), gcd(A,B) = 2^k * gcd(TA,TB) for some k.
2336 * At the loop exit, TA = 0, so gcd(TA,TB) = TB.
2337 * - If there was at least one loop iteration, then one of TA or TB is odd,
2338 * and TA = 0, so TB is odd and gcd(TA,TB) = gcd(A',B'). In this case,
2339 * lz = min(a,b) so gcd(A,B) = 2^lz * TB.
2340 * - If there was no loop iteration, then A was 0, and gcd(A,B) = B.
Gilles Peskine4d3fd362021-06-21 11:40:38 +02002341 * In this case, lz = 0 and B = TB so gcd(A,B) = B = 2^lz * TB as well.
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002342 */
2343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &TB, lz ) );
2345 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( G, &TB ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002346
2347cleanup:
2348
Alexander Ke8ad49f2019-08-16 16:16:07 +03002349 mbedtls_mpi_free( &TA ); mbedtls_mpi_free( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00002350
2351 return( ret );
2352}
2353
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002354/* Fill X with n_bytes random bytes.
2355 * X must already have room for those bytes.
Gilles Peskineafb2bd22021-06-03 11:51:09 +02002356 * The ordering of the bytes returned from the RNG is suitable for
2357 * deterministic ECDSA (see RFC 6979 §3.3 and mbedtls_mpi_random()).
Gilles Peskineebe9b6a2021-04-13 21:55:35 +02002358 * The size and sign of X are unchanged.
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002359 * n_bytes must not be 0.
2360 */
2361static int mpi_fill_random_internal(
2362 mbedtls_mpi *X, size_t n_bytes,
2363 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng )
2364{
2365 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2366 const size_t limbs = CHARS_TO_LIMBS( n_bytes );
2367 const size_t overhead = ( limbs * ciL ) - n_bytes;
2368
2369 if( X->n < limbs )
2370 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002371
Gilles Peskineebe9b6a2021-04-13 21:55:35 +02002372 memset( X->p, 0, overhead );
2373 memset( (unsigned char *) X->p + limbs * ciL, 0, ( X->n - limbs ) * ciL );
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002374 MBEDTLS_MPI_CHK( f_rng( p_rng, (unsigned char *) X->p + overhead, n_bytes ) );
2375 mpi_bigendian_to_host( X->p, limbs );
2376
2377cleanup:
2378 return( ret );
2379}
2380
Paul Bakker33dc46b2014-04-30 16:11:39 +02002381/*
2382 * Fill X with size bytes of random.
2383 *
2384 * Use a temporary bytes representation to make sure the result is the same
Paul Bakkerc37b0ac2014-05-01 14:19:23 +02002385 * regardless of the platform endianness (useful when f_rng is actually
Paul Bakker33dc46b2014-04-30 16:11:39 +02002386 * deterministic, eg for tests).
2387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002388int mbedtls_mpi_fill_random( mbedtls_mpi *X, size_t size,
Paul Bakkera3d195c2011-11-27 21:07:34 +00002389 int (*f_rng)(void *, unsigned char *, size_t),
2390 void *p_rng )
Paul Bakker287781a2011-03-26 13:18:49 +00002391{
Janos Follath24eed8d2019-11-22 13:21:35 +00002392 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker6dab6202019-01-02 16:42:29 +00002393 size_t const limbs = CHARS_TO_LIMBS( size );
Hanno Beckerda1655a2017-10-18 14:21:44 +01002394
Hanno Becker8ce11a32018-12-19 16:18:52 +00002395 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002396 MPI_VALIDATE_RET( f_rng != NULL );
Paul Bakker33dc46b2014-04-30 16:11:39 +02002397
Hanno Beckerda1655a2017-10-18 14:21:44 +01002398 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskineed32b572021-06-02 22:17:52 +02002399 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002400 if( size == 0 )
2401 return( 0 );
Paul Bakker287781a2011-03-26 13:18:49 +00002402
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002403 ret = mpi_fill_random_internal( X, size, f_rng, p_rng );
Paul Bakker287781a2011-03-26 13:18:49 +00002404
2405cleanup:
2406 return( ret );
2407}
2408
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002409int mbedtls_mpi_random( mbedtls_mpi *X,
2410 mbedtls_mpi_sint min,
2411 const mbedtls_mpi *N,
2412 int (*f_rng)(void *, unsigned char *, size_t),
2413 void *p_rng )
2414{
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002415 int ret = MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
Gilles Peskinee5381682021-04-13 21:23:25 +02002416 int count;
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002417 unsigned lt_lower = 1, lt_upper = 0;
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002418 size_t n_bits = mbedtls_mpi_bitlen( N );
2419 size_t n_bytes = ( n_bits + 7 ) / 8;
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002420 mbedtls_mpi lower_bound;
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002421
Gilles Peskine1e918f42021-03-29 22:14:51 +02002422 if( min < 0 )
2423 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
2424 if( mbedtls_mpi_cmp_int( N, min ) <= 0 )
2425 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
2426
Gilles Peskinee5381682021-04-13 21:23:25 +02002427 /*
2428 * When min == 0, each try has at worst a probability 1/2 of failing
2429 * (the msb has a probability 1/2 of being 0, and then the result will
2430 * be < N), so after 30 tries failure probability is a most 2**(-30).
2431 *
2432 * When N is just below a power of 2, as is the case when generating
Gilles Peskinee842e582021-04-15 11:45:19 +02002433 * a random scalar on most elliptic curves, 1 try is enough with
Gilles Peskinee5381682021-04-13 21:23:25 +02002434 * overwhelming probability. When N is just above a power of 2,
Gilles Peskinee842e582021-04-15 11:45:19 +02002435 * as when generating a random scalar on secp224k1, each try has
Gilles Peskinee5381682021-04-13 21:23:25 +02002436 * a probability of failing that is almost 1/2.
2437 *
2438 * The probabilities are almost the same if min is nonzero but negligible
2439 * compared to N. This is always the case when N is crypto-sized, but
2440 * it's convenient to support small N for testing purposes. When N
2441 * is small, use a higher repeat count, otherwise the probability of
2442 * failure is macroscopic.
2443 */
Gilles Peskine87823d72021-06-02 21:18:59 +02002444 count = ( n_bytes > 4 ? 30 : 250 );
Gilles Peskinee5381682021-04-13 21:23:25 +02002445
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002446 mbedtls_mpi_init( &lower_bound );
2447
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002448 /* Ensure that target MPI has exactly the same number of limbs
2449 * as the upper bound, even if the upper bound has leading zeros.
2450 * This is necessary for the mbedtls_mpi_lt_mpi_ct() check. */
Gilles Peskineed32b572021-06-02 22:17:52 +02002451 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, N->n ) );
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002452 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &lower_bound, N->n ) );
2453 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &lower_bound, min ) );
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002454
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002455 /*
2456 * Match the procedure given in RFC 6979 §3.3 (deterministic ECDSA)
2457 * when f_rng is a suitably parametrized instance of HMAC_DRBG:
2458 * - use the same byte ordering;
2459 * - keep the leftmost n_bits bits of the generated octet string;
2460 * - try until result is in the desired range.
2461 * This also avoids any bias, which is especially important for ECDSA.
2462 */
2463 do
2464 {
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002465 MBEDTLS_MPI_CHK( mpi_fill_random_internal( X, n_bytes, f_rng, p_rng ) );
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002466 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( X, 8 * n_bytes - n_bits ) );
2467
Gilles Peskinee5381682021-04-13 21:23:25 +02002468 if( --count == 0 )
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002469 {
2470 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
2471 goto cleanup;
2472 }
2473
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002474 MBEDTLS_MPI_CHK( mbedtls_mpi_lt_mpi_ct( X, &lower_bound, &lt_lower ) );
2475 MBEDTLS_MPI_CHK( mbedtls_mpi_lt_mpi_ct( X, N, &lt_upper ) );
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002476 }
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002477 while( lt_lower != 0 || lt_upper == 0 );
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002478
2479cleanup:
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002480 mbedtls_mpi_free( &lower_bound );
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002481 return( ret );
2482}
2483
Paul Bakker5121ce52009-01-03 21:22:43 +00002484/*
2485 * Modular inverse: X = A^-1 mod N (HAC 14.61 / 14.64)
2486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002487int mbedtls_mpi_inv_mod( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *N )
Paul Bakker5121ce52009-01-03 21:22:43 +00002488{
Janos Follath24eed8d2019-11-22 13:21:35 +00002489 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002490 mbedtls_mpi G, TA, TU, U1, U2, TB, TV, V1, V2;
Hanno Becker73d7d792018-12-11 10:35:51 +00002491 MPI_VALIDATE_RET( X != NULL );
2492 MPI_VALIDATE_RET( A != NULL );
2493 MPI_VALIDATE_RET( N != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00002494
Hanno Becker4bcb4912017-04-18 15:49:39 +01002495 if( mbedtls_mpi_cmp_int( N, 1 ) <= 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00002497
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TU ); mbedtls_mpi_init( &U1 ); mbedtls_mpi_init( &U2 );
2499 mbedtls_mpi_init( &G ); mbedtls_mpi_init( &TB ); mbedtls_mpi_init( &TV );
2500 mbedtls_mpi_init( &V1 ); mbedtls_mpi_init( &V2 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002501
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502 MBEDTLS_MPI_CHK( mbedtls_mpi_gcd( &G, A, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002503
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002504 if( mbedtls_mpi_cmp_int( &G, 1 ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002505 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker5121ce52009-01-03 21:22:43 +00002507 goto cleanup;
2508 }
2509
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002510 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &TA, A, N ) );
2511 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TU, &TA ) );
2512 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, N ) );
2513 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TV, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002514
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &U1, 1 ) );
2516 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &U2, 0 ) );
2517 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &V1, 0 ) );
2518 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &V2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002519
2520 do
2521 {
2522 while( ( TU.p[0] & 1 ) == 0 )
2523 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TU, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002525
2526 if( ( U1.p[0] & 1 ) != 0 || ( U2.p[0] & 1 ) != 0 )
2527 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002528 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &U1, &U1, &TB ) );
2529 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U2, &U2, &TA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002530 }
2531
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &U1, 1 ) );
2533 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &U2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002534 }
2535
2536 while( ( TV.p[0] & 1 ) == 0 )
2537 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TV, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002539
2540 if( ( V1.p[0] & 1 ) != 0 || ( V2.p[0] & 1 ) != 0 )
2541 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &V1, &V1, &TB ) );
2543 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V2, &V2, &TA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002544 }
2545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &V1, 1 ) );
2547 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &V2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002548 }
2549
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002550 if( mbedtls_mpi_cmp_mpi( &TU, &TV ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002551 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &TU, &TU, &TV ) );
2553 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U1, &U1, &V1 ) );
2554 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U2, &U2, &V2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002555 }
2556 else
2557 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002558 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &TV, &TV, &TU ) );
2559 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V1, &V1, &U1 ) );
2560 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V2, &V2, &U2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002561 }
2562 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563 while( mbedtls_mpi_cmp_int( &TU, 0 ) != 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565 while( mbedtls_mpi_cmp_int( &V1, 0 ) < 0 )
2566 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &V1, &V1, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002567
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568 while( mbedtls_mpi_cmp_mpi( &V1, N ) >= 0 )
2569 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V1, &V1, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, &V1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002572
2573cleanup:
2574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575 mbedtls_mpi_free( &TA ); mbedtls_mpi_free( &TU ); mbedtls_mpi_free( &U1 ); mbedtls_mpi_free( &U2 );
2576 mbedtls_mpi_free( &G ); mbedtls_mpi_free( &TB ); mbedtls_mpi_free( &TV );
2577 mbedtls_mpi_free( &V1 ); mbedtls_mpi_free( &V2 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002578
2579 return( ret );
2580}
2581
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002582#if defined(MBEDTLS_GENPRIME)
Paul Bakkerd9374b02012-11-02 11:02:58 +00002583
Paul Bakker5121ce52009-01-03 21:22:43 +00002584static const int small_prime[] =
2585{
2586 3, 5, 7, 11, 13, 17, 19, 23,
2587 29, 31, 37, 41, 43, 47, 53, 59,
2588 61, 67, 71, 73, 79, 83, 89, 97,
2589 101, 103, 107, 109, 113, 127, 131, 137,
2590 139, 149, 151, 157, 163, 167, 173, 179,
2591 181, 191, 193, 197, 199, 211, 223, 227,
2592 229, 233, 239, 241, 251, 257, 263, 269,
2593 271, 277, 281, 283, 293, 307, 311, 313,
2594 317, 331, 337, 347, 349, 353, 359, 367,
2595 373, 379, 383, 389, 397, 401, 409, 419,
2596 421, 431, 433, 439, 443, 449, 457, 461,
2597 463, 467, 479, 487, 491, 499, 503, 509,
2598 521, 523, 541, 547, 557, 563, 569, 571,
2599 577, 587, 593, 599, 601, 607, 613, 617,
2600 619, 631, 641, 643, 647, 653, 659, 661,
2601 673, 677, 683, 691, 701, 709, 719, 727,
2602 733, 739, 743, 751, 757, 761, 769, 773,
2603 787, 797, 809, 811, 821, 823, 827, 829,
2604 839, 853, 857, 859, 863, 877, 881, 883,
2605 887, 907, 911, 919, 929, 937, 941, 947,
2606 953, 967, 971, 977, 983, 991, 997, -103
2607};
2608
2609/*
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002610 * Small divisors test (X must be positive)
2611 *
2612 * Return values:
2613 * 0: no small factor (possible prime, more tests needed)
2614 * 1: certain prime
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615 * MBEDTLS_ERR_MPI_NOT_ACCEPTABLE: certain non-prime
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002616 * other negative: error
Paul Bakker5121ce52009-01-03 21:22:43 +00002617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618static int mpi_check_small_factors( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +00002619{
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002620 int ret = 0;
2621 size_t i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622 mbedtls_mpi_uint r;
Paul Bakker5121ce52009-01-03 21:22:43 +00002623
Paul Bakker5121ce52009-01-03 21:22:43 +00002624 if( ( X->p[0] & 1 ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002625 return( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE );
Paul Bakker5121ce52009-01-03 21:22:43 +00002626
2627 for( i = 0; small_prime[i] > 0; i++ )
2628 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629 if( mbedtls_mpi_cmp_int( X, small_prime[i] ) <= 0 )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002630 return( 1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002632 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, small_prime[i] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002633
2634 if( r == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002635 return( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE );
Paul Bakker5121ce52009-01-03 21:22:43 +00002636 }
2637
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002638cleanup:
2639 return( ret );
2640}
2641
2642/*
2643 * Miller-Rabin pseudo-primality test (HAC 4.24)
2644 */
Janos Follathda31fa12018-09-03 14:45:23 +01002645static int mpi_miller_rabin( const mbedtls_mpi *X, size_t rounds,
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002646 int (*f_rng)(void *, unsigned char *, size_t),
2647 void *p_rng )
2648{
Pascal Junodb99183d2015-03-11 16:49:45 +01002649 int ret, count;
Janos Follathda31fa12018-09-03 14:45:23 +01002650 size_t i, j, k, s;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002651 mbedtls_mpi W, R, T, A, RR;
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002652
Hanno Becker8ce11a32018-12-19 16:18:52 +00002653 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002654 MPI_VALIDATE_RET( f_rng != NULL );
2655
2656 mbedtls_mpi_init( &W ); mbedtls_mpi_init( &R );
2657 mbedtls_mpi_init( &T ); mbedtls_mpi_init( &A );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658 mbedtls_mpi_init( &RR );
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002659
Paul Bakker5121ce52009-01-03 21:22:43 +00002660 /*
2661 * W = |X| - 1
2662 * R = W >> lsb( W )
2663 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_int( &W, X, 1 ) );
2665 s = mbedtls_mpi_lsb( &W );
2666 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &R, &W ) );
2667 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &R, s ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002668
Janos Follathda31fa12018-09-03 14:45:23 +01002669 for( i = 0; i < rounds; i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00002670 {
2671 /*
2672 * pick a random A, 1 < A < |X| - 1
2673 */
Pascal Junodb99183d2015-03-11 16:49:45 +01002674 count = 0;
2675 do {
Manuel Pégourié-Gonnard53c76c02015-04-17 20:15:36 +02002676 MBEDTLS_MPI_CHK( mbedtls_mpi_fill_random( &A, X->n * ciL, f_rng, p_rng ) );
Pascal Junodb99183d2015-03-11 16:49:45 +01002677
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02002678 j = mbedtls_mpi_bitlen( &A );
2679 k = mbedtls_mpi_bitlen( &W );
Pascal Junodb99183d2015-03-11 16:49:45 +01002680 if (j > k) {
Darryl Greene3f95ed2018-10-02 13:21:35 +01002681 A.p[A.n - 1] &= ( (mbedtls_mpi_uint) 1 << ( k - ( A.n - 1 ) * biL - 1 ) ) - 1;
Pascal Junodb99183d2015-03-11 16:49:45 +01002682 }
2683
2684 if (count++ > 30) {
Jens Wiklanderf08aa3e2019-01-17 13:30:57 +01002685 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
2686 goto cleanup;
Pascal Junodb99183d2015-03-11 16:49:45 +01002687 }
2688
Manuel Pégourié-Gonnard53c76c02015-04-17 20:15:36 +02002689 } while ( mbedtls_mpi_cmp_mpi( &A, &W ) >= 0 ||
2690 mbedtls_mpi_cmp_int( &A, 1 ) <= 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002691
2692 /*
2693 * A = A^R mod |X|
2694 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695 MBEDTLS_MPI_CHK( mbedtls_mpi_exp_mod( &A, &A, &R, X, &RR ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002697 if( mbedtls_mpi_cmp_mpi( &A, &W ) == 0 ||
2698 mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002699 continue;
2700
2701 j = 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702 while( j < s && mbedtls_mpi_cmp_mpi( &A, &W ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002703 {
2704 /*
2705 * A = A * A mod |X|
2706 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_mpi( &T, &A, &A ) );
2708 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &A, &T, X ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002710 if( mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002711 break;
2712
2713 j++;
2714 }
2715
2716 /*
2717 * not prime if A != |X| - 1 or A == 1
2718 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719 if( mbedtls_mpi_cmp_mpi( &A, &W ) != 0 ||
2720 mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002721 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002722 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker5121ce52009-01-03 21:22:43 +00002723 break;
2724 }
2725 }
2726
2727cleanup:
Hanno Becker73d7d792018-12-11 10:35:51 +00002728 mbedtls_mpi_free( &W ); mbedtls_mpi_free( &R );
2729 mbedtls_mpi_free( &T ); mbedtls_mpi_free( &A );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730 mbedtls_mpi_free( &RR );
Paul Bakker5121ce52009-01-03 21:22:43 +00002731
2732 return( ret );
2733}
2734
2735/*
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002736 * Pseudo-primality test: small factors, then Miller-Rabin
2737 */
Janos Follatha0b67c22018-09-18 14:48:23 +01002738int mbedtls_mpi_is_prime_ext( const mbedtls_mpi *X, int rounds,
2739 int (*f_rng)(void *, unsigned char *, size_t),
2740 void *p_rng )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002741{
Janos Follath24eed8d2019-11-22 13:21:35 +00002742 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743 mbedtls_mpi XX;
Hanno Becker8ce11a32018-12-19 16:18:52 +00002744 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002745 MPI_VALIDATE_RET( f_rng != NULL );
Manuel Pégourié-Gonnard7f4ed672014-10-14 20:56:02 +02002746
2747 XX.s = 1;
2748 XX.n = X->n;
2749 XX.p = X->p;
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002751 if( mbedtls_mpi_cmp_int( &XX, 0 ) == 0 ||
2752 mbedtls_mpi_cmp_int( &XX, 1 ) == 0 )
2753 return( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE );
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002754
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002755 if( mbedtls_mpi_cmp_int( &XX, 2 ) == 0 )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002756 return( 0 );
2757
2758 if( ( ret = mpi_check_small_factors( &XX ) ) != 0 )
2759 {
2760 if( ret == 1 )
2761 return( 0 );
2762
2763 return( ret );
2764 }
2765
Janos Follathda31fa12018-09-03 14:45:23 +01002766 return( mpi_miller_rabin( &XX, rounds, f_rng, p_rng ) );
Janos Follathf301d232018-08-14 13:34:01 +01002767}
2768
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002769/*
Paul Bakker5121ce52009-01-03 21:22:43 +00002770 * Prime number generation
Jethro Beekman66689272018-02-14 19:24:10 -08002771 *
Janos Follathf301d232018-08-14 13:34:01 +01002772 * To generate an RSA key in a way recommended by FIPS 186-4, both primes must
2773 * be either 1024 bits or 1536 bits long, and flags must contain
2774 * MBEDTLS_MPI_GEN_PRIME_FLAG_LOW_ERR.
Paul Bakker5121ce52009-01-03 21:22:43 +00002775 */
Janos Follath7c025a92018-08-14 11:08:41 +01002776int mbedtls_mpi_gen_prime( mbedtls_mpi *X, size_t nbits, int flags,
Paul Bakkera3d195c2011-11-27 21:07:34 +00002777 int (*f_rng)(void *, unsigned char *, size_t),
2778 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +00002779{
Jethro Beekman66689272018-02-14 19:24:10 -08002780#ifdef MBEDTLS_HAVE_INT64
2781// ceil(2^63.5)
2782#define CEIL_MAXUINT_DIV_SQRT2 0xb504f333f9de6485ULL
2783#else
2784// ceil(2^31.5)
2785#define CEIL_MAXUINT_DIV_SQRT2 0xb504f334U
2786#endif
2787 int ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker23986e52011-04-24 08:57:21 +00002788 size_t k, n;
Janos Follathda31fa12018-09-03 14:45:23 +01002789 int rounds;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002790 mbedtls_mpi_uint r;
2791 mbedtls_mpi Y;
Paul Bakker5121ce52009-01-03 21:22:43 +00002792
Hanno Becker8ce11a32018-12-19 16:18:52 +00002793 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002794 MPI_VALIDATE_RET( f_rng != NULL );
2795
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796 if( nbits < 3 || nbits > MBEDTLS_MPI_MAX_BITS )
2797 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00002798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002799 mbedtls_mpi_init( &Y );
Paul Bakker5121ce52009-01-03 21:22:43 +00002800
2801 n = BITS_TO_LIMBS( nbits );
2802
Janos Follathda31fa12018-09-03 14:45:23 +01002803 if( ( flags & MBEDTLS_MPI_GEN_PRIME_FLAG_LOW_ERR ) == 0 )
2804 {
2805 /*
2806 * 2^-80 error probability, number of rounds chosen per HAC, table 4.4
2807 */
2808 rounds = ( ( nbits >= 1300 ) ? 2 : ( nbits >= 850 ) ? 3 :
2809 ( nbits >= 650 ) ? 4 : ( nbits >= 350 ) ? 8 :
2810 ( nbits >= 250 ) ? 12 : ( nbits >= 150 ) ? 18 : 27 );
2811 }
2812 else
2813 {
2814 /*
2815 * 2^-100 error probability, number of rounds computed based on HAC,
2816 * fact 4.48
2817 */
2818 rounds = ( ( nbits >= 1450 ) ? 4 : ( nbits >= 1150 ) ? 5 :
2819 ( nbits >= 1000 ) ? 6 : ( nbits >= 850 ) ? 7 :
2820 ( nbits >= 750 ) ? 8 : ( nbits >= 500 ) ? 13 :
2821 ( nbits >= 250 ) ? 28 : ( nbits >= 150 ) ? 40 : 51 );
2822 }
2823
Jethro Beekman66689272018-02-14 19:24:10 -08002824 while( 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002825 {
Jethro Beekman66689272018-02-14 19:24:10 -08002826 MBEDTLS_MPI_CHK( mbedtls_mpi_fill_random( X, n * ciL, f_rng, p_rng ) );
2827 /* make sure generated number is at least (nbits-1)+0.5 bits (FIPS 186-4 §B.3.3 steps 4.4, 5.5) */
2828 if( X->p[n-1] < CEIL_MAXUINT_DIV_SQRT2 ) continue;
2829
2830 k = n * biL;
2831 if( k > nbits ) MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( X, k - nbits ) );
2832 X->p[0] |= 1;
2833
Janos Follath7c025a92018-08-14 11:08:41 +01002834 if( ( flags & MBEDTLS_MPI_GEN_PRIME_FLAG_DH ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002835 {
Janos Follatha0b67c22018-09-18 14:48:23 +01002836 ret = mbedtls_mpi_is_prime_ext( X, rounds, f_rng, p_rng );
Jethro Beekman66689272018-02-14 19:24:10 -08002837
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002838 if( ret != MBEDTLS_ERR_MPI_NOT_ACCEPTABLE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002839 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002840 }
Jethro Beekman66689272018-02-14 19:24:10 -08002841 else
Paul Bakker5121ce52009-01-03 21:22:43 +00002842 {
Manuel Pégourié-Gonnardddf76152013-11-22 19:58:22 +01002843 /*
Jethro Beekman66689272018-02-14 19:24:10 -08002844 * An necessary condition for Y and X = 2Y + 1 to be prime
2845 * is X = 2 mod 3 (which is equivalent to Y = 2 mod 3).
2846 * Make sure it is satisfied, while keeping X = 3 mod 4
Manuel Pégourié-Gonnardddf76152013-11-22 19:58:22 +01002847 */
Jethro Beekman66689272018-02-14 19:24:10 -08002848
2849 X->p[0] |= 2;
2850
2851 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, 3 ) );
2852 if( r == 0 )
2853 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 8 ) );
2854 else if( r == 1 )
2855 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 4 ) );
2856
2857 /* Set Y = (X-1) / 2, which is X / 2 because X is odd */
2858 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Y, X ) );
2859 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &Y, 1 ) );
2860
2861 while( 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002862 {
Jethro Beekman66689272018-02-14 19:24:10 -08002863 /*
2864 * First, check small factors for X and Y
2865 * before doing Miller-Rabin on any of them
2866 */
2867 if( ( ret = mpi_check_small_factors( X ) ) == 0 &&
2868 ( ret = mpi_check_small_factors( &Y ) ) == 0 &&
Janos Follathda31fa12018-09-03 14:45:23 +01002869 ( ret = mpi_miller_rabin( X, rounds, f_rng, p_rng ) )
Janos Follathf301d232018-08-14 13:34:01 +01002870 == 0 &&
Janos Follathda31fa12018-09-03 14:45:23 +01002871 ( ret = mpi_miller_rabin( &Y, rounds, f_rng, p_rng ) )
Janos Follathf301d232018-08-14 13:34:01 +01002872 == 0 )
Jethro Beekman66689272018-02-14 19:24:10 -08002873 goto cleanup;
2874
2875 if( ret != MBEDTLS_ERR_MPI_NOT_ACCEPTABLE )
2876 goto cleanup;
2877
2878 /*
2879 * Next candidates. We want to preserve Y = (X-1) / 2 and
2880 * Y = 1 mod 2 and Y = 2 mod 3 (eq X = 3 mod 4 and X = 2 mod 3)
2881 * so up Y by 6 and X by 12.
2882 */
2883 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 12 ) );
2884 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( &Y, &Y, 6 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002885 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002886 }
2887 }
2888
2889cleanup:
2890
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891 mbedtls_mpi_free( &Y );
Paul Bakker5121ce52009-01-03 21:22:43 +00002892
2893 return( ret );
2894}
2895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896#endif /* MBEDTLS_GENPRIME */
Paul Bakker5121ce52009-01-03 21:22:43 +00002897
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898#if defined(MBEDTLS_SELF_TEST)
Paul Bakker5121ce52009-01-03 21:22:43 +00002899
Paul Bakker23986e52011-04-24 08:57:21 +00002900#define GCD_PAIR_COUNT 3
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002901
2902static const int gcd_pairs[GCD_PAIR_COUNT][3] =
2903{
2904 { 693, 609, 21 },
2905 { 1764, 868, 28 },
2906 { 768454923, 542167814, 1 }
2907};
2908
Paul Bakker5121ce52009-01-03 21:22:43 +00002909/*
2910 * Checkup routine
2911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912int mbedtls_mpi_self_test( int verbose )
Paul Bakker5121ce52009-01-03 21:22:43 +00002913{
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002914 int ret, i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915 mbedtls_mpi A, E, N, X, Y, U, V;
Paul Bakker5121ce52009-01-03 21:22:43 +00002916
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002917 mbedtls_mpi_init( &A ); mbedtls_mpi_init( &E ); mbedtls_mpi_init( &N ); mbedtls_mpi_init( &X );
2918 mbedtls_mpi_init( &Y ); mbedtls_mpi_init( &U ); mbedtls_mpi_init( &V );
Paul Bakker5121ce52009-01-03 21:22:43 +00002919
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002920 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &A, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002921 "EFE021C2645FD1DC586E69184AF4A31E" \
2922 "D5F53E93B5F123FA41680867BA110131" \
2923 "944FE7952E2517337780CB0DB80E61AA" \
2924 "E7C8DDC6C5C6AADEB34EB38A2F40D5E6" ) );
2925
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002926 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &E, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002927 "B2E7EFD37075B9F03FF989C7C5051C20" \
2928 "34D2A323810251127E7BF8625A4F49A5" \
2929 "F3E27F4DA8BD59C47D6DAABA4C8127BD" \
2930 "5B5C25763222FEFCCFC38B832366C29E" ) );
2931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &N, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002933 "0066A198186C18C10B2F5ED9B522752A" \
2934 "9830B69916E535C8F047518A889A43A5" \
2935 "94B6BED27A168D31D4A52F88925AA8F5" ) );
2936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002937 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_mpi( &X, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002938
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002940 "602AB7ECA597A3D6B56FF9829A5E8B85" \
2941 "9E857EA95A03512E2BAE7391688D264A" \
2942 "A5663B0341DB9CCFD2C4C5F421FEC814" \
2943 "8001B72E848A38CAE1C65F78E56ABDEF" \
2944 "E12D3C039B8A02D6BE593F0BBBDA56F1" \
2945 "ECF677152EF804370C1A305CAF3B5BF1" \
2946 "30879B56C61DE584A0F53A2447A51E" ) );
2947
2948 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002949 mbedtls_printf( " MPI test #1 (mul_mpi): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00002950
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002952 {
2953 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002955
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01002956 ret = 1;
2957 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002958 }
2959
2960 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002961 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002962
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963 MBEDTLS_MPI_CHK( mbedtls_mpi_div_mpi( &X, &Y, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002964
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002966 "256567336059E52CAE22925474705F39A94" ) );
2967
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &V, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002969 "6613F26162223DF488E9CD48CC132C7A" \
2970 "0AC93C701B001B092E4E5B9F73BCD27B" \
2971 "9EE50D0657C77F374E903CDFA4C642" ) );
2972
2973 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974 mbedtls_printf( " MPI test #2 (div_mpi): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00002975
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 ||
2977 mbedtls_mpi_cmp_mpi( &Y, &V ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002978 {
2979 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002981
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01002982 ret = 1;
2983 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002984 }
2985
2986 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002988
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 MBEDTLS_MPI_CHK( mbedtls_mpi_exp_mod( &X, &A, &E, &N, NULL ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002992 "36E139AEA55215609D2816998ED020BB" \
2993 "BD96C37890F65171D948E9BC7CBAA4D9" \
2994 "325D24D6A3C12710F10A09FA08AB87" ) );
2995
2996 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997 mbedtls_printf( " MPI test #3 (exp_mod): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00002998
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002999 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003000 {
3001 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003003
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003004 ret = 1;
3005 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00003006 }
3007
3008 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003010
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003011 MBEDTLS_MPI_CHK( mbedtls_mpi_inv_mod( &X, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00003014 "003A0AAEDD7E784FC07D8F9EC6E3BFD5" \
3015 "C3DBA76456363A10869622EAC2DD84EC" \
3016 "C5B8A74DAC4D09E03B5E0BE779F2DF61" ) );
3017
3018 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019 mbedtls_printf( " MPI test #4 (inv_mod): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00003020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003021 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003022 {
3023 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003024 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003025
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003026 ret = 1;
3027 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00003028 }
3029
3030 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003032
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003033 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034 mbedtls_printf( " MPI test #5 (simple gcd): " );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003035
Paul Bakker66d5d072014-06-17 16:39:18 +02003036 for( i = 0; i < GCD_PAIR_COUNT; i++ )
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003037 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003038 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &X, gcd_pairs[i][0] ) );
3039 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &Y, gcd_pairs[i][1] ) );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041 MBEDTLS_MPI_CHK( mbedtls_mpi_gcd( &A, &X, &Y ) );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043 if( mbedtls_mpi_cmp_int( &A, gcd_pairs[i][2] ) != 0 )
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003044 {
3045 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046 mbedtls_printf( "failed at %d\n", i );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003047
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003048 ret = 1;
3049 goto cleanup;
3050 }
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003051 }
3052
3053 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054 mbedtls_printf( "passed\n" );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003055
Paul Bakker5121ce52009-01-03 21:22:43 +00003056cleanup:
3057
3058 if( ret != 0 && verbose != 0 )
Kenneth Soerensen518d4352020-04-01 17:22:45 +02003059 mbedtls_printf( "Unexpected error, return code = %08X\n", (unsigned int) ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00003060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061 mbedtls_mpi_free( &A ); mbedtls_mpi_free( &E ); mbedtls_mpi_free( &N ); mbedtls_mpi_free( &X );
3062 mbedtls_mpi_free( &Y ); mbedtls_mpi_free( &U ); mbedtls_mpi_free( &V );
Paul Bakker5121ce52009-01-03 21:22:43 +00003063
3064 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065 mbedtls_printf( "\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003066
3067 return( ret );
3068}
3069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003070#endif /* MBEDTLS_SELF_TEST */
Paul Bakker5121ce52009-01-03 21:22:43 +00003071
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072#endif /* MBEDTLS_BIGNUM_C */