blob: 0c82c094373570109fb48d32048dd0151e35654b [file] [log] [blame]
gabor-mezei-arm90559722021-07-12 16:31:22 +02001/**
2 * Constant-time functions
3 *
4 * Copyright The Mbed TLS Contributors
5 * 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.
18 */
19
Gabor Mezei3c38b6e2021-10-18 16:09:41 +020020 /*
21 * The following functiona are implemented without using comparison operators, as those
22 * might be translated to branches by some compilers on some platforms.
23 */
24
gabor-mezei-arm90559722021-07-12 16:31:22 +020025#include "common.h"
gabor-mezei-arm944c1072021-09-27 11:28:54 +020026#include "constant_time.h"
gabor-mezei-armcb4317b2021-09-27 14:28:31 +020027#include "mbedtls/error.h"
gabor-mezei-armd5a392a2021-09-29 10:50:31 +020028#include "mbedtls/platform_util.h"
gabor-mezei-arm944c1072021-09-27 11:28:54 +020029
gabor-mezei-arm097d4f52021-09-27 12:55:33 +020030#if defined(MBEDTLS_BIGNUM_C)
31#include "mbedtls/bignum.h"
32#endif
33
gabor-mezei-armcb4317b2021-09-27 14:28:31 +020034#if defined(MBEDTLS_SSL_TLS_C)
35#include "mbedtls/ssl_internal.h"
36#endif
37
gabor-mezei-armd5a392a2021-09-29 10:50:31 +020038#if defined(MBEDTLS_RSA_C)
39#include "mbedtls/rsa.h"
40#endif
41
gabor-mezei-armf52941e2021-09-27 16:11:12 +020042#include <string.h>
gabor-mezei-arm097d4f52021-09-27 12:55:33 +020043
gabor-mezei-arm378e7eb2021-07-19 15:19:19 +020044int mbedtls_cf_memcmp( const void *a,
45 const void *b,
46 size_t n )
gabor-mezei-arm944c1072021-09-27 11:28:54 +020047{
48 size_t i;
49 volatile const unsigned char *A = (volatile const unsigned char *) a;
50 volatile const unsigned char *B = (volatile const unsigned char *) b;
51 volatile unsigned char diff = 0;
52
53 for( i = 0; i < n; i++ )
54 {
55 /* Read volatile data in order before computing diff.
56 * This avoids IAR compiler warning:
57 * 'the order of volatile accesses is undefined ..' */
58 unsigned char x = A[i], y = B[i];
59 diff |= x ^ y;
60 }
61
gabor-mezei-arm944c1072021-09-27 11:28:54 +020062 return( (int)diff );
63}
64
gabor-mezei-armc11cac92021-09-27 11:40:03 +020065unsigned mbedtls_cf_uint_mask( unsigned value )
66{
67 /* MSVC has a warning about unary minus on unsigned, but this is
68 * well-defined and precisely what we want to do here */
69#if defined(_MSC_VER)
70#pragma warning( push )
71#pragma warning( disable : 4146 )
72#endif
73 return( - ( ( value | - value ) >> ( sizeof( value ) * 8 - 1 ) ) );
74#if defined(_MSC_VER)
75#pragma warning( pop )
76#endif
77}
gabor-mezei-armd361ccd2021-09-27 11:49:42 +020078
gabor-mezei-arm2f2c0be2021-08-10 20:56:21 +020079size_t mbedtls_cf_size_mask( size_t value )
gabor-mezei-armd361ccd2021-09-27 11:49:42 +020080{
81 /* MSVC has a warning about unary minus on unsigned integer types,
82 * but this is well-defined and precisely what we want to do here. */
83#if defined(_MSC_VER)
84#pragma warning( push )
85#pragma warning( disable : 4146 )
86#endif
gabor-mezei-arm2f2c0be2021-08-10 20:56:21 +020087 return( - ( ( value | - value ) >> ( sizeof( value ) * 8 - 1 ) ) );
gabor-mezei-armd361ccd2021-09-27 11:49:42 +020088#if defined(_MSC_VER)
89#pragma warning( pop )
90#endif
91}
gabor-mezei-arm4d6b1462021-09-27 11:53:54 +020092
gabor-mezei-arm60febd52021-08-11 15:07:02 +020093#if defined(MBEDTLS_BIGNUM_C)
94
95mbedtls_mpi_uint mbedtls_cf_mpi_uint_mask( mbedtls_mpi_uint value )
96{
97 /* MSVC has a warning about unary minus on unsigned, but this is
98 * well-defined and precisely what we want to do here */
99#if defined(_MSC_VER)
100#pragma warning( push )
101#pragma warning( disable : 4146 )
102#endif
103 return( - ( ( value | - value ) >> ( sizeof( value ) * 8 - 1 ) ) );
104#if defined(_MSC_VER)
105#pragma warning( pop )
106#endif
107}
108
109#endif /* MBEDTLS_BIGNUM_C */
110
Gabor Mezei2c5ed222021-10-18 16:05:50 +0200111/** Constant-flow mask generation for "less than" comparison:
112 * - if \p x < \p y, return all-bits 1, that is (size_t) -1
113 * - otherwise, return all bits 0, that is 0
114 *
115 * This function can be used to write constant-time code by replacing branches
116 * with bit operations using masks.
117 *
118 * \param x The first value to analyze.
119 * \param y The second value to analyze.
120 *
121 * \return All-bits-one if \p x is less than \p y, otherwise zero.
122 */
123static size_t mbedtls_cf_size_mask_lt( size_t x,
124 size_t y )
gabor-mezei-arm4d6b1462021-09-27 11:53:54 +0200125{
126 /* This has the most significant bit set if and only if x < y */
127 const size_t sub = x - y;
128
129 /* sub1 = (x < y) ? 1 : 0 */
130 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
131
132 /* mask = (x < y) ? 0xff... : 0x00... */
133 const size_t mask = mbedtls_cf_size_mask( sub1 );
134
135 return( mask );
136}
gabor-mezei-arma2bcabc2021-09-27 11:58:31 +0200137
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200138size_t mbedtls_cf_size_mask_ge( size_t x,
139 size_t y )
gabor-mezei-arma2bcabc2021-09-27 11:58:31 +0200140{
141 return( ~mbedtls_cf_size_mask_lt( x, y ) );
142}
gabor-mezei-arm96584dd2021-09-27 12:15:19 +0200143
gabor-mezei-arm1ffd0cc2021-08-11 17:28:49 +0200144unsigned mbedtls_cf_size_bool_eq( size_t x,
145 size_t y )
gabor-mezei-arm96584dd2021-09-27 12:15:19 +0200146{
147 /* diff = 0 if x == y, non-zero otherwise */
148 const size_t diff = x ^ y;
149
150 /* MSVC has a warning about unary minus on unsigned integer types,
151 * but this is well-defined and precisely what we want to do here. */
152#if defined(_MSC_VER)
153#pragma warning( push )
154#pragma warning( disable : 4146 )
155#endif
156
157 /* diff_msb's most significant bit is equal to x != y */
158 const size_t diff_msb = ( diff | (size_t) -diff );
159
160#if defined(_MSC_VER)
161#pragma warning( pop )
162#endif
163
164 /* diff1 = (x != y) ? 1 : 0 */
gabor-mezei-arm1ffd0cc2021-08-11 17:28:49 +0200165 const unsigned diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
gabor-mezei-arm96584dd2021-09-27 12:15:19 +0200166
167 return( 1 ^ diff1 );
168}
gabor-mezei-arm9d7bf092021-09-27 12:25:07 +0200169
Gabor Mezeifd8a42d2021-10-18 16:35:23 +0200170/** Constant-flow "greater than" comparison:
171 * return x > y
172 *
173 * This is equivalent to \p x > \p y, but is likely to be compiled
174 * to code using bitwise operation rather than a branch.
175 *
176 * \param x The first value to analyze.
177 * \param y The second value to analyze.
178 *
179 * \return 1 if \p x greater than \p y, otherwise 0.
180 */
181static unsigned mbedtls_cf_size_gt( size_t x,
182 size_t y )
gabor-mezei-arm9d7bf092021-09-27 12:25:07 +0200183{
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200184 /* Return the sign bit (1 for negative) of (y - x). */
185 return( ( y - x ) >> ( sizeof( size_t ) * 8 - 1 ) );
gabor-mezei-arm9d7bf092021-09-27 12:25:07 +0200186}
gabor-mezei-arm097d4f52021-09-27 12:55:33 +0200187
188#if defined(MBEDTLS_BIGNUM_C)
189
gabor-mezei-arm097d4f52021-09-27 12:55:33 +0200190unsigned mbedtls_cf_mpi_uint_lt( const mbedtls_mpi_uint x,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200191 const mbedtls_mpi_uint y )
gabor-mezei-arm097d4f52021-09-27 12:55:33 +0200192{
193 mbedtls_mpi_uint ret;
194 mbedtls_mpi_uint cond;
195
196 /*
197 * Check if the most significant bits (MSB) of the operands are different.
198 */
199 cond = ( x ^ y );
200 /*
201 * If the MSB are the same then the difference x-y will be negative (and
202 * have its MSB set to 1 during conversion to unsigned) if and only if x<y.
203 */
204 ret = ( x - y ) & ~cond;
205 /*
206 * If the MSB are different, then the operand with the MSB of 1 is the
207 * bigger. (That is if y has MSB of 1, then x<y is true and it is false if
208 * the MSB of y is 0.)
209 */
210 ret |= y & cond;
211
212
213 ret = ret >> ( sizeof( mbedtls_mpi_uint ) * 8 - 1 );
214
215 return (unsigned) ret;
216}
217
218#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-arm75332532021-09-27 12:59:30 +0200219
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200220unsigned mbedtls_cf_uint_if( unsigned condition,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200221 unsigned if1,
222 unsigned if0 )
gabor-mezei-arm75332532021-09-27 12:59:30 +0200223{
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200224 unsigned mask = mbedtls_cf_uint_mask( condition );
gabor-mezei-arm75332532021-09-27 12:59:30 +0200225 return( ( mask & if1 ) | (~mask & if0 ) );
226}
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200227
gabor-mezei-armbc3a2882021-09-27 15:47:00 +0200228
Gabor Mezeifd8a42d2021-10-18 16:35:23 +0200229/** Select between two sign values witout branches.
230 *
231 * This is functionally equivalent to `condition ? if1 : if0` but uses only bit
232 * operations in order to avoid branches.
233 *
234 * \note if1 and if0 must be either 1 or -1, otherwise the result
235 * is undefined.
236 *
237 * \param condition Condition to test.
238 * \param if1 The first sign; must be either +1 or -1.
239 * \param if0 The second sign; must be either +1 or -1.
240 *
241 * \return \c if1 if \p condition is nonzero, otherwise \c if0.
242 * */
243static int mbedtls_cf_cond_select_sign( unsigned char condition,
244 int if1,
245 int if0 )
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200246{
247 /* In order to avoid questions about what we can reasonnably assume about
248 * the representations of signed integers, move everything to unsigned
Gabor Mezei4b4e4d82021-10-18 16:28:27 +0200249 * by taking advantage of the fact that if1 and if0 are either +1 or -1. */
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200250 unsigned uif1 = if1 + 1;
251 unsigned uif0 = if0 + 1;
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200252
Gabor Mezei4b4e4d82021-10-18 16:28:27 +0200253 /* condition was 0 or 1, mask is 0 or 2 as are uif1 and uif0 */
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200254 const unsigned mask = condition << 1;
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200255
Gabor Mezei4b4e4d82021-10-18 16:28:27 +0200256 /* select uif1 or uif0 */
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200257 unsigned ur = ( uif0 & ~mask ) | ( uif1 & mask );
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200258
259 /* ur is now 0 or 2, convert back to -1 or +1 */
260 return( (int) ur - 1 );
261}
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200262
263#if defined(MBEDTLS_BIGNUM_C)
264
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200265void mbedtls_cf_mpi_uint_cond_assign( size_t n,
266 mbedtls_mpi_uint *dest,
267 const mbedtls_mpi_uint *src,
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200268 unsigned char condition )
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200269{
270 size_t i;
271
272 /* MSVC has a warning about unary minus on unsigned integer types,
273 * but this is well-defined and precisely what we want to do here. */
274#if defined(_MSC_VER)
275#pragma warning( push )
276#pragma warning( disable : 4146 )
277#endif
278
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200279 /* all-bits 1 if condition is 1, all-bits 0 if condition is 0 */
280 const mbedtls_mpi_uint mask = -condition;
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200281
282#if defined(_MSC_VER)
283#pragma warning( pop )
284#endif
285
286 for( i = 0; i < n; i++ )
287 dest[i] = ( src[i] & mask ) | ( dest[i] & ~mask );
288}
289
290#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-arm7b23c0b2021-09-27 13:31:06 +0200291
Gabor Mezeifd8a42d2021-10-18 16:35:23 +0200292/** Shift some data towards the left inside a buffer.
293 *
294 * `mbedtls_cf_mem_move_to_left(start, total, offset)` is functionally
295 * equivalent to
296 * ```
297 * memmove(start, start + offset, total - offset);
298 * memset(start + offset, 0, total - offset);
299 * ```
300 * but it strives to use a memory access pattern (and thus total timing)
301 * that does not depend on \p offset. This timing independence comes at
302 * the expense of performance.
303 *
304 * \param start Pointer to the start of the buffer.
305 * \param total Total size of the buffer.
306 * \param offset Offset from which to copy \p total - \p offset bytes.
307 */
308static void mbedtls_cf_mem_move_to_left( void *start,
309 size_t total,
310 size_t offset )
gabor-mezei-arm7b23c0b2021-09-27 13:31:06 +0200311{
312 volatile unsigned char *buf = start;
313 size_t i, n;
314 if( total == 0 )
315 return;
316 for( i = 0; i < total; i++ )
317 {
318 unsigned no_op = mbedtls_cf_size_gt( total - offset, i );
319 /* The first `total - offset` passes are a no-op. The last
320 * `offset` passes shift the data one byte to the left and
321 * zero out the last byte. */
322 for( n = 0; n < total - 1; n++ )
323 {
324 unsigned char current = buf[n];
325 unsigned char next = buf[n+1];
326 buf[n] = mbedtls_cf_uint_if( no_op, current, next );
327 }
328 buf[total-1] = mbedtls_cf_uint_if( no_op, buf[total-1], 0 );
329 }
330}
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200331
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200332void mbedtls_cf_memcpy_if_eq( unsigned char *dest,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200333 const unsigned char *src,
334 size_t len,
335 size_t c1,
336 size_t c2 )
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200337{
338 /* mask = c1 == c2 ? 0xff : 0x00 */
339 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
340 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
341
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200342 /* dest[i] = c1 == c2 ? src[i] : dest[i] */
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200343 for( size_t i = 0; i < len; i++ )
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200344 dest[i] = ( src[i] & mask ) | ( dest[i] & ~mask );
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200345}
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200346
Gabor Mezei91deea72021-10-18 16:17:57 +0200347void mbedtls_cf_memcpy_offset( unsigned char *dest,
348 const unsigned char *src,
349 size_t offset,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200350 size_t offset_min,
351 size_t offset_max,
352 size_t len )
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200353{
Gabor Mezei91deea72021-10-18 16:17:57 +0200354 size_t offsetval;
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200355
Gabor Mezei91deea72021-10-18 16:17:57 +0200356 for( offsetval = offset_min; offsetval <= offset_max; offsetval++ )
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200357 {
Gabor Mezei91deea72021-10-18 16:17:57 +0200358 mbedtls_cf_memcpy_if_eq( dest, src + offsetval, len,
359 offsetval, offset );
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200360 }
361}
gabor-mezei-armcb4317b2021-09-27 14:28:31 +0200362
363#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
364
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200365int mbedtls_cf_hmac( mbedtls_md_context_t *ctx,
366 const unsigned char *add_data,
367 size_t add_data_len,
368 const unsigned char *data,
369 size_t data_len_secret,
370 size_t min_data_len,
371 size_t max_data_len,
372 unsigned char *output )
gabor-mezei-armcb4317b2021-09-27 14:28:31 +0200373{
374 /*
375 * This function breaks the HMAC abstraction and uses the md_clone()
376 * extension to the MD API in order to get constant-flow behaviour.
377 *
378 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
379 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
380 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
381 *
382 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
383 * minlen, then cloning the context, and for each byte up to maxlen
384 * finishing up the hash computation, keeping only the correct result.
385 *
386 * Then we only need to compute HASH(okey + inner_hash) and we're done.
387 */
388 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
389 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
390 * all of which have the same block size except SHA-384. */
391 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
392 const unsigned char * const ikey = ctx->hmac_ctx;
393 const unsigned char * const okey = ikey + block_size;
394 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
395
396 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
397 mbedtls_md_context_t aux;
398 size_t offset;
399 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
400
401 mbedtls_md_init( &aux );
402
403#define MD_CHK( func_call ) \
404 do { \
405 ret = (func_call); \
406 if( ret != 0 ) \
407 goto cleanup; \
408 } while( 0 )
409
410 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
411
412 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
413 * so we can start directly with the message */
414 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
415 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
416
417 /* For each possible length, compute the hash up to that point */
418 for( offset = min_data_len; offset <= max_data_len; offset++ )
419 {
420 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
421 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
422 /* Keep only the correct inner_hash in the output buffer */
423 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
424 offset, data_len_secret );
425
426 if( offset < max_data_len )
427 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
428 }
429
430 /* The context needs to finish() before it starts() again */
431 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
432
433 /* Now compute HASH(okey + inner_hash) */
434 MD_CHK( mbedtls_md_starts( ctx ) );
435 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
436 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
437 MD_CHK( mbedtls_md_finish( ctx, output ) );
438
439 /* Done, get ready for next time */
440 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
441
442#undef MD_CHK
443
444cleanup:
445 mbedtls_md_free( &aux );
446 return( ret );
447}
448
449#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200450
451#if defined(MBEDTLS_BIGNUM_C)
452
453#define MPI_VALIDATE_RET( cond ) \
454 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA )
455
456/*
457 * Conditionally assign X = Y, without leaking information
458 * about whether the assignment was made or not.
459 * (Leaking information about the respective sizes of X and Y is ok however.)
460 */
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200461int mbedtls_mpi_safe_cond_assign( mbedtls_mpi *X,
462 const mbedtls_mpi *Y,
463 unsigned char assign )
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200464{
465 int ret = 0;
466 size_t i;
467 mbedtls_mpi_uint limb_mask;
468 MPI_VALIDATE_RET( X != NULL );
469 MPI_VALIDATE_RET( Y != NULL );
470
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200471 /* all-bits 1 if assign is 1, all-bits 0 if assign is 0 */
gabor-mezei-arm60febd52021-08-11 15:07:02 +0200472 limb_mask = mbedtls_cf_mpi_uint_mask( assign );;
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200473
474 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, Y->n ) );
475
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200476 X->s = mbedtls_cf_cond_select_sign( assign, Y->s, X->s );
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200477
478 mbedtls_cf_mpi_uint_cond_assign( Y->n, X->p, Y->p, assign );
479
480 for( i = Y->n; i < X->n; i++ )
481 X->p[i] &= ~limb_mask;
482
483cleanup:
484 return( ret );
485}
486
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200487/*
488 * Conditionally swap X and Y, without leaking information
489 * about whether the swap was made or not.
490 * Here it is not ok to simply swap the pointers, which whould lead to
491 * different memory access patterns when X and Y are used afterwards.
492 */
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200493int mbedtls_mpi_safe_cond_swap( mbedtls_mpi *X,
494 mbedtls_mpi *Y,
495 unsigned char swap )
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200496{
497 int ret, s;
498 size_t i;
499 mbedtls_mpi_uint limb_mask;
500 mbedtls_mpi_uint tmp;
501 MPI_VALIDATE_RET( X != NULL );
502 MPI_VALIDATE_RET( Y != NULL );
503
504 if( X == Y )
505 return( 0 );
506
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200507 /* all-bits 1 if swap is 1, all-bits 0 if swap is 0 */
gabor-mezei-arm60febd52021-08-11 15:07:02 +0200508 limb_mask = mbedtls_cf_mpi_uint_mask( swap );
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200509
510 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, Y->n ) );
511 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( Y, X->n ) );
512
513 s = X->s;
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200514 X->s = mbedtls_cf_cond_select_sign( swap, Y->s, X->s );
515 Y->s = mbedtls_cf_cond_select_sign( swap, s, Y->s );
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200516
517
518 for( i = 0; i < X->n; i++ )
519 {
520 tmp = X->p[i];
521 X->p[i] = ( X->p[i] & ~limb_mask ) | ( Y->p[i] & limb_mask );
522 Y->p[i] = ( Y->p[i] & ~limb_mask ) | ( tmp & limb_mask );
523 }
524
525cleanup:
526 return( ret );
527}
528
gabor-mezei-armb10301d2021-09-27 15:41:30 +0200529/*
530 * Compare signed values in constant time
531 */
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200532int mbedtls_mpi_lt_mpi_ct( const mbedtls_mpi *X,
533 const mbedtls_mpi *Y,
534 unsigned *ret )
gabor-mezei-armb10301d2021-09-27 15:41:30 +0200535{
536 size_t i;
537 /* The value of any of these variables is either 0 or 1 at all times. */
538 unsigned cond, done, X_is_negative, Y_is_negative;
539
540 MPI_VALIDATE_RET( X != NULL );
541 MPI_VALIDATE_RET( Y != NULL );
542 MPI_VALIDATE_RET( ret != NULL );
543
544 if( X->n != Y->n )
545 return MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
546
547 /*
548 * Set sign_N to 1 if N >= 0, 0 if N < 0.
549 * We know that N->s == 1 if N >= 0 and N->s == -1 if N < 0.
550 */
551 X_is_negative = ( X->s & 2 ) >> 1;
552 Y_is_negative = ( Y->s & 2 ) >> 1;
553
554 /*
555 * If the signs are different, then the positive operand is the bigger.
556 * That is if X is negative (X_is_negative == 1), then X < Y is true and it
557 * is false if X is positive (X_is_negative == 0).
558 */
559 cond = ( X_is_negative ^ Y_is_negative );
560 *ret = cond & X_is_negative;
561
562 /*
563 * This is a constant-time function. We might have the result, but we still
564 * need to go through the loop. Record if we have the result already.
565 */
566 done = cond;
567
568 for( i = X->n; i > 0; i-- )
569 {
570 /*
571 * If Y->p[i - 1] < X->p[i - 1] then X < Y is true if and only if both
572 * X and Y are negative.
573 *
574 * Again even if we can make a decision, we just mark the result and
575 * the fact that we are done and continue looping.
576 */
577 cond = mbedtls_cf_mpi_uint_lt( Y->p[i - 1], X->p[i - 1] );
578 *ret |= cond & ( 1 - done ) & X_is_negative;
579 done |= cond;
580
581 /*
582 * If X->p[i - 1] < Y->p[i - 1] then X < Y is true if and only if both
583 * X and Y are positive.
584 *
585 * Again even if we can make a decision, we just mark the result and
586 * the fact that we are done and continue looping.
587 */
588 cond = mbedtls_cf_mpi_uint_lt( X->p[i - 1], Y->p[i - 1] );
589 *ret |= cond & ( 1 - done ) & ( 1 - X_is_negative );
590 done |= cond;
591 }
592
593 return( 0 );
594}
595
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200596#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200597
598#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
599
600int mbedtls_cf_rsaes_pkcs1_v15_unpadding( int mode,
Gabor Mezei91deea72021-10-18 16:17:57 +0200601 unsigned char *input,
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200602 size_t ilen,
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200603 unsigned char *output,
604 size_t output_max_len,
Gabor Mezei91deea72021-10-18 16:17:57 +0200605 size_t *olen )
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200606{
607 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
608 size_t i, plaintext_max_size;
609
610 /* The following variables take sensitive values: their value must
611 * not leak into the observable behavior of the function other than
612 * the designated outputs (output, olen, return value). Otherwise
613 * this would open the execution of the function to
614 * side-channel-based variants of the Bleichenbacher padding oracle
615 * attack. Potential side channels include overall timing, memory
616 * access patterns (especially visible to an adversary who has access
617 * to a shared memory cache), and branches (especially visible to
618 * an adversary who has access to a shared code cache or to a shared
619 * branch predictor). */
620 size_t pad_count = 0;
621 unsigned bad = 0;
622 unsigned char pad_done = 0;
623 size_t plaintext_size = 0;
624 unsigned output_too_large;
625
Gabor Mezei150bdee2021-10-18 16:12:45 +0200626 plaintext_max_size = ( output_max_len > ilen - 11 ) ? ilen - 11
627 : output_max_len;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200628
629 /* Check and get padding length in constant time and constant
630 * memory trace. The first byte must be 0. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200631 bad |= input[0];
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200632
633 if( mode == MBEDTLS_RSA_PRIVATE )
634 {
635 /* Decode EME-PKCS1-v1_5 padding: 0x00 || 0x02 || PS || 0x00
636 * where PS must be at least 8 nonzero bytes. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200637 bad |= input[1] ^ MBEDTLS_RSA_CRYPT;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200638
639 /* Read the whole buffer. Set pad_done to nonzero if we find
640 * the 0x00 byte and remember the padding length in pad_count. */
641 for( i = 2; i < ilen; i++ )
642 {
Gabor Mezei91deea72021-10-18 16:17:57 +0200643 pad_done |= ((input[i] | (unsigned char)-input[i]) >> 7) ^ 1;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200644 pad_count += ((pad_done | (unsigned char)-pad_done) >> 7) ^ 1;
645 }
646 }
647 else
648 {
649 /* Decode EMSA-PKCS1-v1_5 padding: 0x00 || 0x01 || PS || 0x00
650 * where PS must be at least 8 bytes with the value 0xFF. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200651 bad |= input[1] ^ MBEDTLS_RSA_SIGN;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200652
653 /* Read the whole buffer. Set pad_done to nonzero if we find
654 * the 0x00 byte and remember the padding length in pad_count.
655 * If there's a non-0xff byte in the padding, the padding is bad. */
656 for( i = 2; i < ilen; i++ )
657 {
Gabor Mezei91deea72021-10-18 16:17:57 +0200658 pad_done |= mbedtls_cf_uint_if( input[i], 0, 1 );
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200659 pad_count += mbedtls_cf_uint_if( pad_done, 0, 1 );
Gabor Mezei91deea72021-10-18 16:17:57 +0200660 bad |= mbedtls_cf_uint_if( pad_done, 0, input[i] ^ 0xFF );
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200661 }
662 }
663
664 /* If pad_done is still zero, there's no data, only unfinished padding. */
665 bad |= mbedtls_cf_uint_if( pad_done, 0, 1 );
666
667 /* There must be at least 8 bytes of padding. */
668 bad |= mbedtls_cf_size_gt( 8, pad_count );
669
670 /* If the padding is valid, set plaintext_size to the number of
671 * remaining bytes after stripping the padding. If the padding
672 * is invalid, avoid leaking this fact through the size of the
673 * output: use the maximum message size that fits in the output
674 * buffer. Do it without branches to avoid leaking the padding
675 * validity through timing. RSA keys are small enough that all the
676 * size_t values involved fit in unsigned int. */
677 plaintext_size = mbedtls_cf_uint_if(
678 bad, (unsigned) plaintext_max_size,
679 (unsigned) ( ilen - pad_count - 3 ) );
680
681 /* Set output_too_large to 0 if the plaintext fits in the output
682 * buffer and to 1 otherwise. */
683 output_too_large = mbedtls_cf_size_gt( plaintext_size,
684 plaintext_max_size );
685
686 /* Set ret without branches to avoid timing attacks. Return:
687 * - INVALID_PADDING if the padding is bad (bad != 0).
688 * - OUTPUT_TOO_LARGE if the padding is good but the decrypted
689 * plaintext does not fit in the output buffer.
690 * - 0 if the padding is correct. */
691 ret = - (int) mbedtls_cf_uint_if(
692 bad, - MBEDTLS_ERR_RSA_INVALID_PADDING,
693 mbedtls_cf_uint_if( output_too_large,
694 - MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE,
695 0 ) );
696
697 /* If the padding is bad or the plaintext is too large, zero the
698 * data that we're about to copy to the output buffer.
699 * We need to copy the same amount of data
700 * from the same buffer whether the padding is good or not to
701 * avoid leaking the padding validity through overall timing or
702 * through memory or cache access patterns. */
703 bad = mbedtls_cf_uint_mask( bad | output_too_large );
704 for( i = 11; i < ilen; i++ )
Gabor Mezei91deea72021-10-18 16:17:57 +0200705 input[i] &= ~bad;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200706
707 /* If the plaintext is too large, truncate it to the buffer size.
708 * Copy anyway to avoid revealing the length through timing, because
709 * revealing the length is as bad as revealing the padding validity
710 * for a Bleichenbacher attack. */
711 plaintext_size = mbedtls_cf_uint_if( output_too_large,
712 (unsigned) plaintext_max_size,
713 (unsigned) plaintext_size );
714
715 /* Move the plaintext to the leftmost position where it can start in
716 * the working buffer, i.e. make it start plaintext_max_size from
717 * the end of the buffer. Do this with a memory access trace that
718 * does not depend on the plaintext size. After this move, the
719 * starting location of the plaintext is no longer sensitive
720 * information. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200721 mbedtls_cf_mem_move_to_left( input + ilen - plaintext_max_size,
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200722 plaintext_max_size,
723 plaintext_max_size - plaintext_size );
724
725 /* Finally copy the decrypted plaintext plus trailing zeros into the output
726 * buffer. If output_max_len is 0, then output may be an invalid pointer
727 * and the result of memcpy() would be undefined; prevent undefined
728 * behavior making sure to depend only on output_max_len (the size of the
729 * user-provided output buffer), which is independent from plaintext
730 * length, validity of padding, success of the decryption, and other
731 * secrets. */
732 if( output_max_len != 0 )
Gabor Mezei91deea72021-10-18 16:17:57 +0200733 memcpy( output, input + ilen - plaintext_max_size, plaintext_max_size );
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200734
735 /* Report the amount of data we copied to the output buffer. In case
736 * of errors (bad padding or output too large), the value of *olen
737 * when this function returns is not specified. Making it equivalent
738 * to the good case limits the risks of leaking the padding validity. */
739 *olen = plaintext_size;
740
741 return( ret );
742}
743
744#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */