blob: 0cbb0ee41add09f5bd35be4ceb78f9aa25571f37 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020025 */
26
Bence Szépkúti2bb74562021-06-21 16:19:00 +020027/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010028 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020029 * config files.
30 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010031 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020032 * introduced the config format we want to be compatible with.
33 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020034//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020035
Paul Bakkerf3b86c12011-01-27 15:24:17 +000036/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000037 * \name SECTION: System support
38 *
39 * This section sets system specific settings.
40 * \{
41 */
42
Paul Bakkerf3b86c12011-01-27 15:24:17 +000043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000045 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020046 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000047 *
48 * Requires support for asm() in compiler.
49 *
50 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000051 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010052 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000053 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000054 * library/constant_time.c
55 * library/padlock.h
Paul Bakker68041ec2009-04-19 21:17:55 +000056 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010057 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000058 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010059 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010060 * MBEDTLS_PADLOCK_C
61 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020062 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000065
Paul Bakkerf3b86c12011-01-27 15:24:17 +000066/**
Gilles Peskineed942f82017-06-08 15:19:20 +020067 * \def MBEDTLS_NO_UDBL_DIVISION
68 *
69 * The platform lacks support for double-width integer division (64-bit
70 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
71 *
72 * Used in:
73 * include/mbedtls/bignum.h
74 * library/bignum.c
75 *
76 * The bignum code uses double-width division to speed up some operations.
77 * Double-width division is often implemented in software that needs to
78 * be linked with the program. The presence of a double-width integer
79 * type is usually detected automatically through preprocessor macros,
80 * but the automatic detection cannot know whether the code needs to
81 * and can be linked with an implementation of division for that type.
82 * By default division is assumed to be usable if the type is present.
83 * Uncomment this option to prevent the use of double-width division.
84 *
85 * Note that division for the native integer type is always required.
86 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010087 * platform, but it need not support multiplication or division. In some
88 * cases it is also desirable to disable some double-width operations. For
89 * example, if double-width division is implemented in software, disabling
90 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020091 */
92//#define MBEDTLS_NO_UDBL_DIVISION
93
94/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020095 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
96 *
97 * The platform lacks support for 32x32 -> 64-bit multiplication.
98 *
99 * Used in:
100 * library/poly1305.c
101 *
102 * Some parts of the library may use multiplication of two unsigned 32-bit
103 * operands with a 64-bit result in order to speed up computations. On some
104 * platforms, this is not available in hardware and has to be implemented in
105 * software, usually in a library provided by the toolchain.
106 *
107 * Sometimes it is not desirable to have to link to that library. This option
108 * removes the dependency of that library on platforms that lack a hardware
109 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
110 *
111 * Note that depending on the compiler, this may decrease performance compared
112 * to using the library function provided by the toolchain.
113 */
114//#define MBEDTLS_NO_64BIT_MULTIPLICATION
115
116/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200117 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000118 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000119 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000120 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000121 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200123//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200124
125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200127 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200128 * System has time.h and time().
129 * The time does not need to be correct, only time differences are used,
130 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200131 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100132 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
133 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
134 * MBEDTLS_PLATFORM_STD_TIME.
135 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400136 * Comment if your system does not support time functions.
137 *
138 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
139 * interface - timing.c will include time.h on suitable platforms
140 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
141 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200143#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100144
145/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200146 * \def MBEDTLS_HAVE_TIME_DATE
147 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100148 * System has time.h, time(), and an implementation for
149 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100150 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200151 * the date should be correct). This is used to verify the validity period of
152 * X.509 certificates.
153 *
154 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100155 *
Hanno Becker6a739782018-09-05 15:06:19 +0100156 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100157 * behaves similarly to the gmtime_r() function from the C standard. Refer to
158 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100159 *
160 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100161 * mbedtls_platform_gmtime_r() at compile-time by using the macro
162 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200163 */
164#define MBEDTLS_HAVE_TIME_DATE
165
166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100168 *
169 * Enable the memory allocation layer.
170 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200171 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100172 * This allows different allocators (self-implemented or provided) to be
173 * provided to the platform abstraction layer.
174 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400175 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200176 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
177 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000178 * free() function pointer at runtime.
179 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400180 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200181 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000182 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100183 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400184 * An overview of how the value of mbedtls_calloc is determined:
185 *
186 * - if !MBEDTLS_PLATFORM_MEMORY
187 * - mbedtls_calloc = calloc
188 * - if MBEDTLS_PLATFORM_MEMORY
189 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
190 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
191 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
192 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
193 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
194 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
195 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
196 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
197 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
198 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
199 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
200 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
201 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
202 *
203 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
204 * - if !MBEDTLS_PLATFORM_STD_CALLOC
205 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
206 *
207 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
208 *
209 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
210 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
211 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
212 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
213 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
214 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
215 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200216 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100217 *
218 * Enable this layer to allow use of alternative memory allocators.
219 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100221
222/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200223 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200224 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200225 * Do not assign standard functions in the platform layer (e.g. calloc() to
226 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200227 *
228 * This makes sure there are no linking errors on platforms that do not support
229 * these functions. You will HAVE to provide alternatives, either at runtime
230 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
232 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200233 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200235 *
236 * Uncomment to prevent default assignment of standard functions in the
237 * platform layer.
238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200240
241/**
Janos Follathc351d182016-03-21 08:43:59 +0000242 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100243 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200244 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100245 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100246 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200247 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200248 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100249 * alternative printf function pointer.
250 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100252 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200253 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
254 * it will be enabled automatically by check_config.h
255 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200256 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000258 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100259 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
260 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100261 * Uncomment a macro to enable alternate implementation of specific base
262 * platform function
263 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200264//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200265//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100266//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200267//#define MBEDTLS_PLATFORM_FPRINTF_ALT
268//#define MBEDTLS_PLATFORM_PRINTF_ALT
269//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200270//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100271//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100272//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800273//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100274
275/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200276 * Uncomment the macro to let Mbed TLS use your alternate implementation of
277 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
278 * platform_util.c.
279 *
280 * gmtime() is not a thread-safe function as defined in the C standard. The
281 * library will try to use safer implementations of this function, such as
282 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
283 * system, the implementation of mbedtls_platform_gmtime_r() will default to
284 * using the standard gmtime(). In this case, calls from the library to
285 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
286 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
287 * library are also guarded with this mutex to avoid race conditions. However,
288 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
289 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
290 * supplied at compile time.
291 */
292//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
293
294/**
Gilles Peskine86733832023-09-07 15:02:39 +0200295 * Uncomment the macro to let Mbed TLS use your alternate implementation of
296 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
297 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200298 *
Gilles Peskine86733832023-09-07 15:02:39 +0200299 * By default, the library uses a system function such as memset_s()
300 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
301 * SecureZeroMemory (Windows). If no such function is detected, the library
302 * falls back to a plain C implementation. Compilers are technically
303 * permitted to optimize this implementation out, meaning that the memory is
304 * not actually wiped. The library tries to prevent that, but the C language
305 * makes it impossible to guarantee that the memory will always be wiped.
306 *
307 * If your platform provides a guaranteed method to wipe memory which
308 * `platform_util.c` does not detect, define this macro to the name of
309 * a function that takes two arguments, a `void *` pointer and a length,
310 * and wipes that many bytes starting at the specified address. For example,
311 * if your platform has explicit_bzero() but `platform_util.c` does not
312 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
313 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200314 */
315//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
316
317/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100319 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000320 * Mark deprecated functions and features so that they generate a warning if
321 * used. Functionality deprecated in one version will usually be removed in the
322 * next version. You can enable this to help you prepare the transition to a
323 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100324 *
325 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200326 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000328 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100331
332/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200333 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100334 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000335 * Remove deprecated functions and features so that they generate an error if
336 * used. Functionality deprecated in one version will usually be removed in the
337 * next version. You can enable this to help you prepare the transition to a
338 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100339 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000340 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100341 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200342//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100343
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100344/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000345
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000346/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200347 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000348 *
349 * This section sets support for features that are or are not needed
350 * within the modules that are enabled.
351 * \{
352 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000353
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000354/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200355 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100356 *
TRodziewiczd8540832021-06-10 15:16:50 +0200357 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200358 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100359 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100361 *
362 * You will need to provide a header "timing_alt.h" and an implementation at
363 * compile time.
364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200365//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100366
367/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100368 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200369 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200370 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100371 * alternate core implementation of a symmetric crypto, an arithmetic or hash
372 * module (e.g. platform specific assembly optimized implementations). Keep
373 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200374 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200375 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200377 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200378 * Example: In case you uncomment MBEDTLS_AES_ALT, Mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000379 * provide the "struct mbedtls_aes_context" definition and omit the base
380 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200381 * "aes.h" to include the new function definitions.
382 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200383 * Uncomment a macro to enable alternate implementation of the corresponding
384 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100385 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200386 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100387 * use constitutes a security risk. If possible, we recommend
388 * avoiding dependencies on them, and considering stronger message
389 * digests and ciphers instead.
390 *
Paul Bakker90995b52013-06-24 19:20:35 +0200391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000393//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200395//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300396//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200397//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200398//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200399//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000400//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000401//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100402//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300403//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200404//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300405//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200406//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000407//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200408//#define MBEDTLS_SHA1_ALT
409//#define MBEDTLS_SHA256_ALT
410//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000411
Janos Follathb0697532016-08-18 12:38:46 +0100412/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800413 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100414 * implemented with two .c files:
415 * - ecp.c
416 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000417 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
418 * macros as described above. The only difference is that you have to make sure
419 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100420 */
421//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200422
423/**
TRodziewicz75628d52021-06-18 12:56:27 +0200424 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200425 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200426 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100427 * alternate core implementation of symmetric crypto or hash function. Keep in
428 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200429 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200430 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200432 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200433 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200434 * no longer provide the mbedtls_sha1_process() function, but it will still provide
435 * the other function (using your mbedtls_sha1_process() function) and the definition
436 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200437 * with this definition.
438 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200439 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100440 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
441 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200442 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200443 * Uncomment a macro to enable alternate implementation of the corresponding
444 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100445 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200446 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100447 * constitutes a security risk. If possible, we recommend avoiding
448 * dependencies on them, and considering stronger message digests
449 * and ciphers instead.
450 *
Janos Follath1231d212019-01-07 15:01:32 +0000451 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
452 * enabled, then the deterministic ECDH signature functions pass the
453 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
454 * alternative implementations should use the RNG only for generating
455 * the ephemeral key and nothing else. If this is not possible, then
456 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200457 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000458 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200459 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200460//#define MBEDTLS_MD5_PROCESS_ALT
461//#define MBEDTLS_RIPEMD160_PROCESS_ALT
462//#define MBEDTLS_SHA1_PROCESS_ALT
463//#define MBEDTLS_SHA256_PROCESS_ALT
464//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200465//#define MBEDTLS_DES_SETKEY_ALT
466//#define MBEDTLS_DES_CRYPT_ECB_ALT
467//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200468//#define MBEDTLS_AES_SETKEY_ENC_ALT
469//#define MBEDTLS_AES_SETKEY_DEC_ALT
470//#define MBEDTLS_AES_ENCRYPT_ALT
471//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300472//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300473//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300474//#define MBEDTLS_ECDSA_VERIFY_ALT
475//#define MBEDTLS_ECDSA_SIGN_ALT
476//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200477
478/**
Janos Follathc44ab972016-11-18 16:38:23 +0000479 * \def MBEDTLS_ECP_INTERNAL_ALT
480 *
481 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100482 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200483 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100484 * alternative core implementation of elliptic curve arithmetic. Keep in mind
485 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100486 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200487 * This partially replaces one function. The header file from Mbed TLS is still
Janos Follathb0697532016-08-18 12:38:46 +0100488 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
489 * is still present and it is used for group structures not supported by the
490 * alternative.
491 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100492 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100493 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100494 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
495 * able to fallback to curves not supported by the alternative implementation.
496 *
Janos Follathc44ab972016-11-18 16:38:23 +0000497 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
498 * and implementing the following functions:
499 * unsigned char mbedtls_internal_ecp_grp_capable(
500 * const mbedtls_ecp_group *grp )
501 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500502 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000503 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
504 * replacement functions implement arithmetic for the given group and 0
505 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500506 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000507 * called before and after each point operation and provide an opportunity to
508 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100509 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100510 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200511 * MBEDTLS_ECP_DOUBLE_JAC_ALT, Mbed TLS will still provide the ecp_double_jac()
Steven Cooreman6226a122021-01-21 13:58:31 +0100512 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
513 * for the operation is supported by your implementation (i.e. your
514 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200515 * group is not supported by your implementation, then the original Mbed TLS
Steven Cooreman6226a122021-01-21 13:58:31 +0100516 * implementation of ecp_double_jac() is used instead, unless this fallback
517 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
518 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
519 *
520 * The function prototypes and the definition of mbedtls_ecp_group and
521 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
522 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
523 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100524 *
525 * Uncomment a macro to enable alternate implementation of the corresponding
526 * function.
527 */
528/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000529//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100530/* Turn off software fallback for curves not supported in hardware */
531//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100532/* Support for Weierstrass curves with Jacobi representation */
533//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
534//#define MBEDTLS_ECP_ADD_MIXED_ALT
535//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
536//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
537//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
538/* Support for curves with Montgomery arithmetic */
539//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
540//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
541//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
542
543/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200544 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200545 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200546 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200547 * hardware entropy collector.
548 *
549 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000550 * prototype as declared in library/entropy_poll.h, and accept NULL as first
551 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200552 *
553 * Uncomment to use your own hardware entropy collector.
554 */
555//#define MBEDTLS_ENTROPY_HARDWARE_ALT
556
557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000559 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100560 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000561 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100562 * Uncomment this macro to use precomputed AES tables stored in ROM.
563 * Comment this macro to generate AES tables in RAM at runtime.
564 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100565 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
566 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100567 * initialization time before the first AES operation can be performed.
568 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
569 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
570 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100571 *
572 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000575
576/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100577 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200578 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100579 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200580 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100581 * Uncommenting this macro omits 75% of the AES tables from
582 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
583 * by computing their values on the fly during operations
584 * (the tables are entry-wise rotations of one another).
585 *
586 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100587 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100588 * runtime. Specifically, one has to compare 4 accesses within
589 * different tables to 4 accesses with additional arithmetic
590 * operations within the same table. The performance gain/loss
591 * depends on the system and memory details.
592 *
593 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200594 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100595//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200596
597/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800598 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
599 *
600 * Use only 128-bit keys in AES operations to save ROM.
601 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800602 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800603 * or 256-bit keys.
604 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800605 * Uncommenting this macro reduces the size of AES code by ~300 bytes
606 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800607 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800608 * Module: library/aes.c
609 *
610 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800611 */
612//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
613
Gilles Peskinea8861e02023-09-05 20:20:51 +0200614/*
615 * Disable plain C implementation for AES.
616 *
617 * When the plain C implementation is enabled, and an implementation using a
618 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
619 * detection will be used to select between them.
620 *
621 * If only one implementation is present, runtime detection will not be used.
622 * This configuration will crash at runtime if running on a CPU without the
623 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
624 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
625 */
626//#define MBEDTLS_AES_USE_HARDWARE_ONLY
627
Arto Kinnunen732ca322023-04-14 14:26:10 +0800628/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200630 *
631 * Use less ROM for the Camellia implementation (saves about 768 bytes).
632 *
633 * Uncomment this macro to use less memory for Camellia.
634 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200635//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200636
637/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200638 * \def MBEDTLS_CHECK_RETURN_WARNING
639 *
640 * If this macro is defined, emit a compile-time warning if application code
641 * calls a function without checking its return value, but the return value
642 * should generally be checked in portable applications.
643 *
644 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
645 * implemented. Otherwise this option has no effect.
646 *
647 * Uncomment to get warnings on using fallible functions without checking
648 * their return value.
649 *
650 * \note This feature is a work in progress.
651 * Warnings will be added to more functions in the future.
652 *
653 * \note A few functions are considered critical, and ignoring the return
654 * value of these functions will trigger a warning even if this
655 * macro is not defined. To completely disable return value check
656 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
657 */
658//#define MBEDTLS_CHECK_RETURN_WARNING
659
660/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200662 *
663 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200666
667/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200668 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000669 *
670 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
671 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000673
674/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000676 *
677 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000680
681/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100682 * \def MBEDTLS_CIPHER_MODE_OFB
683 *
684 * Enable Output Feedback mode (OFB) for symmetric ciphers.
685 */
686#define MBEDTLS_CIPHER_MODE_OFB
687
688/**
689 * \def MBEDTLS_CIPHER_MODE_XTS
690 *
691 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
692 */
693#define MBEDTLS_CIPHER_MODE_XTS
694
695/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200696 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000697 *
698 * Enable NULL cipher.
699 * Warning: Only do so when you know what you are doing. This allows for
700 * encryption or channels without any security!
701 *
Ronald Croncee42702021-04-26 11:34:44 +0200702 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
704 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
705 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
706 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
707 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
708 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
709 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
710 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
711 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
712 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
713 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
714 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
715 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
716 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
717 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
718 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
719 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
720 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
721 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000722 *
723 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000724 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000726
727/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100728 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200729 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100730 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
731 * specific padding modes in the cipher layer with cipher modes that support
732 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200733 *
734 * If you disable all padding modes, only full blocks can be used with CBC.
735 *
736 * Enable padding modes in the cipher layer.
737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738#define MBEDTLS_CIPHER_PADDING_PKCS7
739#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
740#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
741#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200742
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200743/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
744 *
745 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800746 * Without this, CTR_DRBG uses a 256-bit key
747 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200748 */
749//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
750
Paul Bakker48e93c82013-08-14 12:21:18 +0200751/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200752 * Enable the verified implementations of ECDH primitives from Project Everest
753 * (currently only Curve25519). This feature changes the layout of ECDH
754 * contexts and therefore is a compatibility break for applications that access
755 * fields of a mbedtls_ecdh_context structure directly. See also
756 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
757 */
758//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
759
760/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100761 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200762 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100763 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
764 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200765 *
766 * Comment macros to disable the curve and functions for it
767 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200768/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
770#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
771#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
772#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
773#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
774#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
775#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
776#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
777#define MBEDTLS_ECP_DP_BP256R1_ENABLED
778#define MBEDTLS_ECP_DP_BP384R1_ENABLED
779#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200780/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200781#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000782#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200783
784/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200786 *
787 * Enable specific 'modulo p' routines for each NIST prime.
788 * Depending on the prime and architecture, makes operations 4 to 8 times
789 * faster on the corresponding curve.
790 *
791 * Comment this macro to disable NIST curves optimisation.
792 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200793#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200794
795/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200796 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100797 *
798 * Enable "non-blocking" ECC operations that can return early and be resumed.
799 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200800 * This allows various functions to pause by returning
801 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
802 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
803 * order to further progress and eventually complete their operation. This is
804 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
805 * number of ECC operations a function may perform before pausing; see
806 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100807 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200808 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200809 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100810 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100811 * This option:
812 * - Adds xxx_restartable() variants of existing operations in the
813 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100814 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
815 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100816 * - ECDSA: signature generation & verification;
817 * - PK: signature generation & verification;
818 * - X509: certificate chain verification.
819 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
820 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
821 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
822 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000823 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100824 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100825 * - verification of the server's key exchange signature;
826 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100827 * - generation of the client's signature if client authentication is used,
828 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100829 *
830 * \note In the cases above, the usual SSL/TLS functions, such as
831 * mbedtls_ssl_handshake(), can now return
832 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200833 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100834 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
835 * restartable operations in PK, X.509 and TLS (see above) are not
836 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100837 * PSA, and are not restartable. These are temporary limitations that
838 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200839 *
Ron Eldor19779c42018-11-05 16:58:13 +0200840 * \note This option only works with the default software implementation of
841 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100842 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100843 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100844 * Requires: MBEDTLS_ECP_C
845 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100846 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100847 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200848//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100849
850/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200851 * Uncomment to enable using new bignum code in the ECC modules.
852 *
853 * \warning This is currently experimental, incomplete and therefore should not
854 * be used in production.
855 */
856//#define MBEDTLS_ECP_WITH_MPI_UINT
857
858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100860 *
861 * Enable deterministic ECDSA (RFC 6979).
862 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
863 * may result in a compromise of the long-term signing key. This is avoided by
864 * the deterministic variant.
865 *
John Durkop36a82e52020-10-26 09:39:05 -0700866 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100867 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100868 * Comment this macro to disable deterministic ECDSA.
869 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100871
872/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200873 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200874 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200875 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200876 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200877 * This enables the following ciphersuites (if other requisites are
878 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
880 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
881 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
882 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
883 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
884 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
885 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
886 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
887 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
888 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200891
892/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200893 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200894 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200895 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200896 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200898 *
899 * This enables the following ciphersuites (if other requisites are
900 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
902 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
903 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
904 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
905 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
906 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
907 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
908 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
909 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
910 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100911 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100912 * \warning Using DHE constitutes a security risk as it
913 * is not possible to validate custom DH parameters.
914 * If possible, it is recommended users should consider
915 * preferring other methods of key exchange.
916 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100917 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200918 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200919#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200920
921/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200922 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200923 *
924 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
925 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200926 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200927 *
928 * This enables the following ciphersuites (if other requisites are
929 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
931 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
932 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
933 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
934 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
935 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200938
939/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200941 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200942 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200943 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200944 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
945 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200946 *
947 * This enables the following ciphersuites (if other requisites are
948 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
950 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
951 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
952 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
953 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
954 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
955 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
956 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
957 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
958 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200959 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200960#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200961
962/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200963 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200964 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200965 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200966 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
968 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200969 *
970 * This enables the following ciphersuites (if other requisites are
971 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
973 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
974 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
975 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
976 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
977 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
978 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
979 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
980 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
981 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
982 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
983 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200986
987/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200989 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200990 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200991 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
993 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200994 *
995 * This enables the following ciphersuites (if other requisites are
996 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
998 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
999 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1000 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1001 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1002 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1003 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1004 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1005 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1006 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1007 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1008 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +01001009 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001010 * \warning Using DHE constitutes a security risk as it
1011 * is not possible to validate custom DH parameters.
1012 * If possible, it is recommended users should consider
1013 * preferring other methods of key exchange.
1014 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001015 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001018
1019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001021 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001022 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001023 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001024 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1025 * MBEDTLS_RSA_C
1026 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001028 *
1029 * This enables the following ciphersuites (if other requisites are
1030 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1032 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1033 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1034 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1035 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1036 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1037 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1038 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1039 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1040 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +02001041 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001043
1044/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001046 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001047 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001048 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001049 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1050 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1051 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001052 *
1053 * This enables the following ciphersuites (if other requisites are
1054 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1056 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1057 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1058 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1059 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1060 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1061 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1062 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1063 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1064 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001067
1068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001070 *
1071 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1072 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001073 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1074 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1075 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001076 *
1077 * This enables the following ciphersuites (if other requisites are
1078 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1080 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1081 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1082 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1083 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1084 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1085 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1086 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1087 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1088 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001091
1092/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001093 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001094 *
1095 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1096 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001097 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1098 * MBEDTLS_RSA_C
1099 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001100 *
1101 * This enables the following ciphersuites (if other requisites are
1102 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1104 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1105 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1106 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1107 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1108 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1109 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1110 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1111 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1112 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001113 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001115
1116/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001117 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1118 *
1119 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1120 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001121 * \warning This is currently experimental. EC J-PAKE support is based on the
1122 * Thread v1.0.0 specification; incompatible changes to the specification
1123 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001124 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001125 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001126 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001127 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1128 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001129 * \warning If SHA-256 is provided only by a PSA driver, you must call
1130 * psa_crypto_init() before the first hanshake (even if
1131 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1132 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001133 * This enables the following ciphersuites (if other requisites are
1134 * enabled as well):
1135 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1136 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001137//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001138
1139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001141 *
1142 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1143 * RFC 5915 and RFC 5480.
1144 *
1145 * Currently this means parsing the SpecifiedECDomain choice of EC
1146 * parameters (only known groups are supported, not arbitrary domains, to
1147 * avoid validation issues).
1148 *
1149 * Disable if you only need to support RFC 5915 + 5480 key formats.
1150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001152
1153/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001154 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1155 *
1156 * Enable the support for parsing public keys of type Short Weierstrass
1157 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001158 * compressed point format. This parsing is done through ECP module's functions.
1159 *
1160 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1161 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1162 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001163 */
1164#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1165
1166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001168 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 * Enable a dummy error function to make use of mbedtls_strerror() in
1170 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1171 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001172 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1174 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001175 *
1176 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001178 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001180
1181/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001182 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001183 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001184 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001185 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001189
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001190/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001192 *
1193 * Enable functions that use the filesystem.
1194 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001196
1197/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001199 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001200 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001201 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001202 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001203 * application.
1204 *
1205 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001208
1209/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001210 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001211 *
1212 * Do not use built-in platform entropy functions.
1213 * This is useful if your platform does not support
1214 * standards like the /dev/urandom or Windows CryptoAPI.
1215 *
1216 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001217 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001219
1220/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001222 *
1223 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1224 * default SHA-512 based one (if both are available).
1225 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001227 *
1228 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1229 * if you have performance concerns.
1230 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231 * This option is only useful if both MBEDTLS_SHA256_C and
1232 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001234//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001235
1236/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001237 * \def MBEDTLS_ENTROPY_NV_SEED
1238 *
1239 * Enable the non-volatile (NV) seed file-based entropy source.
1240 * (Also enables the NV seed read/write functions in the platform layer)
1241 *
1242 * This is crucial (if not required) on systems that do not have a
1243 * cryptographic entropy source (in hardware or kernel) available.
1244 *
1245 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1246 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001247 * \note The read/write functions that are used by the entropy source are
1248 * determined in the platform layer, and can be modified at runtime and/or
1249 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1250 *
1251 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001252 * with regular fopen(), please make sure you make a seedfile with the
1253 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1254 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001255 * and written to or you will get an entropy source error! The default
1256 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1257 * bytes from the file.
1258 *
1259 * \note The entropy collector will write to the seed file before entropy is
1260 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001261 */
1262//#define MBEDTLS_ENTROPY_NV_SEED
1263
Ronald Cron71016a92020-08-28 19:01:50 +02001264/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001265 *
Ronald Cron71016a92020-08-28 19:01:50 +02001266 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001267 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001268 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1269 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001270 *
1271 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001272 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001273 */
Ronald Cron71016a92020-08-28 19:01:50 +02001274//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001275
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001276/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001278 *
1279 * Enable debugging of buffer allocator memory issues. Automatically prints
1280 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1281 * function for 'debug output' of allocated memory.
1282 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001283 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001284 *
1285 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001286 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001287//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001288
1289/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001290 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001291 *
1292 * Include backtrace information with each allocated block.
1293 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001294 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001295 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001296 *
1297 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001300
1301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001303 *
1304 * Support external private RSA keys (eg from a HSM) in the PK layer.
1305 *
1306 * Comment this macro to disable support for external private RSA keys.
1307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001309
1310/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001311 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001312 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001313 * Enable support for PKCS#1 v1.5 encoding.
1314 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001315 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001316 *
Paul Bakker48377d92013-08-30 12:06:24 +02001317 * This enables support for PKCS#1 v1.5 operations.
1318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001320
1321/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001323 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001324 * Enable support for PKCS#1 v2.1 encoding.
1325 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001326 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001327 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001328 * \warning If using a hash that is only provided by PSA drivers, you must
1329 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001330 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001331 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1332 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001334
Steven Cooreman6801f082021-02-19 17:21:22 +01001335/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1336 *
1337 * Enable support for platform built-in keys. If you enable this feature,
1338 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1339 * See the documentation of that function for more information.
1340 *
1341 * Built-in keys are typically derived from a hardware unique key or
1342 * stored in a secure element.
1343 *
1344 * Requires: MBEDTLS_PSA_CRYPTO_C.
1345 *
1346 * \warning This interface is experimental and may change or be removed
1347 * without notice.
1348 */
1349//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1350
Ronald Cron3768ac12021-01-26 16:58:00 +01001351/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1352 *
1353 * Enable support for PSA crypto client.
1354 *
1355 * \note This option allows to include the code necessary for a PSA
1356 * crypto client when the PSA crypto implementation is not included in
1357 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1358 * code to set and get PSA key attributes.
1359 * The development of PSA drivers partially relying on the library to
1360 * fulfill the hardware gaps is another possible usage of this option.
1361 *
1362 * \warning This interface is experimental and may change or be removed
1363 * without notice.
1364 */
1365//#define MBEDTLS_PSA_CRYPTO_CLIENT
1366
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001367/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1368 *
1369 * Make the PSA Crypto module use an external random generator provided
1370 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1371 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001372 * \note This random generator must deliver random numbers with cryptographic
1373 * quality and high performance. It must supply unpredictable numbers
1374 * with a uniform distribution. The implementation of this function
1375 * is responsible for ensuring that the random generator is seeded
1376 * with sufficient entropy. If you have a hardware TRNG which is slow
1377 * or delivers non-uniform output, declare it as an entropy source
1378 * with mbedtls_entropy_add_source() instead of enabling this option.
1379 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001380 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001381 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1382 * and define a function called mbedtls_psa_external_get_random()
1383 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001384 * ```
1385 * psa_status_t mbedtls_psa_external_get_random(
1386 * mbedtls_psa_external_random_context_t *context,
1387 * uint8_t *output, size_t output_size, size_t *output_length);
1388 * );
1389 * ```
1390 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001391 * The function must fill the \c output buffer with \c output_size bytes
1392 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001393 *
1394 * Requires: MBEDTLS_PSA_CRYPTO_C
1395 *
1396 * \warning If you enable this option, code that uses the PSA cryptography
1397 * interface will not use any of the entropy sources set up for
1398 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1399 * enables.
1400 *
1401 * \note This option is experimental and may be removed without notice.
1402 */
1403//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1404
Paul Bakker9dcc3222011-03-08 14:16:06 +00001405/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001406 * \def MBEDTLS_PSA_CRYPTO_SPM
1407 *
1408 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1409 * Partition Manager) integration which separates the code into two parts: a
1410 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1411 * Environment).
1412 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001413 * If you enable this option, your build environment must include a header
1414 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1415 * header files, or in another directory on the compiler's include search
1416 * path). Alternatively, your platform may customize the header
1417 * `psa/crypto_platform.h`, in which case it can skip or replace the
1418 * inclusion of `"crypto_spe.h"`.
1419 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001420 * Module: library/psa_crypto.c
1421 * Requires: MBEDTLS_PSA_CRYPTO_C
1422 *
1423 */
1424//#define MBEDTLS_PSA_CRYPTO_SPM
1425
1426/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001427 * Uncomment to enable p256-m. This is an alternative implementation of
1428 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1429 * Compared to the default implementation:
1430 *
1431 * - p256-m has a much smaller code size and RAM footprint.
1432 * - p256-m is only available via the PSA API. This includes the pk module
1433 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1434 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1435 * over the core arithmetic, or deterministic derivation of keys.
1436 *
1437 * We recommend enabling this option if your application uses the PSA API
1438 * and the only elliptic curve support it needs is ECDH and ECDSA over
1439 * SECP256R1.
1440 *
1441 * If you enable this option, you do not need to enable any ECC-related
1442 * MBEDTLS_xxx option. You do need to separately request support for the
1443 * cryptographic mechanisms through the PSA API:
1444 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1445 * configuration;
1446 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1447 * - #PSA_WANT_ECC_SECP_R1_256;
1448 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1449 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1450 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1451 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1452 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001453 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001454 * \note To benefit from the smaller code size of p256-m, make sure that you
1455 * do not enable any ECC-related option not supported by p256-m: this
1456 * would cause the built-in ECC implementation to be built as well, in
1457 * order to provide the required option.
1458 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001459 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1460 * SECP256R1 are disabled as they are not supported by this driver.
1461 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1462 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001463 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001464 */
1465//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1466
1467/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001468 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001469 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001470 * Enable support for entropy injection at first boot. This feature is
1471 * required on systems that do not have a built-in entropy source (TRNG).
1472 * This feature is currently not supported on systems that have a built-in
1473 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001474 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001475 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001476 *
1477 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001478//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001479
1480/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001481 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001482 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001483 * Do not use the Chinese Remainder Theorem
1484 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001485 *
1486 * Uncomment this macro to disable the use of CRT in RSA.
1487 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001489//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001490
1491/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001492 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001493 *
1494 * Enable the checkup functions (*_self_test).
1495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001496#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001497
1498/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001499 * \def MBEDTLS_SHA256_SMALLER
1500 *
1501 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1502 * lower performance.
1503 *
Adam Wolf039080f2019-09-10 09:53:08 -05001504 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001505 * performance and size. This version optimizes more aggressively for size at
1506 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1507 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1508 * 30%.
1509 *
1510 * Uncomment to enable the smaller implementation of SHA256.
1511 */
1512//#define MBEDTLS_SHA256_SMALLER
1513
1514/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001515 * \def MBEDTLS_SHA512_SMALLER
1516 *
1517 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1518 * lower performance.
1519 *
1520 * Uncomment to enable the smaller implementation of SHA512.
1521 */
1522//#define MBEDTLS_SHA512_SMALLER
1523
1524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001525 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001526 *
1527 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001528 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001529 * with other servers, only debugging of failures is harder.
1530 *
1531 * The advantage of not sending alert messages, is that no information is given
1532 * about reasons for failures thus preventing adversaries of gaining intel.
1533 *
1534 * Enable sending of all alert messages
1535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001537
1538/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001539 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1540 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001541 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001542 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001543 * in the underlying transport. The CID functionality is described
1544 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001545 *
1546 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001547 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1548 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1549 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001550 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001551 * The maximum lengths of outgoing and incoming CIDs can be configured
1552 * through the options
1553 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1554 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1555 *
1556 * Requires: MBEDTLS_SSL_PROTO_DTLS
1557 *
1558 * Uncomment to enable the Connection ID extension.
1559 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001560#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1561
1562
1563/**
1564 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1565 *
1566 * Defines whether RFC 9146 (default) or the legacy version
1567 * (version draft-ietf-tls-dtls-connection-id-05,
1568 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1569 * is used.
1570 *
1571 * Set the value to 0 for the standard version, and
1572 * 1 for the legacy draft version.
1573 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001574 * \deprecated Support for the legacy version of the DTLS
1575 * Connection ID feature is deprecated. Please
1576 * switch to the standardized version defined
1577 * in RFC 9146 enabled by utilizing
1578 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1579 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1580 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001581 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1582 */
1583#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001584
1585/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001586 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1587 *
1588 * Enable asynchronous external private key operations in SSL. This allows
1589 * you to configure an SSL connection to call an external cryptographic
1590 * module to perform private key operations instead of performing the
1591 * operation inside the library.
1592 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001593 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001594 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001595//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001596
1597/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001598 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1599 *
1600 * Enable serialization of the TLS context structures, through use of the
1601 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1602 *
1603 * This pair of functions allows one side of a connection to serialize the
1604 * context associated with the connection, then free or re-use that context
1605 * while the serialized state is persisted elsewhere, and finally deserialize
1606 * that state to a live context for resuming read/write operations on the
1607 * connection. From a protocol perspective, the state of the connection is
1608 * unaffected, in particular this is entirely transparent to the peer.
1609 *
1610 * Note: this is distinct from TLS session resumption, which is part of the
1611 * protocol and fully visible by the peer. TLS session resumption enables
1612 * establishing new connections associated to a saved session with shorter,
1613 * lighter handshakes, while context serialization is a local optimization in
1614 * handling a single, potentially long-lived connection.
1615 *
1616 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1617 * saved after the handshake to allow for more efficient serialization, so if
1618 * you don't need this feature you'll save RAM by disabling it.
1619 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001620 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1621 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001622 * Comment to disable the context serialization APIs.
1623 */
1624#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1625
1626/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001627 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001628 *
1629 * Enable the debug messages in SSL module for all issues.
1630 * Debug messages have been disabled in some places to prevent timing
1631 * attacks due to (unbalanced) debugging function calls.
1632 *
1633 * If you need all error reporting you should enable this during debugging,
1634 * but remove this for production servers that should log as well.
1635 *
1636 * Uncomment this macro to report all debug messages on errors introducing
1637 * a timing side-channel.
1638 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001639 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001643 *
1644 * Enable support for Encrypt-then-MAC, RFC 7366.
1645 *
1646 * This allows peers that both support it to use a more robust protection for
1647 * ciphersuites using CBC, providing deep resistance against timing attacks
1648 * on the padding or underlying cipher.
1649 *
1650 * This only affects CBC ciphersuites, and is useless if none is defined.
1651 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001652 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001653 *
1654 * Comment this macro to disable support for Encrypt-then-MAC
1655 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001656#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001657
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001658/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001659 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001660 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1661 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001662 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001663 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001664 * attacks, but it is recommended to always use it (even if you disable
1665 * renegotiation), since it actually fixes a more fundamental issue in the
1666 * original SSL/TLS design, and has implications beyond Triple Handshake.
1667 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001668 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001669 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001670 * Comment this macro to disable support for Extended Master Secret.
1671 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001672#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001673
Paul Bakkerd66f0702013-01-31 16:57:45 +01001674/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001675 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1676 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001677 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001678 * giving access to the peer's certificate after completion of the handshake.
1679 *
1680 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1681 * recommended to disable this option for reduced RAM usage.
1682 *
1683 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1684 * defined, but always returns \c NULL.
1685 *
1686 * \note This option has no influence on the protection against the
1687 * triple handshake attack. Even if it is disabled, Mbed TLS will
1688 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001689 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001690 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001691 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001692 *
1693 * Comment this macro to disable storing the peer's certificate
1694 * after the handshake.
1695 */
1696#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1697
1698/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001700 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001701 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001702 *
1703 * The two main uses of renegotiation are (1) refresh keys on long-lived
1704 * connections and (2) client authentication after the initial handshake.
1705 * If you don't need renegotiation, it's probably better to disable it, since
1706 * it has been associated with security issues in the past and is easy to
1707 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001708 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001709 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1710 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001711 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001712 *
1713 * \note Even if this option is disabled, both client and server are aware
1714 * of the Renegotiation Indication Extension (RFC 5746) used to
1715 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1716 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1717 * configuration of this extension).
1718 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001719 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001721
1722/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001724 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001725 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001726 *
1727 * Comment this macro to disable support for the max_fragment_length extension
1728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001730
1731/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001732 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1733 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001734 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001735 *
1736 * \warning This extension is currently in development and must NOT be used except
1737 * for testing purposes.
1738 *
1739 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1740 *
1741 * Uncomment this macro to enable support for the record_size_limit extension
1742 */
1743//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1744
1745/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001747 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001748 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001749 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001750 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001751 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1752 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001753 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001754 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001755 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001756 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1757 * are only provided by PSA drivers, you must call psa_crypto_init() before
1758 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001759 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001760 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001762#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001763
1764/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001765 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001766 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001767 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001768 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001769 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001770 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001771 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001772 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001773 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001774 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001775 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1776 * directly performed by TLS 1.3 code. As a consequence, you must
1777 * call psa_crypto_init() before the first TLS 1.3 handshake.
1778 *
1779 * \note Cryptographic operations performed indirectly via another module
1780 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1781 * running handshake hash) only use PSA crypto if
1782 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001783 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001784 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001785 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001786//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001787
1788/**
Ronald Cronab65c522021-11-24 10:47:20 +01001789 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1790 *
1791 * Enable TLS 1.3 middlebox compatibility mode.
1792 *
1793 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1794 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1795 * expecting TLS 1.2 traffic.
1796 *
1797 * Turning on the compatibility mode comes at the cost of a few added bytes
1798 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1799 * that don't use it. Therefore, unless transmission bandwidth is critical and
1800 * you know that middlebox compatibility issues won't occur, it is therefore
1801 * recommended to set this option.
1802 *
1803 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001804 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1805 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001806 *
1807 */
1808//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1809
1810/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001811 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1812 *
1813 * Enable TLS 1.3 PSK key exchange mode.
1814 *
1815 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1816 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1817 * effect on the build.
1818 *
1819 */
1820#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1821
1822/**
1823 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1824 *
1825 * Enable TLS 1.3 ephemeral key exchange mode.
1826 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001827 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001828 * MBEDTLS_X509_CRT_PARSE_C
1829 * and at least one of:
1830 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1831 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001832 *
1833 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1834 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1835 * effect on the build.
1836 *
1837 */
1838#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1839
1840/**
1841 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1842 *
1843 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1844 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001845 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001846 *
1847 * Comment to disable support for the PSK ephemeral key exchange mode in
1848 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1849 * have any effect on the build.
1850 *
1851 */
1852#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1853
1854/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 * \def MBEDTLS_SSL_EARLY_DATA
1856 *
1857 * Enable support for RFC 8446 TLS 1.3 early data.
1858 *
1859 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1860 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1861 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1862 *
1863 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1864 * is not enabled, this option does not have any effect on the build.
1865 *
1866 * This feature is experimental, not completed and thus not ready for
1867 * production.
1868 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001869 * \note The maximum amount of early data can be set with
1870 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1871 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001873//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001874
1875/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001877 *
1878 * Enable support for DTLS (all available versions).
1879 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001880 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001881 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001882 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001883 *
1884 * Comment this macro to disable support for DTLS
1885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001887
1888/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001889 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001890 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001891 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001892 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001893 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001896
1897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001899 *
1900 * Enable support for the anti-replay mechanism in DTLS.
1901 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 * Requires: MBEDTLS_SSL_TLS_C
1903 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001904 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001905 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001906 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001907 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001908 * Comment this to disable anti-replay in DTLS.
1909 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001911
1912/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001914 *
1915 * Enable support for HelloVerifyRequest on DTLS servers.
1916 *
1917 * This feature is highly recommended to prevent DTLS servers being used as
1918 * amplifiers in DoS attacks against other hosts. It should always be enabled
1919 * unless you know for sure amplification cannot be a problem in the
1920 * environment in which your server operates.
1921 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001922 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001923 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001924 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001925 *
1926 * Comment this to disable support for HelloVerifyRequest.
1927 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001928#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001929
1930/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001931 * \def MBEDTLS_SSL_DTLS_SRTP
1932 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001933 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001934 * through the use_srtp extension.
1935 *
1936 * \note This feature provides the minimum functionality required
1937 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1938 * the associated SRTP packet protection key material.
1939 * In particular, the SRTP packet protection itself, as well as the
1940 * demultiplexing of RTP and DTLS packets at the datagram layer
1941 * (see Section 5 of RFC 5764), are not handled by this feature.
1942 * Instead, after successful completion of a handshake negotiating
1943 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001944 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001945 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1946 * (this is implemented in the SSL example programs).
1947 * The resulting key should then be passed to an SRTP stack.
1948 *
1949 * Setting this option enables the runtime API
1950 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1951 * through which the supported DTLS-SRTP protection
1952 * profiles can be configured. You must call this API at
1953 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001954 *
1955 * Requires: MBEDTLS_SSL_PROTO_DTLS
1956 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001957 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001958 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001959//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001960
1961/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001962 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1963 *
1964 * Enable server-side support for clients that reconnect from the same port.
1965 *
1966 * Some clients unexpectedly close the connection and try to reconnect using the
1967 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001968 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001969 * flag enables that support.
1970 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001971 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001972 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001973 * Comment this to disable support for clients reusing the source port.
1974 */
1975#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1976
1977/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001979 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001980 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001981 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001982 * session store remains the responsibility of the application, though).
1983 * Server-side, you also need to provide callbacks for writing and parsing
1984 * tickets, including authenticated encryption and key management. Example
1985 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001986 *
1987 * Comment this macro to disable support for SSL session tickets
1988 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001989#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001990
1991/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001992 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001993 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001994 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001995 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001996 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001997 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001998 * Comment this macro to disable support for server name indication in SSL
1999 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002000#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002001
2002/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01002003 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2004 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05002005 * When this option is enabled, the SSL buffer will be resized automatically
2006 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02002007 *
2008 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01002009 */
2010//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2011
2012/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002013 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2014 *
2015 * Enable testing of the constant-flow nature of some sensitive functions with
2016 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002017 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002018 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002019 * This setting requires compiling with clang -fsanitize=memory. The test
2020 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002021 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002022 * \warning This macro is only used for extended testing; it is not considered
2023 * part of the library's API, so it may change or disappear at any time.
2024 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002025 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002026 */
2027//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2028
2029/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002030 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2031 *
2032 * Enable testing of the constant-flow nature of some sensitive functions with
2033 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002034 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002035 *
2036 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002037 * testing if the tests suites are run with valgrind's memcheck. This can be
2038 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2039 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002040 *
2041 * \warning This macro is only used for extended testing; it is not considered
2042 * part of the library's API, so it may change or disappear at any time.
2043 *
2044 * Uncomment to enable testing of the constant-flow nature of selected code.
2045 */
2046//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2047
2048/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002049 * \def MBEDTLS_TEST_HOOKS
2050 *
2051 * Enable features for invasive testing such as introspection functions and
2052 * hooks for fault injection. This enables additional unit tests.
2053 *
2054 * Merely enabling this feature should not change the behavior of the product.
2055 * It only adds new code, and new branching points where the default behavior
2056 * is the same as when this feature is disabled.
2057 * However, this feature increases the attack surface: there is an added
2058 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2059 * Therefore this feature must never be enabled in production.
2060 *
2061 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2062 * information.
2063 *
2064 * Uncomment to enable invasive tests.
2065 */
2066//#define MBEDTLS_TEST_HOOKS
2067
2068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002070 *
2071 * Provide your own alternate threading implementation.
2072 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002073 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002074 *
2075 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002077//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002078
2079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002081 *
2082 * Enable the pthread wrapper layer for the threading layer.
2083 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002085 *
2086 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002089
2090/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002091 * \def MBEDTLS_USE_PSA_CRYPTO
2092 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002093 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
2094 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002095 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002096 * \note Development of this option is currently in progress, and parts of Mbed
2097 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002098 * will still continue to work as usual, so enabling this option should not
2099 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002100 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02002101 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02002102 * before calling any function from the SSL/TLS, X.509 or PK modules, except
2103 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00002104 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002105 * \note An important and desirable effect of this option is that it allows
2106 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2107 * this option is what allows use of drivers for ECDSA, ECDH and EC J-PAKE in
Manuel Pégourié-Gonnard9463e782023-03-30 09:37:39 +02002108 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002109 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2110 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002111 *
2112 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002113 *
2114 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002115 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002116 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002117 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002118//#define MBEDTLS_USE_PSA_CRYPTO
2119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002121 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2122 *
John Durkop185764f2020-10-12 21:32:12 -07002123 * This setting allows support for cryptographic mechanisms through the PSA
2124 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002125 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002126 * When this option is disabled, the PSA API exposes the cryptographic
2127 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2128 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002129 *
2130 * When this option is enabled, the PSA API exposes the cryptographic
2131 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2132 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2133 * automatically enabled if required (i.e. if no PSA driver provides the
2134 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2135 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002136 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002137 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002138 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002139 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002140 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2141 * symbols is not completely finalized yet, and the configuration
2142 * tooling is not ideally adapted to having two separate configuration
2143 * files.
2144 * Future minor releases of Mbed TLS may make minor changes to those
2145 * symbols, but we will endeavor to provide a transition path.
2146 * Nonetheless, this option is considered mature enough to use in
2147 * production, as long as you accept that you may need to make
2148 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002149 */
2150//#define MBEDTLS_PSA_CRYPTO_CONFIG
2151
2152/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002153 * \def MBEDTLS_VERSION_FEATURES
2154 *
2155 * Allow run-time checking of compile-time enabled features. Thus allowing users
2156 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002157 * support via mbedtls_version_check_feature().
2158 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002159 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002160 *
2161 * Comment this to disable run-time checking and save ROM space
2162 */
2163#define MBEDTLS_VERSION_FEATURES
2164
2165/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002166 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2167 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002168 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002169 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2170 * the set of trusted certificates through a callback instead of a linked
2171 * list.
2172 *
2173 * This is useful for example in environments where a large number of trusted
2174 * certificates is present and storing them in a linked list isn't efficient
2175 * enough, or when the set of trusted certificates changes frequently.
2176 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002177 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002178 * `mbedtls_ssl_conf_ca_cb()` for more information.
2179 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002180 * Requires: MBEDTLS_X509_CRT_PARSE_C
2181 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002182 * Uncomment to enable trusted certificate callbacks.
2183 */
2184//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2185
2186/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002187 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002188 *
Chris Jones2c745862020-12-16 11:41:06 +00002189 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002190 *
Chris Jones2c745862020-12-16 11:41:06 +00002191 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002192 * and other functions/constants only used by these functions, thus reducing
2193 * the code footprint by several KB.
2194 */
Chris Jones2c745862020-12-16 11:41:06 +00002195//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002196
2197/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002198 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002199 *
2200 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2201 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2202 *
2203 * Comment this macro to disallow using RSASSA-PSS in certificates.
2204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002205#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002206/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002207
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002208/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002209 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002210 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002211 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002212 * \{
2213 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002214
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002215/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002216 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002217 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002218 * Enable AES-NI support on x86-64 or x86-32.
2219 *
2220 * \note AESNI is only supported with certain compilers and target options:
2221 * - Visual Studio 2013: supported.
2222 * - GCC, x86-64, target not explicitly supporting AESNI:
2223 * requires MBEDTLS_HAVE_ASM.
2224 * - GCC, x86-32, target not explicitly supporting AESNI:
2225 * not supported.
2226 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2227 * For this assembly-less implementation, you must currently compile
2228 * `library/aesni.c` and `library/aes.c` with machine options to enable
2229 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2230 * `clang -maes -mpclmul`.
2231 * - Non-x86 targets: this option is silently ignored.
2232 * - Other compilers: this option is silently ignored.
2233 *
2234 * \note
2235 * Above, "GCC" includes compatible compilers such as Clang.
2236 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002237 *
2238 * Module: library/aesni.c
2239 * Caller: library/aes.c
2240 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002241 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002242 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002243 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002246
2247/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002248 * \def MBEDTLS_AESCE_C
2249 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002250 * Enable AES cryptographic extension support on 64-bit Arm.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002251 *
2252 * Module: library/aesce.c
2253 * Caller: library/aes.c
2254 *
Jerry Yuf015a932023-04-25 10:38:03 +08002255 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002256 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002257 * \warning Runtime detection only works on Linux. For non-Linux operating
2258 * system, Armv8-A Cryptographic Extensions must be supported by
2259 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002260 *
Jerry Yua1a039d2023-04-26 10:21:42 +08002261 * \note Minimum compiler versions for this feature are Clang 4.0,
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002262 * armclang 6.6, GCC 6.0 or MSVC 2019 version 16.11.2.
2263 *
2264 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2265 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002266 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002267 * This module adds support for the AES Armv8-A Cryptographic Extensions on Aarch64 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002268 */
2269#define MBEDTLS_AESCE_C
2270
2271/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002273 *
2274 * Enable the AES block cipher.
2275 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002276 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002277 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002278 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002279 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002280 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002281 * This module enables the following ciphersuites (if other requisites are
2282 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002283 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2284 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2285 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2286 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2287 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2288 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2289 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2290 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2291 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2292 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2293 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2294 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2295 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2296 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2297 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2298 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2299 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2300 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2301 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2302 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2303 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2304 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2305 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2306 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2307 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2308 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2309 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2310 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2311 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2312 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2313 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2314 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2315 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2316 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2317 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2318 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2319 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2320 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2321 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2322 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2323 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2324 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2325 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2326 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2327 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2328 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2329 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2330 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2331 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2332 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2333 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2334 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2335 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2336 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2337 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2338 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2339 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2340 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002341 *
Paul Bakkercff68422013-09-15 20:43:33 +02002342 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002343 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002345
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002346/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002347 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002348 *
2349 * Enable the generic ASN1 parser.
2350 *
2351 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002352 * Caller: library/x509.c
2353 * library/dhm.c
2354 * library/pkcs12.c
2355 * library/pkcs5.c
2356 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002357 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002358#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002359
2360/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002361 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002362 *
2363 * Enable the generic ASN1 writer.
2364 *
2365 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002366 * Caller: library/ecdsa.c
2367 * library/pkwrite.c
2368 * library/x509_create.c
2369 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002370 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002371 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002372#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002373
2374/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002376 *
2377 * Enable the Base64 module.
2378 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002379 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002380 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002381 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002382 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002384#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002385
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002386/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002387 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002388 *
Paul Bakker9a736322012-11-14 12:39:52 +00002389 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002390 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002391 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002392 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002393 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002394 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002395 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002396 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002397 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002398 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002399 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002400 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002401 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002402 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002403 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002404#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002405
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002406/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002407 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002408 *
2409 * Enable the Camellia block cipher.
2410 *
Paul Bakker38119b12009-01-10 23:31:23 +00002411 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002412 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002413 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002414 * This module enables the following ciphersuites (if other requisites are
2415 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002416 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2417 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2418 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2419 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2420 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2421 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2422 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2423 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2424 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2425 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2426 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2427 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2428 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2429 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2430 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2431 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2432 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2433 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2434 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2435 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2436 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2437 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2438 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2439 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2440 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2441 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2442 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2443 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2444 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2445 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2446 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2447 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2448 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2449 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2450 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2451 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2452 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2453 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2454 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2455 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2456 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2457 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002458 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002459#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002460
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002461/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002462 * \def MBEDTLS_ARIA_C
2463 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002464 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002465 *
2466 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002467 * Caller: library/cipher.c
2468 *
2469 * This module enables the following ciphersuites (if other requisites are
2470 * enabled as well):
2471 *
2472 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2473 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2474 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2475 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2476 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2477 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2478 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2479 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2480 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2481 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2482 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2483 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2484 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2485 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2486 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2487 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2488 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2489 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2490 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2491 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2492 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2493 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2494 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2495 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2496 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2497 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2498 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2499 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2500 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2501 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2502 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2503 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2504 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2505 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2506 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2507 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2508 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2509 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002510 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002511#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002512
2513/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002515 *
2516 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2517 *
2518 * Module: library/ccm.c
2519 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002520 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2521 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002522 *
2523 * This module enables the AES-CCM ciphersuites, if other requisites are
2524 * enabled as well.
2525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002527
2528/**
Daniel King34b822c2016-05-15 17:28:08 -03002529 * \def MBEDTLS_CHACHA20_C
2530 *
2531 * Enable the ChaCha20 stream cipher.
2532 *
2533 * Module: library/chacha20.c
2534 */
2535#define MBEDTLS_CHACHA20_C
2536
2537/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002538 * \def MBEDTLS_CHACHAPOLY_C
2539 *
2540 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2541 *
2542 * Module: library/chachapoly.c
2543 *
2544 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2545 */
2546#define MBEDTLS_CHACHAPOLY_C
2547
2548/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002550 *
2551 * Enable the generic cipher layer.
2552 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002553 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002554 * Caller: library/ccm.c
2555 * library/cmac.c
2556 * library/gcm.c
2557 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002558 * library/pkcs12.c
2559 * library/pkcs5.c
2560 * library/psa_crypto_aead.c
2561 * library/psa_crypto_mac.c
2562 * library/ssl_ciphersuites.c
2563 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002564 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002565 *
2566 * Uncomment to enable generic cipher wrappers.
2567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002569
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002570/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002571 * \def MBEDTLS_CMAC_C
2572 *
Simon Butcher327398a2016-10-05 14:09:11 +01002573 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2574 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002575 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002576 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2577 * implementation of the CMAC algorithm is provided by an alternate
2578 * implementation, that alternate implementation may opt to not support
2579 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2580 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002581 * Module: library/cmac.c
2582 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002583 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002584 *
2585 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002586#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002587
2588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002590 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002591 * Enable the CTR_DRBG AES-based random generator.
2592 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002593 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002594 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002595 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2596 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002597 * \note To achieve a 256-bit security strength with CTR_DRBG,
2598 * you must use AES-256 *and* use sufficient entropy.
2599 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002600 *
2601 * Module: library/ctr_drbg.c
2602 * Caller:
2603 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002605 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002606 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002609
2610/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002612 *
2613 * Enable the debug functions.
2614 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002615 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002616 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002617 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002618 * library/ssl_tls12_*.c
2619 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002620 *
2621 * This module provides debugging functions.
2622 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002624
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002625/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002627 *
2628 * Enable the DES block cipher.
2629 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002630 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002631 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002632 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002633 *
Paul Bakkercff68422013-09-15 20:43:33 +02002634 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002635 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002636 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002637 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002638 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002639#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002640
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002641/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002643 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002644 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002645 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002646 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002647 * Caller: library/ssl_tls.c
2648 * library/ssl*_client.c
2649 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002650 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002651 * This module is used by the following key exchanges:
2652 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002653 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002654 * \warning Using DHE constitutes a security risk as it
2655 * is not possible to validate custom DH parameters.
2656 * If possible, it is recommended users should consider
2657 * preferring other methods of key exchange.
2658 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002659 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002660 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002662
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002663/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002665 *
2666 * Enable the elliptic curve Diffie-Hellman library.
2667 *
2668 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002669 * Caller: library/psa_crypto.c
2670 * library/ssl_tls.c
2671 * library/ssl*_client.c
2672 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002673 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002674 * This module is used by the following key exchanges:
2675 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002676 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002680
2681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002683 *
2684 * Enable the elliptic curve DSA library.
2685 *
2686 * Module: library/ecdsa.c
2687 * Caller:
2688 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002689 * This module is used by the following key exchanges:
2690 * ECDHE-ECDSA
2691 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002692 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2693 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2694 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002695 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002696#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002697
2698/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002699 * \def MBEDTLS_ECJPAKE_C
2700 *
2701 * Enable the elliptic curve J-PAKE library.
2702 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002703 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2704 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002705 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002706 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002707 * Module: library/ecjpake.c
2708 * Caller:
2709 *
2710 * This module is used by the following key exchanges:
2711 * ECJPAKE
2712 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002713 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002714 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002715 * \warning If using a hash that is only provided by PSA drivers, you must
2716 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002717 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002718#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002719
2720/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002721 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002722 *
2723 * Enable the elliptic curve over GF(p) library.
2724 *
2725 * Module: library/ecp.c
2726 * Caller: library/ecdh.c
2727 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002728 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002729 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002731 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002733
2734/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002736 *
2737 * Enable the platform-specific entropy code.
2738 *
2739 * Module: library/entropy.c
2740 * Caller:
2741 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002742 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002743 *
2744 * This module provides a generic entropy pool
2745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002747
2748/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002750 *
2751 * Enable error code to error string conversion.
2752 *
2753 * Module: library/error.c
2754 * Caller:
2755 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002756 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002757 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002758#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002759
2760/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002762 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002763 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002764 *
2765 * Module: library/gcm.c
2766 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002767 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2768 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002769 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002770 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2771 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002772 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002774
2775/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002776 * \def MBEDTLS_HKDF_C
2777 *
2778 * Enable the HKDF algorithm (RFC 5869).
2779 *
2780 * Module: library/hkdf.c
2781 * Caller:
2782 *
2783 * Requires: MBEDTLS_MD_C
2784 *
2785 * This module adds support for the Hashed Message Authentication Code
2786 * (HMAC)-based key derivation function (HKDF).
2787 */
2788#define MBEDTLS_HKDF_C
2789
2790/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002792 *
2793 * Enable the HMAC_DRBG random generator.
2794 *
2795 * Module: library/hmac_drbg.c
2796 * Caller:
2797 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002799 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002800 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002801 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002803
2804/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002805 * \def MBEDTLS_LMS_C
2806 *
2807 * Enable the LMS stateful-hash asymmetric signature algorithm.
2808 *
2809 * Module: library/lms.c
2810 * Caller:
2811 *
Raef Colesab4f8742022-09-01 12:24:31 +01002812 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002813 *
Raef Colesab4f8742022-09-01 12:24:31 +01002814 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002815 */
2816#define MBEDTLS_LMS_C
2817
2818/**
Raef Colesab4f8742022-09-01 12:24:31 +01002819 * \def MBEDTLS_LMS_PRIVATE
2820 *
2821 * Enable LMS private-key operations and signing code. Functions enabled by this
2822 * option are experimental, and should not be used in production.
2823 *
2824 * Requires: MBEDTLS_LMS_C
2825 *
2826 * Uncomment to enable the LMS signature algorithm and private key operations.
2827 */
Raef Coles5127e852022-10-07 10:35:56 +01002828//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002829
2830/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002831 * \def MBEDTLS_NIST_KW_C
2832 *
2833 * Enable the Key Wrapping mode for 128-bit block ciphers,
2834 * as defined in NIST SP 800-38F. Only KW and KWP modes
2835 * are supported. At the moment, only AES is approved by NIST.
2836 *
2837 * Module: library/nist_kw.c
2838 *
2839 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2840 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002841#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002842
2843/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002845 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002846 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002847 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002848 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2849 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002850 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002851 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002852 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002853 * Caller: library/constant_time.c
2854 * library/ecdsa.c
2855 * library/ecjpake.c
2856 * library/hkdf.c
2857 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002858 * library/pk.c
2859 * library/pkcs5.c
2860 * library/pkcs12.c
2861 * library/psa_crypto_ecp.c
2862 * library/psa_crypto_rsa.c
2863 * library/rsa.c
2864 * library/ssl_cookie.c
2865 * library/ssl_msg.c
2866 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002867 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002868 * library/x509_crt.c
2869 * library/x509write_crt.c
2870 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002871 *
2872 * Uncomment to enable generic message digest wrappers.
2873 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002875
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002876/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002878 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002879 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002880 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002881 * Module: library/md5.c
2882 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002883 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002884 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002885 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002886 * This module is required for TLS 1.2 depending on the handshake parameters.
2887 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2888 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002889 *
2890 * \warning MD5 is considered a weak message digest and its use constitutes a
2891 * security risk. If possible, we recommend avoiding dependencies on
2892 * it, and considering stronger message digests instead.
2893 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002896
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002899 *
2900 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002901 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002902 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002903 *
2904 * Module: library/memory_buffer_alloc.c
2905 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002907 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002908 *
2909 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002912
2913/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002915 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002916 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2917 *
Simon Butcherd567a232016-03-09 20:19:21 +00002918 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2919 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002920 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002921 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002922 * \note See also our Knowledge Base article about porting to a new
2923 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002924 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002925 *
Andres AG788aa4a2016-09-14 14:32:09 +01002926 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002927 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002928 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002931
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002932/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002934 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002935 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002936 *
2937 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002938 * Caller: library/asn1write.c
2939 * library/pkcs5.c
2940 * library/pkparse.c
2941 * library/pkwrite.c
2942 * library/rsa.c
2943 * library/x509.c
2944 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002945 * library/x509_crl.c
2946 * library/x509_crt.c
2947 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002948 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002949 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002950 *
2951 * This modules translates between OIDs and internal values.
2952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002954
2955/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002957 *
2958 * Enable VIA Padlock support on x86.
2959 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002960 * Module: library/padlock.c
2961 * Caller: library/aes.c
2962 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002964 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002965 * This modules adds support for the VIA PadLock on x86.
2966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002968
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002971 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002972 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002973 *
2974 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002975 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002976 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002977 * library/x509_crl.c
2978 * library/x509_crt.c
2979 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002980 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002982 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2983 *
2984 * \warning When parsing password-protected files, if MD5 is provided only by
2985 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002986 *
Paul Bakkercff68422013-09-15 20:43:33 +02002987 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002988 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002990
2991/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002993 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002994 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002995 *
2996 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002997 * Caller: library/pkwrite.c
2998 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002999 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02003000 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02003002 *
3003 * This modules adds support for encoding / writing PEM files.
3004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003006
3007/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003009 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003010 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003011 *
3012 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003013 * Caller: library/psa_crypto_rsa.c
3014 * library/ssl_tls.c
3015 * library/ssl*_client.c
3016 * library/ssl*_server.c
3017 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003018 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02003019 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003020 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003021 * Uncomment to enable generic public key wrappers.
3022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003024
3025/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003027 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003028 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02003029 *
3030 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003031 * Caller: library/x509_crt.c
3032 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003033 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003035 *
3036 * Uncomment to enable generic public key parse functions.
3037 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003038#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003039
3040/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003042 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003043 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003044 *
3045 * Module: library/pkwrite.c
3046 * Caller: library/x509write.c
3047 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003049 *
3050 * Uncomment to enable generic public key write functions.
3051 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003053
3054/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003055 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003056 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003057 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003058 *
3059 * Module: library/pkcs5.c
3060 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003061 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01003062 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003063 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003064 * \warning If using a hash that is only provided by PSA drivers, you must
3065 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003066 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003067 * This module adds support for the PKCS#5 functions.
3068 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003070
3071/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003072 * \def MBEDTLS_PKCS7_C
3073 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003074 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003075 * RFC Link - https://tools.ietf.org/html/rfc2315
3076 *
3077 * Module: library/pkcs7.c
3078 *
3079 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003080 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3081 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003082 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003083 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003084 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003085#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003086
3087/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003089 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003090 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003091 * Adds algorithms for parsing PKCS#8 encrypted private keys
3092 *
3093 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003094 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003095 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003096 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
3097 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
3098 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003099 * \warning If using a hash that is only provided by PSA drivers, you must
3100 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003101 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003102 * This module enables PKCS#12 functions.
3103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003105
3106/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003108 *
3109 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003110 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003111 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3113 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003114 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003115 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003116 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003117 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003118 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003119 * Module: library/platform.c
3120 * Caller: Most other .c files
3121 *
3122 * This module enables abstraction of common (libc) functions.
3123 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003124#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003125
3126/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003127 * \def MBEDTLS_POLY1305_C
3128 *
3129 * Enable the Poly1305 MAC algorithm.
3130 *
3131 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003132 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003133 */
3134#define MBEDTLS_POLY1305_C
3135
3136/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003137 * \def MBEDTLS_PSA_CRYPTO_C
3138 *
3139 * Enable the Platform Security Architecture cryptography API.
3140 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003141 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003142 *
Przemek Stekielea805b42022-05-02 10:30:03 +02003143 * Requires: MBEDTLS_CIPHER_C,
3144 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003145 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003146 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003147 *
3148 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003149#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003150
3151/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003152 * \def MBEDTLS_PSA_CRYPTO_SE_C
3153 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003154 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003155 * cryptography API.
3156 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003157 * \deprecated This feature is deprecated. Please switch to the PSA driver
3158 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003159 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003160 * Module: library/psa_crypto_se.c
3161 *
3162 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3163 *
3164 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003165//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003166
3167/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003168 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3169 *
3170 * Enable the Platform Security Architecture persistent key storage.
3171 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003172 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003173 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003174 * Requires: MBEDTLS_PSA_CRYPTO_C,
3175 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3176 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003177 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003178#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003179
3180/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003181 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003182 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003183 * Enable the emulation of the Platform Security Architecture
3184 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003185 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003186 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003187 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003188 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003189 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003190#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003191
3192/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003194 *
3195 * Enable the RIPEMD-160 hash algorithm.
3196 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003197 * Module: library/ripemd160.c
3198 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003199 *
3200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003202
3203/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003204 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003205 *
3206 * Enable the RSA public-key cryptosystem.
3207 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003208 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003209 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003210 * Caller: library/pk.c
3211 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003212 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003213 * library/ssl*_client.c
3214 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003215 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003216 * This module is used by the following key exchanges:
3217 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003218 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003220 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003221#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003222
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003223/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003224 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003225 *
3226 * Enable the SHA1 cryptographic hash algorithm.
3227 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003228 * Module: library/sha1.c
3229 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003230 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003231 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003232 * This module is required for TLS 1.2 depending on the handshake parameters,
3233 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003234 *
3235 * \warning SHA-1 is considered a weak message digest and its use constitutes
3236 * a security risk. If possible, we recommend avoiding dependencies
3237 * on it, and considering stronger message digests instead.
3238 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003239 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003240#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003241
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003242/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003243 * \def MBEDTLS_SHA224_C
3244 *
3245 * Enable the SHA-224 cryptographic hash algorithm.
3246 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003247 * Module: library/sha256.c
3248 * Caller: library/md.c
3249 * library/ssl_cookie.c
3250 *
3251 * This module adds support for SHA-224.
3252 */
3253#define MBEDTLS_SHA224_C
3254
3255/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003256 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003257 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003258 * Enable the SHA-256 cryptographic hash algorithm.
3259 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003260 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003261 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003262 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003263 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003264 * library/ssl*_client.c
3265 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003266 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003267 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003268 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003269 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003270#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003271
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003272/**
Dave Rodgman94a634d2023-10-10 12:59:29 +01003273 * \def MBEDTLS_SHA256_USE_ARMV8_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003274 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003275 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3276 * with the ARMv8 cryptographic extensions if they are available at runtime.
3277 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003278 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003279 * \note If MBEDTLS_SHA256_USE_ARMV8_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanca92f502023-10-05 08:24:55 +01003280 * for a non-Armv8 build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003281 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003282 * \note Minimum compiler versions for this feature are Clang 4.0,
Dave Rodgmanbfe60212023-10-05 08:31:22 +01003283 * armclang 6.6 or GCC 6.0.
3284 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003285 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3286 * armclang <= 6.9
3287 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003288 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3289 * That name is deprecated, but may still be used as an alternative form for this
3290 * option.
3291 *
3292 * \warning MBEDTLS_SHA256_USE_ARMV8_CRYPTO_IF_PRESENT cannot be defined at the
3293 * same time as MBEDTLS_SHA256_USE_ARMV8_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003294 *
3295 * Requires: MBEDTLS_SHA256_C.
3296 *
3297 * Module: library/sha256.c
3298 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003299 * Uncomment to have the library check for the Armv8 SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003300 * and use them if available.
3301 */
Dave Rodgman94a634d2023-10-10 12:59:29 +01003302//#define MBEDTLS_SHA256_USE_ARMV8_CRYPTO_IF_PRESENT
3303
3304/*
3305 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_CRYPTO_IF_PRESENT.
3306 * This name is now deprecated, but may still be used as an alternative form for
3307 * this option.
3308 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003309//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3310
3311/**
Dave Rodgman94a634d2023-10-10 12:59:29 +01003312 * \def MBEDTLS_SHA256_USE_ARMV8_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003313 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003314 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3315 * with the ARMv8 cryptographic extensions, which must be available at runtime
3316 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003317 *
3318 * \note This allows builds with a smaller code size than with
Dave Rodgman94a634d2023-10-10 12:59:29 +01003319 * MBEDTLS_SHA256_USE_ARMV8_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003320 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003321 * \note Minimum compiler versions for this feature are Clang 4.0,
3322 * armclang 6.6 or GCC 6.0.
3323 *
3324 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3325 * armclang <= 6.9
3326 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003327 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3328 * That name is deprecated, but may still be used as an alternative form for this
3329 * option.
3330 *
3331 * \warning MBEDTLS_SHA256_USE_ARMV8_CRYPTO_ONLY cannot be defined at the same
3332 * time as MBEDTLS_SHA256_USE_ARMV8_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003333 *
3334 * Requires: MBEDTLS_SHA256_C.
3335 *
3336 * Module: library/sha256.c
3337 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003338 * Uncomment to have the library use the Armv8 SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003339 * unconditionally.
3340 */
Dave Rodgman94a634d2023-10-10 12:59:29 +01003341//#define MBEDTLS_SHA256_USE_ARMV8_CRYPTO_ONLY
3342
3343/*
3344 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_CRYPTO_ONLY.
3345 * This name is now deprecated, but may still be used as an alternative form for
3346 * this option.
3347 */
Dave Rodgman6ab314f2023-10-10 14:00:17 +01003348//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003349
3350/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003351 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003352 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003353 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003354 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003355 * Module: library/sha512.c
3356 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003357 * library/psa_crypto_hash.c
3358 * library/ssl_tls.c
3359 * library/ssl*_client.c
3360 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003361 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003362 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003363 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003364#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003365
3366/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003368 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003369 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003370 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003371 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003372 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003373 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003374 * library/ssl_tls.c
3375 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003376 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003377 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003380
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003381/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003382 * \def MBEDTLS_SHA3_C
3383 *
3384 * Enable the SHA3 cryptographic hash algorithm.
3385 *
3386 * Module: library/sha3.c
3387 *
3388 * This module adds support for SHA3.
3389 */
3390#define MBEDTLS_SHA3_C
3391
3392/**
Dave Rodgman94a634d2023-10-10 12:59:29 +01003393 * \def MBEDTLS_SHA512_USE_ARMV8_CRYPTO_IF_PRESENT
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003394 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003395 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3396 * with the ARMv8 cryptographic extensions if they are available at runtime.
3397 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003398 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003399 * \note If MBEDTLS_SHA512_USE_ARMV8_CRYPTO_IF_PRESENT is defined when building
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003400 * for a non-Aarch64 build it will be silently ignored.
3401 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003402 * \note Minimum compiler versions for this feature are Clang 7.0,
3403 * armclang 6.9 or GCC 8.0.
3404 *
3405 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3406 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003407 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003408 * \note This was previously known as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3409 * That name is deprecated, but may still be used as an alternative form for this
3410 * option.
3411 *
3412 * \warning MBEDTLS_SHA512_USE_ARMV8_CRYPTO_IF_PRESENT cannot be defined at the
3413 * same time as MBEDTLS_SHA512_USE_ARMV8_CRYPTO_ONLY.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003414 *
3415 * Requires: MBEDTLS_SHA512_C.
3416 *
3417 * Module: library/sha512.c
3418 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003419 * Uncomment to have the library check for the Armv8 SHA-512 crypto extensions
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003420 * and use them if available.
3421 */
Dave Rodgman94a634d2023-10-10 12:59:29 +01003422//#define MBEDTLS_SHA512_USE_ARMV8_CRYPTO_IF_PRESENT
3423
3424/*
3425 * \deprecated This is now known as MBEDTLS_SHA512_USE_ARMV8_CRYPTO_IF_PRESENT.
3426 * This name is now deprecated, but may still be used as an alternative form for
3427 * this option.
3428 */
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003429//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3430
3431/**
Dave Rodgman94a634d2023-10-10 12:59:29 +01003432 * \def MBEDTLS_SHA512_USE_ARMV8_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003433 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003434 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3435 * with the ARMv8 cryptographic extensions, which must be available at runtime
3436 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003437 *
3438 * \note This allows builds with a smaller code size than with
Dave Rodgman94a634d2023-10-10 12:59:29 +01003439 * MBEDTLS_SHA512_USE_ARMV8_CRYPTO_IF_PRESENT
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003440 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003441 * \note Minimum compiler versions for this feature are Clang 7.0,
3442 * armclang 6.9 or GCC 8.0.
3443 *
3444 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3445 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003446 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003447 * \note This was previously known as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3448 * That name is deprecated, but may still be used as an alternative form for this
3449 * option.
3450 *
3451 * \warning MBEDTLS_SHA512_USE_ARMV8_CRYPTO_ONLY cannot be defined at the same
3452 * time as MBEDTLS_SHA512_USE_ARMV8_CRYPTO_IF_PRESENT.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003453 *
3454 * Requires: MBEDTLS_SHA512_C.
3455 *
3456 * Module: library/sha512.c
3457 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003458 * Uncomment to have the library use the Armv8 SHA-512 crypto extensions
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003459 * unconditionally.
3460 */
Dave Rodgman94a634d2023-10-10 12:59:29 +01003461//#define MBEDTLS_SHA512_USE_ARMV8_CRYPTO_ONLY
3462
3463/*
3464 * \deprecated This is now known as MBEDTLS_SHA512_USE_ARMV8_CRYPTO_ONLY.
3465 * This name is now deprecated, but may still be used as an alternative form for
3466 * this option.
3467 */
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003468//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3469
3470/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003471 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003472 *
3473 * Enable simple SSL cache implementation.
3474 *
3475 * Module: library/ssl_cache.c
3476 * Caller:
3477 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003481
3482/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003484 *
3485 * Enable basic implementation of DTLS cookies for hello verification.
3486 *
3487 * Module: library/ssl_cookie.c
3488 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003491
3492/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003493 * \def MBEDTLS_SSL_TICKET_C
3494 *
3495 * Enable an implementation of TLS server-side callbacks for session tickets.
3496 *
3497 * Module: library/ssl_ticket.c
3498 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003499 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003500 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3501 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003502 */
3503#define MBEDTLS_SSL_TICKET_C
3504
3505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003506 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003507 *
3508 * Enable the SSL/TLS client code.
3509 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003510 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003511 * Caller:
3512 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003513 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003514 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003515 * This module is required for SSL/TLS client support.
3516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003518
Paul Bakker9a736322012-11-14 12:39:52 +00003519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003521 *
3522 * Enable the SSL/TLS server code.
3523 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003524 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003525 * Caller:
3526 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003527 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003528 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003529 * This module is required for SSL/TLS server support.
3530 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003531#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003532
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003533/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003535 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003536 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003537 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003538 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003539 * Caller: library/ssl*_client.c
3540 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003541 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3543 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003544 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003545 * This module is required for SSL/TLS.
3546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003547#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003548
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003549/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003551 *
3552 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003553 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003554 * contexts are not shared between threads. If you do intend to use contexts
3555 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003556 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003557 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003558 *
3559 * Module: library/threading.c
3560 *
3561 * This allows different threading implementations (self-implemented or
3562 * provided).
3563 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003564 * You will have to enable either MBEDTLS_THREADING_ALT or
3565 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003566 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003567 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003570
3571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003573 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003574 * Enable the semi-portable timing interface.
3575 *
Simon Butcherd567a232016-03-09 20:19:21 +00003576 * \note The provided implementation only works on POSIX/Unix (including Linux,
3577 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003578 * module and provide your own implementations of the callbacks needed by
3579 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3580 * your own implementation of the whole module by setting
3581 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003582 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003583 * \note The timing module will include time.h on suitable platforms
3584 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3585 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3586 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003587 * \note See also our Knowledge Base article about porting to a new
3588 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003589 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003590 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003591 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003592 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003593#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003594
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003595/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003597 *
3598 * Enable run-time version information.
3599 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003600 * Module: library/version.c
3601 *
3602 * This module provides run-time version information.
3603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003604#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003605
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003606/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003607 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003608 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003609 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003610 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003611 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003612 * Caller: library/x509_crl.c
3613 * library/x509_crt.c
3614 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003615 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003616 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003617 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3618 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003619 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3620 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003621 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003622 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003624#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003625
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003626/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003627 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003628 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003629 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003630 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003631 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003632 * Caller: library/ssl_tls.c
3633 * library/ssl*_client.c
3634 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003635 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003636 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003637 *
3638 * This module is required for X.509 certificate parsing.
3639 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003640#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003641
3642/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003643 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003644 *
3645 * Enable X.509 CRL parsing.
3646 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003647 * Module: library/x509_crl.c
3648 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003649 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003650 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003651 *
3652 * This module is required for X.509 CRL parsing.
3653 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003654#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003655
3656/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003657 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003658 *
3659 * Enable X.509 Certificate Signing Request (CSR) parsing.
3660 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003661 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003662 * Caller: library/x509_crt_write.c
3663 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003664 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003665 *
3666 * This module is used for reading X.509 certificate request.
3667 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003668#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003669
3670/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003671 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003672 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003673 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003674 *
3675 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003676 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003677 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003678 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3679 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003680 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3681 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003682 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003683 * This module is the basis for creating X.509 certificates and CSRs.
3684 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003685#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003686
3687/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003688 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003689 *
3690 * Enable creating X.509 certificates.
3691 *
3692 * Module: library/x509_crt_write.c
3693 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003694 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003695 *
3696 * This module is required for X.509 certificate creation.
3697 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003698#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003699
3700/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003701 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003702 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003703 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003704 *
3705 * Module: library/x509_csr_write.c
3706 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003707 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003708 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003709 * This module is required for X.509 certificate request writing.
3710 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003711#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003712
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003713/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003714
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003715/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003716 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003717 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003718 * This section contains Mbed TLS build settings that are not associated
3719 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003720 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003721 * \{
3722 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003723
Gilles Peskinea02c1242022-03-16 17:03:19 +01003724/**
3725 * \def MBEDTLS_CONFIG_FILE
3726 *
3727 * If defined, this is a header which will be included instead of
3728 * `"mbedtls/mbedtls_config.h"`.
3729 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003730 * Unlike other configuration options, this one must be defined on the
3731 * compiler command line: a definition in `mbedtls_config.h` would have
3732 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003733 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003734 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003735 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003736 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003737 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003738 * The value of this symbol is typically a path in double quotes, either
3739 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003740 */
3741//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3742
3743/**
3744 * \def MBEDTLS_USER_CONFIG_FILE
3745 *
3746 * If defined, this is a header which will be included after
3747 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003748 * This allows you to modify the default configuration, including the ability
3749 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003750 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003751 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003752 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003753 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003754 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003755 * The value of this symbol is typically a path in double quotes, either
3756 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003757 */
3758//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3759
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003760/**
3761 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3762 *
3763 * If defined, this is a header which will be included instead of
3764 * `"psa/crypto_config.h"`.
3765 * This header file specifies which cryptographic mechanisms are available
3766 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3767 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3768 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003769 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003770 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003771 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003772 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003773 * The value of this symbol is typically a path in double quotes, either
3774 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003775 */
3776//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3777
3778/**
3779 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3780 *
3781 * If defined, this is a header which will be included after
3782 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003783 * This allows you to modify the default configuration, including the ability
3784 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003785 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003786 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003787 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003788 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003789 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003790 * The value of this symbol is typically a path in double quotes, either
3791 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003792 */
3793//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3794
Gilles Peskineb1176f22023-02-22 22:07:28 +01003795/**
3796 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3797 *
3798 * If defined, this is a header which will be included instead of
3799 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3800 * as the one in Mbed TLS, but with definitions adapted to the platform on
3801 * which the library code will run.
3802 *
3803 * \note The required content of this header can vary from one version of
3804 * Mbed TLS to the next. Integrators who provide an alternative file
3805 * should review the changes in the original file whenever they
3806 * upgrade Mbed TLS.
3807 *
3808 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3809 * non-standard feature of the C language, so this feature is only available
3810 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3811 *
3812 * The value of this symbol is typically a path in double quotes, either
3813 * absolute or relative to a directory on the include search path.
3814 */
3815//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3816
3817/**
3818 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3819 *
3820 * If defined, this is a header which will be included instead of
3821 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3822 * as the one in Mbed TLS, but with definitions adapted to the environment
3823 * in which the library code will run. The typical use for this feature
3824 * is to provide alternative type definitions on the client side in
3825 * client-server integrations of PSA crypto, where operation structures
3826 * contain handles instead of cryptographic data.
3827 *
3828 * \note The required content of this header can vary from one version of
3829 * Mbed TLS to the next. Integrators who provide an alternative file
3830 * should review the changes in the original file whenever they
3831 * upgrade Mbed TLS.
3832 *
3833 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3834 * non-standard feature of the C language, so this feature is only available
3835 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3836 *
3837 * The value of this symbol is typically a path in double quotes, either
3838 * absolute or relative to a directory on the include search path.
3839 */
3840//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3841
Gilles Peskineba4162a2022-04-11 17:04:38 +02003842/** \} name SECTION: General configuration options */
3843
3844/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003845 * \name SECTION: Module configuration options
3846 *
3847 * This section allows for the setting of module specific sizes and
3848 * configuration options. The default values are already present in the
3849 * relevant header files and should suffice for the regular use cases.
3850 *
3851 * Our advice is to enable options and change their values here
3852 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003853 * \{
3854 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003855/* The Doxygen documentation here is used when a user comments out a
3856 * setting and runs doxygen themselves. On the other hand, when we typeset
3857 * the full documentation including disabled settings, the documentation
3858 * in specific modules' header files is used if present. When editing this
3859 * file, make sure that each option is documented in exactly one place,
3860 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3861 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003862
Paul Bakker088c5c52014-04-25 11:11:10 +02003863/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003864//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003865//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003866
Paul Bakker088c5c52014-04-25 11:11:10 +02003867/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003868//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3869//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3870//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3871//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3872//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003873
Paul Bakker088c5c52014-04-25 11:11:10 +02003874/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003875//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3876//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3877//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3878//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003879
Paul Bakker088c5c52014-04-25 11:11:10 +02003880/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003881//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003882//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003883
Paul Bakker088c5c52014-04-25 11:11:10 +02003884/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003885//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3886//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003887//#define MBEDTLS_ENTROPY_MIN_HARDWARE 32 /**< Default minimum number of bytes required for the hardware entropy source mbedtls_hardware_poll() before entropy is released */
Paul Bakkere1b665e2013-12-11 16:02:58 +01003888
Paul Bakker088c5c52014-04-25 11:11:10 +02003889/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003890//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003891
Paul Bakker088c5c52014-04-25 11:11:10 +02003892/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003893//#define MBEDTLS_PLATFORM_STD_MEM_HDR <stdlib.h> /**< Header to include if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS is defined. Don't define if no header is needed. */
Andrzej Kurek84356a12023-05-06 08:33:56 -04003894
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003895/** \def MBEDTLS_PLATFORM_STD_CALLOC
3896 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003897 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003898 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003899 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003900 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003901 * If the product is 0, the function may either return NULL or a valid pointer to an array of size 0 which is a valid input to the deallocation function.
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003902 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3903 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003904 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003905 */
3906//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003907
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003908/** \def MBEDTLS_PLATFORM_STD_FREE
3909 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003910 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003911 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003912 * A non-null parameter will always be a pointer previously returned by #MBEDTLS_PLATFORM_STD_CALLOC and not yet freed.
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003913 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3914 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details (same principles as for MBEDTLS_PLATFORM_STD_CALLOC apply).
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003915 */
3916//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003917//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003918//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003919//#define MBEDTLS_PLATFORM_STD_TIME time /**< Default time to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003920//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3921//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003922/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003923//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003924//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3925//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003926//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3927//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3928//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003929
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003930/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003931/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003932//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3933//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_FREE for requirements. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003934//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003935//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003936//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3937//#define MBEDTLS_PLATFORM_TIME_TYPE_MACRO time_t /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003938//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3939//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003940/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003941//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003942//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003943//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3944//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
Jerry Yuf181e542023-02-23 17:16:26 +08003945//#define MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO int64_t //#define MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO int64_t /**< Default milliseconds time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled. It must be signed, and at least 64 bits. If it is changed from the default, MBEDTLS_PRINTF_MS_TIME must be updated to match.*/
Jerry Yu10ce5402023-02-21 15:39:02 +08003946//#define MBEDTLS_PRINTF_MS_TIME PRId64 /**< Default fmt for printf. That's avoid compiler warning if mbedtls_ms_time_t is redefined */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003947
Gilles Peskine3f106f72021-09-23 17:42:39 +02003948/** \def MBEDTLS_CHECK_RETURN
3949 *
3950 * This macro is used at the beginning of the declaration of a function
3951 * to indicate that its return value should be checked. It should
3952 * instruct the compiler to emit a warning or an error if the function
3953 * is called without checking its return value.
3954 *
3955 * There is a default implementation for popular compilers in platform_util.h.
3956 * You can override the default implementation by defining your own here.
3957 *
3958 * If the implementation here is empty, this will effectively disable the
3959 * checking of functions' return values.
3960 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003961//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003962
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003963/** \def MBEDTLS_IGNORE_RETURN
3964 *
3965 * This macro requires one argument, which should be a C function call.
3966 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3967 * warning is suppressed.
3968 */
3969//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3970
Gilles Peskineed038902020-11-13 21:33:21 +01003971/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003972/**
Gilles Peskineed038902020-11-13 21:33:21 +01003973 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3974 * PSA crypto subsystem.
3975 *
3976 * If this option is unset:
3977 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003978 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003979 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3980 * on unspecified heuristics.
3981 */
3982//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3983
Steven Cooreman863470a2021-02-15 14:03:19 +01003984/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003985 * Restrict the PSA library to supporting a maximum amount of simultaneously
3986 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3987 * volatile key, or a persistent key which is loaded temporarily by the
3988 * library as part of a crypto operation in flight.
3989 *
3990 * If this option is unset, the library will fall back to a default value of
3991 * 32 keys.
3992 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003993//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003994
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003995/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003996//#define MBEDTLS_RSA_GEN_KEY_MIN_BITS 1024 /**< Minimum RSA key size that can be generated in bits (Minimum possible value is 128 bits) */
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003997
Paul Bakker088c5c52014-04-25 11:11:10 +02003998/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003999//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
4000//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02004001
Paul Bakker088c5c52014-04-25 11:11:10 +02004002/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10004003
Angus Grattond8213d02016-05-25 20:56:48 +10004004/** \def MBEDTLS_SSL_IN_CONTENT_LEN
4005 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004006 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004007 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004008 * This determines the size of the incoming TLS I/O buffer in such a way
4009 * that it is capable of holding the specified amount of plaintext data,
4010 * regardless of the protection mechanism used.
4011 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004012 * \note When using a value less than the default of 16KB on the client, it is
4013 * recommended to use the Maximum Fragment Length (MFL) extension to
4014 * inform the server about this limitation. On the server, there
4015 * is no supported, standardized way of informing the client about
4016 * restriction on the maximum size of incoming messages, and unless
4017 * the limitation has been communicated by other means, it is recommended
4018 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
4019 * while keeping the default value of 16KB for the incoming buffer.
4020 *
David Horstmann95d516f2021-05-04 18:36:56 +01004021 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004022 */
4023//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
4024
Gilles Peskined3d02902020-03-04 21:35:27 +01004025/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
4026 *
4027 * The maximum length of CIDs used for incoming DTLS messages.
4028 *
4029 */
4030//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
4031
4032/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
4033 *
4034 * The maximum length of CIDs used for outgoing DTLS messages.
4035 *
4036 */
4037//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
4038
TRodziewicze8dd7092021-05-12 14:19:11 +02004039/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01004040 *
4041 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02004042 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01004043 *
4044 * The padding will always be chosen so that the length of the
4045 * padded plaintext is a multiple of the value of this option.
4046 *
4047 * Note: A value of \c 1 means that no padding will be used
4048 * for outgoing records.
4049 *
4050 * Note: On systems lacking division instructions,
4051 * a power of two should be preferred.
4052 */
TRodziewicze8dd7092021-05-12 14:19:11 +02004053//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01004054
Angus Grattond8213d02016-05-25 20:56:48 +10004055/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4056 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004057 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004058 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004059 * This determines the size of the outgoing TLS I/O buffer in such a way
4060 * that it is capable of holding the specified amount of plaintext data,
4061 * regardless of the protection mechanism used.
4062 *
Angus Grattond8213d02016-05-25 20:56:48 +10004063 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4064 * the default inward 16384 byte buffer to conform to the TLS specification.
4065 *
4066 * The minimum required outward buffer size is determined by the handshake
4067 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4068 * The specific size requirement depends on the configured ciphers and any
4069 * certificate data which is sent during the handshake.
4070 *
David Horstmann95d516f2021-05-04 18:36:56 +01004071 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004072 */
4073//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4074
Hanno Beckere0b150f2018-08-21 15:51:03 +01004075/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4076 *
4077 * Maximum number of heap-allocated bytes for the purpose of
4078 * DTLS handshake message reassembly and future message buffering.
4079 *
Yuto Takano7828ca22021-08-10 11:26:15 +01004080 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004081 * to account for a reassembled handshake message of maximum size,
4082 * together with its reassembly bitmap.
4083 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004084 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004085 * should be sufficient for all practical situations as it allows
4086 * to reassembly a large handshake message (such as a certificate)
4087 * while buffering multiple smaller handshake messages.
4088 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004089 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004090//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004091
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004092//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 or 384 bits) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004093//#define MBEDTLS_SSL_COOKIE_TIMEOUT 60 /**< Default expiration delay of DTLS cookies, in seconds if HAVE_TIME, or in number of cookies issued */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02004094
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004095/**
4096 * Complete list of ciphersuites to use, in order of preference.
4097 *
4098 * \warning No dependency checking is done on that field! This option can only
4099 * be used to restrict the set of available ciphersuites. It is your
4100 * responsibility to make sure the needed modules are active.
4101 *
4102 * Use this to save a few hundred bytes of ROM (default ordering of all
4103 * available ciphersuites) and a few to a few hundred bytes of RAM.
4104 *
4105 * The value below is only an example, not the default.
4106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004107//#define MBEDTLS_SSL_CIPHERSUITES MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004108
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004109/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004110 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4111 *
4112 * The default maximum amount of 0-RTT data. See the documentation of
4113 * \c mbedtls_ssl_tls13_conf_max_early_data_size() for more information.
4114 *
4115 * It must be positive and smaller than UINT32_MAX.
4116 *
4117 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4118 * have any impact on the build.
4119 *
4120 * This feature is experimental, not completed and thus not ready for
4121 * production.
4122 *
4123 */
4124//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4125
4126/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004127 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4128 *
4129 * Maximum time difference in milliseconds tolerated between the age of a
4130 * ticket from the server and client point of view.
4131 * From the client point of view, the age of a ticket is the time difference
4132 * between the time when the client proposes to the server to use the ticket
4133 * (time of writing of the Pre-Shared Key Extension including the ticket) and
4134 * the time the client received the ticket from the server.
4135 * From the server point of view, the age of a ticket is the time difference
4136 * between the time when the server receives a proposition from the client
4137 * to use the ticket and the time when the ticket was created by the server.
4138 * The server age is expected to be always greater than the client one and
4139 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
4140 * maximum difference tolerated for the server to accept the ticket.
4141 * This is not used in TLS 1.2.
4142 *
4143 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004144//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004145
4146/**
4147 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4148 *
4149 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4150 *
4151 * This must be less than 256.
4152 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004153//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004154
4155/**
4156 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4157 *
4158 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4159 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4160 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4161 *
4162 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004163//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004164
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004165/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004166//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004167//#define MBEDTLS_X509_MAX_FILE_PATH_LEN 512 /**< Maximum length of a path/filename string in bytes including the null terminator character ('\0'). */
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004168
Gilles Peskine611179c2022-04-13 23:04:48 +02004169/** \} name SECTION: Module configuration options */