blob: 6e8a7c2f5709875c0943716bd60cc8bf39383279 [file] [log] [blame]
gabor-mezei-armd1125342021-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 Mezeieab90bc2021-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-armd1125342021-07-12 16:31:22 +020025#include "common.h"
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020026#include "constant_time.h"
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +020027#include "mbedtls/error.h"
gabor-mezei-arm5b3a32d2021-09-29 10:50:31 +020028#include "mbedtls/platform_util.h"
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020029
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +020030#if defined(MBEDTLS_BIGNUM_C)
31#include "mbedtls/bignum.h"
32#endif
33
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +020034#if defined(MBEDTLS_SSL_TLS_C)
35#include "ssl_misc.h"
36#endif
37
gabor-mezei-arm5b3a32d2021-09-29 10:50:31 +020038#if defined(MBEDTLS_RSA_C)
39#include "mbedtls/rsa.h"
40#endif
41
gabor-mezei-armfdb71182021-09-27 16:11:12 +020042#include <string.h>
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +020043
gabor-mezei-arm46025642021-07-19 15:19:19 +020044int mbedtls_cf_memcmp( const void *a,
45 const void *b,
46 size_t n )
gabor-mezei-armdb9a38c2021-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-armdb9a38c2021-09-27 11:28:54 +020062 return( (int)diff );
63}
64
gabor-mezei-arm340948e2021-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-arm3733bf82021-09-27 11:49:42 +020078
gabor-mezei-arm396438c2021-08-10 20:56:21 +020079size_t mbedtls_cf_size_mask( size_t value )
gabor-mezei-arm3733bf82021-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-arm396438c2021-08-10 20:56:21 +020087 return( - ( ( value | - value ) >> ( sizeof( value ) * 8 - 1 ) ) );
gabor-mezei-arm3733bf82021-09-27 11:49:42 +020088#if defined(_MSC_VER)
89#pragma warning( pop )
90#endif
91}
gabor-mezei-armc76227d2021-09-27 11:53:54 +020092
gabor-mezei-arm9cb55692021-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 Mezei1e642612021-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-armc76227d2021-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-arm16fc57b2021-09-27 11:58:31 +0200137
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200138size_t mbedtls_cf_size_mask_ge( size_t x,
139 size_t y )
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200140{
141 return( ~mbedtls_cf_size_mask_lt( x, y ) );
142}
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200143
gabor-mezei-armb11a56e2021-08-11 17:28:49 +0200144unsigned mbedtls_cf_size_bool_eq( size_t x,
145 size_t y )
gabor-mezei-arm8d1d5fd2021-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-armb11a56e2021-08-11 17:28:49 +0200165 const unsigned diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200166
167 return( 1 ^ diff1 );
168}
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200169
Gabor Mezeia2d0f902021-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-arm5a854422021-09-27 12:25:07 +0200183{
gabor-mezei-arm87ac5be2021-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-arm5a854422021-09-27 12:25:07 +0200186}
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200187
188#if defined(MBEDTLS_BIGNUM_C)
189
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200190unsigned mbedtls_cf_mpi_uint_lt( const mbedtls_mpi_uint x,
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200191 const mbedtls_mpi_uint y )
gabor-mezei-arm3f90fd52021-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-armb2dbf2c2021-09-27 12:59:30 +0200219
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200220unsigned mbedtls_cf_uint_if( unsigned condition,
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200221 unsigned if1,
222 unsigned if0 )
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200223{
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200224 unsigned mask = mbedtls_cf_uint_mask( condition );
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200225 return( ( mask & if1 ) | (~mask & if0 ) );
226}
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200227
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200228/** Choose between two integer values without branches.
229 *
230 * This is equivalent to `condition ? if1 : if0`, but is likely to be compiled
231 * to code using bitwise operation rather than a branch.
232 *
233 * \param condition Condition to test.
234 * \param if1 Value to use if \p condition is nonzero.
235 * \param if0 Value to use if \p condition is zero.
236 *
237 * \return \c if1 if \p condition is nonzero, otherwise \c if0.
238 */
239static size_t mbedtls_cf_size_if( unsigned condition,
240 size_t if1,
241 size_t if0 )
gabor-mezei-arm65cefdb2021-09-27 15:47:00 +0200242{
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200243 size_t mask = mbedtls_cf_size_mask( condition );
gabor-mezei-arm65cefdb2021-09-27 15:47:00 +0200244 return( ( mask & if1 ) | (~mask & if0 ) );
245}
246
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200247/** Select between two sign values witout branches.
248 *
249 * This is functionally equivalent to `condition ? if1 : if0` but uses only bit
250 * operations in order to avoid branches.
251 *
252 * \note if1 and if0 must be either 1 or -1, otherwise the result
253 * is undefined.
254 *
255 * \param condition Condition to test.
256 * \param if1 The first sign; must be either +1 or -1.
257 * \param if0 The second sign; must be either +1 or -1.
258 *
259 * \return \c if1 if \p condition is nonzero, otherwise \c if0.
260 * */
261static int mbedtls_cf_cond_select_sign( unsigned char condition,
262 int if1,
263 int if0 )
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200264{
265 /* In order to avoid questions about what we can reasonnably assume about
266 * the representations of signed integers, move everything to unsigned
Gabor Mezeia316fc82021-10-18 16:28:27 +0200267 * by taking advantage of the fact that if1 and if0 are either +1 or -1. */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200268 unsigned uif1 = if1 + 1;
269 unsigned uif0 = if0 + 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200270
Gabor Mezeia316fc82021-10-18 16:28:27 +0200271 /* condition was 0 or 1, mask is 0 or 2 as are uif1 and uif0 */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200272 const unsigned mask = condition << 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200273
Gabor Mezeia316fc82021-10-18 16:28:27 +0200274 /* select uif1 or uif0 */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200275 unsigned ur = ( uif0 & ~mask ) | ( uif1 & mask );
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200276
277 /* ur is now 0 or 2, convert back to -1 or +1 */
278 return( (int) ur - 1 );
279}
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200280
281#if defined(MBEDTLS_BIGNUM_C)
282
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200283void mbedtls_cf_mpi_uint_cond_assign( size_t n,
284 mbedtls_mpi_uint *dest,
285 const mbedtls_mpi_uint *src,
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200286 unsigned char condition )
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200287{
288 size_t i;
289
290 /* MSVC has a warning about unary minus on unsigned integer types,
291 * but this is well-defined and precisely what we want to do here. */
292#if defined(_MSC_VER)
293#pragma warning( push )
294#pragma warning( disable : 4146 )
295#endif
296
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200297 /* all-bits 1 if condition is 1, all-bits 0 if condition is 0 */
298 const mbedtls_mpi_uint mask = -condition;
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200299
300#if defined(_MSC_VER)
301#pragma warning( pop )
302#endif
303
304 for( i = 0; i < n; i++ )
305 dest[i] = ( src[i] & mask ) | ( dest[i] & ~mask );
306}
307
308#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200309
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200310/** Shift some data towards the left inside a buffer.
311 *
312 * `mbedtls_cf_mem_move_to_left(start, total, offset)` is functionally
313 * equivalent to
314 * ```
315 * memmove(start, start + offset, total - offset);
316 * memset(start + offset, 0, total - offset);
317 * ```
318 * but it strives to use a memory access pattern (and thus total timing)
319 * that does not depend on \p offset. This timing independence comes at
320 * the expense of performance.
321 *
322 * \param start Pointer to the start of the buffer.
323 * \param total Total size of the buffer.
324 * \param offset Offset from which to copy \p total - \p offset bytes.
325 */
326static void mbedtls_cf_mem_move_to_left( void *start,
327 size_t total,
328 size_t offset )
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200329{
330 volatile unsigned char *buf = start;
331 size_t i, n;
332 if( total == 0 )
333 return;
334 for( i = 0; i < total; i++ )
335 {
336 unsigned no_op = mbedtls_cf_size_gt( total - offset, i );
337 /* The first `total - offset` passes are a no-op. The last
338 * `offset` passes shift the data one byte to the left and
339 * zero out the last byte. */
340 for( n = 0; n < total - 1; n++ )
341 {
342 unsigned char current = buf[n];
343 unsigned char next = buf[n+1];
344 buf[n] = mbedtls_cf_uint_if( no_op, current, next );
345 }
346 buf[total-1] = mbedtls_cf_uint_if( no_op, buf[total-1], 0 );
347 }
348}
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200349
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200350void mbedtls_cf_memcpy_if_eq( unsigned char *dest,
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200351 const unsigned char *src,
352 size_t len,
353 size_t c1,
354 size_t c2 )
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200355{
356 /* mask = c1 == c2 ? 0xff : 0x00 */
357 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
358 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
359
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200360 /* dest[i] = c1 == c2 ? src[i] : dest[i] */
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200361 for( size_t i = 0; i < len; i++ )
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200362 dest[i] = ( src[i] & mask ) | ( dest[i] & ~mask );
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200363}
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200364
Gabor Mezei63bbba52021-10-18 16:17:57 +0200365void mbedtls_cf_memcpy_offset( unsigned char *dest,
366 const unsigned char *src,
367 size_t offset,
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200368 size_t offset_min,
369 size_t offset_max,
370 size_t len )
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200371{
Gabor Mezei63bbba52021-10-18 16:17:57 +0200372 size_t offsetval;
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200373
Gabor Mezei63bbba52021-10-18 16:17:57 +0200374 for( offsetval = offset_min; offsetval <= offset_max; offsetval++ )
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200375 {
Gabor Mezei63bbba52021-10-18 16:17:57 +0200376 mbedtls_cf_memcpy_if_eq( dest, src + offsetval, len,
377 offsetval, offset );
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200378 }
379}
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200380
381#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
382
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200383int mbedtls_cf_hmac( mbedtls_md_context_t *ctx,
384 const unsigned char *add_data,
385 size_t add_data_len,
386 const unsigned char *data,
387 size_t data_len_secret,
388 size_t min_data_len,
389 size_t max_data_len,
390 unsigned char *output )
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200391{
392 /*
393 * This function breaks the HMAC abstraction and uses the md_clone()
394 * extension to the MD API in order to get constant-flow behaviour.
395 *
396 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
397 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
398 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
399 *
400 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
401 * minlen, then cloning the context, and for each byte up to maxlen
402 * finishing up the hash computation, keeping only the correct result.
403 *
404 * Then we only need to compute HASH(okey + inner_hash) and we're done.
405 */
406 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
407 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
408 * all of which have the same block size except SHA-384. */
409 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
410 const unsigned char * const ikey = ctx->hmac_ctx;
411 const unsigned char * const okey = ikey + block_size;
412 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
413
414 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
415 mbedtls_md_context_t aux;
416 size_t offset;
417 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
418
419 mbedtls_md_init( &aux );
420
421#define MD_CHK( func_call ) \
422 do { \
423 ret = (func_call); \
424 if( ret != 0 ) \
425 goto cleanup; \
426 } while( 0 )
427
428 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
429
430 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
431 * so we can start directly with the message */
432 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
433 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
434
435 /* For each possible length, compute the hash up to that point */
436 for( offset = min_data_len; offset <= max_data_len; offset++ )
437 {
438 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
439 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
440 /* Keep only the correct inner_hash in the output buffer */
441 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
442 offset, data_len_secret );
443
444 if( offset < max_data_len )
445 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
446 }
447
448 /* The context needs to finish() before it starts() again */
449 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
450
451 /* Now compute HASH(okey + inner_hash) */
452 MD_CHK( mbedtls_md_starts( ctx ) );
453 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
454 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
455 MD_CHK( mbedtls_md_finish( ctx, output ) );
456
457 /* Done, get ready for next time */
458 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
459
460#undef MD_CHK
461
462cleanup:
463 mbedtls_md_free( &aux );
464 return( ret );
465}
466
467#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200468
469#if defined(MBEDTLS_BIGNUM_C)
470
471#define MPI_VALIDATE_RET( cond ) \
472 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA )
473
474/*
475 * Conditionally assign X = Y, without leaking information
476 * about whether the assignment was made or not.
477 * (Leaking information about the respective sizes of X and Y is ok however.)
478 */
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200479int mbedtls_mpi_safe_cond_assign( mbedtls_mpi *X,
480 const mbedtls_mpi *Y,
481 unsigned char assign )
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200482{
483 int ret = 0;
484 size_t i;
485 mbedtls_mpi_uint limb_mask;
486 MPI_VALIDATE_RET( X != NULL );
487 MPI_VALIDATE_RET( Y != NULL );
488
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200489 /* all-bits 1 if assign is 1, all-bits 0 if assign is 0 */
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200490 limb_mask = mbedtls_cf_mpi_uint_mask( assign );;
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200491
492 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, Y->n ) );
493
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200494 X->s = mbedtls_cf_cond_select_sign( assign, Y->s, X->s );
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200495
496 mbedtls_cf_mpi_uint_cond_assign( Y->n, X->p, Y->p, assign );
497
498 for( i = Y->n; i < X->n; i++ )
499 X->p[i] &= ~limb_mask;
500
501cleanup:
502 return( ret );
503}
504
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200505/*
506 * Conditionally swap X and Y, without leaking information
507 * about whether the swap was made or not.
508 * Here it is not ok to simply swap the pointers, which whould lead to
509 * different memory access patterns when X and Y are used afterwards.
510 */
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200511int mbedtls_mpi_safe_cond_swap( mbedtls_mpi *X,
512 mbedtls_mpi *Y,
513 unsigned char swap )
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200514{
515 int ret, s;
516 size_t i;
517 mbedtls_mpi_uint limb_mask;
518 mbedtls_mpi_uint tmp;
519 MPI_VALIDATE_RET( X != NULL );
520 MPI_VALIDATE_RET( Y != NULL );
521
522 if( X == Y )
523 return( 0 );
524
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200525 /* all-bits 1 if swap is 1, all-bits 0 if swap is 0 */
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200526 limb_mask = mbedtls_cf_mpi_uint_mask( swap );
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200527
528 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, Y->n ) );
529 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( Y, X->n ) );
530
531 s = X->s;
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200532 X->s = mbedtls_cf_cond_select_sign( swap, Y->s, X->s );
533 Y->s = mbedtls_cf_cond_select_sign( swap, s, Y->s );
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200534
535
536 for( i = 0; i < X->n; i++ )
537 {
538 tmp = X->p[i];
539 X->p[i] = ( X->p[i] & ~limb_mask ) | ( Y->p[i] & limb_mask );
540 Y->p[i] = ( Y->p[i] & ~limb_mask ) | ( tmp & limb_mask );
541 }
542
543cleanup:
544 return( ret );
545}
546
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200547/*
548 * Compare signed values in constant time
549 */
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200550int mbedtls_mpi_lt_mpi_ct( const mbedtls_mpi *X,
551 const mbedtls_mpi *Y,
552 unsigned *ret )
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200553{
554 size_t i;
555 /* The value of any of these variables is either 0 or 1 at all times. */
556 unsigned cond, done, X_is_negative, Y_is_negative;
557
558 MPI_VALIDATE_RET( X != NULL );
559 MPI_VALIDATE_RET( Y != NULL );
560 MPI_VALIDATE_RET( ret != NULL );
561
562 if( X->n != Y->n )
563 return MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
564
565 /*
566 * Set sign_N to 1 if N >= 0, 0 if N < 0.
567 * We know that N->s == 1 if N >= 0 and N->s == -1 if N < 0.
568 */
569 X_is_negative = ( X->s & 2 ) >> 1;
570 Y_is_negative = ( Y->s & 2 ) >> 1;
571
572 /*
573 * If the signs are different, then the positive operand is the bigger.
574 * That is if X is negative (X_is_negative == 1), then X < Y is true and it
575 * is false if X is positive (X_is_negative == 0).
576 */
577 cond = ( X_is_negative ^ Y_is_negative );
578 *ret = cond & X_is_negative;
579
580 /*
581 * This is a constant-time function. We might have the result, but we still
582 * need to go through the loop. Record if we have the result already.
583 */
584 done = cond;
585
586 for( i = X->n; i > 0; i-- )
587 {
588 /*
589 * If Y->p[i - 1] < X->p[i - 1] then X < Y is true if and only if both
590 * X and Y are negative.
591 *
592 * Again even if we can make a decision, we just mark the result and
593 * the fact that we are done and continue looping.
594 */
595 cond = mbedtls_cf_mpi_uint_lt( Y->p[i - 1], X->p[i - 1] );
596 *ret |= cond & ( 1 - done ) & X_is_negative;
597 done |= cond;
598
599 /*
600 * If X->p[i - 1] < Y->p[i - 1] then X < Y is true if and only if both
601 * X and Y are positive.
602 *
603 * Again even if we can make a decision, we just mark the result and
604 * the fact that we are done and continue looping.
605 */
606 cond = mbedtls_cf_mpi_uint_lt( X->p[i - 1], Y->p[i - 1] );
607 *ret |= cond & ( 1 - done ) & ( 1 - X_is_negative );
608 done |= cond;
609 }
610
611 return( 0 );
612}
613
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200614#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200615
616#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
617
Gabor Mezei63bbba52021-10-18 16:17:57 +0200618int mbedtls_cf_rsaes_pkcs1_v15_unpadding( unsigned char *input,
619 size_t ilen,
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200620 unsigned char *output,
621 size_t output_max_len,
Gabor Mezei63bbba52021-10-18 16:17:57 +0200622 size_t *olen )
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200623{
624 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
625 size_t i, plaintext_max_size;
626
627 /* The following variables take sensitive values: their value must
628 * not leak into the observable behavior of the function other than
629 * the designated outputs (output, olen, return value). Otherwise
630 * this would open the execution of the function to
631 * side-channel-based variants of the Bleichenbacher padding oracle
632 * attack. Potential side channels include overall timing, memory
633 * access patterns (especially visible to an adversary who has access
634 * to a shared memory cache), and branches (especially visible to
635 * an adversary who has access to a shared code cache or to a shared
636 * branch predictor). */
637 size_t pad_count = 0;
638 unsigned bad = 0;
639 unsigned char pad_done = 0;
640 size_t plaintext_size = 0;
641 unsigned output_too_large;
642
Gabor Mezei7013f622021-10-18 16:12:45 +0200643 plaintext_max_size = ( output_max_len > ilen - 11 ) ? ilen - 11
644 : output_max_len;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200645
646 /* Check and get padding length in constant time and constant
647 * memory trace. The first byte must be 0. */
Gabor Mezei63bbba52021-10-18 16:17:57 +0200648 bad |= input[0];
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200649
650
651 /* Decode EME-PKCS1-v1_5 padding: 0x00 || 0x02 || PS || 0x00
Gabor Mezei63bbba52021-10-18 16:17:57 +0200652 * where PS must be at least 8 nonzero bytes. */
653 bad |= input[1] ^ MBEDTLS_RSA_CRYPT;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200654
655 /* Read the whole buffer. Set pad_done to nonzero if we find
Gabor Mezei63bbba52021-10-18 16:17:57 +0200656 * the 0x00 byte and remember the padding length in pad_count. */
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200657 for( i = 2; i < ilen; i++ )
658 {
Gabor Mezei63bbba52021-10-18 16:17:57 +0200659 pad_done |= ((input[i] | (unsigned char)-input[i]) >> 7) ^ 1;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200660 pad_count += ((pad_done | (unsigned char)-pad_done) >> 7) ^ 1;
661 }
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 Mezei63bbba52021-10-18 16:17:57 +0200705 input[i] &= ~bad;
gabor-mezei-armfdb71182021-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 Mezei63bbba52021-10-18 16:17:57 +0200721 mbedtls_cf_mem_move_to_left( input + ilen - plaintext_max_size,
gabor-mezei-armfdb71182021-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 Mezei63bbba52021-10-18 16:17:57 +0200733 memcpy( output, input + ilen - plaintext_max_size, plaintext_max_size );
gabor-mezei-armfdb71182021-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 */