blob: a8f8f84be4f6d04fff6ae0ee235c638295443013 [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 Mezei22c9a6f2021-10-20 12:09:35 +020044#include "constant_time_internal.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000045
Dave Rodgman351c71b2021-12-06 17:50:53 +000046#include <limits.h>
Rich Evans00ab4702015-02-06 13:43:58 +000047#include <string.h>
48
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020049#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000050#include "mbedtls/platform.h"
Paul Bakker6e339b52013-07-03 13:37:05 +020051#else
Rich Evans00ab4702015-02-06 13:43:58 +000052#include <stdio.h>
53#include <stdlib.h>
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020054#define mbedtls_printf printf
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +020055#define mbedtls_calloc calloc
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020056#define mbedtls_free free
Paul Bakker6e339b52013-07-03 13:37:05 +020057#endif
58
Hanno Becker73d7d792018-12-11 10:35:51 +000059#define MPI_VALIDATE_RET( cond ) \
60 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA )
61#define MPI_VALIDATE( cond ) \
62 MBEDTLS_INTERNAL_VALIDATE( cond )
63
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064#define ciL (sizeof(mbedtls_mpi_uint)) /* chars in limb */
Paul Bakker5121ce52009-01-03 21:22:43 +000065#define biL (ciL << 3) /* bits in limb */
66#define biH (ciL << 2) /* half limb size */
67
Manuel Pégourié-Gonnard2d708342015-10-05 15:23:11 +010068#define MPI_SIZE_T_MAX ( (size_t) -1 ) /* SIZE_T_MAX is not standard */
69
Paul Bakker5121ce52009-01-03 21:22:43 +000070/*
71 * Convert between bits/chars and number of limbs
Manuel Pégourié-Gonnard58fb4952015-09-28 13:48:04 +020072 * Divide first in order to avoid potential overflows
Paul Bakker5121ce52009-01-03 21:22:43 +000073 */
Manuel Pégourié-Gonnard58fb4952015-09-28 13:48:04 +020074#define BITS_TO_LIMBS(i) ( (i) / biL + ( (i) % biL != 0 ) )
75#define CHARS_TO_LIMBS(i) ( (i) / ciL + ( (i) % ciL != 0 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +000076
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050077/* Implementation that should never be optimized out by the compiler */
Andres Amaya Garcia6698d2f2018-04-24 08:39:07 -050078static void mbedtls_mpi_zeroize( mbedtls_mpi_uint *v, size_t n )
79{
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050080 mbedtls_platform_zeroize( v, ciL * n );
81}
82
Paul Bakker5121ce52009-01-03 21:22:43 +000083/*
Paul Bakker6c591fa2011-05-05 11:49:20 +000084 * Initialize one MPI
Paul Bakker5121ce52009-01-03 21:22:43 +000085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020086void mbedtls_mpi_init( mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +000087{
Hanno Becker73d7d792018-12-11 10:35:51 +000088 MPI_VALIDATE( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +000089
Paul Bakker6c591fa2011-05-05 11:49:20 +000090 X->s = 1;
91 X->n = 0;
92 X->p = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +000093}
94
95/*
Paul Bakker6c591fa2011-05-05 11:49:20 +000096 * Unallocate one MPI
Paul Bakker5121ce52009-01-03 21:22:43 +000097 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020098void mbedtls_mpi_free( mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +000099{
Paul Bakker6c591fa2011-05-05 11:49:20 +0000100 if( X == NULL )
101 return;
Paul Bakker5121ce52009-01-03 21:22:43 +0000102
Paul Bakker6c591fa2011-05-05 11:49:20 +0000103 if( X->p != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000104 {
Alexey Skalozube17a8da2016-01-13 17:19:33 +0200105 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200106 mbedtls_free( X->p );
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 }
108
Paul Bakker6c591fa2011-05-05 11:49:20 +0000109 X->s = 1;
110 X->n = 0;
111 X->p = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +0000112}
113
114/*
115 * Enlarge to the specified number of limbs
116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200117int mbedtls_mpi_grow( mbedtls_mpi *X, size_t nblimbs )
Paul Bakker5121ce52009-01-03 21:22:43 +0000118{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200119 mbedtls_mpi_uint *p;
Hanno Becker73d7d792018-12-11 10:35:51 +0000120 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200122 if( nblimbs > MBEDTLS_MPI_MAX_LIMBS )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200123 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Paul Bakkerf9688572011-05-05 10:00:45 +0000124
Paul Bakker5121ce52009-01-03 21:22:43 +0000125 if( X->n < nblimbs )
126 {
Simon Butcher29176892016-05-20 00:19:09 +0100127 if( ( p = (mbedtls_mpi_uint*)mbedtls_calloc( nblimbs, ciL ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200128 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Paul Bakker5121ce52009-01-03 21:22:43 +0000129
Paul Bakker5121ce52009-01-03 21:22:43 +0000130 if( X->p != NULL )
131 {
132 memcpy( p, X->p, X->n * ciL );
Alexey Skalozube17a8da2016-01-13 17:19:33 +0200133 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200134 mbedtls_free( X->p );
Paul Bakker5121ce52009-01-03 21:22:43 +0000135 }
136
137 X->n = nblimbs;
138 X->p = p;
139 }
140
141 return( 0 );
142}
143
144/*
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100145 * Resize down as much as possible,
146 * while keeping at least the specified number of limbs
147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200148int mbedtls_mpi_shrink( mbedtls_mpi *X, size_t nblimbs )
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100149{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200150 mbedtls_mpi_uint *p;
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100151 size_t i;
Hanno Becker73d7d792018-12-11 10:35:51 +0000152 MPI_VALIDATE_RET( X != NULL );
153
154 if( nblimbs > MBEDTLS_MPI_MAX_LIMBS )
155 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100156
Gilles Peskinee2f563e2020-01-20 21:17:43 +0100157 /* Actually resize up if there are currently fewer than nblimbs limbs. */
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100158 if( X->n <= nblimbs )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200159 return( mbedtls_mpi_grow( X, nblimbs ) );
Gilles Peskine322752b2020-01-21 13:59:51 +0100160 /* After this point, then X->n > nblimbs and in particular X->n > 0. */
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100161
162 for( i = X->n - 1; i > 0; i-- )
163 if( X->p[i] != 0 )
164 break;
165 i++;
166
167 if( i < nblimbs )
168 i = nblimbs;
169
Simon Butcher29176892016-05-20 00:19:09 +0100170 if( ( p = (mbedtls_mpi_uint*)mbedtls_calloc( i, ciL ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200171 return( MBEDTLS_ERR_MPI_ALLOC_FAILED );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100172
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100173 if( X->p != NULL )
174 {
175 memcpy( p, X->p, i * ciL );
Alexey Skalozube17a8da2016-01-13 17:19:33 +0200176 mbedtls_mpi_zeroize( X->p, X->n );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177 mbedtls_free( X->p );
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100178 }
179
180 X->n = i;
181 X->p = p;
182
183 return( 0 );
184}
185
Gilles Peskineed32b572021-06-02 22:17:52 +0200186/* Resize X to have exactly n limbs and set it to 0. */
187static int mbedtls_mpi_resize_clear( mbedtls_mpi *X, size_t limbs )
188{
189 if( limbs == 0 )
190 {
191 mbedtls_mpi_free( X );
192 return( 0 );
193 }
194 else if( X->n == limbs )
195 {
196 memset( X->p, 0, limbs * ciL );
197 X->s = 1;
198 return( 0 );
199 }
200 else
201 {
202 mbedtls_mpi_free( X );
203 return( mbedtls_mpi_grow( X, limbs ) );
204 }
205}
206
Manuel Pégourié-Gonnard58681632013-11-21 10:39:37 +0100207/*
Gilles Peskine3da1a8f2021-06-08 23:17:42 +0200208 * Copy the contents of Y into X.
209 *
210 * This function is not constant-time. Leading zeros in Y may be removed.
211 *
212 * Ensure that X does not shrink. This is not guaranteed by the public API,
213 * but some code in the bignum module relies on this property, for example
214 * in mbedtls_mpi_exp_mod().
Paul Bakker5121ce52009-01-03 21:22:43 +0000215 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200216int mbedtls_mpi_copy( mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +0000217{
Gilles Peskine4e4be7c2018-03-21 16:29:03 +0100218 int ret = 0;
Paul Bakker23986e52011-04-24 08:57:21 +0000219 size_t i;
Hanno Becker73d7d792018-12-11 10:35:51 +0000220 MPI_VALIDATE_RET( X != NULL );
221 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000222
223 if( X == Y )
224 return( 0 );
225
Gilles Peskinedb420622020-01-20 21:12:50 +0100226 if( Y->n == 0 )
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200227 {
Gilles Peskine3da1a8f2021-06-08 23:17:42 +0200228 if( X->n != 0 )
229 {
230 X->s = 1;
231 memset( X->p, 0, X->n * ciL );
232 }
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200233 return( 0 );
234 }
235
Paul Bakker5121ce52009-01-03 21:22:43 +0000236 for( i = Y->n - 1; i > 0; i-- )
237 if( Y->p[i] != 0 )
238 break;
239 i++;
240
241 X->s = Y->s;
242
Gilles Peskine4e4be7c2018-03-21 16:29:03 +0100243 if( X->n < i )
244 {
245 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, i ) );
246 }
247 else
248 {
249 memset( X->p + i, 0, ( X->n - i ) * ciL );
250 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000251
Paul Bakker5121ce52009-01-03 21:22:43 +0000252 memcpy( X->p, Y->p, i * ciL );
253
254cleanup:
255
256 return( ret );
257}
258
259/*
260 * Swap the contents of X and Y
261 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262void mbedtls_mpi_swap( mbedtls_mpi *X, mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +0000263{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000265 MPI_VALIDATE( X != NULL );
266 MPI_VALIDATE( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000267
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200268 memcpy( &T, X, sizeof( mbedtls_mpi ) );
269 memcpy( X, Y, sizeof( mbedtls_mpi ) );
270 memcpy( Y, &T, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000271}
272
273/*
274 * Set value from integer
275 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276int mbedtls_mpi_lset( mbedtls_mpi *X, mbedtls_mpi_sint z )
Paul Bakker5121ce52009-01-03 21:22:43 +0000277{
Janos Follath24eed8d2019-11-22 13:21:35 +0000278 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker73d7d792018-12-11 10:35:51 +0000279 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000282 memset( X->p, 0, X->n * ciL );
283
284 X->p[0] = ( z < 0 ) ? -z : z;
285 X->s = ( z < 0 ) ? -1 : 1;
286
287cleanup:
288
289 return( ret );
290}
291
292/*
Paul Bakker2f5947e2011-05-18 15:47:11 +0000293 * Get a specific bit
294 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200295int mbedtls_mpi_get_bit( const mbedtls_mpi *X, size_t pos )
Paul Bakker2f5947e2011-05-18 15:47:11 +0000296{
Hanno Becker73d7d792018-12-11 10:35:51 +0000297 MPI_VALIDATE_RET( X != NULL );
298
Paul Bakker2f5947e2011-05-18 15:47:11 +0000299 if( X->n * biL <= pos )
300 return( 0 );
301
Paul Bakkerd8bb8262014-06-17 14:06:49 +0200302 return( ( X->p[pos / biL] >> ( pos % biL ) ) & 0x01 );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000303}
304
Gilles Peskine11cdb052018-11-20 16:47:47 +0100305/* Get a specific byte, without range checks. */
306#define GET_BYTE( X, i ) \
307 ( ( ( X )->p[( i ) / ciL] >> ( ( ( i ) % ciL ) * 8 ) ) & 0xff )
308
Paul Bakker2f5947e2011-05-18 15:47:11 +0000309/*
310 * Set a bit to a specific value of 0 or 1
311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312int mbedtls_mpi_set_bit( mbedtls_mpi *X, size_t pos, unsigned char val )
Paul Bakker2f5947e2011-05-18 15:47:11 +0000313{
314 int ret = 0;
315 size_t off = pos / biL;
316 size_t idx = pos % biL;
Hanno Becker73d7d792018-12-11 10:35:51 +0000317 MPI_VALIDATE_RET( X != NULL );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000318
319 if( val != 0 && val != 1 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker9af723c2014-05-01 13:03:14 +0200321
Paul Bakker2f5947e2011-05-18 15:47:11 +0000322 if( X->n * biL <= pos )
323 {
324 if( val == 0 )
Paul Bakkerd8bb8262014-06-17 14:06:49 +0200325 return( 0 );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000326
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200327 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, off + 1 ) );
Paul Bakker2f5947e2011-05-18 15:47:11 +0000328 }
329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330 X->p[off] &= ~( (mbedtls_mpi_uint) 0x01 << idx );
331 X->p[off] |= (mbedtls_mpi_uint) val << idx;
Paul Bakker2f5947e2011-05-18 15:47:11 +0000332
333cleanup:
Paul Bakker9af723c2014-05-01 13:03:14 +0200334
Paul Bakker2f5947e2011-05-18 15:47:11 +0000335 return( ret );
336}
337
338/*
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200339 * Return the number of less significant zero-bits
Paul Bakker5121ce52009-01-03 21:22:43 +0000340 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341size_t mbedtls_mpi_lsb( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000342{
Paul Bakker23986e52011-04-24 08:57:21 +0000343 size_t i, j, count = 0;
Hanno Beckerf25ee7f2018-12-19 16:51:02 +0000344 MBEDTLS_INTERNAL_VALIDATE_RET( X != NULL, 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000345
346 for( i = 0; i < X->n; i++ )
Paul Bakkerf9688572011-05-05 10:00:45 +0000347 for( j = 0; j < biL; j++, count++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000348 if( ( ( X->p[i] >> j ) & 1 ) != 0 )
349 return( count );
350
351 return( 0 );
352}
353
354/*
Simon Butcher15b15d12015-11-26 19:35:03 +0000355 * Count leading zero bits in a given integer
356 */
357static size_t mbedtls_clz( const mbedtls_mpi_uint x )
358{
359 size_t j;
Manuel Pégourié-Gonnarde3e8edf2015-12-01 09:31:52 +0100360 mbedtls_mpi_uint mask = (mbedtls_mpi_uint) 1 << (biL - 1);
Simon Butcher15b15d12015-11-26 19:35:03 +0000361
362 for( j = 0; j < biL; j++ )
363 {
364 if( x & mask ) break;
365
366 mask >>= 1;
367 }
368
369 return j;
370}
371
372/*
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200373 * Return the number of bits
Paul Bakker5121ce52009-01-03 21:22:43 +0000374 */
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200375size_t mbedtls_mpi_bitlen( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000376{
Paul Bakker23986e52011-04-24 08:57:21 +0000377 size_t i, j;
Paul Bakker5121ce52009-01-03 21:22:43 +0000378
Manuel Pégourié-Gonnard770b5e12015-04-29 17:02:01 +0200379 if( X->n == 0 )
380 return( 0 );
381
Paul Bakker5121ce52009-01-03 21:22:43 +0000382 for( i = X->n - 1; i > 0; i-- )
383 if( X->p[i] != 0 )
384 break;
385
Simon Butcher15b15d12015-11-26 19:35:03 +0000386 j = biL - mbedtls_clz( X->p[i] );
Paul Bakker5121ce52009-01-03 21:22:43 +0000387
Paul Bakker23986e52011-04-24 08:57:21 +0000388 return( ( i * biL ) + j );
Paul Bakker5121ce52009-01-03 21:22:43 +0000389}
390
391/*
392 * Return the total size in bytes
393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394size_t mbedtls_mpi_size( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +0000395{
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200396 return( ( mbedtls_mpi_bitlen( X ) + 7 ) >> 3 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000397}
398
399/*
400 * Convert an ASCII character to digit value
401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200402static int mpi_get_digit( mbedtls_mpi_uint *d, int radix, char c )
Paul Bakker5121ce52009-01-03 21:22:43 +0000403{
404 *d = 255;
405
406 if( c >= 0x30 && c <= 0x39 ) *d = c - 0x30;
407 if( c >= 0x41 && c <= 0x46 ) *d = c - 0x37;
408 if( c >= 0x61 && c <= 0x66 ) *d = c - 0x57;
409
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200410 if( *d >= (mbedtls_mpi_uint) radix )
411 return( MBEDTLS_ERR_MPI_INVALID_CHARACTER );
Paul Bakker5121ce52009-01-03 21:22:43 +0000412
413 return( 0 );
414}
415
416/*
417 * Import from an ASCII string
418 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200419int mbedtls_mpi_read_string( mbedtls_mpi *X, int radix, const char *s )
Paul Bakker5121ce52009-01-03 21:22:43 +0000420{
Janos Follath24eed8d2019-11-22 13:21:35 +0000421 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000422 size_t i, j, slen, n;
Gilles Peskine80f56732021-04-03 18:26:13 +0200423 int sign = 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200424 mbedtls_mpi_uint d;
425 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000426 MPI_VALIDATE_RET( X != NULL );
427 MPI_VALIDATE_RET( s != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000428
429 if( radix < 2 || radix > 16 )
Hanno Becker54c91dd2018-12-12 13:37:06 +0000430 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200432 mbedtls_mpi_init( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000433
Gilles Peskine7cba8592021-06-08 18:32:34 +0200434 if( s[0] == 0 )
435 {
436 mbedtls_mpi_free( X );
437 return( 0 );
438 }
439
Gilles Peskine80f56732021-04-03 18:26:13 +0200440 if( s[0] == '-' )
441 {
442 ++s;
443 sign = -1;
444 }
445
Paul Bakkerff60ee62010-03-16 21:09:09 +0000446 slen = strlen( s );
447
Paul Bakker5121ce52009-01-03 21:22:43 +0000448 if( radix == 16 )
449 {
Manuel Pégourié-Gonnard2d708342015-10-05 15:23:11 +0100450 if( slen > MPI_SIZE_T_MAX >> 2 )
Manuel Pégourié-Gonnard58fb4952015-09-28 13:48:04 +0200451 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
452
Paul Bakkerff60ee62010-03-16 21:09:09 +0000453 n = BITS_TO_LIMBS( slen << 2 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000454
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200455 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, n ) );
456 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000457
Paul Bakker23986e52011-04-24 08:57:21 +0000458 for( i = slen, j = 0; i > 0; i--, j++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000459 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200460 MBEDTLS_MPI_CHK( mpi_get_digit( &d, radix, s[i - 1] ) );
Paul Bakker66d5d072014-06-17 16:39:18 +0200461 X->p[j / ( 2 * ciL )] |= d << ( ( j % ( 2 * ciL ) ) << 2 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000462 }
463 }
464 else
465 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200466 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000467
Paul Bakkerff60ee62010-03-16 21:09:09 +0000468 for( i = 0; i < slen; i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +0000469 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200470 MBEDTLS_MPI_CHK( mpi_get_digit( &d, radix, s[i] ) );
471 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T, X, radix ) );
Gilles Peskine80f56732021-04-03 18:26:13 +0200472 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, &T, d ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000473 }
474 }
475
Gilles Peskine80f56732021-04-03 18:26:13 +0200476 if( sign < 0 && mbedtls_mpi_bitlen( X ) != 0 )
477 X->s = -1;
478
Paul Bakker5121ce52009-01-03 21:22:43 +0000479cleanup:
480
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200481 mbedtls_mpi_free( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000482
483 return( ret );
484}
485
486/*
Ron Eldora16fa292018-11-20 14:07:01 +0200487 * Helper to write the digits high-order first.
Paul Bakker5121ce52009-01-03 21:22:43 +0000488 */
Ron Eldora16fa292018-11-20 14:07:01 +0200489static int mpi_write_hlp( mbedtls_mpi *X, int radix,
490 char **p, const size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000491{
Janos Follath24eed8d2019-11-22 13:21:35 +0000492 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200493 mbedtls_mpi_uint r;
Ron Eldora16fa292018-11-20 14:07:01 +0200494 size_t length = 0;
495 char *p_end = *p + buflen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000496
Ron Eldora16fa292018-11-20 14:07:01 +0200497 do
498 {
499 if( length >= buflen )
500 {
501 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
502 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000503
Ron Eldora16fa292018-11-20 14:07:01 +0200504 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, radix ) );
505 MBEDTLS_MPI_CHK( mbedtls_mpi_div_int( X, NULL, X, radix ) );
506 /*
507 * Write the residue in the current position, as an ASCII character.
508 */
509 if( r < 0xA )
510 *(--p_end) = (char)( '0' + r );
511 else
512 *(--p_end) = (char)( 'A' + ( r - 0xA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000513
Ron Eldora16fa292018-11-20 14:07:01 +0200514 length++;
515 } while( mbedtls_mpi_cmp_int( X, 0 ) != 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +0000516
Ron Eldora16fa292018-11-20 14:07:01 +0200517 memmove( *p, p_end, length );
518 *p += length;
Paul Bakker5121ce52009-01-03 21:22:43 +0000519
520cleanup:
521
522 return( ret );
523}
524
525/*
526 * Export into an ASCII string
527 */
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100528int mbedtls_mpi_write_string( const mbedtls_mpi *X, int radix,
529 char *buf, size_t buflen, size_t *olen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000530{
Paul Bakker23986e52011-04-24 08:57:21 +0000531 int ret = 0;
532 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +0000533 char *p;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200534 mbedtls_mpi T;
Hanno Becker73d7d792018-12-11 10:35:51 +0000535 MPI_VALIDATE_RET( X != NULL );
536 MPI_VALIDATE_RET( olen != NULL );
537 MPI_VALIDATE_RET( buflen == 0 || buf != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000538
539 if( radix < 2 || radix > 16 )
Hanno Becker54c91dd2018-12-12 13:37:06 +0000540 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000541
Hanno Becker23cfea02019-02-04 09:45:07 +0000542 n = mbedtls_mpi_bitlen( X ); /* Number of bits necessary to present `n`. */
543 if( radix >= 4 ) n >>= 1; /* Number of 4-adic digits necessary to present
544 * `n`. If radix > 4, this might be a strict
545 * overapproximation of the number of
546 * radix-adic digits needed to present `n`. */
547 if( radix >= 16 ) n >>= 1; /* Number of hexadecimal digits necessary to
548 * present `n`. */
549
Janos Follath80470622019-03-06 13:43:02 +0000550 n += 1; /* Terminating null byte */
Hanno Becker23cfea02019-02-04 09:45:07 +0000551 n += 1; /* Compensate for the divisions above, which round down `n`
552 * in case it's not even. */
553 n += 1; /* Potential '-'-sign. */
554 n += ( n & 1 ); /* Make n even to have enough space for hexadecimal writing,
555 * which always uses an even number of hex-digits. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000556
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100557 if( buflen < n )
Paul Bakker5121ce52009-01-03 21:22:43 +0000558 {
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100559 *olen = n;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000561 }
562
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100563 p = buf;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564 mbedtls_mpi_init( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000565
566 if( X->s == -1 )
Hanno Beckerc983c812019-02-01 16:41:30 +0000567 {
Paul Bakker5121ce52009-01-03 21:22:43 +0000568 *p++ = '-';
Hanno Beckerc983c812019-02-01 16:41:30 +0000569 buflen--;
570 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000571
572 if( radix == 16 )
573 {
Paul Bakker23986e52011-04-24 08:57:21 +0000574 int c;
575 size_t i, j, k;
Paul Bakker5121ce52009-01-03 21:22:43 +0000576
Paul Bakker23986e52011-04-24 08:57:21 +0000577 for( i = X->n, k = 0; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +0000578 {
Paul Bakker23986e52011-04-24 08:57:21 +0000579 for( j = ciL; j > 0; j-- )
Paul Bakker5121ce52009-01-03 21:22:43 +0000580 {
Paul Bakker23986e52011-04-24 08:57:21 +0000581 c = ( X->p[i - 1] >> ( ( j - 1 ) << 3) ) & 0xFF;
Paul Bakker5121ce52009-01-03 21:22:43 +0000582
Paul Bakker6c343d72014-07-10 14:36:19 +0200583 if( c == 0 && k == 0 && ( i + j ) != 2 )
Paul Bakker5121ce52009-01-03 21:22:43 +0000584 continue;
585
Paul Bakker98fe5ea2012-10-24 11:17:48 +0000586 *(p++) = "0123456789ABCDEF" [c / 16];
Paul Bakkerd2c167e2012-10-30 07:49:19 +0000587 *(p++) = "0123456789ABCDEF" [c % 16];
Paul Bakker5121ce52009-01-03 21:22:43 +0000588 k = 1;
589 }
590 }
591 }
592 else
593 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &T, X ) );
Paul Bakkerce40a6d2009-06-23 19:46:08 +0000595
596 if( T.s == -1 )
597 T.s = 1;
598
Ron Eldora16fa292018-11-20 14:07:01 +0200599 MBEDTLS_MPI_CHK( mpi_write_hlp( &T, radix, &p, buflen ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000600 }
601
602 *p++ = '\0';
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100603 *olen = p - buf;
Paul Bakker5121ce52009-01-03 21:22:43 +0000604
605cleanup:
606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607 mbedtls_mpi_free( &T );
Paul Bakker5121ce52009-01-03 21:22:43 +0000608
609 return( ret );
610}
611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612#if defined(MBEDTLS_FS_IO)
Paul Bakker5121ce52009-01-03 21:22:43 +0000613/*
614 * Read X from an opened file
615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200616int mbedtls_mpi_read_file( mbedtls_mpi *X, int radix, FILE *fin )
Paul Bakker5121ce52009-01-03 21:22:43 +0000617{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200618 mbedtls_mpi_uint d;
Paul Bakker23986e52011-04-24 08:57:21 +0000619 size_t slen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000620 char *p;
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000621 /*
Paul Bakkercb37aa52011-11-30 16:00:20 +0000622 * Buffer should have space for (short) label and decimal formatted MPI,
623 * newline characters and '\0'
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000624 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200625 char s[ MBEDTLS_MPI_RW_BUFFER_SIZE ];
Paul Bakker5121ce52009-01-03 21:22:43 +0000626
Hanno Becker73d7d792018-12-11 10:35:51 +0000627 MPI_VALIDATE_RET( X != NULL );
628 MPI_VALIDATE_RET( fin != NULL );
629
630 if( radix < 2 || radix > 16 )
631 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
632
Paul Bakker5121ce52009-01-03 21:22:43 +0000633 memset( s, 0, sizeof( s ) );
634 if( fgets( s, sizeof( s ) - 1, fin ) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200635 return( MBEDTLS_ERR_MPI_FILE_IO_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +0000636
637 slen = strlen( s );
Paul Bakkercb37aa52011-11-30 16:00:20 +0000638 if( slen == sizeof( s ) - 2 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200639 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
Paul Bakkercb37aa52011-11-30 16:00:20 +0000640
Hanno Beckerb2034b72017-04-26 11:46:46 +0100641 if( slen > 0 && s[slen - 1] == '\n' ) { slen--; s[slen] = '\0'; }
642 if( slen > 0 && s[slen - 1] == '\r' ) { slen--; s[slen] = '\0'; }
Paul Bakker5121ce52009-01-03 21:22:43 +0000643
644 p = s + slen;
Hanno Beckerb2034b72017-04-26 11:46:46 +0100645 while( p-- > s )
Paul Bakker5121ce52009-01-03 21:22:43 +0000646 if( mpi_get_digit( &d, radix, *p ) != 0 )
647 break;
648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649 return( mbedtls_mpi_read_string( X, radix, p + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000650}
651
652/*
653 * Write X into an opened file (or stdout if fout == NULL)
654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655int mbedtls_mpi_write_file( const char *p, const mbedtls_mpi *X, int radix, FILE *fout )
Paul Bakker5121ce52009-01-03 21:22:43 +0000656{
Janos Follath24eed8d2019-11-22 13:21:35 +0000657 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000658 size_t n, slen, plen;
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000659 /*
Paul Bakker5531c6d2012-09-26 19:20:46 +0000660 * Buffer should have space for (short) label and decimal formatted MPI,
661 * newline characters and '\0'
Paul Bakkerfe3256e2011-11-25 12:11:43 +0000662 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663 char s[ MBEDTLS_MPI_RW_BUFFER_SIZE ];
Hanno Becker73d7d792018-12-11 10:35:51 +0000664 MPI_VALIDATE_RET( X != NULL );
665
666 if( radix < 2 || radix > 16 )
667 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +0000668
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100669 memset( s, 0, sizeof( s ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000670
Manuel Pégourié-Gonnardf79b4252015-06-02 15:41:48 +0100671 MBEDTLS_MPI_CHK( mbedtls_mpi_write_string( X, radix, s, sizeof( s ) - 2, &n ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000672
673 if( p == NULL ) p = "";
674
675 plen = strlen( p );
676 slen = strlen( s );
677 s[slen++] = '\r';
678 s[slen++] = '\n';
679
680 if( fout != NULL )
681 {
682 if( fwrite( p, 1, plen, fout ) != plen ||
683 fwrite( s, 1, slen, fout ) != slen )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684 return( MBEDTLS_ERR_MPI_FILE_IO_ERROR );
Paul Bakker5121ce52009-01-03 21:22:43 +0000685 }
686 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687 mbedtls_printf( "%s%s", p, s );
Paul Bakker5121ce52009-01-03 21:22:43 +0000688
689cleanup:
690
691 return( ret );
692}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693#endif /* MBEDTLS_FS_IO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000694
Hanno Beckerda1655a2017-10-18 14:21:44 +0100695
696/* Convert a big-endian byte array aligned to the size of mbedtls_mpi_uint
697 * into the storage form used by mbedtls_mpi. */
Hanno Beckerf8720072018-11-08 11:53:49 +0000698
699static mbedtls_mpi_uint mpi_uint_bigendian_to_host_c( mbedtls_mpi_uint x )
700{
701 uint8_t i;
Hanno Becker031d6332019-05-01 17:09:11 +0100702 unsigned char *x_ptr;
Hanno Beckerf8720072018-11-08 11:53:49 +0000703 mbedtls_mpi_uint tmp = 0;
Hanno Becker031d6332019-05-01 17:09:11 +0100704
705 for( i = 0, x_ptr = (unsigned char*) &x; i < ciL; i++, x_ptr++ )
706 {
707 tmp <<= CHAR_BIT;
708 tmp |= (mbedtls_mpi_uint) *x_ptr;
709 }
710
Hanno Beckerf8720072018-11-08 11:53:49 +0000711 return( tmp );
712}
713
714static mbedtls_mpi_uint mpi_uint_bigendian_to_host( mbedtls_mpi_uint x )
715{
716#if defined(__BYTE_ORDER__)
717
718/* Nothing to do on bigendian systems. */
719#if ( __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ )
720 return( x );
721#endif /* __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ */
722
723#if ( __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ )
724
725/* For GCC and Clang, have builtins for byte swapping. */
Hanno Becker9f6d16a2019-01-02 17:15:06 +0000726#if defined(__GNUC__) && defined(__GNUC_PREREQ)
727#if __GNUC_PREREQ(4,3)
Hanno Beckerf8720072018-11-08 11:53:49 +0000728#define have_bswap
729#endif
Hanno Becker9f6d16a2019-01-02 17:15:06 +0000730#endif
731
732#if defined(__clang__) && defined(__has_builtin)
733#if __has_builtin(__builtin_bswap32) && \
734 __has_builtin(__builtin_bswap64)
735#define have_bswap
736#endif
737#endif
738
Hanno Beckerf8720072018-11-08 11:53:49 +0000739#if defined(have_bswap)
740 /* The compiler is hopefully able to statically evaluate this! */
741 switch( sizeof(mbedtls_mpi_uint) )
742 {
743 case 4:
744 return( __builtin_bswap32(x) );
745 case 8:
746 return( __builtin_bswap64(x) );
747 }
748#endif
749#endif /* __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ */
750#endif /* __BYTE_ORDER__ */
751
752 /* Fall back to C-based reordering if we don't know the byte order
753 * or we couldn't use a compiler-specific builtin. */
754 return( mpi_uint_bigendian_to_host_c( x ) );
755}
756
Hanno Becker2be8a552018-10-25 12:40:09 +0100757static void mpi_bigendian_to_host( mbedtls_mpi_uint * const p, size_t limbs )
Hanno Beckerda1655a2017-10-18 14:21:44 +0100758{
Hanno Beckerda1655a2017-10-18 14:21:44 +0100759 mbedtls_mpi_uint *cur_limb_left;
760 mbedtls_mpi_uint *cur_limb_right;
Hanno Becker2be8a552018-10-25 12:40:09 +0100761 if( limbs == 0 )
762 return;
Hanno Beckerda1655a2017-10-18 14:21:44 +0100763
764 /*
765 * Traverse limbs and
766 * - adapt byte-order in each limb
767 * - swap the limbs themselves.
768 * For that, simultaneously traverse the limbs from left to right
769 * and from right to left, as long as the left index is not bigger
770 * than the right index (it's not a problem if limbs is odd and the
771 * indices coincide in the last iteration).
772 */
Hanno Beckerda1655a2017-10-18 14:21:44 +0100773 for( cur_limb_left = p, cur_limb_right = p + ( limbs - 1 );
774 cur_limb_left <= cur_limb_right;
775 cur_limb_left++, cur_limb_right-- )
776 {
Hanno Beckerf8720072018-11-08 11:53:49 +0000777 mbedtls_mpi_uint tmp;
778 /* Note that if cur_limb_left == cur_limb_right,
779 * this code effectively swaps the bytes only once. */
780 tmp = mpi_uint_bigendian_to_host( *cur_limb_left );
781 *cur_limb_left = mpi_uint_bigendian_to_host( *cur_limb_right );
782 *cur_limb_right = tmp;
Hanno Beckerda1655a2017-10-18 14:21:44 +0100783 }
Hanno Beckerda1655a2017-10-18 14:21:44 +0100784}
785
Paul Bakker5121ce52009-01-03 21:22:43 +0000786/*
Janos Follatha778a942019-02-13 10:28:28 +0000787 * Import X from unsigned binary data, little endian
Przemyslaw Stekiel76960a72022-02-21 13:42:09 +0100788 *
789 * This function is guaranteed to return an MPI with exactly the necessary
790 * number of limbs (in particular, it does not skip 0s in the input).
Janos Follatha778a942019-02-13 10:28:28 +0000791 */
792int mbedtls_mpi_read_binary_le( mbedtls_mpi *X,
793 const unsigned char *buf, size_t buflen )
794{
Janos Follath24eed8d2019-11-22 13:21:35 +0000795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Janos Follatha778a942019-02-13 10:28:28 +0000796 size_t i;
797 size_t const limbs = CHARS_TO_LIMBS( buflen );
798
799 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskineed32b572021-06-02 22:17:52 +0200800 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Janos Follatha778a942019-02-13 10:28:28 +0000801
802 for( i = 0; i < buflen; i++ )
803 X->p[i / ciL] |= ((mbedtls_mpi_uint) buf[i]) << ((i % ciL) << 3);
804
805cleanup:
806
Janos Follath171a7ef2019-02-15 16:17:45 +0000807 /*
808 * This function is also used to import keys. However, wiping the buffers
809 * upon failure is not necessary because failure only can happen before any
810 * input is copied.
811 */
Janos Follatha778a942019-02-13 10:28:28 +0000812 return( ret );
813}
814
815/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000816 * Import X from unsigned binary data, big endian
Przemyslaw Stekiel76960a72022-02-21 13:42:09 +0100817 *
818 * This function is guaranteed to return an MPI with exactly the necessary
819 * number of limbs (in particular, it does not skip 0s in the input).
Paul Bakker5121ce52009-01-03 21:22:43 +0000820 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200821int mbedtls_mpi_read_binary( mbedtls_mpi *X, const unsigned char *buf, size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000822{
Janos Follath24eed8d2019-11-22 13:21:35 +0000823 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerda1655a2017-10-18 14:21:44 +0100824 size_t const limbs = CHARS_TO_LIMBS( buflen );
825 size_t const overhead = ( limbs * ciL ) - buflen;
826 unsigned char *Xp;
Paul Bakker5121ce52009-01-03 21:22:43 +0000827
Hanno Becker8ce11a32018-12-19 16:18:52 +0000828 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +0000829 MPI_VALIDATE_RET( buflen == 0 || buf != NULL );
830
Hanno Becker073c1992017-10-17 15:17:27 +0100831 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskineed32b572021-06-02 22:17:52 +0200832 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000833
Gilles Peskineed32b572021-06-02 22:17:52 +0200834 /* Avoid calling `memcpy` with NULL source or destination argument,
Hanno Becker0e810b92019-01-03 17:13:11 +0000835 * even if buflen is 0. */
Gilles Peskineed32b572021-06-02 22:17:52 +0200836 if( buflen != 0 )
Hanno Becker0e810b92019-01-03 17:13:11 +0000837 {
838 Xp = (unsigned char*) X->p;
839 memcpy( Xp + overhead, buf, buflen );
Hanno Beckerda1655a2017-10-18 14:21:44 +0100840
Hanno Becker0e810b92019-01-03 17:13:11 +0000841 mpi_bigendian_to_host( X->p, limbs );
842 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000843
844cleanup:
845
Janos Follath171a7ef2019-02-15 16:17:45 +0000846 /*
847 * This function is also used to import keys. However, wiping the buffers
848 * upon failure is not necessary because failure only can happen before any
849 * input is copied.
850 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000851 return( ret );
852}
853
854/*
Janos Follathe344d0f2019-02-19 16:17:40 +0000855 * Export X into unsigned binary data, little endian
856 */
857int mbedtls_mpi_write_binary_le( const mbedtls_mpi *X,
858 unsigned char *buf, size_t buflen )
859{
860 size_t stored_bytes = X->n * ciL;
861 size_t bytes_to_copy;
862 size_t i;
863
864 if( stored_bytes < buflen )
865 {
866 bytes_to_copy = stored_bytes;
867 }
868 else
869 {
870 bytes_to_copy = buflen;
871
872 /* The output buffer is smaller than the allocated size of X.
873 * However X may fit if its leading bytes are zero. */
874 for( i = bytes_to_copy; i < stored_bytes; i++ )
875 {
876 if( GET_BYTE( X, i ) != 0 )
877 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
878 }
879 }
880
881 for( i = 0; i < bytes_to_copy; i++ )
882 buf[i] = GET_BYTE( X, i );
883
884 if( stored_bytes < buflen )
885 {
886 /* Write trailing 0 bytes */
887 memset( buf + stored_bytes, 0, buflen - stored_bytes );
888 }
889
890 return( 0 );
891}
892
893/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000894 * Export X into unsigned binary data, big endian
895 */
Gilles Peskine11cdb052018-11-20 16:47:47 +0100896int mbedtls_mpi_write_binary( const mbedtls_mpi *X,
897 unsigned char *buf, size_t buflen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000898{
Hanno Becker73d7d792018-12-11 10:35:51 +0000899 size_t stored_bytes;
Gilles Peskine11cdb052018-11-20 16:47:47 +0100900 size_t bytes_to_copy;
901 unsigned char *p;
902 size_t i;
Paul Bakker5121ce52009-01-03 21:22:43 +0000903
Hanno Becker73d7d792018-12-11 10:35:51 +0000904 MPI_VALIDATE_RET( X != NULL );
905 MPI_VALIDATE_RET( buflen == 0 || buf != NULL );
906
907 stored_bytes = X->n * ciL;
908
Gilles Peskine11cdb052018-11-20 16:47:47 +0100909 if( stored_bytes < buflen )
910 {
911 /* There is enough space in the output buffer. Write initial
912 * null bytes and record the position at which to start
913 * writing the significant bytes. In this case, the execution
914 * trace of this function does not depend on the value of the
915 * number. */
916 bytes_to_copy = stored_bytes;
917 p = buf + buflen - stored_bytes;
918 memset( buf, 0, buflen - stored_bytes );
919 }
920 else
921 {
922 /* The output buffer is smaller than the allocated size of X.
923 * However X may fit if its leading bytes are zero. */
924 bytes_to_copy = buflen;
925 p = buf;
926 for( i = bytes_to_copy; i < stored_bytes; i++ )
927 {
928 if( GET_BYTE( X, i ) != 0 )
929 return( MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL );
930 }
931 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000932
Gilles Peskine11cdb052018-11-20 16:47:47 +0100933 for( i = 0; i < bytes_to_copy; i++ )
934 p[bytes_to_copy - i - 1] = GET_BYTE( X, i );
Paul Bakker5121ce52009-01-03 21:22:43 +0000935
936 return( 0 );
937}
938
939/*
940 * Left-shift: X <<= count
941 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200942int mbedtls_mpi_shift_l( mbedtls_mpi *X, size_t count )
Paul Bakker5121ce52009-01-03 21:22:43 +0000943{
Janos Follath24eed8d2019-11-22 13:21:35 +0000944 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +0000945 size_t i, v0, t1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200946 mbedtls_mpi_uint r0 = 0, r1;
Hanno Becker73d7d792018-12-11 10:35:51 +0000947 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000948
949 v0 = count / (biL );
950 t1 = count & (biL - 1);
951
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +0200952 i = mbedtls_mpi_bitlen( X ) + count;
Paul Bakker5121ce52009-01-03 21:22:43 +0000953
Paul Bakkerf9688572011-05-05 10:00:45 +0000954 if( X->n * biL < i )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, BITS_TO_LIMBS( i ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000956
957 ret = 0;
958
959 /*
960 * shift by count / limb_size
961 */
962 if( v0 > 0 )
963 {
Paul Bakker23986e52011-04-24 08:57:21 +0000964 for( i = X->n; i > v0; i-- )
965 X->p[i - 1] = X->p[i - v0 - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +0000966
Paul Bakker23986e52011-04-24 08:57:21 +0000967 for( ; i > 0; i-- )
968 X->p[i - 1] = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +0000969 }
970
971 /*
972 * shift by count % limb_size
973 */
974 if( t1 > 0 )
975 {
976 for( i = v0; i < X->n; i++ )
977 {
978 r1 = X->p[i] >> (biL - t1);
979 X->p[i] <<= t1;
980 X->p[i] |= r0;
981 r0 = r1;
982 }
983 }
984
985cleanup:
986
987 return( ret );
988}
989
990/*
991 * Right-shift: X >>= count
992 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993int mbedtls_mpi_shift_r( mbedtls_mpi *X, size_t count )
Paul Bakker5121ce52009-01-03 21:22:43 +0000994{
Paul Bakker23986e52011-04-24 08:57:21 +0000995 size_t i, v0, v1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996 mbedtls_mpi_uint r0 = 0, r1;
Hanno Becker73d7d792018-12-11 10:35:51 +0000997 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +0000998
999 v0 = count / biL;
1000 v1 = count & (biL - 1);
1001
Manuel Pégourié-Gonnarde44ec102012-11-17 12:42:51 +01001002 if( v0 > X->n || ( v0 == X->n && v1 > 0 ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003 return mbedtls_mpi_lset( X, 0 );
Manuel Pégourié-Gonnarde44ec102012-11-17 12:42:51 +01001004
Paul Bakker5121ce52009-01-03 21:22:43 +00001005 /*
1006 * shift by count / limb_size
1007 */
1008 if( v0 > 0 )
1009 {
1010 for( i = 0; i < X->n - v0; i++ )
1011 X->p[i] = X->p[i + v0];
1012
1013 for( ; i < X->n; i++ )
1014 X->p[i] = 0;
1015 }
1016
1017 /*
1018 * shift by count % limb_size
1019 */
1020 if( v1 > 0 )
1021 {
Paul Bakker23986e52011-04-24 08:57:21 +00001022 for( i = X->n; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001023 {
Paul Bakker23986e52011-04-24 08:57:21 +00001024 r1 = X->p[i - 1] << (biL - v1);
1025 X->p[i - 1] >>= v1;
1026 X->p[i - 1] |= r0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001027 r0 = r1;
1028 }
1029 }
1030
1031 return( 0 );
1032}
1033
1034/*
1035 * Compare unsigned values
1036 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037int mbedtls_mpi_cmp_abs( const mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +00001038{
Paul Bakker23986e52011-04-24 08:57:21 +00001039 size_t i, j;
Hanno Becker73d7d792018-12-11 10:35:51 +00001040 MPI_VALIDATE_RET( X != NULL );
1041 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001042
Paul Bakker23986e52011-04-24 08:57:21 +00001043 for( i = X->n; i > 0; i-- )
1044 if( X->p[i - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001045 break;
1046
Paul Bakker23986e52011-04-24 08:57:21 +00001047 for( j = Y->n; j > 0; j-- )
1048 if( Y->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001049 break;
1050
Paul Bakker23986e52011-04-24 08:57:21 +00001051 if( i == 0 && j == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001052 return( 0 );
1053
1054 if( i > j ) return( 1 );
1055 if( j > i ) return( -1 );
1056
Paul Bakker23986e52011-04-24 08:57:21 +00001057 for( ; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001058 {
Paul Bakker23986e52011-04-24 08:57:21 +00001059 if( X->p[i - 1] > Y->p[i - 1] ) return( 1 );
1060 if( X->p[i - 1] < Y->p[i - 1] ) return( -1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001061 }
1062
1063 return( 0 );
1064}
1065
1066/*
1067 * Compare signed values
1068 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069int mbedtls_mpi_cmp_mpi( const mbedtls_mpi *X, const mbedtls_mpi *Y )
Paul Bakker5121ce52009-01-03 21:22:43 +00001070{
Paul Bakker23986e52011-04-24 08:57:21 +00001071 size_t i, j;
Hanno Becker73d7d792018-12-11 10:35:51 +00001072 MPI_VALIDATE_RET( X != NULL );
1073 MPI_VALIDATE_RET( Y != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001074
Paul Bakker23986e52011-04-24 08:57:21 +00001075 for( i = X->n; i > 0; i-- )
1076 if( X->p[i - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001077 break;
1078
Paul Bakker23986e52011-04-24 08:57:21 +00001079 for( j = Y->n; j > 0; j-- )
1080 if( Y->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001081 break;
1082
Paul Bakker23986e52011-04-24 08:57:21 +00001083 if( i == 0 && j == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001084 return( 0 );
1085
1086 if( i > j ) return( X->s );
Paul Bakker0c8f73b2012-03-22 14:08:57 +00001087 if( j > i ) return( -Y->s );
Paul Bakker5121ce52009-01-03 21:22:43 +00001088
1089 if( X->s > 0 && Y->s < 0 ) return( 1 );
1090 if( Y->s > 0 && X->s < 0 ) return( -1 );
1091
Paul Bakker23986e52011-04-24 08:57:21 +00001092 for( ; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001093 {
Paul Bakker23986e52011-04-24 08:57:21 +00001094 if( X->p[i - 1] > Y->p[i - 1] ) return( X->s );
1095 if( X->p[i - 1] < Y->p[i - 1] ) return( -X->s );
Paul Bakker5121ce52009-01-03 21:22:43 +00001096 }
1097
1098 return( 0 );
1099}
1100
Janos Follathee6abce2019-09-05 14:47:19 +01001101/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001102 * Compare signed values
1103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104int mbedtls_mpi_cmp_int( const mbedtls_mpi *X, mbedtls_mpi_sint z )
Paul Bakker5121ce52009-01-03 21:22:43 +00001105{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 mbedtls_mpi Y;
1107 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001108 MPI_VALIDATE_RET( X != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001109
1110 *p = ( z < 0 ) ? -z : z;
1111 Y.s = ( z < 0 ) ? -1 : 1;
1112 Y.n = 1;
1113 Y.p = p;
1114
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115 return( mbedtls_mpi_cmp_mpi( X, &Y ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001116}
1117
1118/*
1119 * Unsigned addition: X = |A| + |B| (HAC 14.7)
1120 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001121int mbedtls_mpi_add_abs( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001122{
Janos Follath24eed8d2019-11-22 13:21:35 +00001123 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001124 size_t i, j;
Janos Follath6c922682015-10-30 17:43:11 +01001125 mbedtls_mpi_uint *o, *p, c, tmp;
Hanno Becker73d7d792018-12-11 10:35:51 +00001126 MPI_VALIDATE_RET( X != NULL );
1127 MPI_VALIDATE_RET( A != NULL );
1128 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001129
1130 if( X == B )
1131 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132 const mbedtls_mpi *T = A; A = X; B = T;
Paul Bakker5121ce52009-01-03 21:22:43 +00001133 }
1134
1135 if( X != A )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, A ) );
Paul Bakker9af723c2014-05-01 13:03:14 +02001137
Paul Bakkerf7ca7b92009-06-20 10:31:06 +00001138 /*
1139 * X should always be positive as a result of unsigned additions.
1140 */
1141 X->s = 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001142
Paul Bakker23986e52011-04-24 08:57:21 +00001143 for( j = B->n; j > 0; j-- )
1144 if( B->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001145 break;
1146
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001147 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, j ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001148
1149 o = B->p; p = X->p; c = 0;
1150
Janos Follath6c922682015-10-30 17:43:11 +01001151 /*
1152 * tmp is used because it might happen that p == o
1153 */
Paul Bakker23986e52011-04-24 08:57:21 +00001154 for( i = 0; i < j; i++, o++, p++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001155 {
Janos Follath6c922682015-10-30 17:43:11 +01001156 tmp= *o;
Paul Bakker5121ce52009-01-03 21:22:43 +00001157 *p += c; c = ( *p < c );
Janos Follath6c922682015-10-30 17:43:11 +01001158 *p += tmp; c += ( *p < tmp );
Paul Bakker5121ce52009-01-03 21:22:43 +00001159 }
1160
1161 while( c != 0 )
1162 {
1163 if( i >= X->n )
1164 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, i + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001166 p = X->p + i;
1167 }
1168
Paul Bakker2d319fd2012-09-16 21:34:26 +00001169 *p += c; c = ( *p < c ); i++; p++;
Paul Bakker5121ce52009-01-03 21:22:43 +00001170 }
1171
1172cleanup:
1173
1174 return( ret );
1175}
1176
Gilles Peskine09ec10a2020-06-09 10:39:38 +02001177/**
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001178 * Helper for mbedtls_mpi subtraction.
1179 *
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001180 * Calculate l - r where l and r have the same size.
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001181 * This function operates modulo (2^ciL)^n and returns the carry
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001182 * (1 if there was a wraparound, i.e. if `l < r`, and 0 otherwise).
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001183 *
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001184 * d may be aliased to l or r.
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001185 *
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001186 * \param n Number of limbs of \p d, \p l and \p r.
1187 * \param[out] d The result of the subtraction.
1188 * \param[in] l The left operand.
1189 * \param[in] r The right operand.
1190 *
1191 * \return 1 if `l < r`.
1192 * 0 if `l >= r`.
Paul Bakker5121ce52009-01-03 21:22:43 +00001193 */
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001194static mbedtls_mpi_uint mpi_sub_hlp( size_t n,
1195 mbedtls_mpi_uint *d,
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001196 const mbedtls_mpi_uint *l,
1197 const mbedtls_mpi_uint *r )
Paul Bakker5121ce52009-01-03 21:22:43 +00001198{
Paul Bakker23986e52011-04-24 08:57:21 +00001199 size_t i;
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001200 mbedtls_mpi_uint c = 0, t, z;
Paul Bakker5121ce52009-01-03 21:22:43 +00001201
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001202 for( i = 0; i < n; i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001203 {
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001204 z = ( l[i] < c ); t = l[i] - c;
1205 c = ( t < r[i] ) + z; d[i] = t - r[i];
Paul Bakker5121ce52009-01-03 21:22:43 +00001206 }
1207
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001208 return( c );
Paul Bakker5121ce52009-01-03 21:22:43 +00001209}
1210
1211/*
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001212 * Unsigned subtraction: X = |A| - |B| (HAC 14.9, 14.10)
Paul Bakker5121ce52009-01-03 21:22:43 +00001213 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001214int mbedtls_mpi_sub_abs( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001215{
Janos Follath24eed8d2019-11-22 13:21:35 +00001216 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001217 size_t n;
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001218 mbedtls_mpi_uint carry;
Hanno Becker73d7d792018-12-11 10:35:51 +00001219 MPI_VALIDATE_RET( X != NULL );
1220 MPI_VALIDATE_RET( A != NULL );
1221 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001222
Paul Bakker23986e52011-04-24 08:57:21 +00001223 for( n = B->n; n > 0; n-- )
1224 if( B->p[n - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001225 break;
Gilles Peskinec8a91772021-01-27 22:30:43 +01001226 if( n > A->n )
1227 {
1228 /* B >= (2^ciL)^n > A */
1229 ret = MBEDTLS_ERR_MPI_NEGATIVE_VALUE;
1230 goto cleanup;
1231 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001232
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001233 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, A->n ) );
1234
1235 /* Set the high limbs of X to match A. Don't touch the lower limbs
1236 * because X might be aliased to B, and we must not overwrite the
1237 * significant digits of B. */
1238 if( A->n > n )
1239 memcpy( X->p + n, A->p + n, ( A->n - n ) * ciL );
1240 if( X->n > A->n )
1241 memset( X->p + A->n, 0, ( X->n - A->n ) * ciL );
1242
1243 carry = mpi_sub_hlp( n, X->p, A->p, B->p );
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001244 if( carry != 0 )
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001245 {
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001246 /* Propagate the carry to the first nonzero limb of X. */
1247 for( ; n < X->n && X->p[n] == 0; n++ )
1248 --X->p[n];
1249 /* If we ran out of space for the carry, it means that the result
1250 * is negative. */
1251 if( n == X->n )
Gilles Peskine89b41302020-07-23 01:16:46 +02001252 {
1253 ret = MBEDTLS_ERR_MPI_NEGATIVE_VALUE;
1254 goto cleanup;
1255 }
Gilles Peskine0e5faf62020-06-08 22:50:35 +02001256 --X->p[n];
Gilles Peskinec097e9e2020-06-08 21:58:22 +02001257 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001258
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001259 /* X should always be positive as a result of unsigned subtractions. */
1260 X->s = 1;
1261
Paul Bakker5121ce52009-01-03 21:22:43 +00001262cleanup:
Paul Bakker5121ce52009-01-03 21:22:43 +00001263 return( ret );
1264}
1265
1266/*
1267 * Signed addition: X = A + B
1268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001269int mbedtls_mpi_add_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001270{
Hanno Becker73d7d792018-12-11 10:35:51 +00001271 int ret, s;
1272 MPI_VALIDATE_RET( X != NULL );
1273 MPI_VALIDATE_RET( A != NULL );
1274 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001275
Hanno Becker73d7d792018-12-11 10:35:51 +00001276 s = A->s;
Paul Bakker5121ce52009-01-03 21:22:43 +00001277 if( A->s * B->s < 0 )
1278 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279 if( mbedtls_mpi_cmp_abs( A, B ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001280 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001281 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001282 X->s = s;
1283 }
1284 else
1285 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001286 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, B, A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001287 X->s = -s;
1288 }
1289 }
1290 else
1291 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001292 MBEDTLS_MPI_CHK( mbedtls_mpi_add_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001293 X->s = s;
1294 }
1295
1296cleanup:
1297
1298 return( ret );
1299}
1300
1301/*
Paul Bakker60b1d102013-10-29 10:02:51 +01001302 * Signed subtraction: X = A - B
Paul Bakker5121ce52009-01-03 21:22:43 +00001303 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001304int mbedtls_mpi_sub_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001305{
Hanno Becker73d7d792018-12-11 10:35:51 +00001306 int ret, s;
1307 MPI_VALIDATE_RET( X != NULL );
1308 MPI_VALIDATE_RET( A != NULL );
1309 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001310
Hanno Becker73d7d792018-12-11 10:35:51 +00001311 s = A->s;
Paul Bakker5121ce52009-01-03 21:22:43 +00001312 if( A->s * B->s > 0 )
1313 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314 if( mbedtls_mpi_cmp_abs( A, B ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001315 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001316 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001317 X->s = s;
1318 }
1319 else
1320 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001321 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( X, B, A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001322 X->s = -s;
1323 }
1324 }
1325 else
1326 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327 MBEDTLS_MPI_CHK( mbedtls_mpi_add_abs( X, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001328 X->s = s;
1329 }
1330
1331cleanup:
1332
1333 return( ret );
1334}
1335
1336/*
1337 * Signed addition: X = A + b
1338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339int mbedtls_mpi_add_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001340{
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001341 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001342 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001343 MPI_VALIDATE_RET( X != NULL );
1344 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001345
1346 p[0] = ( b < 0 ) ? -b : b;
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001347 B.s = ( b < 0 ) ? -1 : 1;
1348 B.n = 1;
1349 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001350
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001351 return( mbedtls_mpi_add_mpi( X, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001352}
1353
1354/*
Paul Bakker60b1d102013-10-29 10:02:51 +01001355 * Signed subtraction: X = A - b
Paul Bakker5121ce52009-01-03 21:22:43 +00001356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001357int mbedtls_mpi_sub_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001358{
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001359 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001361 MPI_VALIDATE_RET( X != NULL );
1362 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001363
1364 p[0] = ( b < 0 ) ? -b : b;
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001365 B.s = ( b < 0 ) ? -1 : 1;
1366 B.n = 1;
1367 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001368
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001369 return( mbedtls_mpi_sub_mpi( X, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001370}
1371
Gilles Peskinea5d8d892020-07-23 21:27:15 +02001372/** Helper for mbedtls_mpi multiplication.
1373 *
1374 * Add \p b * \p s to \p d.
1375 *
Hanno Beckerdefe5692022-04-06 06:12:09 +01001376 * \param[in,out] d The bignum to add to.
1377 * \param d_len The number of limbs of \p d. This must be
1378 * at least \p s_len.
1379 * \param s_len The number of limbs of \p s.
Gilles Peskinea5d8d892020-07-23 21:27:15 +02001380 * \param[in] s A bignum to multiply, of size \p i.
1381 * It may overlap with \p d, but only if
1382 * \p d <= \p s.
1383 * Its leading limb must not be \c 0.
Gilles Peskinea5d8d892020-07-23 21:27:15 +02001384 * \param b A scalar to multiply.
Hanno Beckerdefe5692022-04-06 06:12:09 +01001385 *
1386 * \return c The carry at the end of the operation.
Paul Bakkerfc4f46f2013-06-24 19:23:56 +02001387 */
1388static
1389#if defined(__APPLE__) && defined(__arm__)
1390/*
1391 * Apple LLVM version 4.2 (clang-425.0.24) (based on LLVM 3.2svn)
1392 * appears to need this to prevent bad ARM code generation at -O3.
1393 */
1394__attribute__ ((noinline))
1395#endif
Hanno Beckerdefe5692022-04-06 06:12:09 +01001396mbedtls_mpi_uint mpi_mul_hlp( mbedtls_mpi_uint *d, size_t d_len ,
1397 const mbedtls_mpi_uint *s, size_t s_len,
1398 mbedtls_mpi_uint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001399{
Hanno Beckere7f14a32022-04-06 06:11:26 +01001400 mbedtls_mpi_uint c = 0; /* carry */
Paul Bakker5121ce52009-01-03 21:22:43 +00001401
Hanno Beckerdefe5692022-04-06 06:12:09 +01001402 /* Remember the excess of d over s for later */
1403 d_len -= s_len;
1404
Paul Bakker5121ce52009-01-03 21:22:43 +00001405#if defined(MULADDC_HUIT)
Hanno Beckerdefe5692022-04-06 06:12:09 +01001406 for( ; s_len >= 8; s_len -= 8 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001407 {
1408 MULADDC_INIT
1409 MULADDC_HUIT
1410 MULADDC_STOP
1411 }
1412
Hanno Beckerdefe5692022-04-06 06:12:09 +01001413 for( ; s_len > 0; s_len-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001414 {
1415 MULADDC_INIT
1416 MULADDC_CORE
1417 MULADDC_STOP
1418 }
Paul Bakker9af723c2014-05-01 13:03:14 +02001419#else /* MULADDC_HUIT */
Hanno Beckerdefe5692022-04-06 06:12:09 +01001420 for( ; s_len >= 16; s_len -= 16 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001421 {
1422 MULADDC_INIT
1423 MULADDC_CORE MULADDC_CORE
1424 MULADDC_CORE MULADDC_CORE
1425 MULADDC_CORE MULADDC_CORE
1426 MULADDC_CORE MULADDC_CORE
1427
1428 MULADDC_CORE MULADDC_CORE
1429 MULADDC_CORE MULADDC_CORE
1430 MULADDC_CORE MULADDC_CORE
1431 MULADDC_CORE MULADDC_CORE
1432 MULADDC_STOP
1433 }
1434
Hanno Beckerdefe5692022-04-06 06:12:09 +01001435 for( ; s_len >= 8; s_len -= 8 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001436 {
1437 MULADDC_INIT
1438 MULADDC_CORE MULADDC_CORE
1439 MULADDC_CORE MULADDC_CORE
1440
1441 MULADDC_CORE MULADDC_CORE
1442 MULADDC_CORE MULADDC_CORE
1443 MULADDC_STOP
1444 }
1445
Hanno Beckerdefe5692022-04-06 06:12:09 +01001446 for( ; s_len > 0; s_len-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001447 {
1448 MULADDC_INIT
1449 MULADDC_CORE
1450 MULADDC_STOP
1451 }
Paul Bakker9af723c2014-05-01 13:03:14 +02001452#endif /* MULADDC_HUIT */
Paul Bakker5121ce52009-01-03 21:22:43 +00001453
Hanno Beckerdefe5692022-04-06 06:12:09 +01001454 while( d_len-- )
Gilles Peskine8e464c42020-07-24 00:08:38 +02001455 {
Paul Bakker5121ce52009-01-03 21:22:43 +00001456 *d += c; c = ( *d < c ); d++;
1457 }
Hanno Beckerdefe5692022-04-06 06:12:09 +01001458
1459 return( c );
Paul Bakker5121ce52009-01-03 21:22:43 +00001460}
1461
1462/*
1463 * Baseline multiplication: X = A * B (HAC 14.12)
1464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001465int mbedtls_mpi_mul_mpi( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001466{
Janos Follath24eed8d2019-11-22 13:21:35 +00001467 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerfee261a2022-04-06 06:20:22 +01001468 size_t i, j, k;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469 mbedtls_mpi TA, TB;
Gilles Peskine997be0a2021-06-15 21:44:32 +02001470 int result_is_zero = 0;
Hanno Becker73d7d792018-12-11 10:35:51 +00001471 MPI_VALIDATE_RET( X != NULL );
1472 MPI_VALIDATE_RET( A != NULL );
1473 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001474
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001475 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00001476
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001477 if( X == A ) { MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TA, A ) ); A = &TA; }
1478 if( X == B ) { MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, B ) ); B = &TB; }
Paul Bakker5121ce52009-01-03 21:22:43 +00001479
Paul Bakker23986e52011-04-24 08:57:21 +00001480 for( i = A->n; i > 0; i-- )
1481 if( A->p[i - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001482 break;
Gilles Peskine4169c322021-06-17 14:35:25 +02001483 if( i == 0 )
Gilles Peskine997be0a2021-06-15 21:44:32 +02001484 result_is_zero = 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001485
Paul Bakker23986e52011-04-24 08:57:21 +00001486 for( j = B->n; j > 0; j-- )
1487 if( B->p[j - 1] != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001488 break;
Gilles Peskine4169c322021-06-17 14:35:25 +02001489 if( j == 0 )
Gilles Peskine997be0a2021-06-15 21:44:32 +02001490 result_is_zero = 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001491
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001492 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, i + j ) );
1493 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( X, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001494
Hanno Beckerfee261a2022-04-06 06:20:22 +01001495 for( k = 0; k < j; k++ )
1496 {
1497 /* We know that there cannot be any carry-out since we're
1498 * iterating from bottom to top. */
1499 (void) mpi_mul_hlp( X->p + k, i + 1,
1500 A->p, i,
1501 B->p[k] );
1502 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001503
Gilles Peskinef4998b02021-06-10 15:51:54 +02001504 /* If the result is 0, we don't shortcut the operation, which reduces
1505 * but does not eliminate side channels leaking the zero-ness. We do
1506 * need to take care to set the sign bit properly since the library does
1507 * not fully support an MPI object with a value of 0 and s == -1. */
Gilles Peskine997be0a2021-06-15 21:44:32 +02001508 if( result_is_zero )
Gilles Peskinef4998b02021-06-10 15:51:54 +02001509 X->s = 1;
Gilles Peskinef4998b02021-06-10 15:51:54 +02001510 else
1511 X->s = A->s * B->s;
Paul Bakker5121ce52009-01-03 21:22:43 +00001512
1513cleanup:
1514
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001515 mbedtls_mpi_free( &TB ); mbedtls_mpi_free( &TA );
Paul Bakker5121ce52009-01-03 21:22:43 +00001516
1517 return( ret );
1518}
1519
1520/*
1521 * Baseline multiplication: X = A * b
1522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523int mbedtls_mpi_mul_int( mbedtls_mpi *X, const mbedtls_mpi *A, mbedtls_mpi_uint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001524{
Hanno Becker73d7d792018-12-11 10:35:51 +00001525 MPI_VALIDATE_RET( X != NULL );
1526 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001527
Hanno Becker74a11a32022-04-06 06:27:00 +01001528 /* The general method below doesn't work if b==0. */
1529 if( b == 0 )
Paul Elliott986b55a2021-04-20 21:46:29 +01001530 return( mbedtls_mpi_lset( X, 0 ) );
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001531
Gilles Peskinee1bba7c2021-03-10 23:44:10 +01001532 /* Calculate A*b as A + A*(b-1) to take advantage of mpi_mul_hlp */
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001533 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskinecd0dbf32020-07-24 00:09:04 +02001534 /* In general, A * b requires 1 limb more than b. If
1535 * A->p[n - 1] * b / b == A->p[n - 1], then A * b fits in the same
1536 * number of limbs as A and the call to grow() is not required since
Gilles Peskinee1bba7c2021-03-10 23:44:10 +01001537 * copy() will take care of the growth if needed. However, experimentally,
1538 * making the call to grow() unconditional causes slightly fewer
Gilles Peskinecd0dbf32020-07-24 00:09:04 +02001539 * calls to calloc() in ECP code, presumably because it reuses the
1540 * same mpi for a while and this way the mpi is more likely to directly
1541 * grow to its final size. */
Hanno Becker74a11a32022-04-06 06:27:00 +01001542 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, A->n + 1 ) );
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001543 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, A ) );
Hanno Becker74a11a32022-04-06 06:27:00 +01001544 mpi_mul_hlp( X->p, X->n, A->p, A->n, b - 1 );
Gilles Peskine8fd95c62020-07-23 21:58:50 +02001545
1546cleanup:
1547 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001548}
1549
1550/*
Simon Butcherf5ba0452015-12-27 23:01:55 +00001551 * Unsigned integer divide - double mbedtls_mpi_uint dividend, u1/u0, and
1552 * mbedtls_mpi_uint divisor, d
Simon Butcher15b15d12015-11-26 19:35:03 +00001553 */
Simon Butcherf5ba0452015-12-27 23:01:55 +00001554static mbedtls_mpi_uint mbedtls_int_div_int( mbedtls_mpi_uint u1,
1555 mbedtls_mpi_uint u0, mbedtls_mpi_uint d, mbedtls_mpi_uint *r )
Simon Butcher15b15d12015-11-26 19:35:03 +00001556{
Manuel Pégourié-Gonnard16308882015-12-01 10:27:00 +01001557#if defined(MBEDTLS_HAVE_UDBL)
1558 mbedtls_t_udbl dividend, quotient;
Simon Butcherf5ba0452015-12-27 23:01:55 +00001559#else
Simon Butcher9803d072016-01-03 00:24:34 +00001560 const mbedtls_mpi_uint radix = (mbedtls_mpi_uint) 1 << biH;
1561 const mbedtls_mpi_uint uint_halfword_mask = ( (mbedtls_mpi_uint) 1 << biH ) - 1;
Simon Butcherf5ba0452015-12-27 23:01:55 +00001562 mbedtls_mpi_uint d0, d1, q0, q1, rAX, r0, quotient;
1563 mbedtls_mpi_uint u0_msw, u0_lsw;
Simon Butcher9803d072016-01-03 00:24:34 +00001564 size_t s;
Manuel Pégourié-Gonnard16308882015-12-01 10:27:00 +01001565#endif
1566
Simon Butcher15b15d12015-11-26 19:35:03 +00001567 /*
1568 * Check for overflow
1569 */
Simon Butcherf5ba0452015-12-27 23:01:55 +00001570 if( 0 == d || u1 >= d )
Simon Butcher15b15d12015-11-26 19:35:03 +00001571 {
Simon Butcherf5ba0452015-12-27 23:01:55 +00001572 if (r != NULL) *r = ~0;
Simon Butcher15b15d12015-11-26 19:35:03 +00001573
Simon Butcherf5ba0452015-12-27 23:01:55 +00001574 return ( ~0 );
Simon Butcher15b15d12015-11-26 19:35:03 +00001575 }
1576
1577#if defined(MBEDTLS_HAVE_UDBL)
Simon Butcher15b15d12015-11-26 19:35:03 +00001578 dividend = (mbedtls_t_udbl) u1 << biL;
1579 dividend |= (mbedtls_t_udbl) u0;
1580 quotient = dividend / d;
1581 if( quotient > ( (mbedtls_t_udbl) 1 << biL ) - 1 )
1582 quotient = ( (mbedtls_t_udbl) 1 << biL ) - 1;
1583
1584 if( r != NULL )
Simon Butcher9803d072016-01-03 00:24:34 +00001585 *r = (mbedtls_mpi_uint)( dividend - (quotient * d ) );
Simon Butcher15b15d12015-11-26 19:35:03 +00001586
1587 return (mbedtls_mpi_uint) quotient;
1588#else
Simon Butcher15b15d12015-11-26 19:35:03 +00001589
1590 /*
1591 * Algorithm D, Section 4.3.1 - The Art of Computer Programming
1592 * Vol. 2 - Seminumerical Algorithms, Knuth
1593 */
1594
1595 /*
1596 * Normalize the divisor, d, and dividend, u0, u1
1597 */
1598 s = mbedtls_clz( d );
1599 d = d << s;
1600
1601 u1 = u1 << s;
Simon Butcher9803d072016-01-03 00:24:34 +00001602 u1 |= ( u0 >> ( biL - s ) ) & ( -(mbedtls_mpi_sint)s >> ( biL - 1 ) );
Simon Butcher15b15d12015-11-26 19:35:03 +00001603 u0 = u0 << s;
1604
1605 d1 = d >> biH;
Simon Butcher9803d072016-01-03 00:24:34 +00001606 d0 = d & uint_halfword_mask;
Simon Butcher15b15d12015-11-26 19:35:03 +00001607
1608 u0_msw = u0 >> biH;
Simon Butcher9803d072016-01-03 00:24:34 +00001609 u0_lsw = u0 & uint_halfword_mask;
Simon Butcher15b15d12015-11-26 19:35:03 +00001610
1611 /*
1612 * Find the first quotient and remainder
1613 */
1614 q1 = u1 / d1;
1615 r0 = u1 - d1 * q1;
1616
1617 while( q1 >= radix || ( q1 * d0 > radix * r0 + u0_msw ) )
1618 {
1619 q1 -= 1;
1620 r0 += d1;
1621
1622 if ( r0 >= radix ) break;
1623 }
1624
Simon Butcherf5ba0452015-12-27 23:01:55 +00001625 rAX = ( u1 * radix ) + ( u0_msw - q1 * d );
Simon Butcher15b15d12015-11-26 19:35:03 +00001626 q0 = rAX / d1;
1627 r0 = rAX - q0 * d1;
1628
1629 while( q0 >= radix || ( q0 * d0 > radix * r0 + u0_lsw ) )
1630 {
1631 q0 -= 1;
1632 r0 += d1;
1633
1634 if ( r0 >= radix ) break;
1635 }
1636
1637 if (r != NULL)
Simon Butcherf5ba0452015-12-27 23:01:55 +00001638 *r = ( rAX * radix + u0_lsw - q0 * d ) >> s;
Simon Butcher15b15d12015-11-26 19:35:03 +00001639
1640 quotient = q1 * radix + q0;
1641
1642 return quotient;
1643#endif
1644}
1645
1646/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647 * Division by mbedtls_mpi: A = Q * B + R (HAC 14.20)
Paul Bakker5121ce52009-01-03 21:22:43 +00001648 */
Hanno Becker73d7d792018-12-11 10:35:51 +00001649int mbedtls_mpi_div_mpi( mbedtls_mpi *Q, mbedtls_mpi *R, const mbedtls_mpi *A,
1650 const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001651{
Janos Follath24eed8d2019-11-22 13:21:35 +00001652 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001653 size_t i, n, t, k;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654 mbedtls_mpi X, Y, Z, T1, T2;
Alexander Kd19a1932019-11-01 18:20:42 +03001655 mbedtls_mpi_uint TP2[3];
Hanno Becker73d7d792018-12-11 10:35:51 +00001656 MPI_VALIDATE_RET( A != NULL );
1657 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001658
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001659 if( mbedtls_mpi_cmp_int( B, 0 ) == 0 )
1660 return( MBEDTLS_ERR_MPI_DIVISION_BY_ZERO );
Paul Bakker5121ce52009-01-03 21:22:43 +00001661
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662 mbedtls_mpi_init( &X ); mbedtls_mpi_init( &Y ); mbedtls_mpi_init( &Z );
Alexander K35d6d462019-10-31 14:46:45 +03001663 mbedtls_mpi_init( &T1 );
Alexander Kd19a1932019-11-01 18:20:42 +03001664 /*
1665 * Avoid dynamic memory allocations for constant-size T2.
1666 *
1667 * T2 is used for comparison only and the 3 limbs are assigned explicitly,
1668 * so nobody increase the size of the MPI and we're safe to use an on-stack
1669 * buffer.
1670 */
Alexander K35d6d462019-10-31 14:46:45 +03001671 T2.s = 1;
Alexander Kd19a1932019-11-01 18:20:42 +03001672 T2.n = sizeof( TP2 ) / sizeof( *TP2 );
1673 T2.p = TP2;
Paul Bakker5121ce52009-01-03 21:22:43 +00001674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001675 if( mbedtls_mpi_cmp_abs( A, B ) < 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001676 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677 if( Q != NULL ) MBEDTLS_MPI_CHK( mbedtls_mpi_lset( Q, 0 ) );
1678 if( R != NULL ) MBEDTLS_MPI_CHK( mbedtls_mpi_copy( R, A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001679 return( 0 );
1680 }
1681
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001682 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &X, A ) );
1683 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Y, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001684 X.s = Y.s = 1;
1685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001686 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &Z, A->n + 2 ) );
1687 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &Z, 0 ) );
Gilles Peskine2536aa72020-07-24 00:12:59 +02001688 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &T1, A->n + 2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001689
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02001690 k = mbedtls_mpi_bitlen( &Y ) % biL;
Paul Bakkerf9688572011-05-05 10:00:45 +00001691 if( k < biL - 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001692 {
1693 k = biL - 1 - k;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &X, k ) );
1695 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &Y, k ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001696 }
1697 else k = 0;
1698
1699 n = X.n - 1;
1700 t = Y.n - 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001701 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &Y, biL * ( n - t ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001702
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001703 while( mbedtls_mpi_cmp_mpi( &X, &Y ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001704 {
1705 Z.p[n - t]++;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &X, &X, &Y ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001707 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &Y, biL * ( n - t ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001709
1710 for( i = n; i > t ; i-- )
1711 {
1712 if( X.p[i] >= Y.p[t] )
1713 Z.p[i - t - 1] = ~0;
1714 else
1715 {
Simon Butcher15b15d12015-11-26 19:35:03 +00001716 Z.p[i - t - 1] = mbedtls_int_div_int( X.p[i], X.p[i - 1],
1717 Y.p[t], NULL);
Paul Bakker5121ce52009-01-03 21:22:43 +00001718 }
1719
Alexander K35d6d462019-10-31 14:46:45 +03001720 T2.p[0] = ( i < 2 ) ? 0 : X.p[i - 2];
1721 T2.p[1] = ( i < 1 ) ? 0 : X.p[i - 1];
1722 T2.p[2] = X.p[i];
1723
Paul Bakker5121ce52009-01-03 21:22:43 +00001724 Z.p[i - t - 1]++;
1725 do
1726 {
1727 Z.p[i - t - 1]--;
1728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &T1, 0 ) );
Paul Bakker66d5d072014-06-17 16:39:18 +02001730 T1.p[0] = ( t < 1 ) ? 0 : Y.p[t - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +00001731 T1.p[1] = Y.p[t];
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T1, &T1, Z.p[i - t - 1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001733 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734 while( mbedtls_mpi_cmp_mpi( &T1, &T2 ) > 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_int( &T1, &Y, Z.p[i - t - 1] ) );
1737 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &T1, biL * ( i - t - 1 ) ) );
1738 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &X, &X, &T1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001740 if( mbedtls_mpi_cmp_int( &X, 0 ) < 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001741 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &T1, &Y ) );
1743 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &T1, biL * ( i - t - 1 ) ) );
1744 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &X, &X, &T1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001745 Z.p[i - t - 1]--;
1746 }
1747 }
1748
1749 if( Q != NULL )
1750 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001751 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( Q, &Z ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001752 Q->s = A->s * B->s;
1753 }
1754
1755 if( R != NULL )
1756 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &X, k ) );
Paul Bakkerf02c5642012-11-13 10:25:21 +00001758 X.s = A->s;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001759 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( R, &X ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761 if( mbedtls_mpi_cmp_int( R, 0 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001762 R->s = 1;
1763 }
1764
1765cleanup:
1766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767 mbedtls_mpi_free( &X ); mbedtls_mpi_free( &Y ); mbedtls_mpi_free( &Z );
Alexander K35d6d462019-10-31 14:46:45 +03001768 mbedtls_mpi_free( &T1 );
Alexander Kd19a1932019-11-01 18:20:42 +03001769 mbedtls_platform_zeroize( TP2, sizeof( TP2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001770
1771 return( ret );
1772}
1773
1774/*
1775 * Division by int: A = Q * b + R
Paul Bakker5121ce52009-01-03 21:22:43 +00001776 */
Hanno Becker73d7d792018-12-11 10:35:51 +00001777int mbedtls_mpi_div_int( mbedtls_mpi *Q, mbedtls_mpi *R,
1778 const mbedtls_mpi *A,
1779 mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001780{
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001781 mbedtls_mpi B;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782 mbedtls_mpi_uint p[1];
Hanno Becker73d7d792018-12-11 10:35:51 +00001783 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001784
1785 p[0] = ( b < 0 ) ? -b : b;
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001786 B.s = ( b < 0 ) ? -1 : 1;
1787 B.n = 1;
1788 B.p = p;
Paul Bakker5121ce52009-01-03 21:22:43 +00001789
Yuto Takano36c8ddc2021-07-05 09:10:52 +01001790 return( mbedtls_mpi_div_mpi( Q, R, A, &B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001791}
1792
1793/*
1794 * Modulo: R = A mod B
1795 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796int mbedtls_mpi_mod_mpi( mbedtls_mpi *R, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00001797{
Janos Follath24eed8d2019-11-22 13:21:35 +00001798 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker73d7d792018-12-11 10:35:51 +00001799 MPI_VALIDATE_RET( R != NULL );
1800 MPI_VALIDATE_RET( A != NULL );
1801 MPI_VALIDATE_RET( B != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 if( mbedtls_mpi_cmp_int( B, 0 ) < 0 )
1804 return( MBEDTLS_ERR_MPI_NEGATIVE_VALUE );
Paul Bakkerce40a6d2009-06-23 19:46:08 +00001805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 MBEDTLS_MPI_CHK( mbedtls_mpi_div_mpi( NULL, R, A, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001807
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001808 while( mbedtls_mpi_cmp_int( R, 0 ) < 0 )
1809 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( R, R, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001810
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811 while( mbedtls_mpi_cmp_mpi( R, B ) >= 0 )
1812 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( R, R, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001813
1814cleanup:
1815
1816 return( ret );
1817}
1818
1819/*
1820 * Modulo: r = A mod b
1821 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822int mbedtls_mpi_mod_int( mbedtls_mpi_uint *r, const mbedtls_mpi *A, mbedtls_mpi_sint b )
Paul Bakker5121ce52009-01-03 21:22:43 +00001823{
Paul Bakker23986e52011-04-24 08:57:21 +00001824 size_t i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825 mbedtls_mpi_uint x, y, z;
Hanno Becker73d7d792018-12-11 10:35:51 +00001826 MPI_VALIDATE_RET( r != NULL );
1827 MPI_VALIDATE_RET( A != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00001828
1829 if( b == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830 return( MBEDTLS_ERR_MPI_DIVISION_BY_ZERO );
Paul Bakker5121ce52009-01-03 21:22:43 +00001831
1832 if( b < 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001833 return( MBEDTLS_ERR_MPI_NEGATIVE_VALUE );
Paul Bakker5121ce52009-01-03 21:22:43 +00001834
1835 /*
1836 * handle trivial cases
1837 */
1838 if( b == 1 )
1839 {
1840 *r = 0;
1841 return( 0 );
1842 }
1843
1844 if( b == 2 )
1845 {
1846 *r = A->p[0] & 1;
1847 return( 0 );
1848 }
1849
1850 /*
1851 * general case
1852 */
Paul Bakker23986e52011-04-24 08:57:21 +00001853 for( i = A->n, y = 0; i > 0; i-- )
Paul Bakker5121ce52009-01-03 21:22:43 +00001854 {
Paul Bakker23986e52011-04-24 08:57:21 +00001855 x = A->p[i - 1];
Paul Bakker5121ce52009-01-03 21:22:43 +00001856 y = ( y << biH ) | ( x >> biH );
1857 z = y / b;
1858 y -= z * b;
1859
1860 x <<= biH;
1861 y = ( y << biH ) | ( x >> biH );
1862 z = y / b;
1863 y -= z * b;
1864 }
1865
Paul Bakkerce40a6d2009-06-23 19:46:08 +00001866 /*
1867 * If A is negative, then the current y represents a negative value.
1868 * Flipping it to the positive side.
1869 */
1870 if( A->s < 0 && y != 0 )
1871 y = b - y;
1872
Paul Bakker5121ce52009-01-03 21:22:43 +00001873 *r = y;
1874
1875 return( 0 );
1876}
1877
1878/*
1879 * Fast Montgomery initialization (thanks to Tom St Denis)
1880 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881static void mpi_montg_init( mbedtls_mpi_uint *mm, const mbedtls_mpi *N )
Paul Bakker5121ce52009-01-03 21:22:43 +00001882{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883 mbedtls_mpi_uint x, m0 = N->p[0];
Manuel Pégourié-Gonnardfdf3f0e2014-03-11 13:47:05 +01001884 unsigned int i;
Paul Bakker5121ce52009-01-03 21:22:43 +00001885
1886 x = m0;
1887 x += ( ( m0 + 2 ) & 4 ) << 1;
Paul Bakker5121ce52009-01-03 21:22:43 +00001888
Manuel Pégourié-Gonnardfdf3f0e2014-03-11 13:47:05 +01001889 for( i = biL; i >= 8; i /= 2 )
1890 x *= ( 2 - ( m0 * x ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001891
1892 *mm = ~x + 1;
1893}
1894
Gilles Peskine2a82f722020-06-04 15:00:49 +02001895/** Montgomery multiplication: A = A * B * R^-1 mod N (HAC 14.36)
1896 *
1897 * \param[in,out] A One of the numbers to multiply.
Gilles Peskine221626f2020-06-08 22:37:50 +02001898 * It must have at least as many limbs as N
1899 * (A->n >= N->n), and any limbs beyond n are ignored.
Gilles Peskine2a82f722020-06-04 15:00:49 +02001900 * On successful completion, A contains the result of
1901 * the multiplication A * B * R^-1 mod N where
1902 * R = (2^ciL)^n.
1903 * \param[in] B One of the numbers to multiply.
1904 * It must be nonzero and must not have more limbs than N
1905 * (B->n <= N->n).
1906 * \param[in] N The modulo. N must be odd.
1907 * \param mm The value calculated by `mpi_montg_init(&mm, N)`.
1908 * This is -N^-1 mod 2^ciL.
1909 * \param[in,out] T A bignum for temporary storage.
Hanno Beckere1417022022-04-06 06:45:45 +01001910 * It must be at least twice the limb size of N plus 1
1911 * (T->n >= 2 * N->n + 1).
Gilles Peskine2a82f722020-06-04 15:00:49 +02001912 * Its initial content is unused and
1913 * its final content is indeterminate.
1914 * Note that unlike the usual convention in the library
1915 * for `const mbedtls_mpi*`, the content of T can change.
Paul Bakker5121ce52009-01-03 21:22:43 +00001916 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02001917static 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 +02001918 const mbedtls_mpi *T )
Paul Bakker5121ce52009-01-03 21:22:43 +00001919{
Paul Bakker23986e52011-04-24 08:57:21 +00001920 size_t i, n, m;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921 mbedtls_mpi_uint u0, u1, *d;
Paul Bakker5121ce52009-01-03 21:22:43 +00001922
1923 memset( T->p, 0, T->n * ciL );
1924
1925 d = T->p;
1926 n = N->n;
1927 m = ( B->n < n ) ? B->n : n;
1928
1929 for( i = 0; i < n; i++ )
1930 {
1931 /*
1932 * T = (T + u0*B + u1*N) / 2^biL
1933 */
1934 u0 = A->p[i];
1935 u1 = ( d[0] + u0 * B->p[0] ) * mm;
1936
Hanno Beckere1417022022-04-06 06:45:45 +01001937 (void) mpi_mul_hlp( d, n + 2,
1938 B->p, m,
1939 u0 );
1940 (void) mpi_mul_hlp( d, n + 2,
1941 N->p, n,
1942 u1 );
1943 d++;
Paul Bakker5121ce52009-01-03 21:22:43 +00001944 }
1945
Gilles Peskine221626f2020-06-08 22:37:50 +02001946 /* At this point, d is either the desired result or the desired result
1947 * plus N. We now potentially subtract N, avoiding leaking whether the
1948 * subtraction is performed through side channels. */
Paul Bakker5121ce52009-01-03 21:22:43 +00001949
Gilles Peskine221626f2020-06-08 22:37:50 +02001950 /* Copy the n least significant limbs of d to A, so that
1951 * A = d if d < N (recall that N has n limbs). */
1952 memcpy( A->p, d, n * ciL );
Gilles Peskine09ec10a2020-06-09 10:39:38 +02001953 /* If d >= N then we want to set A to d - N. To prevent timing attacks,
Gilles Peskine221626f2020-06-08 22:37:50 +02001954 * do the calculation without using conditional tests. */
1955 /* Set d to d0 + (2^biL)^n - N where d0 is the current value of d. */
Gilles Peskine132c0972020-06-04 21:05:24 +02001956 d[n] += 1;
Gilles Peskine1acf7cb2020-07-23 01:03:22 +02001957 d[n] -= mpi_sub_hlp( n, d, d, N->p );
Gilles Peskine221626f2020-06-08 22:37:50 +02001958 /* If d0 < N then d < (2^biL)^n
1959 * so d[n] == 0 and we want to keep A as it is.
1960 * If d0 >= N then d >= (2^biL)^n, and d <= (2^biL)^n + N < 2 * (2^biL)^n
1961 * so d[n] == 1 and we want to set A to the result of the subtraction
1962 * which is d - (2^biL)^n, i.e. the n least significant limbs of d.
1963 * This exactly corresponds to a conditional assignment. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001964 mbedtls_ct_mpi_uint_cond_assign( n, A->p, d, (unsigned char) d[n] );
Paul Bakker5121ce52009-01-03 21:22:43 +00001965}
1966
1967/*
1968 * Montgomery reduction: A = A * R^-1 mod N
Gilles Peskine2a82f722020-06-04 15:00:49 +02001969 *
1970 * See mpi_montmul() regarding constraints and guarantees on the parameters.
Paul Bakker5121ce52009-01-03 21:22:43 +00001971 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02001972static void mpi_montred( mbedtls_mpi *A, const mbedtls_mpi *N,
1973 mbedtls_mpi_uint mm, const mbedtls_mpi *T )
Paul Bakker5121ce52009-01-03 21:22:43 +00001974{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001975 mbedtls_mpi_uint z = 1;
1976 mbedtls_mpi U;
Paul Bakker5121ce52009-01-03 21:22:43 +00001977
Paul Bakker8ddb6452013-02-27 14:56:33 +01001978 U.n = U.s = (int) z;
Paul Bakker5121ce52009-01-03 21:22:43 +00001979 U.p = &z;
1980
Gilles Peskine4e91d472020-06-04 20:55:15 +02001981 mpi_montmul( A, &U, N, mm, T );
Paul Bakker5121ce52009-01-03 21:22:43 +00001982}
1983
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01001984/**
1985 * Select an MPI from a table without leaking the index.
1986 *
1987 * This is functionally equivalent to mbedtls_mpi_copy(R, T[idx]) except it
1988 * reads the entire table in order to avoid leaking the value of idx to an
1989 * attacker able to observe memory access patterns.
1990 *
1991 * \param[out] R Where to write the selected MPI.
1992 * \param[in] T The table to read from.
1993 * \param[in] T_size The number of elements in the table.
1994 * \param[in] idx The index of the element to select;
1995 * this must satisfy 0 <= idx < T_size.
1996 *
1997 * \return \c 0 on success, or a negative error code.
1998 */
1999static int mpi_select( mbedtls_mpi *R, const mbedtls_mpi *T, size_t T_size, size_t idx )
2000{
2001 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2002
2003 for( size_t i = 0; i < T_size; i++ )
Manuel Pégourié-Gonnard92413ef2021-06-03 10:42:46 +02002004 {
2005 MBEDTLS_MPI_CHK( mbedtls_mpi_safe_cond_assign( R, &T[i],
Gabor Mezei90437e32021-10-20 11:59:27 +02002006 (unsigned char) mbedtls_ct_size_bool_eq( i, idx ) ) );
Manuel Pégourié-Gonnard92413ef2021-06-03 10:42:46 +02002007 }
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01002008
2009cleanup:
2010 return( ret );
2011}
2012
Paul Bakker5121ce52009-01-03 21:22:43 +00002013/*
2014 * Sliding-window exponentiation: X = A^E mod N (HAC 14.85)
2015 */
Hanno Becker73d7d792018-12-11 10:35:51 +00002016int mbedtls_mpi_exp_mod( mbedtls_mpi *X, const mbedtls_mpi *A,
2017 const mbedtls_mpi *E, const mbedtls_mpi *N,
Yuto Takano538a0cb2021-07-14 10:20:09 +01002018 mbedtls_mpi *prec_RR )
Paul Bakker5121ce52009-01-03 21:22:43 +00002019{
Janos Follath24eed8d2019-11-22 13:21:35 +00002020 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002021 size_t wbits, wsize, one = 1;
2022 size_t i, j, nblimbs;
2023 size_t bufsize, nbits;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002024 mbedtls_mpi_uint ei, mm, state;
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01002025 mbedtls_mpi RR, T, W[ 1 << MBEDTLS_MPI_WINDOW_SIZE ], WW, Apos;
Paul Bakkerf6198c12012-05-16 08:02:29 +00002026 int neg;
Paul Bakker5121ce52009-01-03 21:22:43 +00002027
Hanno Becker73d7d792018-12-11 10:35:51 +00002028 MPI_VALIDATE_RET( X != NULL );
2029 MPI_VALIDATE_RET( A != NULL );
2030 MPI_VALIDATE_RET( E != NULL );
2031 MPI_VALIDATE_RET( N != NULL );
2032
Hanno Becker8d1dd1b2017-09-28 11:02:24 +01002033 if( mbedtls_mpi_cmp_int( N, 0 ) <= 0 || ( N->p[0] & 1 ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00002035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002036 if( mbedtls_mpi_cmp_int( E, 0 ) < 0 )
2037 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakkerf6198c12012-05-16 08:02:29 +00002038
Chris Jones9246d042020-11-25 15:12:39 +00002039 if( mbedtls_mpi_bitlen( E ) > MBEDTLS_MPI_MAX_BITS ||
2040 mbedtls_mpi_bitlen( N ) > MBEDTLS_MPI_MAX_BITS )
2041 return ( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
2042
Paul Bakkerf6198c12012-05-16 08:02:29 +00002043 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00002044 * Init temps and window size
2045 */
2046 mpi_montg_init( &mm, N );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002047 mbedtls_mpi_init( &RR ); mbedtls_mpi_init( &T );
2048 mbedtls_mpi_init( &Apos );
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01002049 mbedtls_mpi_init( &WW );
Paul Bakker5121ce52009-01-03 21:22:43 +00002050 memset( W, 0, sizeof( W ) );
2051
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02002052 i = mbedtls_mpi_bitlen( E );
Paul Bakker5121ce52009-01-03 21:22:43 +00002053
2054 wsize = ( i > 671 ) ? 6 : ( i > 239 ) ? 5 :
2055 ( i > 79 ) ? 4 : ( i > 23 ) ? 3 : 1;
2056
Peter Kolbuse6bcad32018-12-11 14:01:44 -06002057#if( MBEDTLS_MPI_WINDOW_SIZE < 6 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002058 if( wsize > MBEDTLS_MPI_WINDOW_SIZE )
2059 wsize = MBEDTLS_MPI_WINDOW_SIZE;
Peter Kolbuse6bcad32018-12-11 14:01:44 -06002060#endif
Paul Bakkerb6d5f082011-11-25 11:52:11 +00002061
Paul Bakker5121ce52009-01-03 21:22:43 +00002062 j = N->n + 1;
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02002063 /* All W[i] and X must have at least N->n limbs for the mpi_montmul()
2064 * and mpi_montred() calls later. Here we ensure that W[1] and X are
2065 * large enough, and later we'll grow other W[i] to the same length.
2066 * They must not be shrunk midway through this function!
2067 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002068 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, j ) );
2069 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[1], j ) );
2070 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &T, j * 2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002071
2072 /*
Paul Bakker50546922012-05-19 08:40:49 +00002073 * Compensate for negative A (and correct at the end)
2074 */
2075 neg = ( A->s == -1 );
Paul Bakker50546922012-05-19 08:40:49 +00002076 if( neg )
2077 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Apos, A ) );
Paul Bakker50546922012-05-19 08:40:49 +00002079 Apos.s = 1;
2080 A = &Apos;
2081 }
2082
2083 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00002084 * If 1st call, pre-compute R^2 mod N
2085 */
Yuto Takano538a0cb2021-07-14 10:20:09 +01002086 if( prec_RR == NULL || prec_RR->p == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002087 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &RR, 1 ) );
2089 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &RR, N->n * 2 * biL ) );
2090 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &RR, &RR, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002091
Yuto Takano538a0cb2021-07-14 10:20:09 +01002092 if( prec_RR != NULL )
2093 memcpy( prec_RR, &RR, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002094 }
2095 else
Yuto Takano538a0cb2021-07-14 10:20:09 +01002096 memcpy( &RR, prec_RR, sizeof( mbedtls_mpi ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002097
2098 /*
2099 * W[1] = A * R^2 * R^-1 mod N = A * R mod N
2100 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002101 if( mbedtls_mpi_cmp_mpi( A, N ) >= 0 )
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02002102 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &W[1], A, N ) );
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02002104 /* This should be a no-op because W[1] is already that large before
2105 * mbedtls_mpi_mod_mpi(), but it's necessary to avoid an overflow
2106 * in mpi_montmul() below, so let's make sure. */
Gilles Peskine2aa3f162021-06-15 21:22:48 +02002107 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[1], N->n + 1 ) );
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02002108 }
Paul Bakkerc2024f42014-01-23 20:38:35 +01002109 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[1], A ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002111
Gilles Peskine3da1a8f2021-06-08 23:17:42 +02002112 /* Note that this is safe because W[1] always has at least N->n limbs
2113 * (it grew above and was preserved by mbedtls_mpi_copy()). */
Gilles Peskine4e91d472020-06-04 20:55:15 +02002114 mpi_montmul( &W[1], &RR, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002115
2116 /*
2117 * X = R^2 * R^-1 mod N = R mod N
2118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, &RR ) );
Gilles Peskine4e91d472020-06-04 20:55:15 +02002120 mpi_montred( X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002121
2122 if( wsize > 1 )
2123 {
2124 /*
2125 * W[1 << (wsize - 1)] = W[1] ^ (wsize - 1)
2126 */
Paul Bakker66d5d072014-06-17 16:39:18 +02002127 j = one << ( wsize - 1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002129 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[j], N->n + 1 ) );
2130 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[j], &W[1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002131
2132 for( i = 0; i < wsize - 1; i++ )
Gilles Peskine4e91d472020-06-04 20:55:15 +02002133 mpi_montmul( &W[j], &W[j], N, mm, &T );
Paul Bakker0d7702c2013-10-29 16:18:35 +01002134
Paul Bakker5121ce52009-01-03 21:22:43 +00002135 /*
2136 * W[i] = W[i - 1] * W[1]
2137 */
Paul Bakker66d5d072014-06-17 16:39:18 +02002138 for( i = j + 1; i < ( one << wsize ); i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00002139 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &W[i], N->n + 1 ) );
2141 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &W[i], &W[i - 1] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002142
Gilles Peskine4e91d472020-06-04 20:55:15 +02002143 mpi_montmul( &W[i], &W[1], N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002144 }
2145 }
2146
2147 nblimbs = E->n;
2148 bufsize = 0;
2149 nbits = 0;
2150 wbits = 0;
2151 state = 0;
2152
2153 while( 1 )
2154 {
2155 if( bufsize == 0 )
2156 {
Paul Bakker0d7702c2013-10-29 16:18:35 +01002157 if( nblimbs == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002158 break;
2159
Paul Bakker0d7702c2013-10-29 16:18:35 +01002160 nblimbs--;
2161
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002162 bufsize = sizeof( mbedtls_mpi_uint ) << 3;
Paul Bakker5121ce52009-01-03 21:22:43 +00002163 }
2164
2165 bufsize--;
2166
2167 ei = (E->p[nblimbs] >> bufsize) & 1;
2168
2169 /*
2170 * skip leading 0s
2171 */
2172 if( ei == 0 && state == 0 )
2173 continue;
2174
2175 if( ei == 0 && state == 1 )
2176 {
2177 /*
2178 * out of window, square X
2179 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02002180 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002181 continue;
2182 }
2183
2184 /*
2185 * add ei to current window
2186 */
2187 state = 2;
2188
2189 nbits++;
Paul Bakker66d5d072014-06-17 16:39:18 +02002190 wbits |= ( ei << ( wsize - nbits ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002191
2192 if( nbits == wsize )
2193 {
2194 /*
2195 * X = X^wsize R^-1 mod N
2196 */
2197 for( i = 0; i < wsize; i++ )
Gilles Peskine4e91d472020-06-04 20:55:15 +02002198 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002199
2200 /*
2201 * X = X * W[wbits] R^-1 mod N
2202 */
Manuel Pégourié-Gonnarde22176e2021-06-10 09:34:00 +02002203 MBEDTLS_MPI_CHK( mpi_select( &WW, W, (size_t) 1 << wsize, wbits ) );
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01002204 mpi_montmul( X, &WW, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002205
2206 state--;
2207 nbits = 0;
2208 wbits = 0;
2209 }
2210 }
2211
2212 /*
2213 * process the remaining bits
2214 */
2215 for( i = 0; i < nbits; i++ )
2216 {
Gilles Peskine4e91d472020-06-04 20:55:15 +02002217 mpi_montmul( X, X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002218
2219 wbits <<= 1;
2220
Paul Bakker66d5d072014-06-17 16:39:18 +02002221 if( ( wbits & ( one << wsize ) ) != 0 )
Gilles Peskine4e91d472020-06-04 20:55:15 +02002222 mpi_montmul( X, &W[1], N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002223 }
2224
2225 /*
2226 * X = A^E * R * R^-1 mod N = A^E mod N
2227 */
Gilles Peskine4e91d472020-06-04 20:55:15 +02002228 mpi_montred( X, N, mm, &T );
Paul Bakker5121ce52009-01-03 21:22:43 +00002229
Hanno Beckera4af1c42017-04-18 09:07:45 +01002230 if( neg && E->n != 0 && ( E->p[0] & 1 ) != 0 )
Paul Bakkerf6198c12012-05-16 08:02:29 +00002231 {
2232 X->s = -1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002233 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( X, N, X ) );
Paul Bakkerf6198c12012-05-16 08:02:29 +00002234 }
2235
Paul Bakker5121ce52009-01-03 21:22:43 +00002236cleanup:
2237
Paul Bakker66d5d072014-06-17 16:39:18 +02002238 for( i = ( one << ( wsize - 1 ) ); i < ( one << wsize ); i++ )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002239 mbedtls_mpi_free( &W[i] );
Paul Bakker5121ce52009-01-03 21:22:43 +00002240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241 mbedtls_mpi_free( &W[1] ); mbedtls_mpi_free( &T ); mbedtls_mpi_free( &Apos );
Manuel Pégourié-Gonnard1297ef32021-03-09 11:22:20 +01002242 mbedtls_mpi_free( &WW );
Paul Bakker6c591fa2011-05-05 11:49:20 +00002243
Yuto Takano538a0cb2021-07-14 10:20:09 +01002244 if( prec_RR == NULL || prec_RR->p == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245 mbedtls_mpi_free( &RR );
Paul Bakker5121ce52009-01-03 21:22:43 +00002246
2247 return( ret );
2248}
2249
Paul Bakker5121ce52009-01-03 21:22:43 +00002250/*
2251 * Greatest common divisor: G = gcd(A, B) (HAC 14.54)
2252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253int mbedtls_mpi_gcd( mbedtls_mpi *G, const mbedtls_mpi *A, const mbedtls_mpi *B )
Paul Bakker5121ce52009-01-03 21:22:43 +00002254{
Janos Follath24eed8d2019-11-22 13:21:35 +00002255 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002256 size_t lz, lzt;
Alexander Ke8ad49f2019-08-16 16:16:07 +03002257 mbedtls_mpi TA, TB;
Paul Bakker5121ce52009-01-03 21:22:43 +00002258
Hanno Becker73d7d792018-12-11 10:35:51 +00002259 MPI_VALIDATE_RET( G != NULL );
2260 MPI_VALIDATE_RET( A != NULL );
2261 MPI_VALIDATE_RET( B != NULL );
2262
Alexander Ke8ad49f2019-08-16 16:16:07 +03002263 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00002264
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002265 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TA, A ) );
2266 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, B ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002267
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268 lz = mbedtls_mpi_lsb( &TA );
2269 lzt = mbedtls_mpi_lsb( &TB );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002270
Gilles Peskine27253bc2021-06-09 13:26:43 +02002271 /* The loop below gives the correct result when A==0 but not when B==0.
2272 * So have a special case for B==0. Leverage the fact that we just
2273 * calculated the lsb and lsb(B)==0 iff B is odd or 0 to make the test
2274 * slightly more efficient than cmp_int(). */
2275 if( lzt == 0 && mbedtls_mpi_get_bit( &TB, 0 ) == 0 )
2276 {
2277 ret = mbedtls_mpi_copy( G, A );
2278 goto cleanup;
2279 }
2280
Paul Bakker66d5d072014-06-17 16:39:18 +02002281 if( lzt < lz )
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002282 lz = lzt;
2283
Paul Bakker5121ce52009-01-03 21:22:43 +00002284 TA.s = TB.s = 1;
2285
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002286 /* We mostly follow the procedure described in HAC 14.54, but with some
2287 * minor differences:
2288 * - Sequences of multiplications or divisions by 2 are grouped into a
2289 * single shift operation.
Gilles Peskineb09c7ee2021-06-21 18:58:39 +02002290 * - The procedure in HAC assumes that 0 < TB <= TA.
2291 * - The condition TB <= TA is not actually necessary for correctness.
2292 * TA and TB have symmetric roles except for the loop termination
2293 * condition, and the shifts at the beginning of the loop body
2294 * remove any significance from the ordering of TA vs TB before
2295 * the shifts.
2296 * - If TA = 0, the loop goes through 0 iterations and the result is
2297 * correctly TB.
2298 * - The case TB = 0 was short-circuited above.
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002299 *
2300 * For the correctness proof below, decompose the original values of
2301 * A and B as
2302 * A = sa * 2^a * A' with A'=0 or A' odd, and sa = +-1
2303 * B = sb * 2^b * B' with B'=0 or B' odd, and sb = +-1
2304 * Then gcd(A, B) = 2^{min(a,b)} * gcd(A',B'),
2305 * and gcd(A',B') is odd or 0.
2306 *
2307 * At the beginning, we have TA = |A| and TB = |B| so gcd(A,B) = gcd(TA,TB).
2308 * The code maintains the following invariant:
2309 * gcd(A,B) = 2^k * gcd(TA,TB) for some k (I)
Gilles Peskine4df3f1f2021-06-15 22:09:39 +02002310 */
2311
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002312 /* Proof that the loop terminates:
2313 * At each iteration, either the right-shift by 1 is made on a nonzero
2314 * value and the nonnegative integer bitlen(TA) + bitlen(TB) decreases
2315 * by at least 1, or the right-shift by 1 is made on zero and then
2316 * TA becomes 0 which ends the loop (TB cannot be 0 if it is right-shifted
2317 * since in that case TB is calculated from TB-TA with the condition TB>TA).
2318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002319 while( mbedtls_mpi_cmp_int( &TA, 0 ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002320 {
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002321 /* Divisions by 2 preserve the invariant (I). */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TA, mbedtls_mpi_lsb( &TA ) ) );
2323 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TB, mbedtls_mpi_lsb( &TB ) ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002324
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002325 /* Set either TA or TB to |TA-TB|/2. Since TA and TB are both odd,
2326 * TA-TB is even so the division by 2 has an integer result.
2327 * Invariant (I) is preserved since any odd divisor of both TA and TB
2328 * also divides |TA-TB|/2, and any odd divisor of both TA and |TA-TB|/2
2329 * also divides TB, and any odd divisior of both TB and |TA-TB|/2 also
2330 * divides TA.
2331 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002332 if( mbedtls_mpi_cmp_mpi( &TA, &TB ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002333 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( &TA, &TA, &TB ) );
2335 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TA, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002336 }
2337 else
2338 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_abs( &TB, &TB, &TA ) );
2340 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TB, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002341 }
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002342 /* Note that one of TA or TB is still odd. */
Paul Bakker5121ce52009-01-03 21:22:43 +00002343 }
2344
Gilles Peskine2a63c5b2021-06-16 13:42:04 +02002345 /* By invariant (I), gcd(A,B) = 2^k * gcd(TA,TB) for some k.
2346 * At the loop exit, TA = 0, so gcd(TA,TB) = TB.
2347 * - If there was at least one loop iteration, then one of TA or TB is odd,
2348 * and TA = 0, so TB is odd and gcd(TA,TB) = gcd(A',B'). In this case,
2349 * lz = min(a,b) so gcd(A,B) = 2^lz * TB.
2350 * - If there was no loop iteration, then A was 0, and gcd(A,B) = B.
Gilles Peskine4d3fd362021-06-21 11:40:38 +02002351 * 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 +02002352 */
2353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_l( &TB, lz ) );
2355 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( G, &TB ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002356
2357cleanup:
2358
Alexander Ke8ad49f2019-08-16 16:16:07 +03002359 mbedtls_mpi_free( &TA ); mbedtls_mpi_free( &TB );
Paul Bakker5121ce52009-01-03 21:22:43 +00002360
2361 return( ret );
2362}
2363
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002364/* Fill X with n_bytes random bytes.
2365 * X must already have room for those bytes.
Gilles Peskineafb2bd22021-06-03 11:51:09 +02002366 * The ordering of the bytes returned from the RNG is suitable for
2367 * deterministic ECDSA (see RFC 6979 §3.3 and mbedtls_mpi_random()).
Gilles Peskineebe9b6a2021-04-13 21:55:35 +02002368 * The size and sign of X are unchanged.
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002369 * n_bytes must not be 0.
2370 */
2371static int mpi_fill_random_internal(
2372 mbedtls_mpi *X, size_t n_bytes,
2373 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng )
2374{
2375 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2376 const size_t limbs = CHARS_TO_LIMBS( n_bytes );
2377 const size_t overhead = ( limbs * ciL ) - n_bytes;
2378
2379 if( X->n < limbs )
2380 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002381
Gilles Peskineebe9b6a2021-04-13 21:55:35 +02002382 memset( X->p, 0, overhead );
2383 memset( (unsigned char *) X->p + limbs * ciL, 0, ( X->n - limbs ) * ciL );
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002384 MBEDTLS_MPI_CHK( f_rng( p_rng, (unsigned char *) X->p + overhead, n_bytes ) );
2385 mpi_bigendian_to_host( X->p, limbs );
2386
2387cleanup:
2388 return( ret );
2389}
2390
Paul Bakker33dc46b2014-04-30 16:11:39 +02002391/*
2392 * Fill X with size bytes of random.
2393 *
2394 * Use a temporary bytes representation to make sure the result is the same
Paul Bakkerc37b0ac2014-05-01 14:19:23 +02002395 * regardless of the platform endianness (useful when f_rng is actually
Paul Bakker33dc46b2014-04-30 16:11:39 +02002396 * deterministic, eg for tests).
2397 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002398int mbedtls_mpi_fill_random( mbedtls_mpi *X, size_t size,
Paul Bakkera3d195c2011-11-27 21:07:34 +00002399 int (*f_rng)(void *, unsigned char *, size_t),
2400 void *p_rng )
Paul Bakker287781a2011-03-26 13:18:49 +00002401{
Janos Follath24eed8d2019-11-22 13:21:35 +00002402 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker6dab6202019-01-02 16:42:29 +00002403 size_t const limbs = CHARS_TO_LIMBS( size );
Hanno Beckerda1655a2017-10-18 14:21:44 +01002404
Hanno Becker8ce11a32018-12-19 16:18:52 +00002405 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002406 MPI_VALIDATE_RET( f_rng != NULL );
Paul Bakker33dc46b2014-04-30 16:11:39 +02002407
Hanno Beckerda1655a2017-10-18 14:21:44 +01002408 /* Ensure that target MPI has exactly the necessary number of limbs */
Gilles Peskineed32b572021-06-02 22:17:52 +02002409 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, limbs ) );
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002410 if( size == 0 )
2411 return( 0 );
Paul Bakker287781a2011-03-26 13:18:49 +00002412
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002413 ret = mpi_fill_random_internal( X, size, f_rng, p_rng );
Paul Bakker287781a2011-03-26 13:18:49 +00002414
2415cleanup:
2416 return( ret );
2417}
2418
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002419int mbedtls_mpi_random( mbedtls_mpi *X,
2420 mbedtls_mpi_sint min,
2421 const mbedtls_mpi *N,
2422 int (*f_rng)(void *, unsigned char *, size_t),
2423 void *p_rng )
2424{
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002425 int ret = MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
Gilles Peskinee5381682021-04-13 21:23:25 +02002426 int count;
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002427 unsigned lt_lower = 1, lt_upper = 0;
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002428 size_t n_bits = mbedtls_mpi_bitlen( N );
2429 size_t n_bytes = ( n_bits + 7 ) / 8;
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002430 mbedtls_mpi lower_bound;
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002431
Gilles Peskine1e918f42021-03-29 22:14:51 +02002432 if( min < 0 )
2433 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
2434 if( mbedtls_mpi_cmp_int( N, min ) <= 0 )
2435 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
2436
Gilles Peskinee5381682021-04-13 21:23:25 +02002437 /*
2438 * When min == 0, each try has at worst a probability 1/2 of failing
2439 * (the msb has a probability 1/2 of being 0, and then the result will
2440 * be < N), so after 30 tries failure probability is a most 2**(-30).
2441 *
2442 * When N is just below a power of 2, as is the case when generating
Gilles Peskinee842e582021-04-15 11:45:19 +02002443 * a random scalar on most elliptic curves, 1 try is enough with
Gilles Peskinee5381682021-04-13 21:23:25 +02002444 * overwhelming probability. When N is just above a power of 2,
Gilles Peskinee842e582021-04-15 11:45:19 +02002445 * as when generating a random scalar on secp224k1, each try has
Gilles Peskinee5381682021-04-13 21:23:25 +02002446 * a probability of failing that is almost 1/2.
2447 *
2448 * The probabilities are almost the same if min is nonzero but negligible
2449 * compared to N. This is always the case when N is crypto-sized, but
2450 * it's convenient to support small N for testing purposes. When N
2451 * is small, use a higher repeat count, otherwise the probability of
2452 * failure is macroscopic.
2453 */
Gilles Peskine87823d72021-06-02 21:18:59 +02002454 count = ( n_bytes > 4 ? 30 : 250 );
Gilles Peskinee5381682021-04-13 21:23:25 +02002455
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002456 mbedtls_mpi_init( &lower_bound );
2457
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002458 /* Ensure that target MPI has exactly the same number of limbs
2459 * as the upper bound, even if the upper bound has leading zeros.
2460 * This is necessary for the mbedtls_mpi_lt_mpi_ct() check. */
Gilles Peskineed32b572021-06-02 22:17:52 +02002461 MBEDTLS_MPI_CHK( mbedtls_mpi_resize_clear( X, N->n ) );
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002462 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( &lower_bound, N->n ) );
2463 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &lower_bound, min ) );
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002464
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002465 /*
2466 * Match the procedure given in RFC 6979 §3.3 (deterministic ECDSA)
2467 * when f_rng is a suitably parametrized instance of HMAC_DRBG:
2468 * - use the same byte ordering;
2469 * - keep the leftmost n_bits bits of the generated octet string;
2470 * - try until result is in the desired range.
2471 * This also avoids any bias, which is especially important for ECDSA.
2472 */
2473 do
2474 {
Gilles Peskine1a7df4e2021-04-01 15:57:18 +02002475 MBEDTLS_MPI_CHK( mpi_fill_random_internal( X, n_bytes, f_rng, p_rng ) );
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002476 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( X, 8 * n_bytes - n_bits ) );
2477
Gilles Peskinee5381682021-04-13 21:23:25 +02002478 if( --count == 0 )
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002479 {
2480 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
2481 goto cleanup;
2482 }
2483
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002484 MBEDTLS_MPI_CHK( mbedtls_mpi_lt_mpi_ct( X, &lower_bound, &lt_lower ) );
2485 MBEDTLS_MPI_CHK( mbedtls_mpi_lt_mpi_ct( X, N, &lt_upper ) );
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002486 }
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002487 while( lt_lower != 0 || lt_upper == 0 );
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002488
2489cleanup:
Gilles Peskine5b0589e2021-04-13 21:09:10 +02002490 mbedtls_mpi_free( &lower_bound );
Gilles Peskine02ac93a2021-03-29 22:02:55 +02002491 return( ret );
2492}
2493
Paul Bakker5121ce52009-01-03 21:22:43 +00002494/*
2495 * Modular inverse: X = A^-1 mod N (HAC 14.61 / 14.64)
2496 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497int mbedtls_mpi_inv_mod( mbedtls_mpi *X, const mbedtls_mpi *A, const mbedtls_mpi *N )
Paul Bakker5121ce52009-01-03 21:22:43 +00002498{
Janos Follath24eed8d2019-11-22 13:21:35 +00002499 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002500 mbedtls_mpi G, TA, TU, U1, U2, TB, TV, V1, V2;
Hanno Becker73d7d792018-12-11 10:35:51 +00002501 MPI_VALIDATE_RET( X != NULL );
2502 MPI_VALIDATE_RET( A != NULL );
2503 MPI_VALIDATE_RET( N != NULL );
Paul Bakker5121ce52009-01-03 21:22:43 +00002504
Hanno Becker4bcb4912017-04-18 15:49:39 +01002505 if( mbedtls_mpi_cmp_int( N, 1 ) <= 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00002507
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002508 mbedtls_mpi_init( &TA ); mbedtls_mpi_init( &TU ); mbedtls_mpi_init( &U1 ); mbedtls_mpi_init( &U2 );
2509 mbedtls_mpi_init( &G ); mbedtls_mpi_init( &TB ); mbedtls_mpi_init( &TV );
2510 mbedtls_mpi_init( &V1 ); mbedtls_mpi_init( &V2 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002511
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512 MBEDTLS_MPI_CHK( mbedtls_mpi_gcd( &G, A, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002513
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514 if( mbedtls_mpi_cmp_int( &G, 1 ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002515 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002516 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker5121ce52009-01-03 21:22:43 +00002517 goto cleanup;
2518 }
2519
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002520 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &TA, A, N ) );
2521 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TU, &TA ) );
2522 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TB, N ) );
2523 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &TV, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002524
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002525 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &U1, 1 ) );
2526 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &U2, 0 ) );
2527 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &V1, 0 ) );
2528 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &V2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002529
2530 do
2531 {
2532 while( ( TU.p[0] & 1 ) == 0 )
2533 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TU, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002535
2536 if( ( U1.p[0] & 1 ) != 0 || ( U2.p[0] & 1 ) != 0 )
2537 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &U1, &U1, &TB ) );
2539 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U2, &U2, &TA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002540 }
2541
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &U1, 1 ) );
2543 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &U2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002544 }
2545
2546 while( ( TV.p[0] & 1 ) == 0 )
2547 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &TV, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002549
2550 if( ( V1.p[0] & 1 ) != 0 || ( V2.p[0] & 1 ) != 0 )
2551 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &V1, &V1, &TB ) );
2553 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V2, &V2, &TA ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002554 }
2555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &V1, 1 ) );
2557 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &V2, 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002558 }
2559
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560 if( mbedtls_mpi_cmp_mpi( &TU, &TV ) >= 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002561 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &TU, &TU, &TV ) );
2563 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U1, &U1, &V1 ) );
2564 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &U2, &U2, &V2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002565 }
2566 else
2567 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &TV, &TV, &TU ) );
2569 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V1, &V1, &U1 ) );
2570 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V2, &V2, &U2 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002571 }
2572 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573 while( mbedtls_mpi_cmp_int( &TU, 0 ) != 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575 while( mbedtls_mpi_cmp_int( &V1, 0 ) < 0 )
2576 MBEDTLS_MPI_CHK( mbedtls_mpi_add_mpi( &V1, &V1, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002578 while( mbedtls_mpi_cmp_mpi( &V1, N ) >= 0 )
2579 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_mpi( &V1, &V1, N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002580
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002581 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( X, &V1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002582
2583cleanup:
2584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585 mbedtls_mpi_free( &TA ); mbedtls_mpi_free( &TU ); mbedtls_mpi_free( &U1 ); mbedtls_mpi_free( &U2 );
2586 mbedtls_mpi_free( &G ); mbedtls_mpi_free( &TB ); mbedtls_mpi_free( &TV );
2587 mbedtls_mpi_free( &V1 ); mbedtls_mpi_free( &V2 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002588
2589 return( ret );
2590}
2591
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592#if defined(MBEDTLS_GENPRIME)
Paul Bakkerd9374b02012-11-02 11:02:58 +00002593
Paul Bakker5121ce52009-01-03 21:22:43 +00002594static const int small_prime[] =
2595{
2596 3, 5, 7, 11, 13, 17, 19, 23,
2597 29, 31, 37, 41, 43, 47, 53, 59,
2598 61, 67, 71, 73, 79, 83, 89, 97,
2599 101, 103, 107, 109, 113, 127, 131, 137,
2600 139, 149, 151, 157, 163, 167, 173, 179,
2601 181, 191, 193, 197, 199, 211, 223, 227,
2602 229, 233, 239, 241, 251, 257, 263, 269,
2603 271, 277, 281, 283, 293, 307, 311, 313,
2604 317, 331, 337, 347, 349, 353, 359, 367,
2605 373, 379, 383, 389, 397, 401, 409, 419,
2606 421, 431, 433, 439, 443, 449, 457, 461,
2607 463, 467, 479, 487, 491, 499, 503, 509,
2608 521, 523, 541, 547, 557, 563, 569, 571,
2609 577, 587, 593, 599, 601, 607, 613, 617,
2610 619, 631, 641, 643, 647, 653, 659, 661,
2611 673, 677, 683, 691, 701, 709, 719, 727,
2612 733, 739, 743, 751, 757, 761, 769, 773,
2613 787, 797, 809, 811, 821, 823, 827, 829,
2614 839, 853, 857, 859, 863, 877, 881, 883,
2615 887, 907, 911, 919, 929, 937, 941, 947,
2616 953, 967, 971, 977, 983, 991, 997, -103
2617};
2618
2619/*
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002620 * Small divisors test (X must be positive)
2621 *
2622 * Return values:
2623 * 0: no small factor (possible prime, more tests needed)
2624 * 1: certain prime
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002625 * MBEDTLS_ERR_MPI_NOT_ACCEPTABLE: certain non-prime
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002626 * other negative: error
Paul Bakker5121ce52009-01-03 21:22:43 +00002627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002628static int mpi_check_small_factors( const mbedtls_mpi *X )
Paul Bakker5121ce52009-01-03 21:22:43 +00002629{
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002630 int ret = 0;
2631 size_t i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002632 mbedtls_mpi_uint r;
Paul Bakker5121ce52009-01-03 21:22:43 +00002633
Paul Bakker5121ce52009-01-03 21:22:43 +00002634 if( ( X->p[0] & 1 ) == 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 for( i = 0; small_prime[i] > 0; i++ )
2638 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002639 if( mbedtls_mpi_cmp_int( X, small_prime[i] ) <= 0 )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002640 return( 1 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, small_prime[i] ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002643
2644 if( r == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002645 return( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE );
Paul Bakker5121ce52009-01-03 21:22:43 +00002646 }
2647
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002648cleanup:
2649 return( ret );
2650}
2651
2652/*
2653 * Miller-Rabin pseudo-primality test (HAC 4.24)
2654 */
Janos Follathda31fa12018-09-03 14:45:23 +01002655static int mpi_miller_rabin( const mbedtls_mpi *X, size_t rounds,
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002656 int (*f_rng)(void *, unsigned char *, size_t),
2657 void *p_rng )
2658{
Pascal Junodb99183d2015-03-11 16:49:45 +01002659 int ret, count;
Janos Follathda31fa12018-09-03 14:45:23 +01002660 size_t i, j, k, s;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661 mbedtls_mpi W, R, T, A, RR;
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002662
Hanno Becker8ce11a32018-12-19 16:18:52 +00002663 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002664 MPI_VALIDATE_RET( f_rng != NULL );
2665
2666 mbedtls_mpi_init( &W ); mbedtls_mpi_init( &R );
2667 mbedtls_mpi_init( &T ); mbedtls_mpi_init( &A );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668 mbedtls_mpi_init( &RR );
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002669
Paul Bakker5121ce52009-01-03 21:22:43 +00002670 /*
2671 * W = |X| - 1
2672 * R = W >> lsb( W )
2673 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674 MBEDTLS_MPI_CHK( mbedtls_mpi_sub_int( &W, X, 1 ) );
2675 s = mbedtls_mpi_lsb( &W );
2676 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &R, &W ) );
2677 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &R, s ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002678
Janos Follathda31fa12018-09-03 14:45:23 +01002679 for( i = 0; i < rounds; i++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00002680 {
2681 /*
2682 * pick a random A, 1 < A < |X| - 1
2683 */
Pascal Junodb99183d2015-03-11 16:49:45 +01002684 count = 0;
2685 do {
Manuel Pégourié-Gonnard53c76c02015-04-17 20:15:36 +02002686 MBEDTLS_MPI_CHK( mbedtls_mpi_fill_random( &A, X->n * ciL, f_rng, p_rng ) );
Pascal Junodb99183d2015-03-11 16:49:45 +01002687
Manuel Pégourié-Gonnardc0696c22015-06-18 16:47:17 +02002688 j = mbedtls_mpi_bitlen( &A );
2689 k = mbedtls_mpi_bitlen( &W );
Pascal Junodb99183d2015-03-11 16:49:45 +01002690 if (j > k) {
Darryl Greene3f95ed2018-10-02 13:21:35 +01002691 A.p[A.n - 1] &= ( (mbedtls_mpi_uint) 1 << ( k - ( A.n - 1 ) * biL - 1 ) ) - 1;
Pascal Junodb99183d2015-03-11 16:49:45 +01002692 }
2693
2694 if (count++ > 30) {
Jens Wiklanderf08aa3e2019-01-17 13:30:57 +01002695 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
2696 goto cleanup;
Pascal Junodb99183d2015-03-11 16:49:45 +01002697 }
2698
Manuel Pégourié-Gonnard53c76c02015-04-17 20:15:36 +02002699 } while ( mbedtls_mpi_cmp_mpi( &A, &W ) >= 0 ||
2700 mbedtls_mpi_cmp_int( &A, 1 ) <= 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00002701
2702 /*
2703 * A = A^R mod |X|
2704 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705 MBEDTLS_MPI_CHK( mbedtls_mpi_exp_mod( &A, &A, &R, X, &RR ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 if( mbedtls_mpi_cmp_mpi( &A, &W ) == 0 ||
2708 mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002709 continue;
2710
2711 j = 1;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712 while( j < s && mbedtls_mpi_cmp_mpi( &A, &W ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002713 {
2714 /*
2715 * A = A * A mod |X|
2716 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002717 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_mpi( &T, &A, &A ) );
2718 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_mpi( &A, &T, X ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002720 if( mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002721 break;
2722
2723 j++;
2724 }
2725
2726 /*
2727 * not prime if A != |X| - 1 or A == 1
2728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729 if( mbedtls_mpi_cmp_mpi( &A, &W ) != 0 ||
2730 mbedtls_mpi_cmp_int( &A, 1 ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002731 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732 ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker5121ce52009-01-03 21:22:43 +00002733 break;
2734 }
2735 }
2736
2737cleanup:
Hanno Becker73d7d792018-12-11 10:35:51 +00002738 mbedtls_mpi_free( &W ); mbedtls_mpi_free( &R );
2739 mbedtls_mpi_free( &T ); mbedtls_mpi_free( &A );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740 mbedtls_mpi_free( &RR );
Paul Bakker5121ce52009-01-03 21:22:43 +00002741
2742 return( ret );
2743}
2744
2745/*
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002746 * Pseudo-primality test: small factors, then Miller-Rabin
2747 */
Janos Follatha0b67c22018-09-18 14:48:23 +01002748int mbedtls_mpi_is_prime_ext( const mbedtls_mpi *X, int rounds,
2749 int (*f_rng)(void *, unsigned char *, size_t),
2750 void *p_rng )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002751{
Janos Follath24eed8d2019-11-22 13:21:35 +00002752 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002753 mbedtls_mpi XX;
Hanno Becker8ce11a32018-12-19 16:18:52 +00002754 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002755 MPI_VALIDATE_RET( f_rng != NULL );
Manuel Pégourié-Gonnard7f4ed672014-10-14 20:56:02 +02002756
2757 XX.s = 1;
2758 XX.n = X->n;
2759 XX.p = X->p;
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761 if( mbedtls_mpi_cmp_int( &XX, 0 ) == 0 ||
2762 mbedtls_mpi_cmp_int( &XX, 1 ) == 0 )
2763 return( MBEDTLS_ERR_MPI_NOT_ACCEPTABLE );
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002764
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002765 if( mbedtls_mpi_cmp_int( &XX, 2 ) == 0 )
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002766 return( 0 );
2767
2768 if( ( ret = mpi_check_small_factors( &XX ) ) != 0 )
2769 {
2770 if( ret == 1 )
2771 return( 0 );
2772
2773 return( ret );
2774 }
2775
Janos Follathda31fa12018-09-03 14:45:23 +01002776 return( mpi_miller_rabin( &XX, rounds, f_rng, p_rng ) );
Janos Follathf301d232018-08-14 13:34:01 +01002777}
2778
Manuel Pégourié-Gonnard378fb4b2013-11-22 18:39:18 +01002779/*
Paul Bakker5121ce52009-01-03 21:22:43 +00002780 * Prime number generation
Jethro Beekman66689272018-02-14 19:24:10 -08002781 *
Janos Follathf301d232018-08-14 13:34:01 +01002782 * To generate an RSA key in a way recommended by FIPS 186-4, both primes must
2783 * be either 1024 bits or 1536 bits long, and flags must contain
2784 * MBEDTLS_MPI_GEN_PRIME_FLAG_LOW_ERR.
Paul Bakker5121ce52009-01-03 21:22:43 +00002785 */
Janos Follath7c025a92018-08-14 11:08:41 +01002786int mbedtls_mpi_gen_prime( mbedtls_mpi *X, size_t nbits, int flags,
Paul Bakkera3d195c2011-11-27 21:07:34 +00002787 int (*f_rng)(void *, unsigned char *, size_t),
2788 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +00002789{
Jethro Beekman66689272018-02-14 19:24:10 -08002790#ifdef MBEDTLS_HAVE_INT64
2791// ceil(2^63.5)
2792#define CEIL_MAXUINT_DIV_SQRT2 0xb504f333f9de6485ULL
2793#else
2794// ceil(2^31.5)
2795#define CEIL_MAXUINT_DIV_SQRT2 0xb504f334U
2796#endif
2797 int ret = MBEDTLS_ERR_MPI_NOT_ACCEPTABLE;
Paul Bakker23986e52011-04-24 08:57:21 +00002798 size_t k, n;
Janos Follathda31fa12018-09-03 14:45:23 +01002799 int rounds;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002800 mbedtls_mpi_uint r;
2801 mbedtls_mpi Y;
Paul Bakker5121ce52009-01-03 21:22:43 +00002802
Hanno Becker8ce11a32018-12-19 16:18:52 +00002803 MPI_VALIDATE_RET( X != NULL );
Hanno Becker73d7d792018-12-11 10:35:51 +00002804 MPI_VALIDATE_RET( f_rng != NULL );
2805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002806 if( nbits < 3 || nbits > MBEDTLS_MPI_MAX_BITS )
2807 return( MBEDTLS_ERR_MPI_BAD_INPUT_DATA );
Paul Bakker5121ce52009-01-03 21:22:43 +00002808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809 mbedtls_mpi_init( &Y );
Paul Bakker5121ce52009-01-03 21:22:43 +00002810
2811 n = BITS_TO_LIMBS( nbits );
2812
Janos Follathda31fa12018-09-03 14:45:23 +01002813 if( ( flags & MBEDTLS_MPI_GEN_PRIME_FLAG_LOW_ERR ) == 0 )
2814 {
2815 /*
2816 * 2^-80 error probability, number of rounds chosen per HAC, table 4.4
2817 */
2818 rounds = ( ( nbits >= 1300 ) ? 2 : ( nbits >= 850 ) ? 3 :
2819 ( nbits >= 650 ) ? 4 : ( nbits >= 350 ) ? 8 :
2820 ( nbits >= 250 ) ? 12 : ( nbits >= 150 ) ? 18 : 27 );
2821 }
2822 else
2823 {
2824 /*
2825 * 2^-100 error probability, number of rounds computed based on HAC,
2826 * fact 4.48
2827 */
2828 rounds = ( ( nbits >= 1450 ) ? 4 : ( nbits >= 1150 ) ? 5 :
2829 ( nbits >= 1000 ) ? 6 : ( nbits >= 850 ) ? 7 :
2830 ( nbits >= 750 ) ? 8 : ( nbits >= 500 ) ? 13 :
2831 ( nbits >= 250 ) ? 28 : ( nbits >= 150 ) ? 40 : 51 );
2832 }
2833
Jethro Beekman66689272018-02-14 19:24:10 -08002834 while( 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002835 {
Jethro Beekman66689272018-02-14 19:24:10 -08002836 MBEDTLS_MPI_CHK( mbedtls_mpi_fill_random( X, n * ciL, f_rng, p_rng ) );
2837 /* make sure generated number is at least (nbits-1)+0.5 bits (FIPS 186-4 §B.3.3 steps 4.4, 5.5) */
2838 if( X->p[n-1] < CEIL_MAXUINT_DIV_SQRT2 ) continue;
2839
2840 k = n * biL;
2841 if( k > nbits ) MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( X, k - nbits ) );
2842 X->p[0] |= 1;
2843
Janos Follath7c025a92018-08-14 11:08:41 +01002844 if( ( flags & MBEDTLS_MPI_GEN_PRIME_FLAG_DH ) == 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002845 {
Janos Follatha0b67c22018-09-18 14:48:23 +01002846 ret = mbedtls_mpi_is_prime_ext( X, rounds, f_rng, p_rng );
Jethro Beekman66689272018-02-14 19:24:10 -08002847
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002848 if( ret != MBEDTLS_ERR_MPI_NOT_ACCEPTABLE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002849 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002850 }
Jethro Beekman66689272018-02-14 19:24:10 -08002851 else
Paul Bakker5121ce52009-01-03 21:22:43 +00002852 {
Manuel Pégourié-Gonnardddf76152013-11-22 19:58:22 +01002853 /*
Jethro Beekman66689272018-02-14 19:24:10 -08002854 * An necessary condition for Y and X = 2Y + 1 to be prime
2855 * is X = 2 mod 3 (which is equivalent to Y = 2 mod 3).
2856 * Make sure it is satisfied, while keeping X = 3 mod 4
Manuel Pégourié-Gonnardddf76152013-11-22 19:58:22 +01002857 */
Jethro Beekman66689272018-02-14 19:24:10 -08002858
2859 X->p[0] |= 2;
2860
2861 MBEDTLS_MPI_CHK( mbedtls_mpi_mod_int( &r, X, 3 ) );
2862 if( r == 0 )
2863 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 8 ) );
2864 else if( r == 1 )
2865 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 4 ) );
2866
2867 /* Set Y = (X-1) / 2, which is X / 2 because X is odd */
2868 MBEDTLS_MPI_CHK( mbedtls_mpi_copy( &Y, X ) );
2869 MBEDTLS_MPI_CHK( mbedtls_mpi_shift_r( &Y, 1 ) );
2870
2871 while( 1 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002872 {
Jethro Beekman66689272018-02-14 19:24:10 -08002873 /*
2874 * First, check small factors for X and Y
2875 * before doing Miller-Rabin on any of them
2876 */
2877 if( ( ret = mpi_check_small_factors( X ) ) == 0 &&
2878 ( ret = mpi_check_small_factors( &Y ) ) == 0 &&
Janos Follathda31fa12018-09-03 14:45:23 +01002879 ( ret = mpi_miller_rabin( X, rounds, f_rng, p_rng ) )
Janos Follathf301d232018-08-14 13:34:01 +01002880 == 0 &&
Janos Follathda31fa12018-09-03 14:45:23 +01002881 ( ret = mpi_miller_rabin( &Y, rounds, f_rng, p_rng ) )
Janos Follathf301d232018-08-14 13:34:01 +01002882 == 0 )
Jethro Beekman66689272018-02-14 19:24:10 -08002883 goto cleanup;
2884
2885 if( ret != MBEDTLS_ERR_MPI_NOT_ACCEPTABLE )
2886 goto cleanup;
2887
2888 /*
2889 * Next candidates. We want to preserve Y = (X-1) / 2 and
2890 * Y = 1 mod 2 and Y = 2 mod 3 (eq X = 3 mod 4 and X = 2 mod 3)
2891 * so up Y by 6 and X by 12.
2892 */
2893 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( X, X, 12 ) );
2894 MBEDTLS_MPI_CHK( mbedtls_mpi_add_int( &Y, &Y, 6 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002895 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002896 }
2897 }
2898
2899cleanup:
2900
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002901 mbedtls_mpi_free( &Y );
Paul Bakker5121ce52009-01-03 21:22:43 +00002902
2903 return( ret );
2904}
2905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906#endif /* MBEDTLS_GENPRIME */
Paul Bakker5121ce52009-01-03 21:22:43 +00002907
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908#if defined(MBEDTLS_SELF_TEST)
Paul Bakker5121ce52009-01-03 21:22:43 +00002909
Paul Bakker23986e52011-04-24 08:57:21 +00002910#define GCD_PAIR_COUNT 3
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002911
2912static const int gcd_pairs[GCD_PAIR_COUNT][3] =
2913{
2914 { 693, 609, 21 },
2915 { 1764, 868, 28 },
2916 { 768454923, 542167814, 1 }
2917};
2918
Paul Bakker5121ce52009-01-03 21:22:43 +00002919/*
2920 * Checkup routine
2921 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922int mbedtls_mpi_self_test( int verbose )
Paul Bakker5121ce52009-01-03 21:22:43 +00002923{
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00002924 int ret, i;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925 mbedtls_mpi A, E, N, X, Y, U, V;
Paul Bakker5121ce52009-01-03 21:22:43 +00002926
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002927 mbedtls_mpi_init( &A ); mbedtls_mpi_init( &E ); mbedtls_mpi_init( &N ); mbedtls_mpi_init( &X );
2928 mbedtls_mpi_init( &Y ); mbedtls_mpi_init( &U ); mbedtls_mpi_init( &V );
Paul Bakker5121ce52009-01-03 21:22:43 +00002929
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &A, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002931 "EFE021C2645FD1DC586E69184AF4A31E" \
2932 "D5F53E93B5F123FA41680867BA110131" \
2933 "944FE7952E2517337780CB0DB80E61AA" \
2934 "E7C8DDC6C5C6AADEB34EB38A2F40D5E6" ) );
2935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002936 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &E, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002937 "B2E7EFD37075B9F03FF989C7C5051C20" \
2938 "34D2A323810251127E7BF8625A4F49A5" \
2939 "F3E27F4DA8BD59C47D6DAABA4C8127BD" \
2940 "5B5C25763222FEFCCFC38B832366C29E" ) );
2941
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &N, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002943 "0066A198186C18C10B2F5ED9B522752A" \
2944 "9830B69916E535C8F047518A889A43A5" \
2945 "94B6BED27A168D31D4A52F88925AA8F5" ) );
2946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947 MBEDTLS_MPI_CHK( mbedtls_mpi_mul_mpi( &X, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002949 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002950 "602AB7ECA597A3D6B56FF9829A5E8B85" \
2951 "9E857EA95A03512E2BAE7391688D264A" \
2952 "A5663B0341DB9CCFD2C4C5F421FEC814" \
2953 "8001B72E848A38CAE1C65F78E56ABDEF" \
2954 "E12D3C039B8A02D6BE593F0BBBDA56F1" \
2955 "ECF677152EF804370C1A305CAF3B5BF1" \
2956 "30879B56C61DE584A0F53A2447A51E" ) );
2957
2958 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959 mbedtls_printf( " MPI test #1 (mul_mpi): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00002960
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002961 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002962 {
2963 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002965
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01002966 ret = 1;
2967 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002968 }
2969
2970 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973 MBEDTLS_MPI_CHK( mbedtls_mpi_div_mpi( &X, &Y, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002974
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002976 "256567336059E52CAE22925474705F39A94" ) );
2977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &V, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00002979 "6613F26162223DF488E9CD48CC132C7A" \
2980 "0AC93C701B001B092E4E5B9F73BCD27B" \
2981 "9EE50D0657C77F374E903CDFA4C642" ) );
2982
2983 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984 mbedtls_printf( " MPI test #2 (div_mpi): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00002985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 ||
2987 mbedtls_mpi_cmp_mpi( &Y, &V ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002988 {
2989 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002991
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01002992 ret = 1;
2993 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00002994 }
2995
2996 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00002998
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002999 MBEDTLS_MPI_CHK( mbedtls_mpi_exp_mod( &X, &A, &E, &N, NULL ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00003002 "36E139AEA55215609D2816998ED020BB" \
3003 "BD96C37890F65171D948E9BC7CBAA4D9" \
3004 "325D24D6A3C12710F10A09FA08AB87" ) );
3005
3006 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007 mbedtls_printf( " MPI test #3 (exp_mod): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00003008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003010 {
3011 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003013
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003014 ret = 1;
3015 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00003016 }
3017
3018 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003021 MBEDTLS_MPI_CHK( mbedtls_mpi_inv_mod( &X, &A, &N ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003022
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023 MBEDTLS_MPI_CHK( mbedtls_mpi_read_string( &U, 16,
Paul Bakker5121ce52009-01-03 21:22:43 +00003024 "003A0AAEDD7E784FC07D8F9EC6E3BFD5" \
3025 "C3DBA76456363A10869622EAC2DD84EC" \
3026 "C5B8A74DAC4D09E03B5E0BE779F2DF61" ) );
3027
3028 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029 mbedtls_printf( " MPI test #4 (inv_mod): " );
Paul Bakker5121ce52009-01-03 21:22:43 +00003030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031 if( mbedtls_mpi_cmp_mpi( &X, &U ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003032 {
3033 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034 mbedtls_printf( "failed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003035
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003036 ret = 1;
3037 goto cleanup;
Paul Bakker5121ce52009-01-03 21:22:43 +00003038 }
3039
3040 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041 mbedtls_printf( "passed\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003042
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003043 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044 mbedtls_printf( " MPI test #5 (simple gcd): " );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003045
Paul Bakker66d5d072014-06-17 16:39:18 +02003046 for( i = 0; i < GCD_PAIR_COUNT; i++ )
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003047 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &X, gcd_pairs[i][0] ) );
3049 MBEDTLS_MPI_CHK( mbedtls_mpi_lset( &Y, gcd_pairs[i][1] ) );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051 MBEDTLS_MPI_CHK( mbedtls_mpi_gcd( &A, &X, &Y ) );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003052
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003053 if( mbedtls_mpi_cmp_int( &A, gcd_pairs[i][2] ) != 0 )
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003054 {
3055 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056 mbedtls_printf( "failed at %d\n", i );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003057
Manuel Pégourié-Gonnard9e987ed2014-01-20 10:03:15 +01003058 ret = 1;
3059 goto cleanup;
3060 }
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003061 }
3062
3063 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064 mbedtls_printf( "passed\n" );
Paul Bakker4e0d7ca2009-01-29 22:24:33 +00003065
Paul Bakker5121ce52009-01-03 21:22:43 +00003066cleanup:
3067
3068 if( ret != 0 && verbose != 0 )
Kenneth Soerensen518d4352020-04-01 17:22:45 +02003069 mbedtls_printf( "Unexpected error, return code = %08X\n", (unsigned int) ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00003070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071 mbedtls_mpi_free( &A ); mbedtls_mpi_free( &E ); mbedtls_mpi_free( &N ); mbedtls_mpi_free( &X );
3072 mbedtls_mpi_free( &Y ); mbedtls_mpi_free( &U ); mbedtls_mpi_free( &V );
Paul Bakker5121ce52009-01-03 21:22:43 +00003073
3074 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003075 mbedtls_printf( "\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +00003076
3077 return( ret );
3078}
3079
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003080#endif /* MBEDTLS_SELF_TEST */
Paul Bakker5121ce52009-01-03 21:22:43 +00003081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082#endif /* MBEDTLS_BIGNUM_C */