blob: c5b6690ddcf15188f8280d49898b584933b058cf [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
Gilles Peskine449bd832023-01-11 14:50:10 +010020/*
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"
Gabor Mezei87638a92022-09-15 20:02:36 +020033#include "bignum_core.h"
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +020034#endif
35
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +020036#if defined(MBEDTLS_SSL_TLS_C)
37#include "ssl_misc.h"
38#endif
39
gabor-mezei-arm5b3a32d2021-09-29 10:50:31 +020040#if defined(MBEDTLS_RSA_C)
41#include "mbedtls/rsa.h"
42#endif
43
Gabor Mezei28d61152021-11-15 16:13:01 +010044#if defined(MBEDTLS_BASE64_C)
45#include "constant_time_invasive.h"
46#endif
47
gabor-mezei-armfdb71182021-09-27 16:11:12 +020048#include <string.h>
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +020049
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000050/*
51 * Define MBEDTLS_EFFICIENT_UNALIGNED_ACCESS for architectures where unaligned memory
52 * accesses are known to be safe and efficient.
53 *
54 * This is needed because mbedtls_get_unaligned_uintXX etc don't support volatile
55 * memory accesses.
56 *
57 * This macro could be moved into alignment.h but for now it's only used here.
58 */
59#if defined(__ARM_FEATURE_UNALIGNED)
60/* __ARM_FEATURE_UNALIGNED is defined by armcc, gcc 7, clang 9 and later versions. */
61#define MBEDTLS_EFFICIENT_UNALIGNED_ACCESS
62#endif
63
64#if defined(MBEDTLS_EFFICIENT_UNALIGNED_ACCESS) && defined(MBEDTLS_HAVE_ASM)
65static inline uint32_t mbedtls_get_unaligned_volatile_uint32(volatile const unsigned char *p)
66{
67 /* This is UB, even where it's safe:
68 * return *((volatile uint32_t*)p);
69 * so instead the same thing is expressed in assembly below.
70 */
71 uint32_t r;
72#if defined(__arm__) || defined(__thumb__) || defined(__thumb2__)
73 asm ("ldr %0, [%1]" : "=r" (r) : "r" (p) :);
74 return r;
75#endif
76#if defined(__aarch64__)
77 asm ("ldr %w0, [%1]" : "=r" (r) : "r" (p) :);
78 return r;
79#endif
80
81 /* Always safe, but inefficient, fall-back */
82 if (MBEDTLS_IS_BIG_ENDIAN) {
83 return (p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3];
84 } else {
85 return p[0] | (p[1] << 8) | (p[2] << 16) | (p[3] << 24);
86 }
87}
88#endif /* MBEDTLS_EFFICIENT_UNALIGNED_ACCESS */
89
Gilles Peskine449bd832023-01-11 14:50:10 +010090int mbedtls_ct_memcmp(const void *a,
91 const void *b,
92 size_t n)
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020093{
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000094 size_t i = 0;
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020095 volatile const unsigned char *A = (volatile const unsigned char *) a;
96 volatile const unsigned char *B = (volatile const unsigned char *) b;
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000097 volatile uint32_t diff = 0;
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020098
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000099#if defined(MBEDTLS_EFFICIENT_UNALIGNED_ACCESS)
100 for (; (i + 4) <= n; i += 4) {
101 uint32_t x = mbedtls_get_unaligned_volatile_uint32(A + i);
102 uint32_t y = mbedtls_get_unaligned_volatile_uint32(B + i);
103 diff |= x ^ y;
104 }
105#endif
106
107 for (; i < n; i++) {
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +0200108 /* Read volatile data in order before computing diff.
109 * This avoids IAR compiler warning:
110 * 'the order of volatile accesses is undefined ..' */
111 unsigned char x = A[i], y = B[i];
112 diff |= x ^ y;
113 }
114
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 return (int) diff;
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +0200116}
117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118unsigned mbedtls_ct_uint_mask(unsigned value)
gabor-mezei-arm340948e2021-09-27 11:40:03 +0200119{
120 /* MSVC has a warning about unary minus on unsigned, but this is
121 * well-defined and precisely what we want to do here */
122#if defined(_MSC_VER)
123#pragma warning( push )
124#pragma warning( disable : 4146 )
125#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 return -((value | -value) >> (sizeof(value) * 8 - 1));
gabor-mezei-arm340948e2021-09-27 11:40:03 +0200127#if defined(_MSC_VER)
128#pragma warning( pop )
129#endif
130}
gabor-mezei-arm3733bf82021-09-27 11:49:42 +0200131
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200132#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gabor Mezei6a426c92021-10-20 11:17:43 +0200133
Gilles Peskine449bd832023-01-11 14:50:10 +0100134size_t mbedtls_ct_size_mask(size_t value)
gabor-mezei-arm3733bf82021-09-27 11:49:42 +0200135{
136 /* MSVC has a warning about unary minus on unsigned integer types,
137 * but this is well-defined and precisely what we want to do here. */
138#if defined(_MSC_VER)
139#pragma warning( push )
140#pragma warning( disable : 4146 )
141#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 return -((value | -value) >> (sizeof(value) * 8 - 1));
gabor-mezei-arm3733bf82021-09-27 11:49:42 +0200143#if defined(_MSC_VER)
144#pragma warning( pop )
145#endif
146}
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200147
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200148#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gabor Mezei6a426c92021-10-20 11:17:43 +0200149
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200150#if defined(MBEDTLS_BIGNUM_C)
151
Gilles Peskine449bd832023-01-11 14:50:10 +0100152mbedtls_mpi_uint mbedtls_ct_mpi_uint_mask(mbedtls_mpi_uint value)
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200153{
154 /* MSVC has a warning about unary minus on unsigned, but this is
155 * 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
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return -((value | -value) >> (sizeof(value) * 8 - 1));
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200161#if defined(_MSC_VER)
162#pragma warning( pop )
163#endif
164}
165
166#endif /* MBEDTLS_BIGNUM_C */
167
Gabor Mezeie2123792021-10-18 17:05:06 +0200168#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
169
Gabor Mezei1e642612021-10-18 16:05:50 +0200170/** Constant-flow mask generation for "less than" comparison:
171 * - if \p x < \p y, return all-bits 1, that is (size_t) -1
172 * - otherwise, return all bits 0, that is 0
173 *
174 * This function can be used to write constant-time code by replacing branches
175 * with bit operations using masks.
176 *
177 * \param x The first value to analyze.
178 * \param y The second value to analyze.
179 *
180 * \return All-bits-one if \p x is less than \p y, otherwise zero.
181 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100182static size_t mbedtls_ct_size_mask_lt(size_t x,
183 size_t y)
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200184{
185 /* This has the most significant bit set if and only if x < y */
186 const size_t sub = x - y;
187
188 /* sub1 = (x < y) ? 1 : 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 const size_t sub1 = sub >> (sizeof(sub) * 8 - 1);
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200190
191 /* mask = (x < y) ? 0xff... : 0x00... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 const size_t mask = mbedtls_ct_size_mask(sub1);
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return mask;
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200195}
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200196
Gilles Peskine449bd832023-01-11 14:50:10 +0100197size_t mbedtls_ct_size_mask_ge(size_t x,
198 size_t y)
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200199{
Gilles Peskine449bd832023-01-11 14:50:10 +0100200 return ~mbedtls_ct_size_mask_lt(x, y);
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200201}
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200202
Gabor Mezeie2123792021-10-18 17:05:06 +0200203#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
204
Gabor Mezei28d61152021-11-15 16:13:01 +0100205#if defined(MBEDTLS_BASE64_C)
206
207/* Return 0xff if low <= c <= high, 0 otherwise.
208 *
209 * Constant flow with respect to c.
210 */
Gabor Mezeic0d8dda2021-11-26 17:20:36 +0100211MBEDTLS_STATIC_TESTABLE
Gilles Peskine449bd832023-01-11 14:50:10 +0100212unsigned char mbedtls_ct_uchar_mask_of_range(unsigned char low,
213 unsigned char high,
214 unsigned char c)
Gabor Mezei28d61152021-11-15 16:13:01 +0100215{
216 /* low_mask is: 0 if low <= c, 0x...ff if low > c */
Gilles Peskine449bd832023-01-11 14:50:10 +0100217 unsigned low_mask = ((unsigned) c - low) >> 8;
Gabor Mezei28d61152021-11-15 16:13:01 +0100218 /* high_mask is: 0 if c <= high, 0x...ff if c > high */
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 unsigned high_mask = ((unsigned) high - c) >> 8;
220 return ~(low_mask | high_mask) & 0xff;
Gabor Mezei28d61152021-11-15 16:13:01 +0100221}
222
223#endif /* MBEDTLS_BASE64_C */
224
Gilles Peskine449bd832023-01-11 14:50:10 +0100225unsigned mbedtls_ct_size_bool_eq(size_t x,
226 size_t y)
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200227{
228 /* diff = 0 if x == y, non-zero otherwise */
229 const size_t diff = x ^ y;
230
231 /* MSVC has a warning about unary minus on unsigned integer types,
232 * but this is well-defined and precisely what we want to do here. */
233#if defined(_MSC_VER)
234#pragma warning( push )
235#pragma warning( disable : 4146 )
236#endif
237
238 /* diff_msb's most significant bit is equal to x != y */
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 const size_t diff_msb = (diff | (size_t) -diff);
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200240
241#if defined(_MSC_VER)
242#pragma warning( pop )
243#endif
244
245 /* diff1 = (x != y) ? 1 : 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 const unsigned diff1 = diff_msb >> (sizeof(diff_msb) * 8 - 1);
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200247
Gilles Peskine449bd832023-01-11 14:50:10 +0100248 return 1 ^ diff1;
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200249}
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200250
Gabor Mezeie2123792021-10-18 17:05:06 +0200251#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
252
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200253/** Constant-flow "greater than" comparison:
254 * return x > y
255 *
256 * This is equivalent to \p x > \p y, but is likely to be compiled
257 * to code using bitwise operation rather than a branch.
258 *
259 * \param x The first value to analyze.
260 * \param y The second value to analyze.
261 *
262 * \return 1 if \p x greater than \p y, otherwise 0.
263 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100264static unsigned mbedtls_ct_size_gt(size_t x,
265 size_t y)
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200266{
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200267 /* Return the sign bit (1 for negative) of (y - x). */
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 return (y - x) >> (sizeof(size_t) * 8 - 1);
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200269}
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200270
Gabor Mezeie2123792021-10-18 17:05:06 +0200271#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
272
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200273#if defined(MBEDTLS_BIGNUM_C)
274
Gilles Peskine449bd832023-01-11 14:50:10 +0100275unsigned mbedtls_ct_mpi_uint_lt(const mbedtls_mpi_uint x,
276 const mbedtls_mpi_uint y)
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200277{
278 mbedtls_mpi_uint ret;
279 mbedtls_mpi_uint cond;
280
281 /*
282 * Check if the most significant bits (MSB) of the operands are different.
283 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 cond = (x ^ y);
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200285 /*
286 * If the MSB are the same then the difference x-y will be negative (and
287 * have its MSB set to 1 during conversion to unsigned) if and only if x<y.
288 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 ret = (x - y) & ~cond;
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200290 /*
291 * If the MSB are different, then the operand with the MSB of 1 is the
292 * bigger. (That is if y has MSB of 1, then x<y is true and it is false if
293 * the MSB of y is 0.)
294 */
295 ret |= y & cond;
296
297
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 ret = ret >> (sizeof(mbedtls_mpi_uint) * 8 - 1);
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200299
300 return (unsigned) ret;
301}
302
303#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200304
Gilles Peskine449bd832023-01-11 14:50:10 +0100305unsigned mbedtls_ct_uint_if(unsigned condition,
306 unsigned if1,
307 unsigned if0)
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200308{
Gilles Peskine449bd832023-01-11 14:50:10 +0100309 unsigned mask = mbedtls_ct_uint_mask(condition);
310 return (mask & if1) | (~mask & if0);
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200311}
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200312
Gabor Mezeie2123792021-10-18 17:05:06 +0200313#if defined(MBEDTLS_BIGNUM_C)
gabor-mezei-arm65cefdb2021-09-27 15:47:00 +0200314
Gabor Mezei642eeb22021-11-03 16:13:32 +0100315/** Select between two sign values without branches.
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200316 *
317 * This is functionally equivalent to `condition ? if1 : if0` but uses only bit
318 * operations in order to avoid branches.
319 *
320 * \note if1 and if0 must be either 1 or -1, otherwise the result
321 * is undefined.
322 *
Tom Cosgrove583816c2022-08-18 14:09:18 +0100323 * \param condition Condition to test; must be either 0 or 1.
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200324 * \param if1 The first sign; must be either +1 or -1.
325 * \param if0 The second sign; must be either +1 or -1.
326 *
327 * \return \c if1 if \p condition is nonzero, otherwise \c if0.
328 * */
Gilles Peskine449bd832023-01-11 14:50:10 +0100329static int mbedtls_ct_cond_select_sign(unsigned char condition,
330 int if1,
331 int if0)
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200332{
Gabor Mezei642eeb22021-11-03 16:13:32 +0100333 /* In order to avoid questions about what we can reasonably assume about
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200334 * the representations of signed integers, move everything to unsigned
Gabor Mezeia316fc82021-10-18 16:28:27 +0200335 * by taking advantage of the fact that if1 and if0 are either +1 or -1. */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200336 unsigned uif1 = if1 + 1;
337 unsigned uif0 = if0 + 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200338
Gabor Mezeia316fc82021-10-18 16:28:27 +0200339 /* condition was 0 or 1, mask is 0 or 2 as are uif1 and uif0 */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200340 const unsigned mask = condition << 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200341
Gabor Mezeia316fc82021-10-18 16:28:27 +0200342 /* select uif1 or uif0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 unsigned ur = (uif0 & ~mask) | (uif1 & mask);
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200344
345 /* ur is now 0 or 2, convert back to -1 or +1 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 return (int) ur - 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200347}
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200348
Gilles Peskine449bd832023-01-11 14:50:10 +0100349void mbedtls_ct_mpi_uint_cond_assign(size_t n,
350 mbedtls_mpi_uint *dest,
351 const mbedtls_mpi_uint *src,
352 unsigned char condition)
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200353{
354 size_t i;
355
356 /* MSVC has a warning about unary minus on unsigned integer types,
357 * but this is well-defined and precisely what we want to do here. */
358#if defined(_MSC_VER)
359#pragma warning( push )
360#pragma warning( disable : 4146 )
361#endif
362
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200363 /* all-bits 1 if condition is 1, all-bits 0 if condition is 0 */
364 const mbedtls_mpi_uint mask = -condition;
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200365
366#if defined(_MSC_VER)
367#pragma warning( pop )
368#endif
369
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 for (i = 0; i < n; i++) {
371 dest[i] = (src[i] & mask) | (dest[i] & ~mask);
372 }
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200373}
374
375#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200376
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100377#if defined(MBEDTLS_BASE64_C)
378
Gilles Peskine449bd832023-01-11 14:50:10 +0100379unsigned char mbedtls_ct_base64_enc_char(unsigned char value)
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100380{
381 unsigned char digit = 0;
Gabor Mezei14d5fac2021-11-24 15:51:39 +0100382 /* For each range of values, if value is in that range, mask digit with
383 * the corresponding value. Since value can only be in a single range,
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100384 * only at most one masking will change digit. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 digit |= mbedtls_ct_uchar_mask_of_range(0, 25, value) & ('A' + value);
386 digit |= mbedtls_ct_uchar_mask_of_range(26, 51, value) & ('a' + value - 26);
387 digit |= mbedtls_ct_uchar_mask_of_range(52, 61, value) & ('0' + value - 52);
388 digit |= mbedtls_ct_uchar_mask_of_range(62, 62, value) & '+';
389 digit |= mbedtls_ct_uchar_mask_of_range(63, 63, value) & '/';
390 return digit;
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100391}
392
Gilles Peskine449bd832023-01-11 14:50:10 +0100393signed char mbedtls_ct_base64_dec_value(unsigned char c)
Gabor Mezei358829a2021-11-15 16:22:37 +0100394{
395 unsigned char val = 0;
396 /* For each range of digits, if c is in that range, mask val with
397 * the corresponding value. Since c can only be in a single range,
398 * only at most one masking will change val. Set val to one plus
399 * the desired value so that it stays 0 if c is in none of the ranges. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 val |= mbedtls_ct_uchar_mask_of_range('A', 'Z', c) & (c - 'A' + 0 + 1);
401 val |= mbedtls_ct_uchar_mask_of_range('a', 'z', c) & (c - 'a' + 26 + 1);
402 val |= mbedtls_ct_uchar_mask_of_range('0', '9', c) & (c - '0' + 52 + 1);
403 val |= mbedtls_ct_uchar_mask_of_range('+', '+', c) & (c - '+' + 62 + 1);
404 val |= mbedtls_ct_uchar_mask_of_range('/', '/', c) & (c - '/' + 63 + 1);
Gabor Mezei358829a2021-11-15 16:22:37 +0100405 /* At this point, val is 0 if c is an invalid digit and v+1 if c is
406 * a digit with the value v. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100407 return val - 1;
Gabor Mezei358829a2021-11-15 16:22:37 +0100408}
409
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100410#endif /* MBEDTLS_BASE64_C */
411
Gabor Mezeie2123792021-10-18 17:05:06 +0200412#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
413
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200414/** Shift some data towards the left inside a buffer.
415 *
Gabor Mezei90437e32021-10-20 11:59:27 +0200416 * `mbedtls_ct_mem_move_to_left(start, total, offset)` is functionally
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200417 * equivalent to
418 * ```
419 * memmove(start, start + offset, total - offset);
420 * memset(start + offset, 0, total - offset);
421 * ```
422 * but it strives to use a memory access pattern (and thus total timing)
423 * that does not depend on \p offset. This timing independence comes at
424 * the expense of performance.
425 *
426 * \param start Pointer to the start of the buffer.
427 * \param total Total size of the buffer.
428 * \param offset Offset from which to copy \p total - \p offset bytes.
429 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100430static void mbedtls_ct_mem_move_to_left(void *start,
431 size_t total,
432 size_t offset)
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200433{
434 volatile unsigned char *buf = start;
435 size_t i, n;
Gilles Peskine449bd832023-01-11 14:50:10 +0100436 if (total == 0) {
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200437 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 }
439 for (i = 0; i < total; i++) {
440 unsigned no_op = mbedtls_ct_size_gt(total - offset, i);
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200441 /* The first `total - offset` passes are a no-op. The last
442 * `offset` passes shift the data one byte to the left and
443 * zero out the last byte. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 for (n = 0; n < total - 1; n++) {
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200445 unsigned char current = buf[n];
446 unsigned char next = buf[n+1];
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 buf[n] = mbedtls_ct_uint_if(no_op, current, next);
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200448 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 buf[total-1] = mbedtls_ct_uint_if(no_op, buf[total-1], 0);
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200450 }
451}
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200452
Gabor Mezeie2123792021-10-18 17:05:06 +0200453#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
454
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200455#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gabor Mezeie2123792021-10-18 17:05:06 +0200456
Gilles Peskine449bd832023-01-11 14:50:10 +0100457void mbedtls_ct_memcpy_if_eq(unsigned char *dest,
458 const unsigned char *src,
459 size_t len,
460 size_t c1,
461 size_t c2)
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200462{
463 /* mask = c1 == c2 ? 0xff : 0x00 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 const size_t equal = mbedtls_ct_size_bool_eq(c1, c2);
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200465
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200466 /* dest[i] = c1 == c2 ? src[i] : dest[i] */
Dave Rodgman36dfc5a2022-12-22 15:04:43 +0000467 size_t i = 0;
468#if defined(MBEDTLS_EFFICIENT_UNALIGNED_ACCESS)
469 const uint32_t mask32 = (uint32_t) mbedtls_ct_size_mask(equal);
470 const unsigned char mask = (unsigned char) mask32 & 0xff;
471
472 for (; (i + 4) <= len; i += 4) {
473 uint32_t a = mbedtls_get_unaligned_uint32(src + i) & mask32;
474 uint32_t b = mbedtls_get_unaligned_uint32(dest + i) & ~mask32;
475 mbedtls_put_unaligned_uint32(dest + i, a | b);
476 }
477#else
478 const unsigned char mask = (unsigned char) mbedtls_ct_size_mask(equal);
479#endif /* MBEDTLS_EFFICIENT_UNALIGNED_ACCESS */
480 for (; i < len; i++) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 dest[i] = (src[i] & mask) | (dest[i] & ~mask);
482 }
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200483}
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200484
Gilles Peskine449bd832023-01-11 14:50:10 +0100485void mbedtls_ct_memcpy_offset(unsigned char *dest,
486 const unsigned char *src,
487 size_t offset,
488 size_t offset_min,
489 size_t offset_max,
490 size_t len)
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200491{
Gabor Mezei63bbba52021-10-18 16:17:57 +0200492 size_t offsetval;
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200493
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 for (offsetval = offset_min; offsetval <= offset_max; offsetval++) {
495 mbedtls_ct_memcpy_if_eq(dest, src + offsetval, len,
496 offsetval, offset);
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200497 }
498}
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200499
Neil Armstrong2968d302022-02-25 15:09:36 +0100500#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100501
502#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100503#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100504#elif defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100505#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100506#else /* See check_config.h */
Gilles Peskine449bd832023-01-11 14:50:10 +0100507#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100508#endif
509
Gilles Peskine449bd832023-01-11 14:50:10 +0100510int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
511 psa_algorithm_t mac_alg,
512 const unsigned char *add_data,
513 size_t add_data_len,
514 const unsigned char *data,
515 size_t data_len_secret,
516 size_t min_data_len,
517 size_t max_data_len,
518 unsigned char *output)
Neil Armstrong2968d302022-02-25 15:09:36 +0100519{
520 /*
Neil Armstrong28d9c632022-03-17 16:33:27 +0100521 * This function breaks the HMAC abstraction and uses psa_hash_clone()
522 * extension in order to get constant-flow behaviour.
Neil Armstrong2968d302022-02-25 15:09:36 +0100523 *
524 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
525 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
526 * patterns (see RFC 2104, sec. 2).
527 *
528 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
529 * hashing up to minlen, then cloning the context, and for each byte up
530 * to maxlen finishing up the hash computation, keeping only the
531 * correct result.
532 *
533 * Then we only need to compute HASH(okey + inner_hash) and we're done.
534 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
536 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100537 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Neil Armstrong2968d302022-02-25 15:09:36 +0100539 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
540 size_t hash_length;
541
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100542 unsigned char aux_out[PSA_HASH_MAX_SIZE];
Neil Armstrong2968d302022-02-25 15:09:36 +0100543 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
544 size_t offset;
545 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
546
Neil Armstrong2968d302022-02-25 15:09:36 +0100547 size_t mac_key_length;
548 size_t i;
549
Gilles Peskine449bd832023-01-11 14:50:10 +0100550#define PSA_CHK(func_call) \
Neil Armstrong2968d302022-02-25 15:09:36 +0100551 do { \
552 status = (func_call); \
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 if (status != PSA_SUCCESS) \
554 goto cleanup; \
555 } while (0)
Neil Armstrong2968d302022-02-25 15:09:36 +0100556
Neil Armstrong72c2f762022-03-17 16:39:10 +0100557 /* Export MAC key
558 * We assume key length is always exactly the output size
559 * which is never more than the block size, thus we use block_size
560 * as the key buffer size.
561 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
Neil Armstrong2968d302022-02-25 15:09:36 +0100563
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100564 /* Calculate ikey */
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 for (i = 0; i < mac_key_length; i++) {
566 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
567 }
568 for (; i < block_size; ++i) {
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100569 key_buf[i] = 0x36;
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 }
Neil Armstrong2968d302022-02-25 15:09:36 +0100571
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 PSA_CHK(psa_hash_setup(&operation, hash_alg));
Neil Armstrong2968d302022-02-25 15:09:36 +0100573
574 /* Now compute inner_hash = HASH(ikey + msg) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
576 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
577 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
Neil Armstrong2968d302022-02-25 15:09:36 +0100578
Paul Elliott5260ce22022-05-09 18:15:54 +0100579 /* Fill the hash buffer in advance with something that is
580 * not a valid hash (barring an attack on the hash and
581 * deliberately-crafted input), in case the caller doesn't
582 * check the return status properly. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 memset(output, '!', hash_size);
Paul Elliott5260ce22022-05-09 18:15:54 +0100584
Neil Armstrong2968d302022-02-25 15:09:36 +0100585 /* For each possible length, compute the hash up to that point */
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 for (offset = min_data_len; offset <= max_data_len; offset++) {
587 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
588 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
589 PSA_HASH_MAX_SIZE, &hash_length));
Neil Armstrong2968d302022-02-25 15:09:36 +0100590 /* Keep only the correct inner_hash in the output buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 mbedtls_ct_memcpy_if_eq(output, aux_out, hash_size,
592 offset, data_len_secret);
Neil Armstrong2968d302022-02-25 15:09:36 +0100593
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 if (offset < max_data_len) {
595 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
596 }
Neil Armstrong2968d302022-02-25 15:09:36 +0100597 }
598
Neil Armstrong28d9c632022-03-17 16:33:27 +0100599 /* Abort current operation to prepare for final operation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 PSA_CHK(psa_hash_abort(&operation));
Neil Armstrong2968d302022-02-25 15:09:36 +0100601
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100602 /* Calculate okey */
Gilles Peskine449bd832023-01-11 14:50:10 +0100603 for (i = 0; i < mac_key_length; i++) {
604 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
605 }
606 for (; i < block_size; ++i) {
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100607 key_buf[i] = 0x5C;
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 }
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100609
Neil Armstrong2968d302022-02-25 15:09:36 +0100610 /* Now compute HASH(okey + inner_hash) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100611 PSA_CHK(psa_hash_setup(&operation, hash_alg));
612 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
613 PSA_CHK(psa_hash_update(&operation, output, hash_size));
614 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
Neil Armstrong2968d302022-02-25 15:09:36 +0100615
616#undef PSA_CHK
617
618cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100619 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
620 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100621
Gilles Peskine449bd832023-01-11 14:50:10 +0100622 psa_hash_abort(&operation);
623 psa_hash_abort(&aux_operation);
624 return psa_ssl_status_to_mbedtls(status);
Neil Armstrong2968d302022-02-25 15:09:36 +0100625}
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100626
627#undef MAX_HASH_BLOCK_LENGTH
628
Neil Armstrong2968d302022-02-25 15:09:36 +0100629#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100630int mbedtls_ct_hmac(mbedtls_md_context_t *ctx,
631 const unsigned char *add_data,
632 size_t add_data_len,
633 const unsigned char *data,
634 size_t data_len_secret,
635 size_t min_data_len,
636 size_t max_data_len,
637 unsigned char *output)
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200638{
639 /*
640 * This function breaks the HMAC abstraction and uses the md_clone()
641 * extension to the MD API in order to get constant-flow behaviour.
642 *
643 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
644 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
645 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
646 *
647 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
648 * minlen, then cloning the context, and for each byte up to maxlen
649 * finishing up the hash computation, keeping only the correct result.
650 *
651 * Then we only need to compute HASH(okey + inner_hash) and we're done.
652 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100653 const mbedtls_md_type_t md_alg = mbedtls_md_get_type(ctx->md_info);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200654 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
655 * all of which have the same block size except SHA-384. */
656 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
657 const unsigned char * const ikey = ctx->hmac_ctx;
658 const unsigned char * const okey = ikey + block_size;
Gilles Peskine449bd832023-01-11 14:50:10 +0100659 const size_t hash_size = mbedtls_md_get_size(ctx->md_info);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200660
661 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
662 mbedtls_md_context_t aux;
663 size_t offset;
664 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
665
Gilles Peskine449bd832023-01-11 14:50:10 +0100666 mbedtls_md_init(&aux);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200667
Gilles Peskine449bd832023-01-11 14:50:10 +0100668#define MD_CHK(func_call) \
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200669 do { \
670 ret = (func_call); \
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 if (ret != 0) \
672 goto cleanup; \
673 } while (0)
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200674
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 MD_CHK(mbedtls_md_setup(&aux, ctx->md_info, 0));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200676
677 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
678 * so we can start directly with the message */
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 MD_CHK(mbedtls_md_update(ctx, add_data, add_data_len));
680 MD_CHK(mbedtls_md_update(ctx, data, min_data_len));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200681
Paul Elliott5260ce22022-05-09 18:15:54 +0100682 /* Fill the hash buffer in advance with something that is
683 * not a valid hash (barring an attack on the hash and
684 * deliberately-crafted input), in case the caller doesn't
685 * check the return status properly. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 memset(output, '!', hash_size);
Paul Elliott5260ce22022-05-09 18:15:54 +0100687
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200688 /* For each possible length, compute the hash up to that point */
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 for (offset = min_data_len; offset <= max_data_len; offset++) {
690 MD_CHK(mbedtls_md_clone(&aux, ctx));
691 MD_CHK(mbedtls_md_finish(&aux, aux_out));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200692 /* Keep only the correct inner_hash in the output buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 mbedtls_ct_memcpy_if_eq(output, aux_out, hash_size,
694 offset, data_len_secret);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200695
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 if (offset < max_data_len) {
697 MD_CHK(mbedtls_md_update(ctx, data + offset, 1));
698 }
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200699 }
700
701 /* The context needs to finish() before it starts() again */
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 MD_CHK(mbedtls_md_finish(ctx, aux_out));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200703
704 /* Now compute HASH(okey + inner_hash) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 MD_CHK(mbedtls_md_starts(ctx));
706 MD_CHK(mbedtls_md_update(ctx, okey, block_size));
707 MD_CHK(mbedtls_md_update(ctx, output, hash_size));
708 MD_CHK(mbedtls_md_finish(ctx, output));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200709
710 /* Done, get ready for next time */
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 MD_CHK(mbedtls_md_hmac_reset(ctx));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200712
713#undef MD_CHK
714
715cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100716 mbedtls_md_free(&aux);
717 return ret;
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200718}
Neil Armstrong2968d302022-02-25 15:09:36 +0100719#endif /* MBEDTLS_USE_PSA_CRYPTO */
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200720
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200721#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200722
723#if defined(MBEDTLS_BIGNUM_C)
724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725#define MPI_VALIDATE_RET(cond) \
726 MBEDTLS_INTERNAL_VALIDATE_RET(cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA)
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200727
728/*
729 * Conditionally assign X = Y, without leaking information
730 * about whether the assignment was made or not.
731 * (Leaking information about the respective sizes of X and Y is ok however.)
732 */
Tautvydas Žilys40fc7da2022-01-31 13:34:01 -0800733#if defined(_MSC_VER) && defined(_M_ARM64) && (_MSC_FULL_VER < 193131103)
Tautvydas Žilys60165d72022-01-26 15:33:27 -0800734/*
Tautvydas Žilys40fc7da2022-01-31 13:34:01 -0800735 * MSVC miscompiles this function if it's inlined prior to Visual Studio 2022 version 17.1. See:
Tautvydas Žilys60165d72022-01-26 15:33:27 -0800736 * https://developercommunity.visualstudio.com/t/c-compiler-miscompiles-part-of-mbedtls-library-on/1646989
737 */
738__declspec(noinline)
739#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100740int mbedtls_mpi_safe_cond_assign(mbedtls_mpi *X,
741 const mbedtls_mpi *Y,
742 unsigned char assign)
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200743{
744 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 MPI_VALIDATE_RET(X != NULL);
746 MPI_VALIDATE_RET(Y != NULL);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200747
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200748 /* all-bits 1 if assign is 1, all-bits 0 if assign is 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 mbedtls_mpi_uint limb_mask = mbedtls_ct_mpi_uint_mask(assign);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200750
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 MBEDTLS_MPI_CHK(mbedtls_mpi_grow(X, Y->n));
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200752
Gilles Peskine449bd832023-01-11 14:50:10 +0100753 X->s = mbedtls_ct_cond_select_sign(assign, Y->s, X->s);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200754
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 mbedtls_mpi_core_cond_assign(X->p, Y->p, Y->n, assign);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200756
Gilles Peskine449bd832023-01-11 14:50:10 +0100757 for (size_t i = Y->n; i < X->n; i++) {
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200758 X->p[i] &= ~limb_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 }
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200760
761cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100762 return ret;
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200763}
764
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200765/*
766 * Conditionally swap X and Y, without leaking information
767 * about whether the swap was made or not.
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800768 * Here it is not ok to simply swap the pointers, which would lead to
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200769 * different memory access patterns when X and Y are used afterwards.
770 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100771int mbedtls_mpi_safe_cond_swap(mbedtls_mpi *X,
772 mbedtls_mpi *Y,
773 unsigned char swap)
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200774{
Gabor Mezeid7edb1d2022-10-10 14:32:09 +0200775 int ret = 0;
776 int s;
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 MPI_VALIDATE_RET(X != NULL);
778 MPI_VALIDATE_RET(Y != NULL);
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200779
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 if (X == Y) {
781 return 0;
782 }
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200783
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 MBEDTLS_MPI_CHK(mbedtls_mpi_grow(X, Y->n));
785 MBEDTLS_MPI_CHK(mbedtls_mpi_grow(Y, X->n));
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200786
787 s = X->s;
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 X->s = mbedtls_ct_cond_select_sign(swap, Y->s, X->s);
789 Y->s = mbedtls_ct_cond_select_sign(swap, s, Y->s);
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200790
Gilles Peskine449bd832023-01-11 14:50:10 +0100791 mbedtls_mpi_core_cond_swap(X->p, Y->p, X->n, swap);
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200792
793cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 return ret;
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200795}
796
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200797/*
Janos Follath23bdeca2022-07-22 18:24:06 +0100798 * Compare unsigned values in constant time
799 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100800unsigned mbedtls_mpi_core_lt_ct(const mbedtls_mpi_uint *A,
801 const mbedtls_mpi_uint *B,
802 size_t limbs)
Janos Follath23bdeca2022-07-22 18:24:06 +0100803{
Janos Follath23bdeca2022-07-22 18:24:06 +0100804 unsigned ret, cond, done;
805
Janos Follath63184682022-08-11 17:42:59 +0100806 /* The value of any of these variables is either 0 or 1 for the rest of
807 * their scope. */
Janos Follath23bdeca2022-07-22 18:24:06 +0100808 ret = cond = done = 0;
809
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 for (size_t i = limbs; i > 0; i--) {
Janos Follath23bdeca2022-07-22 18:24:06 +0100811 /*
Janos Follathb7a88ec2022-08-19 12:24:40 +0100812 * If B[i - 1] < A[i - 1] then A < B is false and the result must
Janos Follath23bdeca2022-07-22 18:24:06 +0100813 * remain 0.
814 *
815 * Again even if we can make a decision, we just mark the result and
816 * the fact that we are done and continue looping.
817 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 cond = mbedtls_ct_mpi_uint_lt(B[i - 1], A[i - 1]);
Janos Follath23bdeca2022-07-22 18:24:06 +0100819 done |= cond;
820
821 /*
Janos Follathb7a88ec2022-08-19 12:24:40 +0100822 * If A[i - 1] < B[i - 1] then A < B is true.
Janos Follath23bdeca2022-07-22 18:24:06 +0100823 *
824 * Again even if we can make a decision, we just mark the result and
825 * the fact that we are done and continue looping.
826 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100827 cond = mbedtls_ct_mpi_uint_lt(A[i - 1], B[i - 1]);
828 ret |= cond & (1 - done);
Janos Follath23bdeca2022-07-22 18:24:06 +0100829 done |= cond;
830 }
831
832 /*
Janos Follathb7a88ec2022-08-19 12:24:40 +0100833 * If all the limbs were equal, then the numbers are equal, A < B is false
Janos Follath23bdeca2022-07-22 18:24:06 +0100834 * and leaving the result 0 is correct.
835 */
836
Gilles Peskine449bd832023-01-11 14:50:10 +0100837 return ret;
Janos Follath23bdeca2022-07-22 18:24:06 +0100838}
839
840/*
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200841 * Compare signed values in constant time
842 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100843int mbedtls_mpi_lt_mpi_ct(const mbedtls_mpi *X,
844 const mbedtls_mpi *Y,
845 unsigned *ret)
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200846{
847 size_t i;
848 /* The value of any of these variables is either 0 or 1 at all times. */
849 unsigned cond, done, X_is_negative, Y_is_negative;
850
Gilles Peskine449bd832023-01-11 14:50:10 +0100851 MPI_VALIDATE_RET(X != NULL);
852 MPI_VALIDATE_RET(Y != NULL);
853 MPI_VALIDATE_RET(ret != NULL);
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200854
Gilles Peskine449bd832023-01-11 14:50:10 +0100855 if (X->n != Y->n) {
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200856 return MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 }
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200858
859 /*
860 * Set sign_N to 1 if N >= 0, 0 if N < 0.
861 * We know that N->s == 1 if N >= 0 and N->s == -1 if N < 0.
862 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100863 X_is_negative = (X->s & 2) >> 1;
864 Y_is_negative = (Y->s & 2) >> 1;
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200865
866 /*
867 * If the signs are different, then the positive operand is the bigger.
868 * That is if X is negative (X_is_negative == 1), then X < Y is true and it
869 * is false if X is positive (X_is_negative == 0).
870 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 cond = (X_is_negative ^ Y_is_negative);
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200872 *ret = cond & X_is_negative;
873
874 /*
875 * This is a constant-time function. We might have the result, but we still
876 * need to go through the loop. Record if we have the result already.
877 */
878 done = cond;
879
Gilles Peskine449bd832023-01-11 14:50:10 +0100880 for (i = X->n; i > 0; i--) {
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200881 /*
882 * If Y->p[i - 1] < X->p[i - 1] then X < Y is true if and only if both
883 * X and Y are negative.
884 *
885 * Again even if we can make a decision, we just mark the result and
886 * the fact that we are done and continue looping.
887 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100888 cond = mbedtls_ct_mpi_uint_lt(Y->p[i - 1], X->p[i - 1]);
889 *ret |= cond & (1 - done) & X_is_negative;
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200890 done |= cond;
891
892 /*
893 * If X->p[i - 1] < Y->p[i - 1] then X < Y is true if and only if both
894 * X and Y are positive.
895 *
896 * Again even if we can make a decision, we just mark the result and
897 * the fact that we are done and continue looping.
898 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100899 cond = mbedtls_ct_mpi_uint_lt(X->p[i - 1], Y->p[i - 1]);
900 *ret |= cond & (1 - done) & (1 - X_is_negative);
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200901 done |= cond;
902 }
903
Gilles Peskine449bd832023-01-11 14:50:10 +0100904 return 0;
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200905}
906
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200907#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200908
909#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
910
Gilles Peskine449bd832023-01-11 14:50:10 +0100911int mbedtls_ct_rsaes_pkcs1_v15_unpadding(unsigned char *input,
912 size_t ilen,
913 unsigned char *output,
914 size_t output_max_len,
915 size_t *olen)
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200916{
917 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
918 size_t i, plaintext_max_size;
919
920 /* The following variables take sensitive values: their value must
921 * not leak into the observable behavior of the function other than
922 * the designated outputs (output, olen, return value). Otherwise
923 * this would open the execution of the function to
924 * side-channel-based variants of the Bleichenbacher padding oracle
925 * attack. Potential side channels include overall timing, memory
926 * access patterns (especially visible to an adversary who has access
927 * to a shared memory cache), and branches (especially visible to
928 * an adversary who has access to a shared code cache or to a shared
929 * branch predictor). */
930 size_t pad_count = 0;
931 unsigned bad = 0;
932 unsigned char pad_done = 0;
933 size_t plaintext_size = 0;
934 unsigned output_too_large;
935
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 plaintext_max_size = (output_max_len > ilen - 11) ? ilen - 11
Gabor Mezei7013f622021-10-18 16:12:45 +0200937 : output_max_len;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200938
939 /* Check and get padding length in constant time and constant
940 * memory trace. The first byte must be 0. */
Gabor Mezei63bbba52021-10-18 16:17:57 +0200941 bad |= input[0];
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200942
943
944 /* Decode EME-PKCS1-v1_5 padding: 0x00 || 0x02 || PS || 0x00
Gabor Mezei63bbba52021-10-18 16:17:57 +0200945 * where PS must be at least 8 nonzero bytes. */
946 bad |= input[1] ^ MBEDTLS_RSA_CRYPT;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200947
948 /* Read the whole buffer. Set pad_done to nonzero if we find
Gabor Mezei63bbba52021-10-18 16:17:57 +0200949 * the 0x00 byte and remember the padding length in pad_count. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 for (i = 2; i < ilen; i++) {
951 pad_done |= ((input[i] | (unsigned char) -input[i]) >> 7) ^ 1;
952 pad_count += ((pad_done | (unsigned char) -pad_done) >> 7) ^ 1;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200953 }
954
955
956 /* If pad_done is still zero, there's no data, only unfinished padding. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 bad |= mbedtls_ct_uint_if(pad_done, 0, 1);
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200958
959 /* There must be at least 8 bytes of padding. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 bad |= mbedtls_ct_size_gt(8, pad_count);
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200961
962 /* If the padding is valid, set plaintext_size to the number of
963 * remaining bytes after stripping the padding. If the padding
964 * is invalid, avoid leaking this fact through the size of the
965 * output: use the maximum message size that fits in the output
966 * buffer. Do it without branches to avoid leaking the padding
967 * validity through timing. RSA keys are small enough that all the
968 * size_t values involved fit in unsigned int. */
Gabor Mezei90437e32021-10-20 11:59:27 +0200969 plaintext_size = mbedtls_ct_uint_if(
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 bad, (unsigned) plaintext_max_size,
971 (unsigned) (ilen - pad_count - 3));
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200972
973 /* Set output_too_large to 0 if the plaintext fits in the output
974 * buffer and to 1 otherwise. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 output_too_large = mbedtls_ct_size_gt(plaintext_size,
976 plaintext_max_size);
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200977
978 /* Set ret without branches to avoid timing attacks. Return:
979 * - INVALID_PADDING if the padding is bad (bad != 0).
980 * - OUTPUT_TOO_LARGE if the padding is good but the decrypted
981 * plaintext does not fit in the output buffer.
982 * - 0 if the padding is correct. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 ret = -(int) mbedtls_ct_uint_if(
984 bad, -MBEDTLS_ERR_RSA_INVALID_PADDING,
985 mbedtls_ct_uint_if(output_too_large,
986 -MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE,
987 0));
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200988
989 /* If the padding is bad or the plaintext is too large, zero the
990 * data that we're about to copy to the output buffer.
991 * We need to copy the same amount of data
992 * from the same buffer whether the padding is good or not to
993 * avoid leaking the padding validity through overall timing or
994 * through memory or cache access patterns. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 bad = mbedtls_ct_uint_mask(bad | output_too_large);
996 for (i = 11; i < ilen; i++) {
Gabor Mezei63bbba52021-10-18 16:17:57 +0200997 input[i] &= ~bad;
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 }
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200999
1000 /* If the plaintext is too large, truncate it to the buffer size.
1001 * Copy anyway to avoid revealing the length through timing, because
1002 * revealing the length is as bad as revealing the padding validity
1003 * for a Bleichenbacher attack. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 plaintext_size = mbedtls_ct_uint_if(output_too_large,
1005 (unsigned) plaintext_max_size,
1006 (unsigned) plaintext_size);
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001007
1008 /* Move the plaintext to the leftmost position where it can start in
1009 * the working buffer, i.e. make it start plaintext_max_size from
1010 * the end of the buffer. Do this with a memory access trace that
1011 * does not depend on the plaintext size. After this move, the
1012 * starting location of the plaintext is no longer sensitive
1013 * information. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 mbedtls_ct_mem_move_to_left(input + ilen - plaintext_max_size,
1015 plaintext_max_size,
1016 plaintext_max_size - plaintext_size);
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001017
1018 /* Finally copy the decrypted plaintext plus trailing zeros into the output
1019 * buffer. If output_max_len is 0, then output may be an invalid pointer
1020 * and the result of memcpy() would be undefined; prevent undefined
1021 * behavior making sure to depend only on output_max_len (the size of the
1022 * user-provided output buffer), which is independent from plaintext
1023 * length, validity of padding, success of the decryption, and other
1024 * secrets. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 if (output_max_len != 0) {
1026 memcpy(output, input + ilen - plaintext_max_size, plaintext_max_size);
1027 }
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001028
1029 /* Report the amount of data we copied to the output buffer. In case
1030 * of errors (bad padding or output too large), the value of *olen
1031 * when this function returns is not specified. Making it equivalent
1032 * to the good case limits the risks of leaking the padding validity. */
1033 *olen = plaintext_size;
1034
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 return ret;
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001036}
1037
1038#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */