blob: 7f4d509bc385d96db7ab877c0deb9796e40c3c42 [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/*
Dave Rodgman051225d2022-12-30 21:25:35 +000051 * Define MBEDTLS_EFFICIENT_UNALIGNED_VOLATILE_ACCESS where assembly is present to
52 * perform fast unaligned access to volatile data.
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000053 *
54 * This is needed because mbedtls_get_unaligned_uintXX etc don't support volatile
55 * memory accesses.
56 *
Dave Rodgman051225d2022-12-30 21:25:35 +000057 * Some of these definitions could be moved into alignment.h but for now they are
58 * only used here.
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000059 */
Dave Rodgman051225d2022-12-30 21:25:35 +000060#if defined(MBEDTLS_EFFICIENT_UNALIGNED_ACCESS) && defined(MBEDTLS_HAVE_ASM)
61#if defined(__arm__) || defined(__thumb__) || defined(__thumb2__) || defined(__aarch64__)
62#define MBEDTLS_EFFICIENT_UNALIGNED_VOLATILE_ACCESS
63#endif
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000064#endif
65
Dave Rodgman051225d2022-12-30 21:25:35 +000066#if defined(MBEDTLS_EFFICIENT_UNALIGNED_VOLATILE_ACCESS)
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000067static inline uint32_t mbedtls_get_unaligned_volatile_uint32(volatile const unsigned char *p)
68{
69 /* This is UB, even where it's safe:
70 * return *((volatile uint32_t*)p);
71 * so instead the same thing is expressed in assembly below.
72 */
73 uint32_t r;
74#if defined(__arm__) || defined(__thumb__) || defined(__thumb2__)
75 asm ("ldr %0, [%1]" : "=r" (r) : "r" (p) :);
Dave Rodgman051225d2022-12-30 21:25:35 +000076#elif defined(__aarch64__)
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000077 asm ("ldr %w0, [%1]" : "=r" (r) : "r" (p) :);
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000078#endif
Dave Rodgman051225d2022-12-30 21:25:35 +000079 return r;
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000080}
Dave Rodgman051225d2022-12-30 21:25:35 +000081#endif /* MBEDTLS_EFFICIENT_UNALIGNED_VOLATILE_ACCESS */
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000082
Gilles Peskine449bd832023-01-11 14:50:10 +010083int mbedtls_ct_memcmp(const void *a,
84 const void *b,
85 size_t n)
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020086{
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000087 size_t i = 0;
Dave Rodgman7658b632023-01-11 17:39:33 +000088 /*
89 * `A` and `B` are cast to volatile to ensure that the compiler
90 * generates code that always fully reads both buffers.
91 * Otherwise it could generate a test to exit early if `diff` has all
92 * bits set early in the loop.
93 */
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020094 volatile const unsigned char *A = (volatile const unsigned char *) a;
95 volatile const unsigned char *B = (volatile const unsigned char *) b;
Dave Rodgman7658b632023-01-11 17:39:33 +000096 uint32_t diff = 0;
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +020097
Dave Rodgman051225d2022-12-30 21:25:35 +000098#if defined(MBEDTLS_EFFICIENT_UNALIGNED_VOLATILE_ACCESS)
Dave Rodgman36dfc5a2022-12-22 15:04:43 +000099 for (; (i + 4) <= n; i += 4) {
100 uint32_t x = mbedtls_get_unaligned_volatile_uint32(A + i);
101 uint32_t y = mbedtls_get_unaligned_volatile_uint32(B + i);
102 diff |= x ^ y;
103 }
104#endif
105
106 for (; i < n; i++) {
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +0200107 /* Read volatile data in order before computing diff.
108 * This avoids IAR compiler warning:
109 * 'the order of volatile accesses is undefined ..' */
110 unsigned char x = A[i], y = B[i];
111 diff |= x ^ y;
112 }
113
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 return (int) diff;
gabor-mezei-armdb9a38c2021-09-27 11:28:54 +0200115}
116
Gilles Peskine449bd832023-01-11 14:50:10 +0100117unsigned mbedtls_ct_uint_mask(unsigned value)
gabor-mezei-arm340948e2021-09-27 11:40:03 +0200118{
119 /* MSVC has a warning about unary minus on unsigned, but this is
120 * well-defined and precisely what we want to do here */
121#if defined(_MSC_VER)
122#pragma warning( push )
123#pragma warning( disable : 4146 )
124#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 return -((value | -value) >> (sizeof(value) * 8 - 1));
gabor-mezei-arm340948e2021-09-27 11:40:03 +0200126#if defined(_MSC_VER)
127#pragma warning( pop )
128#endif
129}
gabor-mezei-arm3733bf82021-09-27 11:49:42 +0200130
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200131#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gabor Mezei6a426c92021-10-20 11:17:43 +0200132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133size_t mbedtls_ct_size_mask(size_t value)
gabor-mezei-arm3733bf82021-09-27 11:49:42 +0200134{
135 /* MSVC has a warning about unary minus on unsigned integer types,
136 * but this is well-defined and precisely what we want to do here. */
137#if defined(_MSC_VER)
138#pragma warning( push )
139#pragma warning( disable : 4146 )
140#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100141 return -((value | -value) >> (sizeof(value) * 8 - 1));
gabor-mezei-arm3733bf82021-09-27 11:49:42 +0200142#if defined(_MSC_VER)
143#pragma warning( pop )
144#endif
145}
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200146
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200147#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gabor Mezei6a426c92021-10-20 11:17:43 +0200148
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200149#if defined(MBEDTLS_BIGNUM_C)
150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151mbedtls_mpi_uint mbedtls_ct_mpi_uint_mask(mbedtls_mpi_uint value)
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200152{
153 /* MSVC has a warning about unary minus on unsigned, but this is
154 * well-defined and precisely what we want to do here */
155#if defined(_MSC_VER)
156#pragma warning( push )
157#pragma warning( disable : 4146 )
158#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 return -((value | -value) >> (sizeof(value) * 8 - 1));
gabor-mezei-arm9cb55692021-08-11 15:07:02 +0200160#if defined(_MSC_VER)
161#pragma warning( pop )
162#endif
163}
164
165#endif /* MBEDTLS_BIGNUM_C */
166
Gabor Mezeie2123792021-10-18 17:05:06 +0200167#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
168
Gabor Mezei1e642612021-10-18 16:05:50 +0200169/** Constant-flow mask generation for "less than" comparison:
170 * - if \p x < \p y, return all-bits 1, that is (size_t) -1
171 * - otherwise, return all bits 0, that is 0
172 *
173 * This function can be used to write constant-time code by replacing branches
174 * with bit operations using masks.
175 *
176 * \param x The first value to analyze.
177 * \param y The second value to analyze.
178 *
179 * \return All-bits-one if \p x is less than \p y, otherwise zero.
180 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100181static size_t mbedtls_ct_size_mask_lt(size_t x,
182 size_t y)
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200183{
184 /* This has the most significant bit set if and only if x < y */
185 const size_t sub = x - y;
186
187 /* sub1 = (x < y) ? 1 : 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100188 const size_t sub1 = sub >> (sizeof(sub) * 8 - 1);
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200189
190 /* mask = (x < y) ? 0xff... : 0x00... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100191 const size_t mask = mbedtls_ct_size_mask(sub1);
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 return mask;
gabor-mezei-armc76227d2021-09-27 11:53:54 +0200194}
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200195
Gilles Peskine449bd832023-01-11 14:50:10 +0100196size_t mbedtls_ct_size_mask_ge(size_t x,
197 size_t y)
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200198{
Gilles Peskine449bd832023-01-11 14:50:10 +0100199 return ~mbedtls_ct_size_mask_lt(x, y);
gabor-mezei-arm16fc57b2021-09-27 11:58:31 +0200200}
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200201
Gabor Mezeie2123792021-10-18 17:05:06 +0200202#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
203
Gabor Mezei28d61152021-11-15 16:13:01 +0100204#if defined(MBEDTLS_BASE64_C)
205
206/* Return 0xff if low <= c <= high, 0 otherwise.
207 *
208 * Constant flow with respect to c.
209 */
Gabor Mezeic0d8dda2021-11-26 17:20:36 +0100210MBEDTLS_STATIC_TESTABLE
Gilles Peskine449bd832023-01-11 14:50:10 +0100211unsigned char mbedtls_ct_uchar_mask_of_range(unsigned char low,
212 unsigned char high,
213 unsigned char c)
Gabor Mezei28d61152021-11-15 16:13:01 +0100214{
215 /* low_mask is: 0 if low <= c, 0x...ff if low > c */
Gilles Peskine449bd832023-01-11 14:50:10 +0100216 unsigned low_mask = ((unsigned) c - low) >> 8;
Gabor Mezei28d61152021-11-15 16:13:01 +0100217 /* high_mask is: 0 if c <= high, 0x...ff if c > high */
Gilles Peskine449bd832023-01-11 14:50:10 +0100218 unsigned high_mask = ((unsigned) high - c) >> 8;
219 return ~(low_mask | high_mask) & 0xff;
Gabor Mezei28d61152021-11-15 16:13:01 +0100220}
221
222#endif /* MBEDTLS_BASE64_C */
223
Gilles Peskine449bd832023-01-11 14:50:10 +0100224unsigned mbedtls_ct_size_bool_eq(size_t x,
225 size_t y)
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200226{
227 /* diff = 0 if x == y, non-zero otherwise */
228 const size_t diff = x ^ y;
229
230 /* MSVC has a warning about unary minus on unsigned integer types,
231 * but this is well-defined and precisely what we want to do here. */
232#if defined(_MSC_VER)
233#pragma warning( push )
234#pragma warning( disable : 4146 )
235#endif
236
237 /* diff_msb's most significant bit is equal to x != y */
Gilles Peskine449bd832023-01-11 14:50:10 +0100238 const size_t diff_msb = (diff | (size_t) -diff);
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200239
240#if defined(_MSC_VER)
241#pragma warning( pop )
242#endif
243
244 /* diff1 = (x != y) ? 1 : 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 const unsigned diff1 = diff_msb >> (sizeof(diff_msb) * 8 - 1);
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 return 1 ^ diff1;
gabor-mezei-arm8d1d5fd2021-09-27 12:15:19 +0200248}
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200249
Gabor Mezeie2123792021-10-18 17:05:06 +0200250#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
251
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200252/** Constant-flow "greater than" comparison:
253 * return x > y
254 *
255 * This is equivalent to \p x > \p y, but is likely to be compiled
256 * to code using bitwise operation rather than a branch.
257 *
258 * \param x The first value to analyze.
259 * \param y The second value to analyze.
260 *
261 * \return 1 if \p x greater than \p y, otherwise 0.
262 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100263static unsigned mbedtls_ct_size_gt(size_t x,
264 size_t y)
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200265{
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200266 /* Return the sign bit (1 for negative) of (y - x). */
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 return (y - x) >> (sizeof(size_t) * 8 - 1);
gabor-mezei-arm5a854422021-09-27 12:25:07 +0200268}
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200269
Gabor Mezeie2123792021-10-18 17:05:06 +0200270#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
271
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200272#if defined(MBEDTLS_BIGNUM_C)
273
Gilles Peskine449bd832023-01-11 14:50:10 +0100274unsigned mbedtls_ct_mpi_uint_lt(const mbedtls_mpi_uint x,
275 const mbedtls_mpi_uint y)
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200276{
277 mbedtls_mpi_uint ret;
278 mbedtls_mpi_uint cond;
279
280 /*
281 * Check if the most significant bits (MSB) of the operands are different.
282 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 cond = (x ^ y);
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200284 /*
285 * If the MSB are the same then the difference x-y will be negative (and
286 * have its MSB set to 1 during conversion to unsigned) if and only if x<y.
287 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 ret = (x - y) & ~cond;
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200289 /*
290 * If the MSB are different, then the operand with the MSB of 1 is the
291 * bigger. (That is if y has MSB of 1, then x<y is true and it is false if
292 * the MSB of y is 0.)
293 */
294 ret |= y & cond;
295
296
Gilles Peskine449bd832023-01-11 14:50:10 +0100297 ret = ret >> (sizeof(mbedtls_mpi_uint) * 8 - 1);
gabor-mezei-arm3f90fd52021-09-27 12:55:33 +0200298
299 return (unsigned) ret;
300}
301
302#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200303
Gilles Peskine449bd832023-01-11 14:50:10 +0100304unsigned mbedtls_ct_uint_if(unsigned condition,
305 unsigned if1,
306 unsigned if0)
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200307{
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 unsigned mask = mbedtls_ct_uint_mask(condition);
309 return (mask & if1) | (~mask & if0);
gabor-mezei-armb2dbf2c2021-09-27 12:59:30 +0200310}
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200311
Gabor Mezeie2123792021-10-18 17:05:06 +0200312#if defined(MBEDTLS_BIGNUM_C)
gabor-mezei-arm65cefdb2021-09-27 15:47:00 +0200313
Gabor Mezei642eeb22021-11-03 16:13:32 +0100314/** Select between two sign values without branches.
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200315 *
316 * This is functionally equivalent to `condition ? if1 : if0` but uses only bit
317 * operations in order to avoid branches.
318 *
319 * \note if1 and if0 must be either 1 or -1, otherwise the result
320 * is undefined.
321 *
Tom Cosgrove583816c2022-08-18 14:09:18 +0100322 * \param condition Condition to test; must be either 0 or 1.
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200323 * \param if1 The first sign; must be either +1 or -1.
324 * \param if0 The second sign; must be either +1 or -1.
325 *
326 * \return \c if1 if \p condition is nonzero, otherwise \c if0.
327 * */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328static int mbedtls_ct_cond_select_sign(unsigned char condition,
329 int if1,
330 int if0)
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200331{
Gabor Mezei642eeb22021-11-03 16:13:32 +0100332 /* In order to avoid questions about what we can reasonably assume about
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200333 * the representations of signed integers, move everything to unsigned
Gabor Mezeia316fc82021-10-18 16:28:27 +0200334 * by taking advantage of the fact that if1 and if0 are either +1 or -1. */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200335 unsigned uif1 = if1 + 1;
336 unsigned uif0 = if0 + 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200337
Gabor Mezeia316fc82021-10-18 16:28:27 +0200338 /* condition was 0 or 1, mask is 0 or 2 as are uif1 and uif0 */
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200339 const unsigned mask = condition << 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200340
Gabor Mezeia316fc82021-10-18 16:28:27 +0200341 /* select uif1 or uif0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 unsigned ur = (uif0 & ~mask) | (uif1 & mask);
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200343
344 /* ur is now 0 or 2, convert back to -1 or +1 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 return (int) ur - 1;
gabor-mezei-armd3230d52021-09-27 13:03:57 +0200346}
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200347
Gilles Peskine449bd832023-01-11 14:50:10 +0100348void mbedtls_ct_mpi_uint_cond_assign(size_t n,
349 mbedtls_mpi_uint *dest,
350 const mbedtls_mpi_uint *src,
351 unsigned char condition)
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200352{
353 size_t i;
354
355 /* MSVC has a warning about unary minus on unsigned integer types,
356 * but this is well-defined and precisely what we want to do here. */
357#if defined(_MSC_VER)
358#pragma warning( push )
359#pragma warning( disable : 4146 )
360#endif
361
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200362 /* all-bits 1 if condition is 1, all-bits 0 if condition is 0 */
363 const mbedtls_mpi_uint mask = -condition;
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200364
365#if defined(_MSC_VER)
366#pragma warning( pop )
367#endif
368
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 for (i = 0; i < n; i++) {
370 dest[i] = (src[i] & mask) | (dest[i] & ~mask);
371 }
gabor-mezei-armbe8d98b2021-09-27 13:17:15 +0200372}
373
374#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200375
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100376#if defined(MBEDTLS_BASE64_C)
377
Gilles Peskine449bd832023-01-11 14:50:10 +0100378unsigned char mbedtls_ct_base64_enc_char(unsigned char value)
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100379{
380 unsigned char digit = 0;
Gabor Mezei14d5fac2021-11-24 15:51:39 +0100381 /* For each range of values, if value is in that range, mask digit with
382 * the corresponding value. Since value can only be in a single range,
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100383 * only at most one masking will change digit. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 digit |= mbedtls_ct_uchar_mask_of_range(0, 25, value) & ('A' + value);
385 digit |= mbedtls_ct_uchar_mask_of_range(26, 51, value) & ('a' + value - 26);
386 digit |= mbedtls_ct_uchar_mask_of_range(52, 61, value) & ('0' + value - 52);
387 digit |= mbedtls_ct_uchar_mask_of_range(62, 62, value) & '+';
388 digit |= mbedtls_ct_uchar_mask_of_range(63, 63, value) & '/';
389 return digit;
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100390}
391
Gilles Peskine449bd832023-01-11 14:50:10 +0100392signed char mbedtls_ct_base64_dec_value(unsigned char c)
Gabor Mezei358829a2021-11-15 16:22:37 +0100393{
394 unsigned char val = 0;
395 /* For each range of digits, if c is in that range, mask val with
396 * the corresponding value. Since c can only be in a single range,
397 * only at most one masking will change val. Set val to one plus
398 * the desired value so that it stays 0 if c is in none of the ranges. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 val |= mbedtls_ct_uchar_mask_of_range('A', 'Z', c) & (c - 'A' + 0 + 1);
400 val |= mbedtls_ct_uchar_mask_of_range('a', 'z', c) & (c - 'a' + 26 + 1);
401 val |= mbedtls_ct_uchar_mask_of_range('0', '9', c) & (c - '0' + 52 + 1);
402 val |= mbedtls_ct_uchar_mask_of_range('+', '+', c) & (c - '+' + 62 + 1);
403 val |= mbedtls_ct_uchar_mask_of_range('/', '/', c) & (c - '/' + 63 + 1);
Gabor Mezei358829a2021-11-15 16:22:37 +0100404 /* At this point, val is 0 if c is an invalid digit and v+1 if c is
405 * a digit with the value v. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 return val - 1;
Gabor Mezei358829a2021-11-15 16:22:37 +0100407}
408
Gabor Mezei9a4074a2021-11-15 16:18:54 +0100409#endif /* MBEDTLS_BASE64_C */
410
Gabor Mezeie2123792021-10-18 17:05:06 +0200411#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
412
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200413/** Shift some data towards the left inside a buffer.
414 *
Gabor Mezei90437e32021-10-20 11:59:27 +0200415 * `mbedtls_ct_mem_move_to_left(start, total, offset)` is functionally
Gabor Mezeia2d0f902021-10-18 16:35:23 +0200416 * equivalent to
417 * ```
418 * memmove(start, start + offset, total - offset);
419 * memset(start + offset, 0, total - offset);
420 * ```
421 * but it strives to use a memory access pattern (and thus total timing)
422 * that does not depend on \p offset. This timing independence comes at
423 * the expense of performance.
424 *
425 * \param start Pointer to the start of the buffer.
426 * \param total Total size of the buffer.
427 * \param offset Offset from which to copy \p total - \p offset bytes.
428 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100429static void mbedtls_ct_mem_move_to_left(void *start,
430 size_t total,
431 size_t offset)
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200432{
433 volatile unsigned char *buf = start;
434 size_t i, n;
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 if (total == 0) {
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200436 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 }
438 for (i = 0; i < total; i++) {
439 unsigned no_op = mbedtls_ct_size_gt(total - offset, i);
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200440 /* The first `total - offset` passes are a no-op. The last
441 * `offset` passes shift the data one byte to the left and
442 * zero out the last byte. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 for (n = 0; n < total - 1; n++) {
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200444 unsigned char current = buf[n];
445 unsigned char next = buf[n+1];
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 buf[n] = mbedtls_ct_uint_if(no_op, current, next);
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200447 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100448 buf[total-1] = mbedtls_ct_uint_if(no_op, buf[total-1], 0);
gabor-mezei-arm394aeaa2021-09-27 13:31:06 +0200449 }
450}
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200451
Gabor Mezeie2123792021-10-18 17:05:06 +0200452#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */
453
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200454#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gabor Mezeie2123792021-10-18 17:05:06 +0200455
Gilles Peskine449bd832023-01-11 14:50:10 +0100456void mbedtls_ct_memcpy_if_eq(unsigned char *dest,
457 const unsigned char *src,
458 size_t len,
459 size_t c1,
460 size_t c2)
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200461{
462 /* mask = c1 == c2 ? 0xff : 0x00 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100463 const size_t equal = mbedtls_ct_size_bool_eq(c1, c2);
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200464
gabor-mezei-arm87ac5be2021-08-10 20:36:09 +0200465 /* dest[i] = c1 == c2 ? src[i] : dest[i] */
Dave Rodgman36dfc5a2022-12-22 15:04:43 +0000466 size_t i = 0;
467#if defined(MBEDTLS_EFFICIENT_UNALIGNED_ACCESS)
468 const uint32_t mask32 = (uint32_t) mbedtls_ct_size_mask(equal);
469 const unsigned char mask = (unsigned char) mask32 & 0xff;
470
471 for (; (i + 4) <= len; i += 4) {
472 uint32_t a = mbedtls_get_unaligned_uint32(src + i) & mask32;
473 uint32_t b = mbedtls_get_unaligned_uint32(dest + i) & ~mask32;
474 mbedtls_put_unaligned_uint32(dest + i, a | b);
475 }
476#else
477 const unsigned char mask = (unsigned char) mbedtls_ct_size_mask(equal);
478#endif /* MBEDTLS_EFFICIENT_UNALIGNED_ACCESS */
479 for (; i < len; i++) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100480 dest[i] = (src[i] & mask) | (dest[i] & ~mask);
481 }
gabor-mezei-armdee0fd32021-09-27 13:34:25 +0200482}
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200483
Gilles Peskine449bd832023-01-11 14:50:10 +0100484void mbedtls_ct_memcpy_offset(unsigned char *dest,
485 const unsigned char *src,
486 size_t offset,
487 size_t offset_min,
488 size_t offset_max,
489 size_t len)
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200490{
Gabor Mezei63bbba52021-10-18 16:17:57 +0200491 size_t offsetval;
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200492
Gilles Peskine449bd832023-01-11 14:50:10 +0100493 for (offsetval = offset_min; offsetval <= offset_max; offsetval++) {
494 mbedtls_ct_memcpy_if_eq(dest, src + offsetval, len,
495 offsetval, offset);
gabor-mezei-arm0e7f71e2021-09-27 13:57:45 +0200496 }
497}
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200498
Neil Armstrong2968d302022-02-25 15:09:36 +0100499#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100500
501#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100502#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100503#elif defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100504#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100505#else /* See check_config.h */
Gilles Peskine449bd832023-01-11 14:50:10 +0100506#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100507#endif
508
Gilles Peskine449bd832023-01-11 14:50:10 +0100509int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
510 psa_algorithm_t mac_alg,
511 const unsigned char *add_data,
512 size_t add_data_len,
513 const unsigned char *data,
514 size_t data_len_secret,
515 size_t min_data_len,
516 size_t max_data_len,
517 unsigned char *output)
Neil Armstrong2968d302022-02-25 15:09:36 +0100518{
519 /*
Neil Armstrong28d9c632022-03-17 16:33:27 +0100520 * This function breaks the HMAC abstraction and uses psa_hash_clone()
521 * extension in order to get constant-flow behaviour.
Neil Armstrong2968d302022-02-25 15:09:36 +0100522 *
523 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
524 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
525 * patterns (see RFC 2104, sec. 2).
526 *
527 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
528 * hashing up to minlen, then cloning the context, and for each byte up
529 * to maxlen finishing up the hash computation, keeping only the
530 * correct result.
531 *
532 * Then we only need to compute HASH(okey + inner_hash) and we're done.
533 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
535 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100536 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Neil Armstrong2968d302022-02-25 15:09:36 +0100538 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
539 size_t hash_length;
540
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100541 unsigned char aux_out[PSA_HASH_MAX_SIZE];
Neil Armstrong2968d302022-02-25 15:09:36 +0100542 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
543 size_t offset;
544 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
545
Neil Armstrong2968d302022-02-25 15:09:36 +0100546 size_t mac_key_length;
547 size_t i;
548
Gilles Peskine449bd832023-01-11 14:50:10 +0100549#define PSA_CHK(func_call) \
Neil Armstrong2968d302022-02-25 15:09:36 +0100550 do { \
551 status = (func_call); \
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 if (status != PSA_SUCCESS) \
553 goto cleanup; \
554 } while (0)
Neil Armstrong2968d302022-02-25 15:09:36 +0100555
Neil Armstrong72c2f762022-03-17 16:39:10 +0100556 /* Export MAC key
557 * We assume key length is always exactly the output size
558 * which is never more than the block size, thus we use block_size
559 * as the key buffer size.
560 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
Neil Armstrong2968d302022-02-25 15:09:36 +0100562
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100563 /* Calculate ikey */
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 for (i = 0; i < mac_key_length; i++) {
565 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
566 }
567 for (; i < block_size; ++i) {
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100568 key_buf[i] = 0x36;
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 }
Neil Armstrong2968d302022-02-25 15:09:36 +0100570
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 PSA_CHK(psa_hash_setup(&operation, hash_alg));
Neil Armstrong2968d302022-02-25 15:09:36 +0100572
573 /* Now compute inner_hash = HASH(ikey + msg) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
575 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
576 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
Neil Armstrong2968d302022-02-25 15:09:36 +0100577
Paul Elliott5260ce22022-05-09 18:15:54 +0100578 /* Fill the hash buffer in advance with something that is
579 * not a valid hash (barring an attack on the hash and
580 * deliberately-crafted input), in case the caller doesn't
581 * check the return status properly. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 memset(output, '!', hash_size);
Paul Elliott5260ce22022-05-09 18:15:54 +0100583
Neil Armstrong2968d302022-02-25 15:09:36 +0100584 /* For each possible length, compute the hash up to that point */
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 for (offset = min_data_len; offset <= max_data_len; offset++) {
586 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
587 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
588 PSA_HASH_MAX_SIZE, &hash_length));
Neil Armstrong2968d302022-02-25 15:09:36 +0100589 /* Keep only the correct inner_hash in the output buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 mbedtls_ct_memcpy_if_eq(output, aux_out, hash_size,
591 offset, data_len_secret);
Neil Armstrong2968d302022-02-25 15:09:36 +0100592
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 if (offset < max_data_len) {
594 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
595 }
Neil Armstrong2968d302022-02-25 15:09:36 +0100596 }
597
Neil Armstrong28d9c632022-03-17 16:33:27 +0100598 /* Abort current operation to prepare for final operation */
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 PSA_CHK(psa_hash_abort(&operation));
Neil Armstrong2968d302022-02-25 15:09:36 +0100600
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100601 /* Calculate okey */
Gilles Peskine449bd832023-01-11 14:50:10 +0100602 for (i = 0; i < mac_key_length; i++) {
603 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
604 }
605 for (; i < block_size; ++i) {
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100606 key_buf[i] = 0x5C;
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 }
Neil Armstrong9ebb9ff2022-03-17 17:04:37 +0100608
Neil Armstrong2968d302022-02-25 15:09:36 +0100609 /* Now compute HASH(okey + inner_hash) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 PSA_CHK(psa_hash_setup(&operation, hash_alg));
611 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
612 PSA_CHK(psa_hash_update(&operation, output, hash_size));
613 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
Neil Armstrong2968d302022-02-25 15:09:36 +0100614
615#undef PSA_CHK
616
617cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100618 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
619 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100620
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 psa_hash_abort(&operation);
622 psa_hash_abort(&aux_operation);
623 return psa_ssl_status_to_mbedtls(status);
Neil Armstrong2968d302022-02-25 15:09:36 +0100624}
Neil Armstrong36cc13b2022-03-17 16:36:52 +0100625
626#undef MAX_HASH_BLOCK_LENGTH
627
Neil Armstrong2968d302022-02-25 15:09:36 +0100628#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100629int mbedtls_ct_hmac(mbedtls_md_context_t *ctx,
630 const unsigned char *add_data,
631 size_t add_data_len,
632 const unsigned char *data,
633 size_t data_len_secret,
634 size_t min_data_len,
635 size_t max_data_len,
636 unsigned char *output)
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200637{
638 /*
639 * This function breaks the HMAC abstraction and uses the md_clone()
640 * extension to the MD API in order to get constant-flow behaviour.
641 *
642 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
643 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
644 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
645 *
646 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
647 * minlen, then cloning the context, and for each byte up to maxlen
648 * finishing up the hash computation, keeping only the correct result.
649 *
650 * Then we only need to compute HASH(okey + inner_hash) and we're done.
651 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 const mbedtls_md_type_t md_alg = mbedtls_md_get_type(ctx->md_info);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200653 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
654 * all of which have the same block size except SHA-384. */
655 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
656 const unsigned char * const ikey = ctx->hmac_ctx;
657 const unsigned char * const okey = ikey + block_size;
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 const size_t hash_size = mbedtls_md_get_size(ctx->md_info);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200659
660 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
661 mbedtls_md_context_t aux;
662 size_t offset;
663 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
664
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 mbedtls_md_init(&aux);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200666
Gilles Peskine449bd832023-01-11 14:50:10 +0100667#define MD_CHK(func_call) \
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200668 do { \
669 ret = (func_call); \
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 if (ret != 0) \
671 goto cleanup; \
672 } while (0)
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200673
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 MD_CHK(mbedtls_md_setup(&aux, ctx->md_info, 0));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200675
676 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
677 * so we can start directly with the message */
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 MD_CHK(mbedtls_md_update(ctx, add_data, add_data_len));
679 MD_CHK(mbedtls_md_update(ctx, data, min_data_len));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200680
Paul Elliott5260ce22022-05-09 18:15:54 +0100681 /* Fill the hash buffer in advance with something that is
682 * not a valid hash (barring an attack on the hash and
683 * deliberately-crafted input), in case the caller doesn't
684 * check the return status properly. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 memset(output, '!', hash_size);
Paul Elliott5260ce22022-05-09 18:15:54 +0100686
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200687 /* For each possible length, compute the hash up to that point */
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 for (offset = min_data_len; offset <= max_data_len; offset++) {
689 MD_CHK(mbedtls_md_clone(&aux, ctx));
690 MD_CHK(mbedtls_md_finish(&aux, aux_out));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200691 /* Keep only the correct inner_hash in the output buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 mbedtls_ct_memcpy_if_eq(output, aux_out, hash_size,
693 offset, data_len_secret);
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200694
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 if (offset < max_data_len) {
696 MD_CHK(mbedtls_md_update(ctx, data + offset, 1));
697 }
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200698 }
699
700 /* The context needs to finish() before it starts() again */
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 MD_CHK(mbedtls_md_finish(ctx, aux_out));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200702
703 /* Now compute HASH(okey + inner_hash) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 MD_CHK(mbedtls_md_starts(ctx));
705 MD_CHK(mbedtls_md_update(ctx, okey, block_size));
706 MD_CHK(mbedtls_md_update(ctx, output, hash_size));
707 MD_CHK(mbedtls_md_finish(ctx, output));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200708
709 /* Done, get ready for next time */
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 MD_CHK(mbedtls_md_hmac_reset(ctx));
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200711
712#undef MD_CHK
713
714cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 mbedtls_md_free(&aux);
716 return ret;
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200717}
Neil Armstrong2968d302022-02-25 15:09:36 +0100718#endif /* MBEDTLS_USE_PSA_CRYPTO */
gabor-mezei-arm1349ffd2021-09-27 14:28:31 +0200719
Przemek Stekiel89ad6232022-09-27 13:36:12 +0200720#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200721
722#if defined(MBEDTLS_BIGNUM_C)
723
Gilles Peskine449bd832023-01-11 14:50:10 +0100724#define MPI_VALIDATE_RET(cond) \
725 MBEDTLS_INTERNAL_VALIDATE_RET(cond, MBEDTLS_ERR_MPI_BAD_INPUT_DATA)
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200726
727/*
728 * Conditionally assign X = Y, without leaking information
729 * about whether the assignment was made or not.
730 * (Leaking information about the respective sizes of X and Y is ok however.)
731 */
Tautvydas Žilys40fc7da2022-01-31 13:34:01 -0800732#if defined(_MSC_VER) && defined(_M_ARM64) && (_MSC_FULL_VER < 193131103)
Tautvydas Žilys60165d72022-01-26 15:33:27 -0800733/*
Tautvydas Žilys40fc7da2022-01-31 13:34:01 -0800734 * MSVC miscompiles this function if it's inlined prior to Visual Studio 2022 version 17.1. See:
Tautvydas Žilys60165d72022-01-26 15:33:27 -0800735 * https://developercommunity.visualstudio.com/t/c-compiler-miscompiles-part-of-mbedtls-library-on/1646989
736 */
737__declspec(noinline)
738#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100739int mbedtls_mpi_safe_cond_assign(mbedtls_mpi *X,
740 const mbedtls_mpi *Y,
741 unsigned char assign)
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200742{
743 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100744 MPI_VALIDATE_RET(X != NULL);
745 MPI_VALIDATE_RET(Y != NULL);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200746
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200747 /* all-bits 1 if assign is 1, all-bits 0 if assign is 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 mbedtls_mpi_uint limb_mask = mbedtls_ct_mpi_uint_mask(assign);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200749
Gilles Peskine449bd832023-01-11 14:50:10 +0100750 MBEDTLS_MPI_CHK(mbedtls_mpi_grow(X, Y->n));
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200751
Gilles Peskine449bd832023-01-11 14:50:10 +0100752 X->s = mbedtls_ct_cond_select_sign(assign, Y->s, X->s);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200753
Gilles Peskine449bd832023-01-11 14:50:10 +0100754 mbedtls_mpi_core_cond_assign(X->p, Y->p, Y->n, assign);
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200755
Gilles Peskine449bd832023-01-11 14:50:10 +0100756 for (size_t i = Y->n; i < X->n; i++) {
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200757 X->p[i] &= ~limb_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 }
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200759
760cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 return ret;
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200762}
763
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200764/*
765 * Conditionally swap X and Y, without leaking information
766 * about whether the swap was made or not.
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800767 * Here it is not ok to simply swap the pointers, which would lead to
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200768 * different memory access patterns when X and Y are used afterwards.
769 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100770int mbedtls_mpi_safe_cond_swap(mbedtls_mpi *X,
771 mbedtls_mpi *Y,
772 unsigned char swap)
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200773{
Gabor Mezeid7edb1d2022-10-10 14:32:09 +0200774 int ret = 0;
775 int s;
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 MPI_VALIDATE_RET(X != NULL);
777 MPI_VALIDATE_RET(Y != NULL);
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200778
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 if (X == Y) {
780 return 0;
781 }
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200782
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 MBEDTLS_MPI_CHK(mbedtls_mpi_grow(X, Y->n));
784 MBEDTLS_MPI_CHK(mbedtls_mpi_grow(Y, X->n));
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200785
786 s = X->s;
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 X->s = mbedtls_ct_cond_select_sign(swap, Y->s, X->s);
788 Y->s = mbedtls_ct_cond_select_sign(swap, s, Y->s);
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200789
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 mbedtls_mpi_core_cond_swap(X->p, Y->p, X->n, swap);
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200791
792cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 return ret;
gabor-mezei-arm5c976212021-09-27 15:37:50 +0200794}
795
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200796/*
Janos Follath23bdeca2022-07-22 18:24:06 +0100797 * Compare unsigned values in constant time
798 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100799unsigned mbedtls_mpi_core_lt_ct(const mbedtls_mpi_uint *A,
800 const mbedtls_mpi_uint *B,
801 size_t limbs)
Janos Follath23bdeca2022-07-22 18:24:06 +0100802{
Janos Follath23bdeca2022-07-22 18:24:06 +0100803 unsigned ret, cond, done;
804
Janos Follath63184682022-08-11 17:42:59 +0100805 /* The value of any of these variables is either 0 or 1 for the rest of
806 * their scope. */
Janos Follath23bdeca2022-07-22 18:24:06 +0100807 ret = cond = done = 0;
808
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 for (size_t i = limbs; i > 0; i--) {
Janos Follath23bdeca2022-07-22 18:24:06 +0100810 /*
Janos Follathb7a88ec2022-08-19 12:24:40 +0100811 * If B[i - 1] < A[i - 1] then A < B is false and the result must
Janos Follath23bdeca2022-07-22 18:24:06 +0100812 * remain 0.
813 *
814 * Again even if we can make a decision, we just mark the result and
815 * the fact that we are done and continue looping.
816 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100817 cond = mbedtls_ct_mpi_uint_lt(B[i - 1], A[i - 1]);
Janos Follath23bdeca2022-07-22 18:24:06 +0100818 done |= cond;
819
820 /*
Janos Follathb7a88ec2022-08-19 12:24:40 +0100821 * If A[i - 1] < B[i - 1] then A < B is true.
Janos Follath23bdeca2022-07-22 18:24:06 +0100822 *
823 * Again even if we can make a decision, we just mark the result and
824 * the fact that we are done and continue looping.
825 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100826 cond = mbedtls_ct_mpi_uint_lt(A[i - 1], B[i - 1]);
827 ret |= cond & (1 - done);
Janos Follath23bdeca2022-07-22 18:24:06 +0100828 done |= cond;
829 }
830
831 /*
Janos Follathb7a88ec2022-08-19 12:24:40 +0100832 * If all the limbs were equal, then the numbers are equal, A < B is false
Janos Follath23bdeca2022-07-22 18:24:06 +0100833 * and leaving the result 0 is correct.
834 */
835
Gilles Peskine449bd832023-01-11 14:50:10 +0100836 return ret;
Janos Follath23bdeca2022-07-22 18:24:06 +0100837}
838
839/*
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200840 * Compare signed values in constant time
841 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100842int mbedtls_mpi_lt_mpi_ct(const mbedtls_mpi *X,
843 const mbedtls_mpi *Y,
844 unsigned *ret)
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200845{
846 size_t i;
847 /* The value of any of these variables is either 0 or 1 at all times. */
848 unsigned cond, done, X_is_negative, Y_is_negative;
849
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 MPI_VALIDATE_RET(X != NULL);
851 MPI_VALIDATE_RET(Y != NULL);
852 MPI_VALIDATE_RET(ret != NULL);
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200853
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 if (X->n != Y->n) {
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200855 return MBEDTLS_ERR_MPI_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 }
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200857
858 /*
859 * Set sign_N to 1 if N >= 0, 0 if N < 0.
860 * We know that N->s == 1 if N >= 0 and N->s == -1 if N < 0.
861 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100862 X_is_negative = (X->s & 2) >> 1;
863 Y_is_negative = (Y->s & 2) >> 1;
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200864
865 /*
866 * If the signs are different, then the positive operand is the bigger.
867 * That is if X is negative (X_is_negative == 1), then X < Y is true and it
868 * is false if X is positive (X_is_negative == 0).
869 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100870 cond = (X_is_negative ^ Y_is_negative);
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200871 *ret = cond & X_is_negative;
872
873 /*
874 * This is a constant-time function. We might have the result, but we still
875 * need to go through the loop. Record if we have the result already.
876 */
877 done = cond;
878
Gilles Peskine449bd832023-01-11 14:50:10 +0100879 for (i = X->n; i > 0; i--) {
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200880 /*
881 * If Y->p[i - 1] < X->p[i - 1] then X < Y is true if and only if both
882 * X and Y are negative.
883 *
884 * Again even if we can make a decision, we just mark the result and
885 * the fact that we are done and continue looping.
886 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100887 cond = mbedtls_ct_mpi_uint_lt(Y->p[i - 1], X->p[i - 1]);
888 *ret |= cond & (1 - done) & X_is_negative;
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200889 done |= cond;
890
891 /*
892 * If X->p[i - 1] < Y->p[i - 1] then X < Y is true if and only if both
893 * X and Y are positive.
894 *
895 * Again even if we can make a decision, we just mark the result and
896 * the fact that we are done and continue looping.
897 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 cond = mbedtls_ct_mpi_uint_lt(X->p[i - 1], Y->p[i - 1]);
899 *ret |= cond & (1 - done) & (1 - X_is_negative);
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200900 done |= cond;
901 }
902
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 return 0;
gabor-mezei-armc29a3da2021-09-27 15:41:30 +0200904}
905
gabor-mezei-arm40a49252021-09-27 15:33:35 +0200906#endif /* MBEDTLS_BIGNUM_C */
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200907
908#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C) && !defined(MBEDTLS_RSA_ALT)
909
Gilles Peskine449bd832023-01-11 14:50:10 +0100910int mbedtls_ct_rsaes_pkcs1_v15_unpadding(unsigned char *input,
911 size_t ilen,
912 unsigned char *output,
913 size_t output_max_len,
914 size_t *olen)
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200915{
916 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
917 size_t i, plaintext_max_size;
918
919 /* The following variables take sensitive values: their value must
920 * not leak into the observable behavior of the function other than
921 * the designated outputs (output, olen, return value). Otherwise
922 * this would open the execution of the function to
923 * side-channel-based variants of the Bleichenbacher padding oracle
924 * attack. Potential side channels include overall timing, memory
925 * access patterns (especially visible to an adversary who has access
926 * to a shared memory cache), and branches (especially visible to
927 * an adversary who has access to a shared code cache or to a shared
928 * branch predictor). */
929 size_t pad_count = 0;
930 unsigned bad = 0;
931 unsigned char pad_done = 0;
932 size_t plaintext_size = 0;
933 unsigned output_too_large;
934
Gilles Peskine449bd832023-01-11 14:50:10 +0100935 plaintext_max_size = (output_max_len > ilen - 11) ? ilen - 11
Gabor Mezei7013f622021-10-18 16:12:45 +0200936 : output_max_len;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200937
938 /* Check and get padding length in constant time and constant
939 * memory trace. The first byte must be 0. */
Gabor Mezei63bbba52021-10-18 16:17:57 +0200940 bad |= input[0];
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200941
942
943 /* Decode EME-PKCS1-v1_5 padding: 0x00 || 0x02 || PS || 0x00
Gabor Mezei63bbba52021-10-18 16:17:57 +0200944 * where PS must be at least 8 nonzero bytes. */
945 bad |= input[1] ^ MBEDTLS_RSA_CRYPT;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200946
947 /* Read the whole buffer. Set pad_done to nonzero if we find
Gabor Mezei63bbba52021-10-18 16:17:57 +0200948 * the 0x00 byte and remember the padding length in pad_count. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 for (i = 2; i < ilen; i++) {
950 pad_done |= ((input[i] | (unsigned char) -input[i]) >> 7) ^ 1;
951 pad_count += ((pad_done | (unsigned char) -pad_done) >> 7) ^ 1;
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200952 }
953
954
955 /* If pad_done is still zero, there's no data, only unfinished padding. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 bad |= mbedtls_ct_uint_if(pad_done, 0, 1);
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200957
958 /* There must be at least 8 bytes of padding. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 bad |= mbedtls_ct_size_gt(8, pad_count);
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200960
961 /* If the padding is valid, set plaintext_size to the number of
962 * remaining bytes after stripping the padding. If the padding
963 * is invalid, avoid leaking this fact through the size of the
964 * output: use the maximum message size that fits in the output
965 * buffer. Do it without branches to avoid leaking the padding
966 * validity through timing. RSA keys are small enough that all the
967 * size_t values involved fit in unsigned int. */
Gabor Mezei90437e32021-10-20 11:59:27 +0200968 plaintext_size = mbedtls_ct_uint_if(
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 bad, (unsigned) plaintext_max_size,
970 (unsigned) (ilen - pad_count - 3));
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200971
972 /* Set output_too_large to 0 if the plaintext fits in the output
973 * buffer and to 1 otherwise. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100974 output_too_large = mbedtls_ct_size_gt(plaintext_size,
975 plaintext_max_size);
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200976
977 /* Set ret without branches to avoid timing attacks. Return:
978 * - INVALID_PADDING if the padding is bad (bad != 0).
979 * - OUTPUT_TOO_LARGE if the padding is good but the decrypted
980 * plaintext does not fit in the output buffer.
981 * - 0 if the padding is correct. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 ret = -(int) mbedtls_ct_uint_if(
983 bad, -MBEDTLS_ERR_RSA_INVALID_PADDING,
984 mbedtls_ct_uint_if(output_too_large,
985 -MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE,
986 0));
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200987
988 /* If the padding is bad or the plaintext is too large, zero the
989 * data that we're about to copy to the output buffer.
990 * We need to copy the same amount of data
991 * from the same buffer whether the padding is good or not to
992 * avoid leaking the padding validity through overall timing or
993 * through memory or cache access patterns. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 bad = mbedtls_ct_uint_mask(bad | output_too_large);
995 for (i = 11; i < ilen; i++) {
Gabor Mezei63bbba52021-10-18 16:17:57 +0200996 input[i] &= ~bad;
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 }
gabor-mezei-armfdb71182021-09-27 16:11:12 +0200998
999 /* If the plaintext is too large, truncate it to the buffer size.
1000 * Copy anyway to avoid revealing the length through timing, because
1001 * revealing the length is as bad as revealing the padding validity
1002 * for a Bleichenbacher attack. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 plaintext_size = mbedtls_ct_uint_if(output_too_large,
1004 (unsigned) plaintext_max_size,
1005 (unsigned) plaintext_size);
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001006
1007 /* Move the plaintext to the leftmost position where it can start in
1008 * the working buffer, i.e. make it start plaintext_max_size from
1009 * the end of the buffer. Do this with a memory access trace that
1010 * does not depend on the plaintext size. After this move, the
1011 * starting location of the plaintext is no longer sensitive
1012 * information. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 mbedtls_ct_mem_move_to_left(input + ilen - plaintext_max_size,
1014 plaintext_max_size,
1015 plaintext_max_size - plaintext_size);
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001016
1017 /* Finally copy the decrypted plaintext plus trailing zeros into the output
1018 * buffer. If output_max_len is 0, then output may be an invalid pointer
1019 * and the result of memcpy() would be undefined; prevent undefined
1020 * behavior making sure to depend only on output_max_len (the size of the
1021 * user-provided output buffer), which is independent from plaintext
1022 * length, validity of padding, success of the decryption, and other
1023 * secrets. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 if (output_max_len != 0) {
1025 memcpy(output, input + ilen - plaintext_max_size, plaintext_max_size);
1026 }
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001027
1028 /* Report the amount of data we copied to the output buffer. In case
1029 * of errors (bad padding or output too large), the value of *olen
1030 * when this function returns is not specified. Making it equivalent
1031 * to the good case limits the risks of leaking the padding validity. */
1032 *olen = plaintext_size;
1033
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 return ret;
gabor-mezei-armfdb71182021-09-27 16:11:12 +02001035}
1036
1037#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C && ! MBEDTLS_RSA_ALT */