blob: 952528d98090ef36458307b808f883eaaf670ad4 [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 Mezei2b358802021-10-18 17:05:06 +0200111#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
112
Gabor Mezei2c5ed222021-10-18 16:05:50 +0200113/** Constant-flow mask generation for "less than" comparison:
114 * - if \p x < \p y, return all-bits 1, that is (size_t) -1
115 * - otherwise, return all bits 0, that is 0
116 *
117 * This function can be used to write constant-time code by replacing branches
118 * with bit operations using masks.
119 *
120 * \param x The first value to analyze.
121 * \param y The second value to analyze.
122 *
123 * \return All-bits-one if \p x is less than \p y, otherwise zero.
124 */
125static size_t mbedtls_cf_size_mask_lt( size_t x,
126 size_t y )
gabor-mezei-arm4d6b1462021-09-27 11:53:54 +0200127{
128 /* This has the most significant bit set if and only if x < y */
129 const size_t sub = x - y;
130
131 /* sub1 = (x < y) ? 1 : 0 */
132 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
133
134 /* mask = (x < y) ? 0xff... : 0x00... */
135 const size_t mask = mbedtls_cf_size_mask( sub1 );
136
137 return( mask );
138}
gabor-mezei-arma2bcabc2021-09-27 11:58:31 +0200139
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200140size_t mbedtls_cf_size_mask_ge( size_t x,
141 size_t y )
gabor-mezei-arma2bcabc2021-09-27 11:58:31 +0200142{
143 return( ~mbedtls_cf_size_mask_lt( x, y ) );
144}
gabor-mezei-arm96584dd2021-09-27 12:15:19 +0200145
Gabor Mezei2b358802021-10-18 17:05:06 +0200146#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
147
gabor-mezei-arm1ffd0cc2021-08-11 17:28:49 +0200148unsigned mbedtls_cf_size_bool_eq( size_t x,
149 size_t y )
gabor-mezei-arm96584dd2021-09-27 12:15:19 +0200150{
151 /* diff = 0 if x == y, non-zero otherwise */
152 const size_t diff = x ^ y;
153
154 /* MSVC has a warning about unary minus on unsigned integer types,
155 * but this is well-defined and precisely what we want to do here. */
156#if defined(_MSC_VER)
157#pragma warning( push )
158#pragma warning( disable : 4146 )
159#endif
160
161 /* diff_msb's most significant bit is equal to x != y */
162 const size_t diff_msb = ( diff | (size_t) -diff );
163
164#if defined(_MSC_VER)
165#pragma warning( pop )
166#endif
167
168 /* diff1 = (x != y) ? 1 : 0 */
gabor-mezei-arm1ffd0cc2021-08-11 17:28:49 +0200169 const unsigned diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
gabor-mezei-arm96584dd2021-09-27 12:15:19 +0200170
171 return( 1 ^ diff1 );
172}
gabor-mezei-arm9d7bf092021-09-27 12:25:07 +0200173
Gabor Mezei2b358802021-10-18 17:05:06 +0200174#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
175
Gabor Mezeifd8a42d2021-10-18 16:35:23 +0200176/** Constant-flow "greater than" comparison:
177 * return x > y
178 *
179 * This is equivalent to \p x > \p y, but is likely to be compiled
180 * to code using bitwise operation rather than a branch.
181 *
182 * \param x The first value to analyze.
183 * \param y The second value to analyze.
184 *
185 * \return 1 if \p x greater than \p y, otherwise 0.
186 */
187static unsigned mbedtls_cf_size_gt( size_t x,
188 size_t y )
gabor-mezei-arm9d7bf092021-09-27 12:25:07 +0200189{
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200190 /* Return the sign bit (1 for negative) of (y - x). */
191 return( ( y - x ) >> ( sizeof( size_t ) * 8 - 1 ) );
gabor-mezei-arm9d7bf092021-09-27 12:25:07 +0200192}
gabor-mezei-arm097d4f52021-09-27 12:55:33 +0200193
Gabor Mezei2b358802021-10-18 17:05:06 +0200194#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
195
gabor-mezei-arm097d4f52021-09-27 12:55:33 +0200196#if defined(MBEDTLS_BIGNUM_C)
197
gabor-mezei-arm097d4f52021-09-27 12:55:33 +0200198unsigned mbedtls_cf_mpi_uint_lt( const mbedtls_mpi_uint x,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200199 const mbedtls_mpi_uint y )
gabor-mezei-arm097d4f52021-09-27 12:55:33 +0200200{
201 mbedtls_mpi_uint ret;
202 mbedtls_mpi_uint cond;
203
204 /*
205 * Check if the most significant bits (MSB) of the operands are different.
206 */
207 cond = ( x ^ y );
208 /*
209 * If the MSB are the same then the difference x-y will be negative (and
210 * have its MSB set to 1 during conversion to unsigned) if and only if x<y.
211 */
212 ret = ( x - y ) & ~cond;
213 /*
214 * If the MSB are different, then the operand with the MSB of 1 is the
215 * bigger. (That is if y has MSB of 1, then x<y is true and it is false if
216 * the MSB of y is 0.)
217 */
218 ret |= y & cond;
219
220
221 ret = ret >> ( sizeof( mbedtls_mpi_uint ) * 8 - 1 );
222
223 return (unsigned) ret;
224}
225
226#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-arm75332532021-09-27 12:59:30 +0200227
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200228unsigned mbedtls_cf_uint_if( unsigned condition,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200229 unsigned if1,
230 unsigned if0 )
gabor-mezei-arm75332532021-09-27 12:59:30 +0200231{
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200232 unsigned mask = mbedtls_cf_uint_mask( condition );
gabor-mezei-arm75332532021-09-27 12:59:30 +0200233 return( ( mask & if1 ) | (~mask & if0 ) );
234}
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200235
Gabor Mezei2b358802021-10-18 17:05:06 +0200236#if defined(MBEDTLS_BIGNUM_C)
gabor-mezei-armbc3a2882021-09-27 15:47:00 +0200237
Gabor Mezeifd8a42d2021-10-18 16:35:23 +0200238/** Select between two sign values witout branches.
239 *
240 * This is functionally equivalent to `condition ? if1 : if0` but uses only bit
241 * operations in order to avoid branches.
242 *
243 * \note if1 and if0 must be either 1 or -1, otherwise the result
244 * is undefined.
245 *
246 * \param condition Condition to test.
247 * \param if1 The first sign; must be either +1 or -1.
248 * \param if0 The second sign; must be either +1 or -1.
249 *
250 * \return \c if1 if \p condition is nonzero, otherwise \c if0.
251 * */
252static int mbedtls_cf_cond_select_sign( unsigned char condition,
253 int if1,
254 int if0 )
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200255{
256 /* In order to avoid questions about what we can reasonnably assume about
257 * the representations of signed integers, move everything to unsigned
Gabor Mezei4b4e4d82021-10-18 16:28:27 +0200258 * by taking advantage of the fact that if1 and if0 are either +1 or -1. */
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200259 unsigned uif1 = if1 + 1;
260 unsigned uif0 = if0 + 1;
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200261
Gabor Mezei4b4e4d82021-10-18 16:28:27 +0200262 /* condition was 0 or 1, mask is 0 or 2 as are uif1 and uif0 */
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200263 const unsigned mask = condition << 1;
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200264
Gabor Mezei4b4e4d82021-10-18 16:28:27 +0200265 /* select uif1 or uif0 */
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200266 unsigned ur = ( uif0 & ~mask ) | ( uif1 & mask );
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200267
268 /* ur is now 0 or 2, convert back to -1 or +1 */
269 return( (int) ur - 1 );
270}
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200271
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200272void mbedtls_cf_mpi_uint_cond_assign( size_t n,
273 mbedtls_mpi_uint *dest,
274 const mbedtls_mpi_uint *src,
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200275 unsigned char condition )
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200276{
277 size_t i;
278
279 /* MSVC has a warning about unary minus on unsigned integer types,
280 * but this is well-defined and precisely what we want to do here. */
281#if defined(_MSC_VER)
282#pragma warning( push )
283#pragma warning( disable : 4146 )
284#endif
285
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200286 /* all-bits 1 if condition is 1, all-bits 0 if condition is 0 */
287 const mbedtls_mpi_uint mask = -condition;
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200288
289#if defined(_MSC_VER)
290#pragma warning( pop )
291#endif
292
293 for( i = 0; i < n; i++ )
294 dest[i] = ( src[i] & mask ) | ( dest[i] & ~mask );
295}
296
297#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-arm7b23c0b2021-09-27 13:31:06 +0200298
Gabor Mezei2b358802021-10-18 17:05:06 +0200299#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
300
Gabor Mezeifd8a42d2021-10-18 16:35:23 +0200301/** Shift some data towards the left inside a buffer.
302 *
303 * `mbedtls_cf_mem_move_to_left(start, total, offset)` is functionally
304 * equivalent to
305 * ```
306 * memmove(start, start + offset, total - offset);
307 * memset(start + offset, 0, total - offset);
308 * ```
309 * but it strives to use a memory access pattern (and thus total timing)
310 * that does not depend on \p offset. This timing independence comes at
311 * the expense of performance.
312 *
313 * \param start Pointer to the start of the buffer.
314 * \param total Total size of the buffer.
315 * \param offset Offset from which to copy \p total - \p offset bytes.
316 */
317static void mbedtls_cf_mem_move_to_left( void *start,
318 size_t total,
319 size_t offset )
gabor-mezei-arm7b23c0b2021-09-27 13:31:06 +0200320{
321 volatile unsigned char *buf = start;
322 size_t i, n;
323 if( total == 0 )
324 return;
325 for( i = 0; i < total; i++ )
326 {
327 unsigned no_op = mbedtls_cf_size_gt( total - offset, i );
328 /* The first `total - offset` passes are a no-op. The last
329 * `offset` passes shift the data one byte to the left and
330 * zero out the last byte. */
331 for( n = 0; n < total - 1; n++ )
332 {
333 unsigned char current = buf[n];
334 unsigned char next = buf[n+1];
335 buf[n] = mbedtls_cf_uint_if( no_op, current, next );
336 }
337 buf[total-1] = mbedtls_cf_uint_if( no_op, buf[total-1], 0 );
338 }
339}
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200340
Gabor Mezei2b358802021-10-18 17:05:06 +0200341#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
342
343#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
344
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200345void mbedtls_cf_memcpy_if_eq( unsigned char *dest,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200346 const unsigned char *src,
347 size_t len,
348 size_t c1,
349 size_t c2 )
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200350{
351 /* mask = c1 == c2 ? 0xff : 0x00 */
352 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
353 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
354
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200355 /* dest[i] = c1 == c2 ? src[i] : dest[i] */
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200356 for( size_t i = 0; i < len; i++ )
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200357 dest[i] = ( src[i] & mask ) | ( dest[i] & ~mask );
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200358}
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200359
Gabor Mezei91deea72021-10-18 16:17:57 +0200360void mbedtls_cf_memcpy_offset( unsigned char *dest,
361 const unsigned char *src,
362 size_t offset,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200363 size_t offset_min,
364 size_t offset_max,
365 size_t len )
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200366{
Gabor Mezei91deea72021-10-18 16:17:57 +0200367 size_t offsetval;
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200368
Gabor Mezei91deea72021-10-18 16:17:57 +0200369 for( offsetval = offset_min; offsetval <= offset_max; offsetval++ )
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200370 {
Gabor Mezei91deea72021-10-18 16:17:57 +0200371 mbedtls_cf_memcpy_if_eq( dest, src + offsetval, len,
372 offsetval, offset );
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200373 }
374}
gabor-mezei-armcb4317b2021-09-27 14:28:31 +0200375
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200376int mbedtls_cf_hmac( mbedtls_md_context_t *ctx,
377 const unsigned char *add_data,
378 size_t add_data_len,
379 const unsigned char *data,
380 size_t data_len_secret,
381 size_t min_data_len,
382 size_t max_data_len,
383 unsigned char *output )
gabor-mezei-armcb4317b2021-09-27 14:28:31 +0200384{
385 /*
386 * This function breaks the HMAC abstraction and uses the md_clone()
387 * extension to the MD API in order to get constant-flow behaviour.
388 *
389 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
390 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
391 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
392 *
393 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
394 * minlen, then cloning the context, and for each byte up to maxlen
395 * finishing up the hash computation, keeping only the correct result.
396 *
397 * Then we only need to compute HASH(okey + inner_hash) and we're done.
398 */
399 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
400 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
401 * all of which have the same block size except SHA-384. */
402 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
403 const unsigned char * const ikey = ctx->hmac_ctx;
404 const unsigned char * const okey = ikey + block_size;
405 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
406
407 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
408 mbedtls_md_context_t aux;
409 size_t offset;
410 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
411
412 mbedtls_md_init( &aux );
413
414#define MD_CHK( func_call ) \
415 do { \
416 ret = (func_call); \
417 if( ret != 0 ) \
418 goto cleanup; \
419 } while( 0 )
420
421 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
422
423 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
424 * so we can start directly with the message */
425 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
426 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
427
428 /* For each possible length, compute the hash up to that point */
429 for( offset = min_data_len; offset <= max_data_len; offset++ )
430 {
431 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
432 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
433 /* Keep only the correct inner_hash in the output buffer */
434 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
435 offset, data_len_secret );
436
437 if( offset < max_data_len )
438 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
439 }
440
441 /* The context needs to finish() before it starts() again */
442 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
443
444 /* Now compute HASH(okey + inner_hash) */
445 MD_CHK( mbedtls_md_starts( ctx ) );
446 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
447 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
448 MD_CHK( mbedtls_md_finish( ctx, output ) );
449
450 /* Done, get ready for next time */
451 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
452
453#undef MD_CHK
454
455cleanup:
456 mbedtls_md_free( &aux );
457 return( ret );
458}
459
460#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200461
462#if defined(MBEDTLS_BIGNUM_C)
463
464#define MPI_VALIDATE_RET( cond ) \
465 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA )
466
467/*
468 * Conditionally assign X = Y, without leaking information
469 * about whether the assignment was made or not.
470 * (Leaking information about the respective sizes of X and Y is ok however.)
471 */
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200472int mbedtls_mpi_safe_cond_assign( mbedtls_mpi *X,
473 const mbedtls_mpi *Y,
474 unsigned char assign )
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200475{
476 int ret = 0;
477 size_t i;
478 mbedtls_mpi_uint limb_mask;
479 MPI_VALIDATE_RET( X != NULL );
480 MPI_VALIDATE_RET( Y != NULL );
481
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200482 /* all-bits 1 if assign is 1, all-bits 0 if assign is 0 */
gabor-mezei-arm60febd52021-08-11 15:07:02 +0200483 limb_mask = mbedtls_cf_mpi_uint_mask( assign );;
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200484
485 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, Y->n ) );
486
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200487 X->s = mbedtls_cf_cond_select_sign( assign, Y->s, X->s );
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200488
489 mbedtls_cf_mpi_uint_cond_assign( Y->n, X->p, Y->p, assign );
490
491 for( i = Y->n; i < X->n; i++ )
492 X->p[i] &= ~limb_mask;
493
494cleanup:
495 return( ret );
496}
497
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200498/*
499 * Conditionally swap X and Y, without leaking information
500 * about whether the swap was made or not.
501 * Here it is not ok to simply swap the pointers, which whould lead to
502 * different memory access patterns when X and Y are used afterwards.
503 */
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200504int mbedtls_mpi_safe_cond_swap( mbedtls_mpi *X,
505 mbedtls_mpi *Y,
506 unsigned char swap )
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200507{
508 int ret, s;
509 size_t i;
510 mbedtls_mpi_uint limb_mask;
511 mbedtls_mpi_uint tmp;
512 MPI_VALIDATE_RET( X != NULL );
513 MPI_VALIDATE_RET( Y != NULL );
514
515 if( X == Y )
516 return( 0 );
517
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200518 /* all-bits 1 if swap is 1, all-bits 0 if swap is 0 */
gabor-mezei-arm60febd52021-08-11 15:07:02 +0200519 limb_mask = mbedtls_cf_mpi_uint_mask( swap );
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200520
521 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, Y->n ) );
522 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( Y, X->n ) );
523
524 s = X->s;
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200525 X->s = mbedtls_cf_cond_select_sign( swap, Y->s, X->s );
526 Y->s = mbedtls_cf_cond_select_sign( swap, s, Y->s );
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200527
528
529 for( i = 0; i < X->n; i++ )
530 {
531 tmp = X->p[i];
532 X->p[i] = ( X->p[i] & ~limb_mask ) | ( Y->p[i] & limb_mask );
533 Y->p[i] = ( Y->p[i] & ~limb_mask ) | ( tmp & limb_mask );
534 }
535
536cleanup:
537 return( ret );
538}
539
gabor-mezei-armb10301d2021-09-27 15:41:30 +0200540/*
541 * Compare signed values in constant time
542 */
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200543int mbedtls_mpi_lt_mpi_ct( const mbedtls_mpi *X,
544 const mbedtls_mpi *Y,
545 unsigned *ret )
gabor-mezei-armb10301d2021-09-27 15:41:30 +0200546{
547 size_t i;
548 /* The value of any of these variables is either 0 or 1 at all times. */
549 unsigned cond, done, X_is_negative, Y_is_negative;
550
551 MPI_VALIDATE_RET( X != NULL );
552 MPI_VALIDATE_RET( Y != NULL );
553 MPI_VALIDATE_RET( ret != NULL );
554
555 if( X->n != Y->n )
556 return MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
557
558 /*
559 * Set sign_N to 1 if N >= 0, 0 if N < 0.
560 * We know that N->s == 1 if N >= 0 and N->s == -1 if N < 0.
561 */
562 X_is_negative = ( X->s & 2 ) >> 1;
563 Y_is_negative = ( Y->s & 2 ) >> 1;
564
565 /*
566 * If the signs are different, then the positive operand is the bigger.
567 * That is if X is negative (X_is_negative == 1), then X < Y is true and it
568 * is false if X is positive (X_is_negative == 0).
569 */
570 cond = ( X_is_negative ^ Y_is_negative );
571 *ret = cond & X_is_negative;
572
573 /*
574 * This is a constant-time function. We might have the result, but we still
575 * need to go through the loop. Record if we have the result already.
576 */
577 done = cond;
578
579 for( i = X->n; i > 0; i-- )
580 {
581 /*
582 * If Y->p[i - 1] < X->p[i - 1] then X < Y is true if and only if both
583 * X and Y are negative.
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( Y->p[i - 1], X->p[i - 1] );
589 *ret |= cond & ( 1 - done ) & X_is_negative;
590 done |= cond;
591
592 /*
593 * If X->p[i - 1] < Y->p[i - 1] then X < Y is true if and only if both
594 * X and Y are positive.
595 *
596 * Again even if we can make a decision, we just mark the result and
597 * the fact that we are done and continue looping.
598 */
599 cond = mbedtls_cf_mpi_uint_lt( X->p[i - 1], Y->p[i - 1] );
600 *ret |= cond & ( 1 - done ) & ( 1 - X_is_negative );
601 done |= cond;
602 }
603
604 return( 0 );
605}
606
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200607#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200608
609#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
610
611int mbedtls_cf_rsaes_pkcs1_v15_unpadding( int mode,
Gabor Mezei91deea72021-10-18 16:17:57 +0200612 unsigned char *input,
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200613 size_t ilen,
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200614 unsigned char *output,
615 size_t output_max_len,
Gabor Mezei91deea72021-10-18 16:17:57 +0200616 size_t *olen )
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200617{
618 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
619 size_t i, plaintext_max_size;
620
621 /* The following variables take sensitive values: their value must
622 * not leak into the observable behavior of the function other than
623 * the designated outputs (output, olen, return value). Otherwise
624 * this would open the execution of the function to
625 * side-channel-based variants of the Bleichenbacher padding oracle
626 * attack. Potential side channels include overall timing, memory
627 * access patterns (especially visible to an adversary who has access
628 * to a shared memory cache), and branches (especially visible to
629 * an adversary who has access to a shared code cache or to a shared
630 * branch predictor). */
631 size_t pad_count = 0;
632 unsigned bad = 0;
633 unsigned char pad_done = 0;
634 size_t plaintext_size = 0;
635 unsigned output_too_large;
636
Gabor Mezei150bdee2021-10-18 16:12:45 +0200637 plaintext_max_size = ( output_max_len > ilen - 11 ) ? ilen - 11
638 : output_max_len;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200639
640 /* Check and get padding length in constant time and constant
641 * memory trace. The first byte must be 0. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200642 bad |= input[0];
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200643
644 if( mode == MBEDTLS_RSA_PRIVATE )
645 {
646 /* Decode EME-PKCS1-v1_5 padding: 0x00 || 0x02 || PS || 0x00
647 * where PS must be at least 8 nonzero bytes. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200648 bad |= input[1] ^ MBEDTLS_RSA_CRYPT;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200649
650 /* Read the whole buffer. Set pad_done to nonzero if we find
651 * the 0x00 byte and remember the padding length in pad_count. */
652 for( i = 2; i < ilen; i++ )
653 {
Gabor Mezei91deea72021-10-18 16:17:57 +0200654 pad_done |= ((input[i] | (unsigned char)-input[i]) >> 7) ^ 1;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200655 pad_count += ((pad_done | (unsigned char)-pad_done) >> 7) ^ 1;
656 }
657 }
658 else
659 {
660 /* Decode EMSA-PKCS1-v1_5 padding: 0x00 || 0x01 || PS || 0x00
661 * where PS must be at least 8 bytes with the value 0xFF. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200662 bad |= input[1] ^ MBEDTLS_RSA_SIGN;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200663
664 /* Read the whole buffer. Set pad_done to nonzero if we find
665 * the 0x00 byte and remember the padding length in pad_count.
666 * If there's a non-0xff byte in the padding, the padding is bad. */
667 for( i = 2; i < ilen; i++ )
668 {
Gabor Mezei91deea72021-10-18 16:17:57 +0200669 pad_done |= mbedtls_cf_uint_if( input[i], 0, 1 );
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200670 pad_count += mbedtls_cf_uint_if( pad_done, 0, 1 );
Gabor Mezei91deea72021-10-18 16:17:57 +0200671 bad |= mbedtls_cf_uint_if( pad_done, 0, input[i] ^ 0xFF );
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200672 }
673 }
674
675 /* If pad_done is still zero, there's no data, only unfinished padding. */
676 bad |= mbedtls_cf_uint_if( pad_done, 0, 1 );
677
678 /* There must be at least 8 bytes of padding. */
679 bad |= mbedtls_cf_size_gt( 8, pad_count );
680
681 /* If the padding is valid, set plaintext_size to the number of
682 * remaining bytes after stripping the padding. If the padding
683 * is invalid, avoid leaking this fact through the size of the
684 * output: use the maximum message size that fits in the output
685 * buffer. Do it without branches to avoid leaking the padding
686 * validity through timing. RSA keys are small enough that all the
687 * size_t values involved fit in unsigned int. */
688 plaintext_size = mbedtls_cf_uint_if(
689 bad, (unsigned) plaintext_max_size,
690 (unsigned) ( ilen - pad_count - 3 ) );
691
692 /* Set output_too_large to 0 if the plaintext fits in the output
693 * buffer and to 1 otherwise. */
694 output_too_large = mbedtls_cf_size_gt( plaintext_size,
695 plaintext_max_size );
696
697 /* Set ret without branches to avoid timing attacks. Return:
698 * - INVALID_PADDING if the padding is bad (bad != 0).
699 * - OUTPUT_TOO_LARGE if the padding is good but the decrypted
700 * plaintext does not fit in the output buffer.
701 * - 0 if the padding is correct. */
702 ret = - (int) mbedtls_cf_uint_if(
703 bad, - MBEDTLS_ERR_RSA_INVALID_PADDING,
704 mbedtls_cf_uint_if( output_too_large,
705 - MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE,
706 0 ) );
707
708 /* If the padding is bad or the plaintext is too large, zero the
709 * data that we're about to copy to the output buffer.
710 * We need to copy the same amount of data
711 * from the same buffer whether the padding is good or not to
712 * avoid leaking the padding validity through overall timing or
713 * through memory or cache access patterns. */
714 bad = mbedtls_cf_uint_mask( bad | output_too_large );
715 for( i = 11; i < ilen; i++ )
Gabor Mezei91deea72021-10-18 16:17:57 +0200716 input[i] &= ~bad;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200717
718 /* If the plaintext is too large, truncate it to the buffer size.
719 * Copy anyway to avoid revealing the length through timing, because
720 * revealing the length is as bad as revealing the padding validity
721 * for a Bleichenbacher attack. */
722 plaintext_size = mbedtls_cf_uint_if( output_too_large,
723 (unsigned) plaintext_max_size,
724 (unsigned) plaintext_size );
725
726 /* Move the plaintext to the leftmost position where it can start in
727 * the working buffer, i.e. make it start plaintext_max_size from
728 * the end of the buffer. Do this with a memory access trace that
729 * does not depend on the plaintext size. After this move, the
730 * starting location of the plaintext is no longer sensitive
731 * information. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200732 mbedtls_cf_mem_move_to_left( input + ilen - plaintext_max_size,
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200733 plaintext_max_size,
734 plaintext_max_size - plaintext_size );
735
736 /* Finally copy the decrypted plaintext plus trailing zeros into the output
737 * buffer. If output_max_len is 0, then output may be an invalid pointer
738 * and the result of memcpy() would be undefined; prevent undefined
739 * behavior making sure to depend only on output_max_len (the size of the
740 * user-provided output buffer), which is independent from plaintext
741 * length, validity of padding, success of the decryption, and other
742 * secrets. */
743 if( output_max_len != 0 )
Gabor Mezei91deea72021-10-18 16:17:57 +0200744 memcpy( output, input + ilen - plaintext_max_size, plaintext_max_size );
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200745
746 /* Report the amount of data we copied to the output buffer. In case
747 * of errors (bad padding or output too large), the value of *olen
748 * when this function returns is not specified. Making it equivalent
749 * to the good case limits the risks of leaking the padding validity. */
750 *olen = plaintext_size;
751
752 return( ret );
753}
754
755#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */