blob: 309e11cd2b5dafafc83afad6de54976add78d224 [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.
Dave Rodgman051225d2022-12-30 21:25:35 +000053 */
54#if defined(__ARM_FEATURE_UNALIGNED)
55/* __ARM_FEATURE_UNALIGNED is defined by armcc, gcc 7, clang 9 and later versions */
56#define MBEDTLS_EFFICIENT_UNALIGNED_ACCESS
57#endif
58
59/*
60 * Define MBEDTLS_EFFICIENT_UNALIGNED_VOLATILE_ACCESS where assembly is present to
61 * perform fast unaligned access to volatile data.
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000062 *
63 * This is needed because mbedtls_get_unaligned_uintXX etc don't support volatile
64 * memory accesses.
65 *
Dave Rodgman051225d2022-12-30 21:25:35 +000066 * Some of these definitions could be moved into alignment.h but for now they are
67 * only used here.
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000068 */
Dave Rodgman051225d2022-12-30 21:25:35 +000069#if defined(MBEDTLS_EFFICIENT_UNALIGNED_ACCESS) && defined(MBEDTLS_HAVE_ASM)
70#if defined(__arm__) || defined(__thumb__) || defined(__thumb2__) || defined(__aarch64__)
71#define MBEDTLS_EFFICIENT_UNALIGNED_VOLATILE_ACCESS
72#endif
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000073#endif
74
Dave Rodgman051225d2022-12-30 21:25:35 +000075#if defined(MBEDTLS_EFFICIENT_UNALIGNED_VOLATILE_ACCESS)
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000076static inline uint32_t mbedtls_get_unaligned_volatile_uint32(volatile const unsigned char *p)
77{
78 /* This is UB, even where it's safe:
79 * return *((volatile uint32_t*)p);
80 * so instead the same thing is expressed in assembly below.
81 */
82 uint32_t r;
83#if defined(__arm__) || defined(__thumb__) || defined(__thumb2__)
84 asm ("ldr %0, [%1]" : "=r" (r) : "r" (p) :);
Dave Rodgman051225d2022-12-30 21:25:35 +000085#elif defined(__aarch64__)
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000086 asm ("ldr %w0, [%1]" : "=r" (r) : "r" (p) :);
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000087#endif
Dave Rodgman051225d2022-12-30 21:25:35 +000088 return r;
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000089}
Dave Rodgman051225d2022-12-30 21:25:35 +000090#endif /* MBEDTLS_EFFICIENT_UNALIGNED_VOLATILE_ACCESS */
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000091
Gilles Peskine449bd832023-01-11 14:50:10 +010092int mbedtls_ct_memcmp(const void *a,
93 const void *b,
94 size_t n)
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020095{
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000096 size_t i = 0;
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020097 volatile const unsigned char *A = (volatile const unsigned char *) a;
98 volatile const unsigned char *B = (volatile const unsigned char *) b;
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000099 volatile uint32_t diff = 0;
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +0200100
Dave Rodgman051225d2022-12-30 21:25:35 +0000101#if defined(MBEDTLS_EFFICIENT_UNALIGNED_VOLATILE_ACCESS)
Dave Rodgman36dfc5a2022-12-22 15:04:43 +0000102 for (; (i + 4) <= n; i += 4) {
103 uint32_t x = mbedtls_get_unaligned_volatile_uint32(A + i);
104 uint32_t y = mbedtls_get_unaligned_volatile_uint32(B + i);
105 diff |= x ^ y;
106 }
107#endif
108
109 for (; i < n; i++) {
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +0200110 /* Read volatile data in order before computing diff.
111 * This avoids IAR compiler warning:
112 * 'the order of volatile accesses is undefined ..' */
113 unsigned char x = A[i], y = B[i];
114 diff |= x ^ y;
115 }
116
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 return (int) diff;
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +0200118}
119
Gilles Peskine449bd832023-01-11 14:50:10 +0100120unsigned mbedtls_ct_uint_mask(unsigned value)
gabor-mezei-arm340948e2021-09-27 11:40:03 +0200121{
122 /* MSVC has a warning about unary minus on unsigned, but this is
123 * well-defined and precisely what we want to do here */
124#if defined(_MSC_VER)
125#pragma warning( push )
126#pragma warning( disable : 4146 )
127#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100128 return -((value | -value) >> (sizeof(value) * 8 - 1));
gabor-mezei-arm340948e2021-09-27 11:40:03 +0200129#if defined(_MSC_VER)
130#pragma warning( pop )
131#endif
132}
gabor-mezei-arm3733bf82021-09-27 11:49:42 +0200133
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200134#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gabor Mezei6a426c92021-10-20 11:17:43 +0200135
Gilles Peskine449bd832023-01-11 14:50:10 +0100136size_t mbedtls_ct_size_mask(size_t value)
gabor-mezei-arm3733bf82021-09-27 11:49:42 +0200137{
138 /* MSVC has a warning about unary minus on unsigned integer types,
139 * but this is well-defined and precisely what we want to do here. */
140#if defined(_MSC_VER)
141#pragma warning( push )
142#pragma warning( disable : 4146 )
143#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100144 return -((value | -value) >> (sizeof(value) * 8 - 1));
gabor-mezei-arm3733bf82021-09-27 11:49:42 +0200145#if defined(_MSC_VER)
146#pragma warning( pop )
147#endif
148}
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200149
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200150#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gabor Mezei6a426c92021-10-20 11:17:43 +0200151
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200152#if defined(MBEDTLS_BIGNUM_C)
153
Gilles Peskine449bd832023-01-11 14:50:10 +0100154mbedtls_mpi_uint mbedtls_ct_mpi_uint_mask(mbedtls_mpi_uint value)
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200155{
156 /* MSVC has a warning about unary minus on unsigned, but this is
157 * well-defined and precisely what we want to do here */
158#if defined(_MSC_VER)
159#pragma warning( push )
160#pragma warning( disable : 4146 )
161#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 return -((value | -value) >> (sizeof(value) * 8 - 1));
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200163#if defined(_MSC_VER)
164#pragma warning( pop )
165#endif
166}
167
168#endif /* MBEDTLS_BIGNUM_C */
169
Gabor Mezeie2123792021-10-18 17:05:06 +0200170#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
171
Gabor Mezei1e642612021-10-18 16:05:50 +0200172/** Constant-flow mask generation for "less than" comparison:
173 * - if \p x < \p y, return all-bits 1, that is (size_t) -1
174 * - otherwise, return all bits 0, that is 0
175 *
176 * This function can be used to write constant-time code by replacing branches
177 * with bit operations using masks.
178 *
179 * \param x The first value to analyze.
180 * \param y The second value to analyze.
181 *
182 * \return All-bits-one if \p x is less than \p y, otherwise zero.
183 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100184static size_t mbedtls_ct_size_mask_lt(size_t x,
185 size_t y)
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200186{
187 /* This has the most significant bit set if and only if x < y */
188 const size_t sub = x - y;
189
190 /* sub1 = (x < y) ? 1 : 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100191 const size_t sub1 = sub >> (sizeof(sub) * 8 - 1);
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200192
193 /* mask = (x < y) ? 0xff... : 0x00... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 const size_t mask = mbedtls_ct_size_mask(sub1);
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200195
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 return mask;
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200197}
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200198
Gilles Peskine449bd832023-01-11 14:50:10 +0100199size_t mbedtls_ct_size_mask_ge(size_t x,
200 size_t y)
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200201{
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 return ~mbedtls_ct_size_mask_lt(x, y);
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200203}
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200204
Gabor Mezeie2123792021-10-18 17:05:06 +0200205#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
206
Gabor Mezei28d61152021-11-15 16:13:01 +0100207#if defined(MBEDTLS_BASE64_C)
208
209/* Return 0xff if low <= c <= high, 0 otherwise.
210 *
211 * Constant flow with respect to c.
212 */
Gabor Mezeic0d8dda2021-11-26 17:20:36 +0100213MBEDTLS_STATIC_TESTABLE
Gilles Peskine449bd832023-01-11 14:50:10 +0100214unsigned char mbedtls_ct_uchar_mask_of_range(unsigned char low,
215 unsigned char high,
216 unsigned char c)
Gabor Mezei28d61152021-11-15 16:13:01 +0100217{
218 /* low_mask is: 0 if low <= c, 0x...ff if low > c */
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 unsigned low_mask = ((unsigned) c - low) >> 8;
Gabor Mezei28d61152021-11-15 16:13:01 +0100220 /* high_mask is: 0 if c <= high, 0x...ff if c > high */
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 unsigned high_mask = ((unsigned) high - c) >> 8;
222 return ~(low_mask | high_mask) & 0xff;
Gabor Mezei28d61152021-11-15 16:13:01 +0100223}
224
225#endif /* MBEDTLS_BASE64_C */
226
Gilles Peskine449bd832023-01-11 14:50:10 +0100227unsigned mbedtls_ct_size_bool_eq(size_t x,
228 size_t y)
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200229{
230 /* diff = 0 if x == y, non-zero otherwise */
231 const size_t diff = x ^ y;
232
233 /* MSVC has a warning about unary minus on unsigned integer types,
234 * but this is well-defined and precisely what we want to do here. */
235#if defined(_MSC_VER)
236#pragma warning( push )
237#pragma warning( disable : 4146 )
238#endif
239
240 /* diff_msb's most significant bit is equal to x != y */
Gilles Peskine449bd832023-01-11 14:50:10 +0100241 const size_t diff_msb = (diff | (size_t) -diff);
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200242
243#if defined(_MSC_VER)
244#pragma warning( pop )
245#endif
246
247 /* diff1 = (x != y) ? 1 : 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100248 const unsigned diff1 = diff_msb >> (sizeof(diff_msb) * 8 - 1);
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200249
Gilles Peskine449bd832023-01-11 14:50:10 +0100250 return 1 ^ diff1;
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200251}
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200252
Gabor Mezeie2123792021-10-18 17:05:06 +0200253#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
254
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200255/** Constant-flow "greater than" comparison:
256 * return x > y
257 *
258 * This is equivalent to \p x > \p y, but is likely to be compiled
259 * to code using bitwise operation rather than a branch.
260 *
261 * \param x The first value to analyze.
262 * \param y The second value to analyze.
263 *
264 * \return 1 if \p x greater than \p y, otherwise 0.
265 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100266static unsigned mbedtls_ct_size_gt(size_t x,
267 size_t y)
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200268{
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200269 /* Return the sign bit (1 for negative) of (y - x). */
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 return (y - x) >> (sizeof(size_t) * 8 - 1);
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200271}
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200272
Gabor Mezeie2123792021-10-18 17:05:06 +0200273#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
274
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200275#if defined(MBEDTLS_BIGNUM_C)
276
Gilles Peskine449bd832023-01-11 14:50:10 +0100277unsigned mbedtls_ct_mpi_uint_lt(const mbedtls_mpi_uint x,
278 const mbedtls_mpi_uint y)
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200279{
280 mbedtls_mpi_uint ret;
281 mbedtls_mpi_uint cond;
282
283 /*
284 * Check if the most significant bits (MSB) of the operands are different.
285 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100286 cond = (x ^ y);
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200287 /*
288 * If the MSB are the same then the difference x-y will be negative (and
289 * have its MSB set to 1 during conversion to unsigned) if and only if x<y.
290 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 ret = (x - y) & ~cond;
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200292 /*
293 * If the MSB are different, then the operand with the MSB of 1 is the
294 * bigger. (That is if y has MSB of 1, then x<y is true and it is false if
295 * the MSB of y is 0.)
296 */
297 ret |= y & cond;
298
299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 ret = ret >> (sizeof(mbedtls_mpi_uint) * 8 - 1);
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200301
302 return (unsigned) ret;
303}
304
305#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200306
Gilles Peskine449bd832023-01-11 14:50:10 +0100307unsigned mbedtls_ct_uint_if(unsigned condition,
308 unsigned if1,
309 unsigned if0)
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200310{
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 unsigned mask = mbedtls_ct_uint_mask(condition);
312 return (mask & if1) | (~mask & if0);
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200313}
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200314
Gabor Mezeie2123792021-10-18 17:05:06 +0200315#if defined(MBEDTLS_BIGNUM_C)
gabor-mezei-arm65cefdb2021-09-27 15:47:00 +0200316
Gabor Mezei642eeb22021-11-03 16:13:32 +0100317/** Select between two sign values without branches.
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200318 *
319 * This is functionally equivalent to `condition ? if1 : if0` but uses only bit
320 * operations in order to avoid branches.
321 *
322 * \note if1 and if0 must be either 1 or -1, otherwise the result
323 * is undefined.
324 *
Tom Cosgrove583816c2022-08-18 14:09:18 +0100325 * \param condition Condition to test; must be either 0 or 1.
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200326 * \param if1 The first sign; must be either +1 or -1.
327 * \param if0 The second sign; must be either +1 or -1.
328 *
329 * \return \c if1 if \p condition is nonzero, otherwise \c if0.
330 * */
Gilles Peskine449bd832023-01-11 14:50:10 +0100331static int mbedtls_ct_cond_select_sign(unsigned char condition,
332 int if1,
333 int if0)
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200334{
Gabor Mezei642eeb22021-11-03 16:13:32 +0100335 /* In order to avoid questions about what we can reasonably assume about
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200336 * the representations of signed integers, move everything to unsigned
Gabor Mezeia316fc82021-10-18 16:28:27 +0200337 * by taking advantage of the fact that if1 and if0 are either +1 or -1. */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200338 unsigned uif1 = if1 + 1;
339 unsigned uif0 = if0 + 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200340
Gabor Mezeia316fc82021-10-18 16:28:27 +0200341 /* condition was 0 or 1, mask is 0 or 2 as are uif1 and uif0 */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200342 const unsigned mask = condition << 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200343
Gabor Mezeia316fc82021-10-18 16:28:27 +0200344 /* select uif1 or uif0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 unsigned ur = (uif0 & ~mask) | (uif1 & mask);
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200346
347 /* ur is now 0 or 2, convert back to -1 or +1 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 return (int) ur - 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200349}
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200350
Gilles Peskine449bd832023-01-11 14:50:10 +0100351void mbedtls_ct_mpi_uint_cond_assign(size_t n,
352 mbedtls_mpi_uint *dest,
353 const mbedtls_mpi_uint *src,
354 unsigned char condition)
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200355{
356 size_t i;
357
358 /* MSVC has a warning about unary minus on unsigned integer types,
359 * but this is well-defined and precisely what we want to do here. */
360#if defined(_MSC_VER)
361#pragma warning( push )
362#pragma warning( disable : 4146 )
363#endif
364
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200365 /* all-bits 1 if condition is 1, all-bits 0 if condition is 0 */
366 const mbedtls_mpi_uint mask = -condition;
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200367
368#if defined(_MSC_VER)
369#pragma warning( pop )
370#endif
371
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 for (i = 0; i < n; i++) {
373 dest[i] = (src[i] & mask) | (dest[i] & ~mask);
374 }
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200375}
376
377#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200378
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100379#if defined(MBEDTLS_BASE64_C)
380
Gilles Peskine449bd832023-01-11 14:50:10 +0100381unsigned char mbedtls_ct_base64_enc_char(unsigned char value)
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100382{
383 unsigned char digit = 0;
Gabor Mezei14d5fac2021-11-24 15:51:39 +0100384 /* For each range of values, if value is in that range, mask digit with
385 * the corresponding value. Since value can only be in a single range,
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100386 * only at most one masking will change digit. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 digit |= mbedtls_ct_uchar_mask_of_range(0, 25, value) & ('A' + value);
388 digit |= mbedtls_ct_uchar_mask_of_range(26, 51, value) & ('a' + value - 26);
389 digit |= mbedtls_ct_uchar_mask_of_range(52, 61, value) & ('0' + value - 52);
390 digit |= mbedtls_ct_uchar_mask_of_range(62, 62, value) & '+';
391 digit |= mbedtls_ct_uchar_mask_of_range(63, 63, value) & '/';
392 return digit;
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100393}
394
Gilles Peskine449bd832023-01-11 14:50:10 +0100395signed char mbedtls_ct_base64_dec_value(unsigned char c)
Gabor Mezei358829a2021-11-15 16:22:37 +0100396{
397 unsigned char val = 0;
398 /* For each range of digits, if c is in that range, mask val with
399 * the corresponding value. Since c can only be in a single range,
400 * only at most one masking will change val. Set val to one plus
401 * the desired value so that it stays 0 if c is in none of the ranges. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 val |= mbedtls_ct_uchar_mask_of_range('A', 'Z', c) & (c - 'A' + 0 + 1);
403 val |= mbedtls_ct_uchar_mask_of_range('a', 'z', c) & (c - 'a' + 26 + 1);
404 val |= mbedtls_ct_uchar_mask_of_range('0', '9', c) & (c - '0' + 52 + 1);
405 val |= mbedtls_ct_uchar_mask_of_range('+', '+', c) & (c - '+' + 62 + 1);
406 val |= mbedtls_ct_uchar_mask_of_range('/', '/', c) & (c - '/' + 63 + 1);
Gabor Mezei358829a2021-11-15 16:22:37 +0100407 /* At this point, val is 0 if c is an invalid digit and v+1 if c is
408 * a digit with the value v. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 return val - 1;
Gabor Mezei358829a2021-11-15 16:22:37 +0100410}
411
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100412#endif /* MBEDTLS_BASE64_C */
413
Gabor Mezeie2123792021-10-18 17:05:06 +0200414#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
415
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200416/** Shift some data towards the left inside a buffer.
417 *
Gabor Mezei90437e32021-10-20 11:59:27 +0200418 * `mbedtls_ct_mem_move_to_left(start, total, offset)` is functionally
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200419 * equivalent to
420 * ```
421 * memmove(start, start + offset, total - offset);
422 * memset(start + offset, 0, total - offset);
423 * ```
424 * but it strives to use a memory access pattern (and thus total timing)
425 * that does not depend on \p offset. This timing independence comes at
426 * the expense of performance.
427 *
428 * \param start Pointer to the start of the buffer.
429 * \param total Total size of the buffer.
430 * \param offset Offset from which to copy \p total - \p offset bytes.
431 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100432static void mbedtls_ct_mem_move_to_left(void *start,
433 size_t total,
434 size_t offset)
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200435{
436 volatile unsigned char *buf = start;
437 size_t i, n;
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 if (total == 0) {
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200439 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 }
441 for (i = 0; i < total; i++) {
442 unsigned no_op = mbedtls_ct_size_gt(total - offset, i);
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200443 /* The first `total - offset` passes are a no-op. The last
444 * `offset` passes shift the data one byte to the left and
445 * zero out the last byte. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 for (n = 0; n < total - 1; n++) {
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200447 unsigned char current = buf[n];
448 unsigned char next = buf[n+1];
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 buf[n] = mbedtls_ct_uint_if(no_op, current, next);
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200450 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100451 buf[total-1] = mbedtls_ct_uint_if(no_op, buf[total-1], 0);
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200452 }
453}
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200454
Gabor Mezeie2123792021-10-18 17:05:06 +0200455#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
456
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200457#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gabor Mezeie2123792021-10-18 17:05:06 +0200458
Gilles Peskine449bd832023-01-11 14:50:10 +0100459void mbedtls_ct_memcpy_if_eq(unsigned char *dest,
460 const unsigned char *src,
461 size_t len,
462 size_t c1,
463 size_t c2)
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200464{
465 /* mask = c1 == c2 ? 0xff : 0x00 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 const size_t equal = mbedtls_ct_size_bool_eq(c1, c2);
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200467
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200468 /* dest[i] = c1 == c2 ? src[i] : dest[i] */
Dave Rodgman36dfc5a2022-12-22 15:04:43 +0000469 size_t i = 0;
470#if defined(MBEDTLS_EFFICIENT_UNALIGNED_ACCESS)
471 const uint32_t mask32 = (uint32_t) mbedtls_ct_size_mask(equal);
472 const unsigned char mask = (unsigned char) mask32 & 0xff;
473
474 for (; (i + 4) <= len; i += 4) {
475 uint32_t a = mbedtls_get_unaligned_uint32(src + i) & mask32;
476 uint32_t b = mbedtls_get_unaligned_uint32(dest + i) & ~mask32;
477 mbedtls_put_unaligned_uint32(dest + i, a | b);
478 }
479#else
480 const unsigned char mask = (unsigned char) mbedtls_ct_size_mask(equal);
481#endif /* MBEDTLS_EFFICIENT_UNALIGNED_ACCESS */
482 for (; i < len; i++) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 dest[i] = (src[i] & mask) | (dest[i] & ~mask);
484 }
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200485}
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200486
Gilles Peskine449bd832023-01-11 14:50:10 +0100487void mbedtls_ct_memcpy_offset(unsigned char *dest,
488 const unsigned char *src,
489 size_t offset,
490 size_t offset_min,
491 size_t offset_max,
492 size_t len)
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200493{
Gabor Mezei63bbba52021-10-18 16:17:57 +0200494 size_t offsetval;
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200495
Gilles Peskine449bd832023-01-11 14:50:10 +0100496 for (offsetval = offset_min; offsetval <= offset_max; offsetval++) {
497 mbedtls_ct_memcpy_if_eq(dest, src + offsetval, len,
498 offsetval, offset);
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200499 }
500}
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200501
Neil Armstrong2968d302022-02-25 15:09:36 +0100502#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100503
504#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100505#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100506#elif defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100507#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100508#else /* See check_config.h */
Gilles Peskine449bd832023-01-11 14:50:10 +0100509#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100510#endif
511
Gilles Peskine449bd832023-01-11 14:50:10 +0100512int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
513 psa_algorithm_t mac_alg,
514 const unsigned char *add_data,
515 size_t add_data_len,
516 const unsigned char *data,
517 size_t data_len_secret,
518 size_t min_data_len,
519 size_t max_data_len,
520 unsigned char *output)
Neil Armstrong2968d302022-02-25 15:09:36 +0100521{
522 /*
Neil Armstrong28d9c632022-03-17 16:33:27 +0100523 * This function breaks the HMAC abstraction and uses psa_hash_clone()
524 * extension in order to get constant-flow behaviour.
Neil Armstrong2968d302022-02-25 15:09:36 +0100525 *
526 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
527 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
528 * patterns (see RFC 2104, sec. 2).
529 *
530 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
531 * hashing up to minlen, then cloning the context, and for each byte up
532 * to maxlen finishing up the hash computation, keeping only the
533 * correct result.
534 *
535 * Then we only need to compute HASH(okey + inner_hash) and we're done.
536 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
538 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100539 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Neil Armstrong2968d302022-02-25 15:09:36 +0100541 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
542 size_t hash_length;
543
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100544 unsigned char aux_out[PSA_HASH_MAX_SIZE];
Neil Armstrong2968d302022-02-25 15:09:36 +0100545 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
546 size_t offset;
547 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
548
Neil Armstrong2968d302022-02-25 15:09:36 +0100549 size_t mac_key_length;
550 size_t i;
551
Gilles Peskine449bd832023-01-11 14:50:10 +0100552#define PSA_CHK(func_call) \
Neil Armstrong2968d302022-02-25 15:09:36 +0100553 do { \
554 status = (func_call); \
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 if (status != PSA_SUCCESS) \
556 goto cleanup; \
557 } while (0)
Neil Armstrong2968d302022-02-25 15:09:36 +0100558
Neil Armstrong72c2f762022-03-17 16:39:10 +0100559 /* Export MAC key
560 * We assume key length is always exactly the output size
561 * which is never more than the block size, thus we use block_size
562 * as the key buffer size.
563 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
Neil Armstrong2968d302022-02-25 15:09:36 +0100565
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100566 /* Calculate ikey */
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 for (i = 0; i < mac_key_length; i++) {
568 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
569 }
570 for (; i < block_size; ++i) {
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100571 key_buf[i] = 0x36;
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 }
Neil Armstrong2968d302022-02-25 15:09:36 +0100573
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 PSA_CHK(psa_hash_setup(&operation, hash_alg));
Neil Armstrong2968d302022-02-25 15:09:36 +0100575
576 /* Now compute inner_hash = HASH(ikey + msg) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
578 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
579 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
Neil Armstrong2968d302022-02-25 15:09:36 +0100580
Paul Elliott5260ce22022-05-09 18:15:54 +0100581 /* Fill the hash buffer in advance with something that is
582 * not a valid hash (barring an attack on the hash and
583 * deliberately-crafted input), in case the caller doesn't
584 * check the return status properly. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 memset(output, '!', hash_size);
Paul Elliott5260ce22022-05-09 18:15:54 +0100586
Neil Armstrong2968d302022-02-25 15:09:36 +0100587 /* For each possible length, compute the hash up to that point */
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 for (offset = min_data_len; offset <= max_data_len; offset++) {
589 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
590 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
591 PSA_HASH_MAX_SIZE, &hash_length));
Neil Armstrong2968d302022-02-25 15:09:36 +0100592 /* Keep only the correct inner_hash in the output buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 mbedtls_ct_memcpy_if_eq(output, aux_out, hash_size,
594 offset, data_len_secret);
Neil Armstrong2968d302022-02-25 15:09:36 +0100595
Gilles Peskine449bd832023-01-11 14:50:10 +0100596 if (offset < max_data_len) {
597 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
598 }
Neil Armstrong2968d302022-02-25 15:09:36 +0100599 }
600
Neil Armstrong28d9c632022-03-17 16:33:27 +0100601 /* Abort current operation to prepare for final operation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100602 PSA_CHK(psa_hash_abort(&operation));
Neil Armstrong2968d302022-02-25 15:09:36 +0100603
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100604 /* Calculate okey */
Gilles Peskine449bd832023-01-11 14:50:10 +0100605 for (i = 0; i < mac_key_length; i++) {
606 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
607 }
608 for (; i < block_size; ++i) {
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100609 key_buf[i] = 0x5C;
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 }
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100611
Neil Armstrong2968d302022-02-25 15:09:36 +0100612 /* Now compute HASH(okey + inner_hash) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100613 PSA_CHK(psa_hash_setup(&operation, hash_alg));
614 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
615 PSA_CHK(psa_hash_update(&operation, output, hash_size));
616 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
Neil Armstrong2968d302022-02-25 15:09:36 +0100617
618#undef PSA_CHK
619
620cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
622 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100623
Gilles Peskine449bd832023-01-11 14:50:10 +0100624 psa_hash_abort(&operation);
625 psa_hash_abort(&aux_operation);
626 return psa_ssl_status_to_mbedtls(status);
Neil Armstrong2968d302022-02-25 15:09:36 +0100627}
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100628
629#undef MAX_HASH_BLOCK_LENGTH
630
Neil Armstrong2968d302022-02-25 15:09:36 +0100631#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100632int mbedtls_ct_hmac(mbedtls_md_context_t *ctx,
633 const unsigned char *add_data,
634 size_t add_data_len,
635 const unsigned char *data,
636 size_t data_len_secret,
637 size_t min_data_len,
638 size_t max_data_len,
639 unsigned char *output)
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200640{
641 /*
642 * This function breaks the HMAC abstraction and uses the md_clone()
643 * extension to the MD API in order to get constant-flow behaviour.
644 *
645 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
646 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
647 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
648 *
649 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
650 * minlen, then cloning the context, and for each byte up to maxlen
651 * finishing up the hash computation, keeping only the correct result.
652 *
653 * Then we only need to compute HASH(okey + inner_hash) and we're done.
654 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100655 const mbedtls_md_type_t md_alg = mbedtls_md_get_type(ctx->md_info);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200656 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
657 * all of which have the same block size except SHA-384. */
658 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
659 const unsigned char * const ikey = ctx->hmac_ctx;
660 const unsigned char * const okey = ikey + block_size;
Gilles Peskine449bd832023-01-11 14:50:10 +0100661 const size_t hash_size = mbedtls_md_get_size(ctx->md_info);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200662
663 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
664 mbedtls_md_context_t aux;
665 size_t offset;
666 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
667
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 mbedtls_md_init(&aux);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200669
Gilles Peskine449bd832023-01-11 14:50:10 +0100670#define MD_CHK(func_call) \
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200671 do { \
672 ret = (func_call); \
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 if (ret != 0) \
674 goto cleanup; \
675 } while (0)
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 MD_CHK(mbedtls_md_setup(&aux, ctx->md_info, 0));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200678
679 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
680 * so we can start directly with the message */
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 MD_CHK(mbedtls_md_update(ctx, add_data, add_data_len));
682 MD_CHK(mbedtls_md_update(ctx, data, min_data_len));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200683
Paul Elliott5260ce22022-05-09 18:15:54 +0100684 /* Fill the hash buffer in advance with something that is
685 * not a valid hash (barring an attack on the hash and
686 * deliberately-crafted input), in case the caller doesn't
687 * check the return status properly. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 memset(output, '!', hash_size);
Paul Elliott5260ce22022-05-09 18:15:54 +0100689
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200690 /* For each possible length, compute the hash up to that point */
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 for (offset = min_data_len; offset <= max_data_len; offset++) {
692 MD_CHK(mbedtls_md_clone(&aux, ctx));
693 MD_CHK(mbedtls_md_finish(&aux, aux_out));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200694 /* Keep only the correct inner_hash in the output buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 mbedtls_ct_memcpy_if_eq(output, aux_out, hash_size,
696 offset, data_len_secret);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200697
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 if (offset < max_data_len) {
699 MD_CHK(mbedtls_md_update(ctx, data + offset, 1));
700 }
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200701 }
702
703 /* The context needs to finish() before it starts() again */
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 MD_CHK(mbedtls_md_finish(ctx, aux_out));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200705
706 /* Now compute HASH(okey + inner_hash) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 MD_CHK(mbedtls_md_starts(ctx));
708 MD_CHK(mbedtls_md_update(ctx, okey, block_size));
709 MD_CHK(mbedtls_md_update(ctx, output, hash_size));
710 MD_CHK(mbedtls_md_finish(ctx, output));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200711
712 /* Done, get ready for next time */
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 MD_CHK(mbedtls_md_hmac_reset(ctx));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200714
715#undef MD_CHK
716
717cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 mbedtls_md_free(&aux);
719 return ret;
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200720}
Neil Armstrong2968d302022-02-25 15:09:36 +0100721#endif /* MBEDTLS_USE_PSA_CRYPTO */
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200722
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200723#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200724
725#if defined(MBEDTLS_BIGNUM_C)
726
Gilles Peskine449bd832023-01-11 14:50:10 +0100727#define MPI_VALIDATE_RET(cond) \
728 MBEDTLS_INTERNAL_VALIDATE_RET(cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA)
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200729
730/*
731 * Conditionally assign X = Y, without leaking information
732 * about whether the assignment was made or not.
733 * (Leaking information about the respective sizes of X and Y is ok however.)
734 */
Tautvydas Žilys40fc7da2022-01-31 13:34:01 -0800735#if defined(_MSC_VER) && defined(_M_ARM64) && (_MSC_FULL_VER < 193131103)
Tautvydas Žilys60165d72022-01-26 15:33:27 -0800736/*
Tautvydas Žilys40fc7da2022-01-31 13:34:01 -0800737 * MSVC miscompiles this function if it's inlined prior to Visual Studio 2022 version 17.1. See:
Tautvydas Žilys60165d72022-01-26 15:33:27 -0800738 * https://developercommunity.visualstudio.com/t/c-compiler-miscompiles-part-of-mbedtls-library-on/1646989
739 */
740__declspec(noinline)
741#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100742int mbedtls_mpi_safe_cond_assign(mbedtls_mpi *X,
743 const mbedtls_mpi *Y,
744 unsigned char assign)
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200745{
746 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100747 MPI_VALIDATE_RET(X != NULL);
748 MPI_VALIDATE_RET(Y != NULL);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200749
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200750 /* all-bits 1 if assign is 1, all-bits 0 if assign is 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 mbedtls_mpi_uint limb_mask = mbedtls_ct_mpi_uint_mask(assign);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200752
Gilles Peskine449bd832023-01-11 14:50:10 +0100753 MBEDTLS_MPI_CHK(mbedtls_mpi_grow(X, Y->n));
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200754
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 X->s = mbedtls_ct_cond_select_sign(assign, Y->s, X->s);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200756
Gilles Peskine449bd832023-01-11 14:50:10 +0100757 mbedtls_mpi_core_cond_assign(X->p, Y->p, Y->n, assign);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200758
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 for (size_t i = Y->n; i < X->n; i++) {
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200760 X->p[i] &= ~limb_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 }
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200762
763cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100764 return ret;
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200765}
766
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200767/*
768 * Conditionally swap X and Y, without leaking information
769 * about whether the swap was made or not.
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800770 * Here it is not ok to simply swap the pointers, which would lead to
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200771 * different memory access patterns when X and Y are used afterwards.
772 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100773int mbedtls_mpi_safe_cond_swap(mbedtls_mpi *X,
774 mbedtls_mpi *Y,
775 unsigned char swap)
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200776{
Gabor Mezeid7edb1d2022-10-10 14:32:09 +0200777 int ret = 0;
778 int s;
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 MPI_VALIDATE_RET(X != NULL);
780 MPI_VALIDATE_RET(Y != NULL);
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782 if (X == Y) {
783 return 0;
784 }
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200785
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 MBEDTLS_MPI_CHK(mbedtls_mpi_grow(X, Y->n));
787 MBEDTLS_MPI_CHK(mbedtls_mpi_grow(Y, X->n));
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200788
789 s = X->s;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 X->s = mbedtls_ct_cond_select_sign(swap, Y->s, X->s);
791 Y->s = mbedtls_ct_cond_select_sign(swap, s, Y->s);
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200792
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 mbedtls_mpi_core_cond_swap(X->p, Y->p, X->n, swap);
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200794
795cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 return ret;
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200797}
798
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200799/*
Janos Follath23bdeca2022-07-22 18:24:06 +0100800 * Compare unsigned values in constant time
801 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100802unsigned mbedtls_mpi_core_lt_ct(const mbedtls_mpi_uint *A,
803 const mbedtls_mpi_uint *B,
804 size_t limbs)
Janos Follath23bdeca2022-07-22 18:24:06 +0100805{
Janos Follath23bdeca2022-07-22 18:24:06 +0100806 unsigned ret, cond, done;
807
Janos Follath63184682022-08-11 17:42:59 +0100808 /* The value of any of these variables is either 0 or 1 for the rest of
809 * their scope. */
Janos Follath23bdeca2022-07-22 18:24:06 +0100810 ret = cond = done = 0;
811
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 for (size_t i = limbs; i > 0; i--) {
Janos Follath23bdeca2022-07-22 18:24:06 +0100813 /*
Janos Follathb7a88ec2022-08-19 12:24:40 +0100814 * If B[i - 1] < A[i - 1] then A < B is false and the result must
Janos Follath23bdeca2022-07-22 18:24:06 +0100815 * remain 0.
816 *
817 * Again even if we can make a decision, we just mark the result and
818 * the fact that we are done and continue looping.
819 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 cond = mbedtls_ct_mpi_uint_lt(B[i - 1], A[i - 1]);
Janos Follath23bdeca2022-07-22 18:24:06 +0100821 done |= cond;
822
823 /*
Janos Follathb7a88ec2022-08-19 12:24:40 +0100824 * If A[i - 1] < B[i - 1] then A < B is true.
Janos Follath23bdeca2022-07-22 18:24:06 +0100825 *
826 * Again even if we can make a decision, we just mark the result and
827 * the fact that we are done and continue looping.
828 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100829 cond = mbedtls_ct_mpi_uint_lt(A[i - 1], B[i - 1]);
830 ret |= cond & (1 - done);
Janos Follath23bdeca2022-07-22 18:24:06 +0100831 done |= cond;
832 }
833
834 /*
Janos Follathb7a88ec2022-08-19 12:24:40 +0100835 * If all the limbs were equal, then the numbers are equal, A < B is false
Janos Follath23bdeca2022-07-22 18:24:06 +0100836 * and leaving the result 0 is correct.
837 */
838
Gilles Peskine449bd832023-01-11 14:50:10 +0100839 return ret;
Janos Follath23bdeca2022-07-22 18:24:06 +0100840}
841
842/*
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200843 * Compare signed values in constant time
844 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100845int mbedtls_mpi_lt_mpi_ct(const mbedtls_mpi *X,
846 const mbedtls_mpi *Y,
847 unsigned *ret)
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200848{
849 size_t i;
850 /* The value of any of these variables is either 0 or 1 at all times. */
851 unsigned cond, done, X_is_negative, Y_is_negative;
852
Gilles Peskine449bd832023-01-11 14:50:10 +0100853 MPI_VALIDATE_RET(X != NULL);
854 MPI_VALIDATE_RET(Y != NULL);
855 MPI_VALIDATE_RET(ret != NULL);
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200856
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 if (X->n != Y->n) {
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200858 return MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +0100859 }
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200860
861 /*
862 * Set sign_N to 1 if N >= 0, 0 if N < 0.
863 * We know that N->s == 1 if N >= 0 and N->s == -1 if N < 0.
864 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100865 X_is_negative = (X->s & 2) >> 1;
866 Y_is_negative = (Y->s & 2) >> 1;
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200867
868 /*
869 * If the signs are different, then the positive operand is the bigger.
870 * That is if X is negative (X_is_negative == 1), then X < Y is true and it
871 * is false if X is positive (X_is_negative == 0).
872 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100873 cond = (X_is_negative ^ Y_is_negative);
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200874 *ret = cond & X_is_negative;
875
876 /*
877 * This is a constant-time function. We might have the result, but we still
878 * need to go through the loop. Record if we have the result already.
879 */
880 done = cond;
881
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 for (i = X->n; i > 0; i--) {
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200883 /*
884 * If Y->p[i - 1] < X->p[i - 1] then X < Y is true if and only if both
885 * X and Y are negative.
886 *
887 * Again even if we can make a decision, we just mark the result and
888 * the fact that we are done and continue looping.
889 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100890 cond = mbedtls_ct_mpi_uint_lt(Y->p[i - 1], X->p[i - 1]);
891 *ret |= cond & (1 - done) & X_is_negative;
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200892 done |= cond;
893
894 /*
895 * If X->p[i - 1] < Y->p[i - 1] then X < Y is true if and only if both
896 * X and Y are positive.
897 *
898 * Again even if we can make a decision, we just mark the result and
899 * the fact that we are done and continue looping.
900 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100901 cond = mbedtls_ct_mpi_uint_lt(X->p[i - 1], Y->p[i - 1]);
902 *ret |= cond & (1 - done) & (1 - X_is_negative);
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200903 done |= cond;
904 }
905
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 return 0;
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200907}
908
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200909#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200910
911#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
912
Gilles Peskine449bd832023-01-11 14:50:10 +0100913int mbedtls_ct_rsaes_pkcs1_v15_unpadding(unsigned char *input,
914 size_t ilen,
915 unsigned char *output,
916 size_t output_max_len,
917 size_t *olen)
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200918{
919 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
920 size_t i, plaintext_max_size;
921
922 /* The following variables take sensitive values: their value must
923 * not leak into the observable behavior of the function other than
924 * the designated outputs (output, olen, return value). Otherwise
925 * this would open the execution of the function to
926 * side-channel-based variants of the Bleichenbacher padding oracle
927 * attack. Potential side channels include overall timing, memory
928 * access patterns (especially visible to an adversary who has access
929 * to a shared memory cache), and branches (especially visible to
930 * an adversary who has access to a shared code cache or to a shared
931 * branch predictor). */
932 size_t pad_count = 0;
933 unsigned bad = 0;
934 unsigned char pad_done = 0;
935 size_t plaintext_size = 0;
936 unsigned output_too_large;
937
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 plaintext_max_size = (output_max_len > ilen - 11) ? ilen - 11
Gabor Mezei7013f622021-10-18 16:12:45 +0200939 : output_max_len;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200940
941 /* Check and get padding length in constant time and constant
942 * memory trace. The first byte must be 0. */
Gabor Mezei63bbba52021-10-18 16:17:57 +0200943 bad |= input[0];
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200944
945
946 /* Decode EME-PKCS1-v1_5 padding: 0x00 || 0x02 || PS || 0x00
Gabor Mezei63bbba52021-10-18 16:17:57 +0200947 * where PS must be at least 8 nonzero bytes. */
948 bad |= input[1] ^ MBEDTLS_RSA_CRYPT;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200949
950 /* Read the whole buffer. Set pad_done to nonzero if we find
Gabor Mezei63bbba52021-10-18 16:17:57 +0200951 * the 0x00 byte and remember the padding length in pad_count. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 for (i = 2; i < ilen; i++) {
953 pad_done |= ((input[i] | (unsigned char) -input[i]) >> 7) ^ 1;
954 pad_count += ((pad_done | (unsigned char) -pad_done) >> 7) ^ 1;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200955 }
956
957
958 /* If pad_done is still zero, there's no data, only unfinished padding. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 bad |= mbedtls_ct_uint_if(pad_done, 0, 1);
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200960
961 /* There must be at least 8 bytes of padding. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 bad |= mbedtls_ct_size_gt(8, pad_count);
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200963
964 /* If the padding is valid, set plaintext_size to the number of
965 * remaining bytes after stripping the padding. If the padding
966 * is invalid, avoid leaking this fact through the size of the
967 * output: use the maximum message size that fits in the output
968 * buffer. Do it without branches to avoid leaking the padding
969 * validity through timing. RSA keys are small enough that all the
970 * size_t values involved fit in unsigned int. */
Gabor Mezei90437e32021-10-20 11:59:27 +0200971 plaintext_size = mbedtls_ct_uint_if(
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 bad, (unsigned) plaintext_max_size,
973 (unsigned) (ilen - pad_count - 3));
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200974
975 /* Set output_too_large to 0 if the plaintext fits in the output
976 * buffer and to 1 otherwise. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 output_too_large = mbedtls_ct_size_gt(plaintext_size,
978 plaintext_max_size);
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200979
980 /* Set ret without branches to avoid timing attacks. Return:
981 * - INVALID_PADDING if the padding is bad (bad != 0).
982 * - OUTPUT_TOO_LARGE if the padding is good but the decrypted
983 * plaintext does not fit in the output buffer.
984 * - 0 if the padding is correct. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 ret = -(int) mbedtls_ct_uint_if(
986 bad, -MBEDTLS_ERR_RSA_INVALID_PADDING,
987 mbedtls_ct_uint_if(output_too_large,
988 -MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE,
989 0));
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200990
991 /* If the padding is bad or the plaintext is too large, zero the
992 * data that we're about to copy to the output buffer.
993 * We need to copy the same amount of data
994 * from the same buffer whether the padding is good or not to
995 * avoid leaking the padding validity through overall timing or
996 * through memory or cache access patterns. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 bad = mbedtls_ct_uint_mask(bad | output_too_large);
998 for (i = 11; i < ilen; i++) {
Gabor Mezei63bbba52021-10-18 16:17:57 +0200999 input[i] &= ~bad;
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 }
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001001
1002 /* If the plaintext is too large, truncate it to the buffer size.
1003 * Copy anyway to avoid revealing the length through timing, because
1004 * revealing the length is as bad as revealing the padding validity
1005 * for a Bleichenbacher attack. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 plaintext_size = mbedtls_ct_uint_if(output_too_large,
1007 (unsigned) plaintext_max_size,
1008 (unsigned) plaintext_size);
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001009
1010 /* Move the plaintext to the leftmost position where it can start in
1011 * the working buffer, i.e. make it start plaintext_max_size from
1012 * the end of the buffer. Do this with a memory access trace that
1013 * does not depend on the plaintext size. After this move, the
1014 * starting location of the plaintext is no longer sensitive
1015 * information. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_ct_mem_move_to_left(input + ilen - plaintext_max_size,
1017 plaintext_max_size,
1018 plaintext_max_size - plaintext_size);
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001019
1020 /* Finally copy the decrypted plaintext plus trailing zeros into the output
1021 * buffer. If output_max_len is 0, then output may be an invalid pointer
1022 * and the result of memcpy() would be undefined; prevent undefined
1023 * behavior making sure to depend only on output_max_len (the size of the
1024 * user-provided output buffer), which is independent from plaintext
1025 * length, validity of padding, success of the decryption, and other
1026 * secrets. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001027 if (output_max_len != 0) {
1028 memcpy(output, input + ilen - plaintext_max_size, plaintext_max_size);
1029 }
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001030
1031 /* Report the amount of data we copied to the output buffer. In case
1032 * of errors (bad padding or output too large), the value of *olen
1033 * when this function returns is not specified. Making it equivalent
1034 * to the good case limits the risks of leaking the padding validity. */
1035 *olen = plaintext_size;
1036
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 return ret;
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001038}
1039
1040#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */