blob: 779679c18fb62d51e229799971a2c070663163f5 [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 /*
Gabor Mezei642eeb22021-11-03 16:13:32 +010021 * The following functions are implemented without using comparison operators, as those
Gabor Mezeieab90bc2021-10-18 16:09:41 +020022 * 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 Mezei22c9a6f2021-10-20 12:09:35 +020026#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +020028#include "mbedtls/error.h"
gabor-mezei-arm5b3a32d2021-09-29 10:50:31 +020029#include "mbedtls/platform_util.h"
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020030
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +020031#if defined(MBEDTLS_BIGNUM_C)
32#include "mbedtls/bignum.h"
33#endif
34
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +020035#if defined(MBEDTLS_SSL_TLS_C)
36#include "ssl_misc.h"
37#endif
38
gabor-mezei-arm5b3a32d2021-09-29 10:50:31 +020039#if defined(MBEDTLS_RSA_C)
40#include "mbedtls/rsa.h"
41#endif
42
Gabor Mezei28d61152021-11-15 16:13:01 +010043#if defined(MBEDTLS_BASE64_C)
44#include "constant_time_invasive.h"
45#endif
46
gabor-mezei-armfdb71182021-09-27 16:11:12 +020047#include <string.h>
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +020048
Gabor Mezei90437e32021-10-20 11:59:27 +020049int mbedtls_ct_memcmp( const void *a,
gabor-mezei-arm46025642021-07-19 15:19:19 +020050 const void *b,
51 size_t n )
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020052{
53 size_t i;
54 volatile const unsigned char *A = (volatile const unsigned char *) a;
55 volatile const unsigned char *B = (volatile const unsigned char *) b;
56 volatile unsigned char diff = 0;
57
58 for( i = 0; i < n; i++ )
59 {
60 /* Read volatile data in order before computing diff.
61 * This avoids IAR compiler warning:
62 * 'the order of volatile accesses is undefined ..' */
63 unsigned char x = A[i], y = B[i];
64 diff |= x ^ y;
65 }
66
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020067 return( (int)diff );
68}
69
Gabor Mezei90437e32021-10-20 11:59:27 +020070unsigned mbedtls_ct_uint_mask( unsigned value )
gabor-mezei-arm340948e2021-09-27 11:40:03 +020071{
72 /* MSVC has a warning about unary minus on unsigned, but this is
73 * well-defined and precisely what we want to do here */
74#if defined(_MSC_VER)
75#pragma warning( push )
76#pragma warning( disable : 4146 )
77#endif
78 return( - ( ( value | - value ) >> ( sizeof( value ) * 8 - 1 ) ) );
79#if defined(_MSC_VER)
80#pragma warning( pop )
81#endif
82}
gabor-mezei-arm3733bf82021-09-27 11:49:42 +020083
Gabor Mezei6a426c92021-10-20 11:17:43 +020084#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
85
Gabor Mezei90437e32021-10-20 11:59:27 +020086size_t mbedtls_ct_size_mask( size_t value )
gabor-mezei-arm3733bf82021-09-27 11:49:42 +020087{
88 /* MSVC has a warning about unary minus on unsigned integer types,
89 * but this is well-defined and precisely what we want to do here. */
90#if defined(_MSC_VER)
91#pragma warning( push )
92#pragma warning( disable : 4146 )
93#endif
gabor-mezei-arm396438c2021-08-10 20:56:21 +020094 return( - ( ( value | - value ) >> ( sizeof( value ) * 8 - 1 ) ) );
gabor-mezei-arm3733bf82021-09-27 11:49:42 +020095#if defined(_MSC_VER)
96#pragma warning( pop )
97#endif
98}
gabor-mezei-armc76227d2021-09-27 11:53:54 +020099
Gabor Mezei6a426c92021-10-20 11:17:43 +0200100#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
101
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200102#if defined(MBEDTLS_BIGNUM_C)
103
Gabor Mezei90437e32021-10-20 11:59:27 +0200104mbedtls_mpi_uint mbedtls_ct_mpi_uint_mask( mbedtls_mpi_uint value )
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200105{
106 /* MSVC has a warning about unary minus on unsigned, but this is
107 * well-defined and precisely what we want to do here */
108#if defined(_MSC_VER)
109#pragma warning( push )
110#pragma warning( disable : 4146 )
111#endif
112 return( - ( ( value | - value ) >> ( sizeof( value ) * 8 - 1 ) ) );
113#if defined(_MSC_VER)
114#pragma warning( pop )
115#endif
116}
117
118#endif /* MBEDTLS_BIGNUM_C */
119
Gabor Mezeie2123792021-10-18 17:05:06 +0200120#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
121
Gabor Mezei1e642612021-10-18 16:05:50 +0200122/** Constant-flow mask generation for "less than" comparison:
123 * - if \p x < \p y, return all-bits 1, that is (size_t) -1
124 * - otherwise, return all bits 0, that is 0
125 *
126 * This function can be used to write constant-time code by replacing branches
127 * with bit operations using masks.
128 *
129 * \param x The first value to analyze.
130 * \param y The second value to analyze.
131 *
132 * \return All-bits-one if \p x is less than \p y, otherwise zero.
133 */
Gabor Mezei90437e32021-10-20 11:59:27 +0200134static size_t mbedtls_ct_size_mask_lt( size_t x,
Gabor Mezei1e642612021-10-18 16:05:50 +0200135 size_t y )
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200136{
137 /* This has the most significant bit set if and only if x < y */
138 const size_t sub = x - y;
139
140 /* sub1 = (x < y) ? 1 : 0 */
141 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
142
143 /* mask = (x < y) ? 0xff... : 0x00... */
Gabor Mezei90437e32021-10-20 11:59:27 +0200144 const size_t mask = mbedtls_ct_size_mask( sub1 );
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200145
146 return( mask );
147}
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200148
Gabor Mezei90437e32021-10-20 11:59:27 +0200149size_t mbedtls_ct_size_mask_ge( size_t x,
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200150 size_t y )
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200151{
Gabor Mezei90437e32021-10-20 11:59:27 +0200152 return( ~mbedtls_ct_size_mask_lt( x, y ) );
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200153}
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200154
Gabor Mezeie2123792021-10-18 17:05:06 +0200155#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
156
Gabor Mezei28d61152021-11-15 16:13:01 +0100157#if defined(MBEDTLS_BASE64_C)
158
159/* Return 0xff if low <= c <= high, 0 otherwise.
160 *
161 * Constant flow with respect to c.
162 */
163unsigned char mbedtls_ct_uchar_mask_of_range( unsigned char low,
164 unsigned char high,
165 unsigned char c )
166{
167 /* low_mask is: 0 if low <= c, 0x...ff if low > c */
168 unsigned low_mask = ( (unsigned) c - low ) >> 8;
169 /* high_mask is: 0 if c <= high, 0x...ff if c > high */
170 unsigned high_mask = ( (unsigned) high - c ) >> 8;
171 return( ~( low_mask | high_mask ) & 0xff );
172}
173
174#endif /* MBEDTLS_BASE64_C */
175
Gabor Mezei90437e32021-10-20 11:59:27 +0200176unsigned mbedtls_ct_size_bool_eq( size_t x,
gabor-mezei-armb11a56e2021-08-11 17:28:49 +0200177 size_t y )
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200178{
179 /* diff = 0 if x == y, non-zero otherwise */
180 const size_t diff = x ^ y;
181
182 /* MSVC has a warning about unary minus on unsigned integer types,
183 * but this is well-defined and precisely what we want to do here. */
184#if defined(_MSC_VER)
185#pragma warning( push )
186#pragma warning( disable : 4146 )
187#endif
188
189 /* diff_msb's most significant bit is equal to x != y */
190 const size_t diff_msb = ( diff | (size_t) -diff );
191
192#if defined(_MSC_VER)
193#pragma warning( pop )
194#endif
195
196 /* diff1 = (x != y) ? 1 : 0 */
gabor-mezei-armb11a56e2021-08-11 17:28:49 +0200197 const unsigned diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200198
199 return( 1 ^ diff1 );
200}
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200201
Gabor Mezeie2123792021-10-18 17:05:06 +0200202#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
203
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200204/** Constant-flow "greater than" comparison:
205 * return x > y
206 *
207 * This is equivalent to \p x > \p y, but is likely to be compiled
208 * to code using bitwise operation rather than a branch.
209 *
210 * \param x The first value to analyze.
211 * \param y The second value to analyze.
212 *
213 * \return 1 if \p x greater than \p y, otherwise 0.
214 */
Gabor Mezei90437e32021-10-20 11:59:27 +0200215static unsigned mbedtls_ct_size_gt( size_t x,
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200216 size_t y )
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200217{
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200218 /* Return the sign bit (1 for negative) of (y - x). */
219 return( ( y - x ) >> ( sizeof( size_t ) * 8 - 1 ) );
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200220}
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200221
Gabor Mezeie2123792021-10-18 17:05:06 +0200222#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
223
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200224#if defined(MBEDTLS_BIGNUM_C)
225
Gabor Mezei90437e32021-10-20 11:59:27 +0200226unsigned mbedtls_ct_mpi_uint_lt( const mbedtls_mpi_uint x,
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200227 const mbedtls_mpi_uint y )
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200228{
229 mbedtls_mpi_uint ret;
230 mbedtls_mpi_uint cond;
231
232 /*
233 * Check if the most significant bits (MSB) of the operands are different.
234 */
235 cond = ( x ^ y );
236 /*
237 * If the MSB are the same then the difference x-y will be negative (and
238 * have its MSB set to 1 during conversion to unsigned) if and only if x<y.
239 */
240 ret = ( x - y ) & ~cond;
241 /*
242 * If the MSB are different, then the operand with the MSB of 1 is the
243 * bigger. (That is if y has MSB of 1, then x<y is true and it is false if
244 * the MSB of y is 0.)
245 */
246 ret |= y & cond;
247
248
249 ret = ret >> ( sizeof( mbedtls_mpi_uint ) * 8 - 1 );
250
251 return (unsigned) ret;
252}
253
254#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200255
Gabor Mezei90437e32021-10-20 11:59:27 +0200256unsigned mbedtls_ct_uint_if( unsigned condition,
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200257 unsigned if1,
258 unsigned if0 )
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200259{
Gabor Mezei90437e32021-10-20 11:59:27 +0200260 unsigned mask = mbedtls_ct_uint_mask( condition );
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200261 return( ( mask & if1 ) | (~mask & if0 ) );
262}
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200263
Gabor Mezeie2123792021-10-18 17:05:06 +0200264#if defined(MBEDTLS_BIGNUM_C)
gabor-mezei-arm65cefdb2021-09-27 15:47:00 +0200265
Gabor Mezei642eeb22021-11-03 16:13:32 +0100266/** Select between two sign values without branches.
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200267 *
268 * This is functionally equivalent to `condition ? if1 : if0` but uses only bit
269 * operations in order to avoid branches.
270 *
271 * \note if1 and if0 must be either 1 or -1, otherwise the result
272 * is undefined.
273 *
274 * \param condition Condition to test.
275 * \param if1 The first sign; must be either +1 or -1.
276 * \param if0 The second sign; must be either +1 or -1.
277 *
278 * \return \c if1 if \p condition is nonzero, otherwise \c if0.
279 * */
Gabor Mezei90437e32021-10-20 11:59:27 +0200280static int mbedtls_ct_cond_select_sign( unsigned char condition,
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200281 int if1,
282 int if0 )
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200283{
Gabor Mezei642eeb22021-11-03 16:13:32 +0100284 /* In order to avoid questions about what we can reasonably assume about
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200285 * the representations of signed integers, move everything to unsigned
Gabor Mezeia316fc82021-10-18 16:28:27 +0200286 * by taking advantage of the fact that if1 and if0 are either +1 or -1. */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200287 unsigned uif1 = if1 + 1;
288 unsigned uif0 = if0 + 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200289
Gabor Mezeia316fc82021-10-18 16:28:27 +0200290 /* condition was 0 or 1, mask is 0 or 2 as are uif1 and uif0 */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200291 const unsigned mask = condition << 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200292
Gabor Mezeia316fc82021-10-18 16:28:27 +0200293 /* select uif1 or uif0 */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200294 unsigned ur = ( uif0 & ~mask ) | ( uif1 & mask );
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200295
296 /* ur is now 0 or 2, convert back to -1 or +1 */
297 return( (int) ur - 1 );
298}
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200299
Gabor Mezei90437e32021-10-20 11:59:27 +0200300void mbedtls_ct_mpi_uint_cond_assign( size_t n,
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200301 mbedtls_mpi_uint *dest,
302 const mbedtls_mpi_uint *src,
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200303 unsigned char condition )
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200304{
305 size_t i;
306
307 /* MSVC has a warning about unary minus on unsigned integer types,
308 * but this is well-defined and precisely what we want to do here. */
309#if defined(_MSC_VER)
310#pragma warning( push )
311#pragma warning( disable : 4146 )
312#endif
313
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200314 /* all-bits 1 if condition is 1, all-bits 0 if condition is 0 */
315 const mbedtls_mpi_uint mask = -condition;
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200316
317#if defined(_MSC_VER)
318#pragma warning( pop )
319#endif
320
321 for( i = 0; i < n; i++ )
322 dest[i] = ( src[i] & mask ) | ( dest[i] & ~mask );
323}
324
325#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200326
Gabor Mezeie2123792021-10-18 17:05:06 +0200327#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
328
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200329/** Shift some data towards the left inside a buffer.
330 *
Gabor Mezei90437e32021-10-20 11:59:27 +0200331 * `mbedtls_ct_mem_move_to_left(start, total, offset)` is functionally
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200332 * equivalent to
333 * ```
334 * memmove(start, start + offset, total - offset);
335 * memset(start + offset, 0, total - offset);
336 * ```
337 * but it strives to use a memory access pattern (and thus total timing)
338 * that does not depend on \p offset. This timing independence comes at
339 * the expense of performance.
340 *
341 * \param start Pointer to the start of the buffer.
342 * \param total Total size of the buffer.
343 * \param offset Offset from which to copy \p total - \p offset bytes.
344 */
Gabor Mezei90437e32021-10-20 11:59:27 +0200345static void mbedtls_ct_mem_move_to_left( void *start,
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200346 size_t total,
347 size_t offset )
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200348{
349 volatile unsigned char *buf = start;
350 size_t i, n;
351 if( total == 0 )
352 return;
353 for( i = 0; i < total; i++ )
354 {
Gabor Mezei90437e32021-10-20 11:59:27 +0200355 unsigned no_op = mbedtls_ct_size_gt( total - offset, i );
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200356 /* The first `total - offset` passes are a no-op. The last
357 * `offset` passes shift the data one byte to the left and
358 * zero out the last byte. */
359 for( n = 0; n < total - 1; n++ )
360 {
361 unsigned char current = buf[n];
362 unsigned char next = buf[n+1];
Gabor Mezei90437e32021-10-20 11:59:27 +0200363 buf[n] = mbedtls_ct_uint_if( no_op, current, next );
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200364 }
Gabor Mezei90437e32021-10-20 11:59:27 +0200365 buf[total-1] = mbedtls_ct_uint_if( no_op, buf[total-1], 0 );
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200366 }
367}
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200368
Gabor Mezeie2123792021-10-18 17:05:06 +0200369#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
370
371#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
372
Gabor Mezei90437e32021-10-20 11:59:27 +0200373void mbedtls_ct_memcpy_if_eq( unsigned char *dest,
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200374 const unsigned char *src,
375 size_t len,
376 size_t c1,
377 size_t c2 )
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200378{
379 /* mask = c1 == c2 ? 0xff : 0x00 */
Gabor Mezei90437e32021-10-20 11:59:27 +0200380 const size_t equal = mbedtls_ct_size_bool_eq( c1, c2 );
381 const unsigned char mask = (unsigned char) mbedtls_ct_size_mask( equal );
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200382
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200383 /* dest[i] = c1 == c2 ? src[i] : dest[i] */
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200384 for( size_t i = 0; i < len; i++ )
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200385 dest[i] = ( src[i] & mask ) | ( dest[i] & ~mask );
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200386}
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200387
Gabor Mezei90437e32021-10-20 11:59:27 +0200388void mbedtls_ct_memcpy_offset( unsigned char *dest,
Gabor Mezei63bbba52021-10-18 16:17:57 +0200389 const unsigned char *src,
390 size_t offset,
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200391 size_t offset_min,
392 size_t offset_max,
393 size_t len )
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200394{
Gabor Mezei63bbba52021-10-18 16:17:57 +0200395 size_t offsetval;
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200396
Gabor Mezei63bbba52021-10-18 16:17:57 +0200397 for( offsetval = offset_min; offsetval <= offset_max; offsetval++ )
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200398 {
Gabor Mezei90437e32021-10-20 11:59:27 +0200399 mbedtls_ct_memcpy_if_eq( dest, src + offsetval, len,
Gabor Mezei63bbba52021-10-18 16:17:57 +0200400 offsetval, offset );
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200401 }
402}
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200403
Gabor Mezei90437e32021-10-20 11:59:27 +0200404int mbedtls_ct_hmac( mbedtls_md_context_t *ctx,
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200405 const unsigned char *add_data,
406 size_t add_data_len,
407 const unsigned char *data,
408 size_t data_len_secret,
409 size_t min_data_len,
410 size_t max_data_len,
411 unsigned char *output )
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200412{
413 /*
414 * This function breaks the HMAC abstraction and uses the md_clone()
415 * extension to the MD API in order to get constant-flow behaviour.
416 *
417 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
418 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
419 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
420 *
421 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
422 * minlen, then cloning the context, and for each byte up to maxlen
423 * finishing up the hash computation, keeping only the correct result.
424 *
425 * Then we only need to compute HASH(okey + inner_hash) and we're done.
426 */
427 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
428 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
429 * all of which have the same block size except SHA-384. */
430 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
431 const unsigned char * const ikey = ctx->hmac_ctx;
432 const unsigned char * const okey = ikey + block_size;
433 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
434
435 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
436 mbedtls_md_context_t aux;
437 size_t offset;
438 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
439
440 mbedtls_md_init( &aux );
441
442#define MD_CHK( func_call ) \
443 do { \
444 ret = (func_call); \
445 if( ret != 0 ) \
446 goto cleanup; \
447 } while( 0 )
448
449 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
450
451 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
452 * so we can start directly with the message */
453 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
454 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
455
456 /* For each possible length, compute the hash up to that point */
457 for( offset = min_data_len; offset <= max_data_len; offset++ )
458 {
459 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
460 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
461 /* Keep only the correct inner_hash in the output buffer */
Gabor Mezei90437e32021-10-20 11:59:27 +0200462 mbedtls_ct_memcpy_if_eq( output, aux_out, hash_size,
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200463 offset, data_len_secret );
464
465 if( offset < max_data_len )
466 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
467 }
468
469 /* The context needs to finish() before it starts() again */
470 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
471
472 /* Now compute HASH(okey + inner_hash) */
473 MD_CHK( mbedtls_md_starts( ctx ) );
474 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
475 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
476 MD_CHK( mbedtls_md_finish( ctx, output ) );
477
478 /* Done, get ready for next time */
479 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
480
481#undef MD_CHK
482
483cleanup:
484 mbedtls_md_free( &aux );
485 return( ret );
486}
487
488#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200489
490#if defined(MBEDTLS_BIGNUM_C)
491
492#define MPI_VALIDATE_RET( cond ) \
493 MBEDTLS_INTERNAL_VALIDATE_RET( cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA )
494
495/*
496 * Conditionally assign X = Y, without leaking information
497 * about whether the assignment was made or not.
498 * (Leaking information about the respective sizes of X and Y is ok however.)
499 */
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200500int mbedtls_mpi_safe_cond_assign( mbedtls_mpi *X,
501 const mbedtls_mpi *Y,
502 unsigned char assign )
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200503{
504 int ret = 0;
505 size_t i;
506 mbedtls_mpi_uint limb_mask;
507 MPI_VALIDATE_RET( X != NULL );
508 MPI_VALIDATE_RET( Y != NULL );
509
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200510 /* all-bits 1 if assign is 1, all-bits 0 if assign is 0 */
Gabor Mezei90437e32021-10-20 11:59:27 +0200511 limb_mask = mbedtls_ct_mpi_uint_mask( assign );;
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200512
513 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, Y->n ) );
514
Gabor Mezei90437e32021-10-20 11:59:27 +0200515 X->s = mbedtls_ct_cond_select_sign( assign, Y->s, X->s );
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200516
Gabor Mezei90437e32021-10-20 11:59:27 +0200517 mbedtls_ct_mpi_uint_cond_assign( Y->n, X->p, Y->p, assign );
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200518
519 for( i = Y->n; i < X->n; i++ )
520 X->p[i] &= ~limb_mask;
521
522cleanup:
523 return( ret );
524}
525
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200526/*
527 * Conditionally swap X and Y, without leaking information
528 * about whether the swap was made or not.
529 * Here it is not ok to simply swap the pointers, which whould lead to
530 * different memory access patterns when X and Y are used afterwards.
531 */
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200532int mbedtls_mpi_safe_cond_swap( mbedtls_mpi *X,
533 mbedtls_mpi *Y,
534 unsigned char swap )
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200535{
536 int ret, s;
537 size_t i;
538 mbedtls_mpi_uint limb_mask;
539 mbedtls_mpi_uint tmp;
540 MPI_VALIDATE_RET( X != NULL );
541 MPI_VALIDATE_RET( Y != NULL );
542
543 if( X == Y )
544 return( 0 );
545
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200546 /* all-bits 1 if swap is 1, all-bits 0 if swap is 0 */
Gabor Mezei90437e32021-10-20 11:59:27 +0200547 limb_mask = mbedtls_ct_mpi_uint_mask( swap );
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200548
549 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( X, Y->n ) );
550 MBEDTLS_MPI_CHK( mbedtls_mpi_grow( Y, X->n ) );
551
552 s = X->s;
Gabor Mezei90437e32021-10-20 11:59:27 +0200553 X->s = mbedtls_ct_cond_select_sign( swap, Y->s, X->s );
554 Y->s = mbedtls_ct_cond_select_sign( swap, s, Y->s );
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200555
556
557 for( i = 0; i < X->n; i++ )
558 {
559 tmp = X->p[i];
560 X->p[i] = ( X->p[i] & ~limb_mask ) | ( Y->p[i] & limb_mask );
561 Y->p[i] = ( Y->p[i] & ~limb_mask ) | ( tmp & limb_mask );
562 }
563
564cleanup:
565 return( ret );
566}
567
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200568/*
569 * Compare signed values in constant time
570 */
gabor-mezei-arm2dcd7682021-09-27 16:29:52 +0200571int mbedtls_mpi_lt_mpi_ct( const mbedtls_mpi *X,
572 const mbedtls_mpi *Y,
573 unsigned *ret )
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200574{
575 size_t i;
576 /* The value of any of these variables is either 0 or 1 at all times. */
577 unsigned cond, done, X_is_negative, Y_is_negative;
578
579 MPI_VALIDATE_RET( X != NULL );
580 MPI_VALIDATE_RET( Y != NULL );
581 MPI_VALIDATE_RET( ret != NULL );
582
583 if( X->n != Y->n )
584 return MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
585
586 /*
587 * Set sign_N to 1 if N >= 0, 0 if N < 0.
588 * We know that N->s == 1 if N >= 0 and N->s == -1 if N < 0.
589 */
590 X_is_negative = ( X->s & 2 ) >> 1;
591 Y_is_negative = ( Y->s & 2 ) >> 1;
592
593 /*
594 * If the signs are different, then the positive operand is the bigger.
595 * That is if X is negative (X_is_negative == 1), then X < Y is true and it
596 * is false if X is positive (X_is_negative == 0).
597 */
598 cond = ( X_is_negative ^ Y_is_negative );
599 *ret = cond & X_is_negative;
600
601 /*
602 * This is a constant-time function. We might have the result, but we still
603 * need to go through the loop. Record if we have the result already.
604 */
605 done = cond;
606
607 for( i = X->n; i > 0; i-- )
608 {
609 /*
610 * If Y->p[i - 1] < X->p[i - 1] then X < Y is true if and only if both
611 * X and Y are negative.
612 *
613 * Again even if we can make a decision, we just mark the result and
614 * the fact that we are done and continue looping.
615 */
Gabor Mezei90437e32021-10-20 11:59:27 +0200616 cond = mbedtls_ct_mpi_uint_lt( Y->p[i - 1], X->p[i - 1] );
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200617 *ret |= cond & ( 1 - done ) & X_is_negative;
618 done |= cond;
619
620 /*
621 * If X->p[i - 1] < Y->p[i - 1] then X < Y is true if and only if both
622 * X and Y are positive.
623 *
624 * Again even if we can make a decision, we just mark the result and
625 * the fact that we are done and continue looping.
626 */
Gabor Mezei90437e32021-10-20 11:59:27 +0200627 cond = mbedtls_ct_mpi_uint_lt( X->p[i - 1], Y->p[i - 1] );
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200628 *ret |= cond & ( 1 - done ) & ( 1 - X_is_negative );
629 done |= cond;
630 }
631
632 return( 0 );
633}
634
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200635#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200636
637#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
638
Gabor Mezei90437e32021-10-20 11:59:27 +0200639int mbedtls_ct_rsaes_pkcs1_v15_unpadding( unsigned char *input,
Gabor Mezei63bbba52021-10-18 16:17:57 +0200640 size_t ilen,
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200641 unsigned char *output,
642 size_t output_max_len,
Gabor Mezei63bbba52021-10-18 16:17:57 +0200643 size_t *olen )
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200644{
645 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
646 size_t i, plaintext_max_size;
647
648 /* The following variables take sensitive values: their value must
649 * not leak into the observable behavior of the function other than
650 * the designated outputs (output, olen, return value). Otherwise
651 * this would open the execution of the function to
652 * side-channel-based variants of the Bleichenbacher padding oracle
653 * attack. Potential side channels include overall timing, memory
654 * access patterns (especially visible to an adversary who has access
655 * to a shared memory cache), and branches (especially visible to
656 * an adversary who has access to a shared code cache or to a shared
657 * branch predictor). */
658 size_t pad_count = 0;
659 unsigned bad = 0;
660 unsigned char pad_done = 0;
661 size_t plaintext_size = 0;
662 unsigned output_too_large;
663
Gabor Mezei7013f622021-10-18 16:12:45 +0200664 plaintext_max_size = ( output_max_len > ilen - 11 ) ? ilen - 11
665 : output_max_len;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200666
667 /* Check and get padding length in constant time and constant
668 * memory trace. The first byte must be 0. */
Gabor Mezei63bbba52021-10-18 16:17:57 +0200669 bad |= input[0];
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200670
671
672 /* Decode EME-PKCS1-v1_5 padding: 0x00 || 0x02 || PS || 0x00
Gabor Mezei63bbba52021-10-18 16:17:57 +0200673 * where PS must be at least 8 nonzero bytes. */
674 bad |= input[1] ^ MBEDTLS_RSA_CRYPT;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200675
676 /* Read the whole buffer. Set pad_done to nonzero if we find
Gabor Mezei63bbba52021-10-18 16:17:57 +0200677 * the 0x00 byte and remember the padding length in pad_count. */
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200678 for( i = 2; i < ilen; i++ )
679 {
Gabor Mezei63bbba52021-10-18 16:17:57 +0200680 pad_done |= ((input[i] | (unsigned char)-input[i]) >> 7) ^ 1;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200681 pad_count += ((pad_done | (unsigned char)-pad_done) >> 7) ^ 1;
682 }
683
684
685 /* If pad_done is still zero, there's no data, only unfinished padding. */
Gabor Mezei90437e32021-10-20 11:59:27 +0200686 bad |= mbedtls_ct_uint_if( pad_done, 0, 1 );
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200687
688 /* There must be at least 8 bytes of padding. */
Gabor Mezei90437e32021-10-20 11:59:27 +0200689 bad |= mbedtls_ct_size_gt( 8, pad_count );
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200690
691 /* If the padding is valid, set plaintext_size to the number of
692 * remaining bytes after stripping the padding. If the padding
693 * is invalid, avoid leaking this fact through the size of the
694 * output: use the maximum message size that fits in the output
695 * buffer. Do it without branches to avoid leaking the padding
696 * validity through timing. RSA keys are small enough that all the
697 * size_t values involved fit in unsigned int. */
Gabor Mezei90437e32021-10-20 11:59:27 +0200698 plaintext_size = mbedtls_ct_uint_if(
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200699 bad, (unsigned) plaintext_max_size,
700 (unsigned) ( ilen - pad_count - 3 ) );
701
702 /* Set output_too_large to 0 if the plaintext fits in the output
703 * buffer and to 1 otherwise. */
Gabor Mezei90437e32021-10-20 11:59:27 +0200704 output_too_large = mbedtls_ct_size_gt( plaintext_size,
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200705 plaintext_max_size );
706
707 /* Set ret without branches to avoid timing attacks. Return:
708 * - INVALID_PADDING if the padding is bad (bad != 0).
709 * - OUTPUT_TOO_LARGE if the padding is good but the decrypted
710 * plaintext does not fit in the output buffer.
711 * - 0 if the padding is correct. */
Gabor Mezei90437e32021-10-20 11:59:27 +0200712 ret = - (int) mbedtls_ct_uint_if(
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200713 bad, - MBEDTLS_ERR_RSA_INVALID_PADDING,
Gabor Mezei90437e32021-10-20 11:59:27 +0200714 mbedtls_ct_uint_if( output_too_large,
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200715 - MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE,
716 0 ) );
717
718 /* If the padding is bad or the plaintext is too large, zero the
719 * data that we're about to copy to the output buffer.
720 * We need to copy the same amount of data
721 * from the same buffer whether the padding is good or not to
722 * avoid leaking the padding validity through overall timing or
723 * through memory or cache access patterns. */
Gabor Mezei90437e32021-10-20 11:59:27 +0200724 bad = mbedtls_ct_uint_mask( bad | output_too_large );
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200725 for( i = 11; i < ilen; i++ )
Gabor Mezei63bbba52021-10-18 16:17:57 +0200726 input[i] &= ~bad;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200727
728 /* If the plaintext is too large, truncate it to the buffer size.
729 * Copy anyway to avoid revealing the length through timing, because
730 * revealing the length is as bad as revealing the padding validity
731 * for a Bleichenbacher attack. */
Gabor Mezei90437e32021-10-20 11:59:27 +0200732 plaintext_size = mbedtls_ct_uint_if( output_too_large,
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200733 (unsigned) plaintext_max_size,
734 (unsigned) plaintext_size );
735
736 /* Move the plaintext to the leftmost position where it can start in
737 * the working buffer, i.e. make it start plaintext_max_size from
738 * the end of the buffer. Do this with a memory access trace that
739 * does not depend on the plaintext size. After this move, the
740 * starting location of the plaintext is no longer sensitive
741 * information. */
Gabor Mezei90437e32021-10-20 11:59:27 +0200742 mbedtls_ct_mem_move_to_left( input + ilen - plaintext_max_size,
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200743 plaintext_max_size,
744 plaintext_max_size - plaintext_size );
745
746 /* Finally copy the decrypted plaintext plus trailing zeros into the output
747 * buffer. If output_max_len is 0, then output may be an invalid pointer
748 * and the result of memcpy() would be undefined; prevent undefined
749 * behavior making sure to depend only on output_max_len (the size of the
750 * user-provided output buffer), which is independent from plaintext
751 * length, validity of padding, success of the decryption, and other
752 * secrets. */
753 if( output_max_len != 0 )
Gabor Mezei63bbba52021-10-18 16:17:57 +0200754 memcpy( output, input + ilen - plaintext_max_size, plaintext_max_size );
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200755
756 /* Report the amount of data we copied to the output buffer. In case
757 * of errors (bad padding or output too large), the value of *olen
758 * when this function returns is not specified. Making it equivalent
759 * to the good case limits the risks of leaking the padding validity. */
760 *olen = plaintext_size;
761
762 return( ret );
763}
764
765#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */