blob: 9779712784a6265571f514f7912a4b765592f57e [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 Mezeie24dea82021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
gabor-mezei-armcb4317b2021-09-27 14:28:31 +020028#include "mbedtls/error.h"
gabor-mezei-armd5a392a2021-09-29 10:50:31 +020029#include "mbedtls/platform_util.h"
gabor-mezei-arm944c1072021-09-27 11:28:54 +020030
gabor-mezei-arm097d4f52021-09-27 12:55:33 +020031#if defined(MBEDTLS_BIGNUM_C)
32#include "mbedtls/bignum.h"
33#endif
34
gabor-mezei-armcb4317b2021-09-27 14:28:31 +020035#if defined(MBEDTLS_SSL_TLS_C)
36#include "mbedtls/ssl_internal.h"
37#endif
38
gabor-mezei-armd5a392a2021-09-29 10:50:31 +020039#if defined(MBEDTLS_RSA_C)
40#include "mbedtls/rsa.h"
41#endif
42
gabor-mezei-armf52941e2021-09-27 16:11:12 +020043#include <string.h>
gabor-mezei-arm097d4f52021-09-27 12:55:33 +020044
gabor-mezei-arm378e7eb2021-07-19 15:19:19 +020045int mbedtls_cf_memcmp( const void *a,
46 const void *b,
47 size_t n )
gabor-mezei-arm944c1072021-09-27 11:28:54 +020048{
49 size_t i;
50 volatile const unsigned char *A = (volatile const unsigned char *) a;
51 volatile const unsigned char *B = (volatile const unsigned char *) b;
52 volatile unsigned char diff = 0;
53
54 for( i = 0; i < n; i++ )
55 {
56 /* Read volatile data in order before computing diff.
57 * This avoids IAR compiler warning:
58 * 'the order of volatile accesses is undefined ..' */
59 unsigned char x = A[i], y = B[i];
60 diff |= x ^ y;
61 }
62
gabor-mezei-arm944c1072021-09-27 11:28:54 +020063 return( (int)diff );
64}
65
gabor-mezei-armc11cac92021-09-27 11:40:03 +020066unsigned mbedtls_cf_uint_mask( unsigned value )
67{
68 /* MSVC has a warning about unary minus on unsigned, but this is
69 * well-defined and precisely what we want to do here */
70#if defined(_MSC_VER)
71#pragma warning( push )
72#pragma warning( disable : 4146 )
73#endif
74 return( - ( ( value | - value ) >> ( sizeof( value ) * 8 - 1 ) ) );
75#if defined(_MSC_VER)
76#pragma warning( pop )
77#endif
78}
gabor-mezei-armd361ccd2021-09-27 11:49:42 +020079
gabor-mezei-arm2f2c0be2021-08-10 20:56:21 +020080size_t mbedtls_cf_size_mask( size_t value )
gabor-mezei-armd361ccd2021-09-27 11:49:42 +020081{
82 /* MSVC has a warning about unary minus on unsigned integer types,
83 * but this is well-defined and precisely what we want to do here. */
84#if defined(_MSC_VER)
85#pragma warning( push )
86#pragma warning( disable : 4146 )
87#endif
gabor-mezei-arm2f2c0be2021-08-10 20:56:21 +020088 return( - ( ( value | - value ) >> ( sizeof( value ) * 8 - 1 ) ) );
gabor-mezei-armd361ccd2021-09-27 11:49:42 +020089#if defined(_MSC_VER)
90#pragma warning( pop )
91#endif
92}
gabor-mezei-arm4d6b1462021-09-27 11:53:54 +020093
gabor-mezei-arm60febd52021-08-11 15:07:02 +020094#if defined(MBEDTLS_BIGNUM_C)
95
96mbedtls_mpi_uint mbedtls_cf_mpi_uint_mask( mbedtls_mpi_uint value )
97{
98 /* MSVC has a warning about unary minus on unsigned, but this is
99 * well-defined and precisely what we want to do here */
100#if defined(_MSC_VER)
101#pragma warning( push )
102#pragma warning( disable : 4146 )
103#endif
104 return( - ( ( value | - value ) >> ( sizeof( value ) * 8 - 1 ) ) );
105#if defined(_MSC_VER)
106#pragma warning( pop )
107#endif
108}
109
110#endif /* MBEDTLS_BIGNUM_C */
111
Gabor Mezei2b358802021-10-18 17:05:06 +0200112#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
113
Gabor Mezei2c5ed222021-10-18 16:05:50 +0200114/** Constant-flow mask generation for "less than" comparison:
115 * - if \p x < \p y, return all-bits 1, that is (size_t) -1
116 * - otherwise, return all bits 0, that is 0
117 *
118 * This function can be used to write constant-time code by replacing branches
119 * with bit operations using masks.
120 *
121 * \param x The first value to analyze.
122 * \param y The second value to analyze.
123 *
124 * \return All-bits-one if \p x is less than \p y, otherwise zero.
125 */
126static size_t mbedtls_cf_size_mask_lt( size_t x,
127 size_t y )
gabor-mezei-arm4d6b1462021-09-27 11:53:54 +0200128{
129 /* This has the most significant bit set if and only if x < y */
130 const size_t sub = x - y;
131
132 /* sub1 = (x < y) ? 1 : 0 */
133 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
134
135 /* mask = (x < y) ? 0xff... : 0x00... */
136 const size_t mask = mbedtls_cf_size_mask( sub1 );
137
138 return( mask );
139}
gabor-mezei-arma2bcabc2021-09-27 11:58:31 +0200140
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200141size_t mbedtls_cf_size_mask_ge( size_t x,
142 size_t y )
gabor-mezei-arma2bcabc2021-09-27 11:58:31 +0200143{
144 return( ~mbedtls_cf_size_mask_lt( x, y ) );
145}
gabor-mezei-arm96584dd2021-09-27 12:15:19 +0200146
Gabor Mezei2b358802021-10-18 17:05:06 +0200147#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
148
gabor-mezei-arm1ffd0cc2021-08-11 17:28:49 +0200149unsigned mbedtls_cf_size_bool_eq( size_t x,
150 size_t y )
gabor-mezei-arm96584dd2021-09-27 12:15:19 +0200151{
152 /* diff = 0 if x == y, non-zero otherwise */
153 const size_t diff = x ^ y;
154
155 /* MSVC has a warning about unary minus on unsigned integer types,
156 * but this is well-defined and precisely what we want to do here. */
157#if defined(_MSC_VER)
158#pragma warning( push )
159#pragma warning( disable : 4146 )
160#endif
161
162 /* diff_msb's most significant bit is equal to x != y */
163 const size_t diff_msb = ( diff | (size_t) -diff );
164
165#if defined(_MSC_VER)
166#pragma warning( pop )
167#endif
168
169 /* diff1 = (x != y) ? 1 : 0 */
gabor-mezei-arm1ffd0cc2021-08-11 17:28:49 +0200170 const unsigned diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
gabor-mezei-arm96584dd2021-09-27 12:15:19 +0200171
172 return( 1 ^ diff1 );
173}
gabor-mezei-arm9d7bf092021-09-27 12:25:07 +0200174
Gabor Mezei2b358802021-10-18 17:05:06 +0200175#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
176
Gabor Mezeifd8a42d2021-10-18 16:35:23 +0200177/** Constant-flow "greater than" comparison:
178 * return x > y
179 *
180 * This is equivalent to \p x > \p y, but is likely to be compiled
181 * to code using bitwise operation rather than a branch.
182 *
183 * \param x The first value to analyze.
184 * \param y The second value to analyze.
185 *
186 * \return 1 if \p x greater than \p y, otherwise 0.
187 */
188static unsigned mbedtls_cf_size_gt( size_t x,
189 size_t y )
gabor-mezei-arm9d7bf092021-09-27 12:25:07 +0200190{
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200191 /* Return the sign bit (1 for negative) of (y - x). */
192 return( ( y - x ) >> ( sizeof( size_t ) * 8 - 1 ) );
gabor-mezei-arm9d7bf092021-09-27 12:25:07 +0200193}
gabor-mezei-arm097d4f52021-09-27 12:55:33 +0200194
Gabor Mezei2b358802021-10-18 17:05:06 +0200195#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
196
gabor-mezei-arm097d4f52021-09-27 12:55:33 +0200197#if defined(MBEDTLS_BIGNUM_C)
198
gabor-mezei-arm097d4f52021-09-27 12:55:33 +0200199unsigned mbedtls_cf_mpi_uint_lt( const mbedtls_mpi_uint x,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200200 const mbedtls_mpi_uint y )
gabor-mezei-arm097d4f52021-09-27 12:55:33 +0200201{
202 mbedtls_mpi_uint ret;
203 mbedtls_mpi_uint cond;
204
205 /*
206 * Check if the most significant bits (MSB) of the operands are different.
207 */
208 cond = ( x ^ y );
209 /*
210 * If the MSB are the same then the difference x-y will be negative (and
211 * have its MSB set to 1 during conversion to unsigned) if and only if x<y.
212 */
213 ret = ( x - y ) & ~cond;
214 /*
215 * If the MSB are different, then the operand with the MSB of 1 is the
216 * bigger. (That is if y has MSB of 1, then x<y is true and it is false if
217 * the MSB of y is 0.)
218 */
219 ret |= y & cond;
220
221
222 ret = ret >> ( sizeof( mbedtls_mpi_uint ) * 8 - 1 );
223
224 return (unsigned) ret;
225}
226
227#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-arm75332532021-09-27 12:59:30 +0200228
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200229unsigned mbedtls_cf_uint_if( unsigned condition,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200230 unsigned if1,
231 unsigned if0 )
gabor-mezei-arm75332532021-09-27 12:59:30 +0200232{
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200233 unsigned mask = mbedtls_cf_uint_mask( condition );
gabor-mezei-arm75332532021-09-27 12:59:30 +0200234 return( ( mask & if1 ) | (~mask & if0 ) );
235}
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200236
Gabor Mezei2b358802021-10-18 17:05:06 +0200237#if defined(MBEDTLS_BIGNUM_C)
gabor-mezei-armbc3a2882021-09-27 15:47:00 +0200238
Gabor Mezeifd8a42d2021-10-18 16:35:23 +0200239/** Select between two sign values witout branches.
240 *
241 * This is functionally equivalent to `condition ? if1 : if0` but uses only bit
242 * operations in order to avoid branches.
243 *
244 * \note if1 and if0 must be either 1 or -1, otherwise the result
245 * is undefined.
246 *
247 * \param condition Condition to test.
248 * \param if1 The first sign; must be either +1 or -1.
249 * \param if0 The second sign; must be either +1 or -1.
250 *
251 * \return \c if1 if \p condition is nonzero, otherwise \c if0.
252 * */
253static int mbedtls_cf_cond_select_sign( unsigned char condition,
254 int if1,
255 int if0 )
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200256{
257 /* In order to avoid questions about what we can reasonnably assume about
258 * the representations of signed integers, move everything to unsigned
Gabor Mezei4b4e4d82021-10-18 16:28:27 +0200259 * by taking advantage of the fact that if1 and if0 are either +1 or -1. */
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200260 unsigned uif1 = if1 + 1;
261 unsigned uif0 = if0 + 1;
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200262
Gabor Mezei4b4e4d82021-10-18 16:28:27 +0200263 /* condition was 0 or 1, mask is 0 or 2 as are uif1 and uif0 */
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200264 const unsigned mask = condition << 1;
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200265
Gabor Mezei4b4e4d82021-10-18 16:28:27 +0200266 /* select uif1 or uif0 */
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200267 unsigned ur = ( uif0 & ~mask ) | ( uif1 & mask );
gabor-mezei-arm5cec8b42021-09-27 13:03:57 +0200268
269 /* ur is now 0 or 2, convert back to -1 or +1 */
270 return( (int) ur - 1 );
271}
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200272
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200273void mbedtls_cf_mpi_uint_cond_assign( size_t n,
274 mbedtls_mpi_uint *dest,
275 const mbedtls_mpi_uint *src,
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200276 unsigned char condition )
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200277{
278 size_t i;
279
280 /* MSVC has a warning about unary minus on unsigned integer types,
281 * but this is well-defined and precisely what we want to do here. */
282#if defined(_MSC_VER)
283#pragma warning( push )
284#pragma warning( disable : 4146 )
285#endif
286
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200287 /* all-bits 1 if condition is 1, all-bits 0 if condition is 0 */
288 const mbedtls_mpi_uint mask = -condition;
gabor-mezei-arm043192d2021-09-27 13:17:15 +0200289
290#if defined(_MSC_VER)
291#pragma warning( pop )
292#endif
293
294 for( i = 0; i < n; i++ )
295 dest[i] = ( src[i] & mask ) | ( dest[i] & ~mask );
296}
297
298#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-arm7b23c0b2021-09-27 13:31:06 +0200299
Gabor Mezei2b358802021-10-18 17:05:06 +0200300#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
301
Gabor Mezeifd8a42d2021-10-18 16:35:23 +0200302/** Shift some data towards the left inside a buffer.
303 *
304 * `mbedtls_cf_mem_move_to_left(start, total, offset)` is functionally
305 * equivalent to
306 * ```
307 * memmove(start, start + offset, total - offset);
308 * memset(start + offset, 0, total - offset);
309 * ```
310 * but it strives to use a memory access pattern (and thus total timing)
311 * that does not depend on \p offset. This timing independence comes at
312 * the expense of performance.
313 *
314 * \param start Pointer to the start of the buffer.
315 * \param total Total size of the buffer.
316 * \param offset Offset from which to copy \p total - \p offset bytes.
317 */
318static void mbedtls_cf_mem_move_to_left( void *start,
319 size_t total,
320 size_t offset )
gabor-mezei-arm7b23c0b2021-09-27 13:31:06 +0200321{
322 volatile unsigned char *buf = start;
323 size_t i, n;
324 if( total == 0 )
325 return;
326 for( i = 0; i < total; i++ )
327 {
328 unsigned no_op = mbedtls_cf_size_gt( total - offset, i );
329 /* The first `total - offset` passes are a no-op. The last
330 * `offset` passes shift the data one byte to the left and
331 * zero out the last byte. */
332 for( n = 0; n < total - 1; n++ )
333 {
334 unsigned char current = buf[n];
335 unsigned char next = buf[n+1];
336 buf[n] = mbedtls_cf_uint_if( no_op, current, next );
337 }
338 buf[total-1] = mbedtls_cf_uint_if( no_op, buf[total-1], 0 );
339 }
340}
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200341
Gabor Mezei2b358802021-10-18 17:05:06 +0200342#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
343
344#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
345
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200346void mbedtls_cf_memcpy_if_eq( unsigned char *dest,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200347 const unsigned char *src,
348 size_t len,
349 size_t c1,
350 size_t c2 )
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200351{
352 /* mask = c1 == c2 ? 0xff : 0x00 */
353 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
354 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
355
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200356 /* dest[i] = c1 == c2 ? src[i] : dest[i] */
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200357 for( size_t i = 0; i < len; i++ )
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200358 dest[i] = ( src[i] & mask ) | ( dest[i] & ~mask );
gabor-mezei-armee06feb2021-09-27 13:34:25 +0200359}
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200360
Gabor Mezei91deea72021-10-18 16:17:57 +0200361void mbedtls_cf_memcpy_offset( unsigned char *dest,
362 const unsigned char *src,
363 size_t offset,
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200364 size_t offset_min,
365 size_t offset_max,
366 size_t len )
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200367{
Gabor Mezei91deea72021-10-18 16:17:57 +0200368 size_t offsetval;
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200369
Gabor Mezei91deea72021-10-18 16:17:57 +0200370 for( offsetval = offset_min; offsetval <= offset_max; offsetval++ )
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200371 {
Gabor Mezei91deea72021-10-18 16:17:57 +0200372 mbedtls_cf_memcpy_if_eq( dest, src + offsetval, len,
373 offsetval, offset );
gabor-mezei-arm0f7b9e42021-09-27 13:57:45 +0200374 }
375}
gabor-mezei-armcb4317b2021-09-27 14:28:31 +0200376
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200377int mbedtls_cf_hmac( mbedtls_md_context_t *ctx,
378 const unsigned char *add_data,
379 size_t add_data_len,
380 const unsigned char *data,
381 size_t data_len_secret,
382 size_t min_data_len,
383 size_t max_data_len,
384 unsigned char *output )
gabor-mezei-armcb4317b2021-09-27 14:28:31 +0200385{
386 /*
387 * This function breaks the HMAC abstraction and uses the md_clone()
388 * extension to the MD API in order to get constant-flow behaviour.
389 *
390 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
391 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
392 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
393 *
394 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
395 * minlen, then cloning the context, and for each byte up to maxlen
396 * finishing up the hash computation, keeping only the correct result.
397 *
398 * Then we only need to compute HASH(okey + inner_hash) and we're done.
399 */
400 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
401 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
402 * all of which have the same block size except SHA-384. */
403 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
404 const unsigned char * const ikey = ctx->hmac_ctx;
405 const unsigned char * const okey = ikey + block_size;
406 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
407
408 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
409 mbedtls_md_context_t aux;
410 size_t offset;
411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
412
413 mbedtls_md_init( &aux );
414
415#define MD_CHK( func_call ) \
416 do { \
417 ret = (func_call); \
418 if( ret != 0 ) \
419 goto cleanup; \
420 } while( 0 )
421
422 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
423
424 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
425 * so we can start directly with the message */
426 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
427 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
428
429 /* For each possible length, compute the hash up to that point */
430 for( offset = min_data_len; offset <= max_data_len; offset++ )
431 {
432 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
433 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
434 /* Keep only the correct inner_hash in the output buffer */
435 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
436 offset, data_len_secret );
437
438 if( offset < max_data_len )
439 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
440 }
441
442 /* The context needs to finish() before it starts() again */
443 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
444
445 /* Now compute HASH(okey + inner_hash) */
446 MD_CHK( mbedtls_md_starts( ctx ) );
447 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
448 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
449 MD_CHK( mbedtls_md_finish( ctx, output ) );
450
451 /* Done, get ready for next time */
452 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
453
454#undef MD_CHK
455
456cleanup:
457 mbedtls_md_free( &aux );
458 return( ret );
459}
460
461#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200462
463#if defined(MBEDTLS_BIGNUM_C)
464
465#define MPI_VALIDATE_RET( cond ) \
466 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA )
467
468/*
469 * Conditionally assign X = Y, without leaking information
470 * about whether the assignment was made or not.
471 * (Leaking information about the respective sizes of X and Y is ok however.)
472 */
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200473int mbedtls_mpi_safe_cond_assign( mbedtls_mpi *X,
474 const mbedtls_mpi *Y,
475 unsigned char assign )
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200476{
477 int ret = 0;
478 size_t i;
479 mbedtls_mpi_uint limb_mask;
480 MPI_VALIDATE_RET( X != NULL );
481 MPI_VALIDATE_RET( Y != NULL );
482
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200483 /* all-bits 1 if assign is 1, all-bits 0 if assign is 0 */
gabor-mezei-arm60febd52021-08-11 15:07:02 +0200484 limb_mask = mbedtls_cf_mpi_uint_mask( assign );;
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200485
486 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, Y->n ) );
487
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200488 X->s = mbedtls_cf_cond_select_sign( assign, Y->s, X->s );
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200489
490 mbedtls_cf_mpi_uint_cond_assign( Y->n, X->p, Y->p, assign );
491
492 for( i = Y->n; i < X->n; i++ )
493 X->p[i] &= ~limb_mask;
494
495cleanup:
496 return( ret );
497}
498
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200499/*
500 * Conditionally swap X and Y, without leaking information
501 * about whether the swap was made or not.
502 * Here it is not ok to simply swap the pointers, which whould lead to
503 * different memory access patterns when X and Y are used afterwards.
504 */
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200505int mbedtls_mpi_safe_cond_swap( mbedtls_mpi *X,
506 mbedtls_mpi *Y,
507 unsigned char swap )
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200508{
509 int ret, s;
510 size_t i;
511 mbedtls_mpi_uint limb_mask;
512 mbedtls_mpi_uint tmp;
513 MPI_VALIDATE_RET( X != NULL );
514 MPI_VALIDATE_RET( Y != NULL );
515
516 if( X == Y )
517 return( 0 );
518
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200519 /* all-bits 1 if swap is 1, all-bits 0 if swap is 0 */
gabor-mezei-arm60febd52021-08-11 15:07:02 +0200520 limb_mask = mbedtls_cf_mpi_uint_mask( swap );
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200521
522 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, Y->n ) );
523 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( Y, X->n ) );
524
525 s = X->s;
gabor-mezei-arm5e488242021-08-10 20:36:09 +0200526 X->s = mbedtls_cf_cond_select_sign( swap, Y->s, X->s );
527 Y->s = mbedtls_cf_cond_select_sign( swap, s, Y->s );
gabor-mezei-arm58fc8a62021-09-27 15:37:50 +0200528
529
530 for( i = 0; i < X->n; i++ )
531 {
532 tmp = X->p[i];
533 X->p[i] = ( X->p[i] & ~limb_mask ) | ( Y->p[i] & limb_mask );
534 Y->p[i] = ( Y->p[i] & ~limb_mask ) | ( tmp & limb_mask );
535 }
536
537cleanup:
538 return( ret );
539}
540
gabor-mezei-armb10301d2021-09-27 15:41:30 +0200541/*
542 * Compare signed values in constant time
543 */
gabor-mezei-arm04087df2021-09-27 16:29:52 +0200544int mbedtls_mpi_lt_mpi_ct( const mbedtls_mpi *X,
545 const mbedtls_mpi *Y,
546 unsigned *ret )
gabor-mezei-armb10301d2021-09-27 15:41:30 +0200547{
548 size_t i;
549 /* The value of any of these variables is either 0 or 1 at all times. */
550 unsigned cond, done, X_is_negative, Y_is_negative;
551
552 MPI_VALIDATE_RET( X != NULL );
553 MPI_VALIDATE_RET( Y != NULL );
554 MPI_VALIDATE_RET( ret != NULL );
555
556 if( X->n != Y->n )
557 return MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
558
559 /*
560 * Set sign_N to 1 if N >= 0, 0 if N < 0.
561 * We know that N->s == 1 if N >= 0 and N->s == -1 if N < 0.
562 */
563 X_is_negative = ( X->s & 2 ) >> 1;
564 Y_is_negative = ( Y->s & 2 ) >> 1;
565
566 /*
567 * If the signs are different, then the positive operand is the bigger.
568 * That is if X is negative (X_is_negative == 1), then X < Y is true and it
569 * is false if X is positive (X_is_negative == 0).
570 */
571 cond = ( X_is_negative ^ Y_is_negative );
572 *ret = cond & X_is_negative;
573
574 /*
575 * This is a constant-time function. We might have the result, but we still
576 * need to go through the loop. Record if we have the result already.
577 */
578 done = cond;
579
580 for( i = X->n; i > 0; i-- )
581 {
582 /*
583 * If Y->p[i - 1] < X->p[i - 1] then X < Y is true if and only if both
584 * X and Y are negative.
585 *
586 * Again even if we can make a decision, we just mark the result and
587 * the fact that we are done and continue looping.
588 */
589 cond = mbedtls_cf_mpi_uint_lt( Y->p[i - 1], X->p[i - 1] );
590 *ret |= cond & ( 1 - done ) & X_is_negative;
591 done |= cond;
592
593 /*
594 * If X->p[i - 1] < Y->p[i - 1] then X < Y is true if and only if both
595 * X and Y are positive.
596 *
597 * Again even if we can make a decision, we just mark the result and
598 * the fact that we are done and continue looping.
599 */
600 cond = mbedtls_cf_mpi_uint_lt( X->p[i - 1], Y->p[i - 1] );
601 *ret |= cond & ( 1 - done ) & ( 1 - X_is_negative );
602 done |= cond;
603 }
604
605 return( 0 );
606}
607
gabor-mezei-armb8caeee2021-09-27 15:33:35 +0200608#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200609
610#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
611
612int mbedtls_cf_rsaes_pkcs1_v15_unpadding( int mode,
Gabor Mezei91deea72021-10-18 16:17:57 +0200613 unsigned char *input,
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200614 size_t ilen,
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200615 unsigned char *output,
616 size_t output_max_len,
Gabor Mezei91deea72021-10-18 16:17:57 +0200617 size_t *olen )
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200618{
619 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
620 size_t i, plaintext_max_size;
621
622 /* The following variables take sensitive values: their value must
623 * not leak into the observable behavior of the function other than
624 * the designated outputs (output, olen, return value). Otherwise
625 * this would open the execution of the function to
626 * side-channel-based variants of the Bleichenbacher padding oracle
627 * attack. Potential side channels include overall timing, memory
628 * access patterns (especially visible to an adversary who has access
629 * to a shared memory cache), and branches (especially visible to
630 * an adversary who has access to a shared code cache or to a shared
631 * branch predictor). */
632 size_t pad_count = 0;
633 unsigned bad = 0;
634 unsigned char pad_done = 0;
635 size_t plaintext_size = 0;
636 unsigned output_too_large;
637
Gabor Mezei150bdee2021-10-18 16:12:45 +0200638 plaintext_max_size = ( output_max_len > ilen - 11 ) ? ilen - 11
639 : output_max_len;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200640
641 /* Check and get padding length in constant time and constant
642 * memory trace. The first byte must be 0. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200643 bad |= input[0];
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200644
645 if( mode == MBEDTLS_RSA_PRIVATE )
646 {
647 /* Decode EME-PKCS1-v1_5 padding: 0x00 || 0x02 || PS || 0x00
648 * where PS must be at least 8 nonzero bytes. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200649 bad |= input[1] ^ MBEDTLS_RSA_CRYPT;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200650
651 /* Read the whole buffer. Set pad_done to nonzero if we find
652 * the 0x00 byte and remember the padding length in pad_count. */
653 for( i = 2; i < ilen; i++ )
654 {
Gabor Mezei91deea72021-10-18 16:17:57 +0200655 pad_done |= ((input[i] | (unsigned char)-input[i]) >> 7) ^ 1;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200656 pad_count += ((pad_done | (unsigned char)-pad_done) >> 7) ^ 1;
657 }
658 }
659 else
660 {
661 /* Decode EMSA-PKCS1-v1_5 padding: 0x00 || 0x01 || PS || 0x00
662 * where PS must be at least 8 bytes with the value 0xFF. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200663 bad |= input[1] ^ MBEDTLS_RSA_SIGN;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200664
665 /* Read the whole buffer. Set pad_done to nonzero if we find
666 * the 0x00 byte and remember the padding length in pad_count.
667 * If there's a non-0xff byte in the padding, the padding is bad. */
668 for( i = 2; i < ilen; i++ )
669 {
Gabor Mezei91deea72021-10-18 16:17:57 +0200670 pad_done |= mbedtls_cf_uint_if( input[i], 0, 1 );
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200671 pad_count += mbedtls_cf_uint_if( pad_done, 0, 1 );
Gabor Mezei91deea72021-10-18 16:17:57 +0200672 bad |= mbedtls_cf_uint_if( pad_done, 0, input[i] ^ 0xFF );
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200673 }
674 }
675
676 /* If pad_done is still zero, there's no data, only unfinished padding. */
677 bad |= mbedtls_cf_uint_if( pad_done, 0, 1 );
678
679 /* There must be at least 8 bytes of padding. */
680 bad |= mbedtls_cf_size_gt( 8, pad_count );
681
682 /* If the padding is valid, set plaintext_size to the number of
683 * remaining bytes after stripping the padding. If the padding
684 * is invalid, avoid leaking this fact through the size of the
685 * output: use the maximum message size that fits in the output
686 * buffer. Do it without branches to avoid leaking the padding
687 * validity through timing. RSA keys are small enough that all the
688 * size_t values involved fit in unsigned int. */
689 plaintext_size = mbedtls_cf_uint_if(
690 bad, (unsigned) plaintext_max_size,
691 (unsigned) ( ilen - pad_count - 3 ) );
692
693 /* Set output_too_large to 0 if the plaintext fits in the output
694 * buffer and to 1 otherwise. */
695 output_too_large = mbedtls_cf_size_gt( plaintext_size,
696 plaintext_max_size );
697
698 /* Set ret without branches to avoid timing attacks. Return:
699 * - INVALID_PADDING if the padding is bad (bad != 0).
700 * - OUTPUT_TOO_LARGE if the padding is good but the decrypted
701 * plaintext does not fit in the output buffer.
702 * - 0 if the padding is correct. */
703 ret = - (int) mbedtls_cf_uint_if(
704 bad, - MBEDTLS_ERR_RSA_INVALID_PADDING,
705 mbedtls_cf_uint_if( output_too_large,
706 - MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE,
707 0 ) );
708
709 /* If the padding is bad or the plaintext is too large, zero the
710 * data that we're about to copy to the output buffer.
711 * We need to copy the same amount of data
712 * from the same buffer whether the padding is good or not to
713 * avoid leaking the padding validity through overall timing or
714 * through memory or cache access patterns. */
715 bad = mbedtls_cf_uint_mask( bad | output_too_large );
716 for( i = 11; i < ilen; i++ )
Gabor Mezei91deea72021-10-18 16:17:57 +0200717 input[i] &= ~bad;
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200718
719 /* If the plaintext is too large, truncate it to the buffer size.
720 * Copy anyway to avoid revealing the length through timing, because
721 * revealing the length is as bad as revealing the padding validity
722 * for a Bleichenbacher attack. */
723 plaintext_size = mbedtls_cf_uint_if( output_too_large,
724 (unsigned) plaintext_max_size,
725 (unsigned) plaintext_size );
726
727 /* Move the plaintext to the leftmost position where it can start in
728 * the working buffer, i.e. make it start plaintext_max_size from
729 * the end of the buffer. Do this with a memory access trace that
730 * does not depend on the plaintext size. After this move, the
731 * starting location of the plaintext is no longer sensitive
732 * information. */
Gabor Mezei91deea72021-10-18 16:17:57 +0200733 mbedtls_cf_mem_move_to_left( input + ilen - plaintext_max_size,
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200734 plaintext_max_size,
735 plaintext_max_size - plaintext_size );
736
737 /* Finally copy the decrypted plaintext plus trailing zeros into the output
738 * buffer. If output_max_len is 0, then output may be an invalid pointer
739 * and the result of memcpy() would be undefined; prevent undefined
740 * behavior making sure to depend only on output_max_len (the size of the
741 * user-provided output buffer), which is independent from plaintext
742 * length, validity of padding, success of the decryption, and other
743 * secrets. */
744 if( output_max_len != 0 )
Gabor Mezei91deea72021-10-18 16:17:57 +0200745 memcpy( output, input + ilen - plaintext_max_size, plaintext_max_size );
gabor-mezei-armf52941e2021-09-27 16:11:12 +0200746
747 /* Report the amount of data we copied to the output buffer. In case
748 * of errors (bad padding or output too large), the value of *olen
749 * when this function returns is not specified. Making it equivalent
750 * to the good case limits the risks of leaking the padding validity. */
751 *olen = plaintext_size;
752
753 return( ret );
754}
755
756#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */