blob: df6bf55ef5bb52f938801ce48ca1d7384c069cf9 [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
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020034 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000035 *
36 * Requires support for asm() in compiler.
37 *
38 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000039 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010040 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000041 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000042 * library/constant_time.c
Paul Bakker68041ec2009-04-19 21:17:55 +000043 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010044 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000045 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010046 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020048 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000051
Paul Bakkerf3b86c12011-01-27 15:24:17 +000052/**
Gilles Peskineed942f82017-06-08 15:19:20 +020053 * \def MBEDTLS_NO_UDBL_DIVISION
54 *
55 * The platform lacks support for double-width integer division (64-bit
56 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
57 *
58 * Used in:
59 * include/mbedtls/bignum.h
60 * library/bignum.c
61 *
62 * The bignum code uses double-width division to speed up some operations.
63 * Double-width division is often implemented in software that needs to
64 * be linked with the program. The presence of a double-width integer
65 * type is usually detected automatically through preprocessor macros,
66 * but the automatic detection cannot know whether the code needs to
67 * and can be linked with an implementation of division for that type.
68 * By default division is assumed to be usable if the type is present.
69 * Uncomment this option to prevent the use of double-width division.
70 *
71 * Note that division for the native integer type is always required.
72 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010073 * platform, but it need not support multiplication or division. In some
74 * cases it is also desirable to disable some double-width operations. For
75 * example, if double-width division is implemented in software, disabling
76 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020077 */
78//#define MBEDTLS_NO_UDBL_DIVISION
79
80/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020081 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
82 *
83 * The platform lacks support for 32x32 -> 64-bit multiplication.
84 *
85 * Used in:
86 * library/poly1305.c
87 *
88 * Some parts of the library may use multiplication of two unsigned 32-bit
89 * operands with a 64-bit result in order to speed up computations. On some
90 * platforms, this is not available in hardware and has to be implemented in
91 * software, usually in a library provided by the toolchain.
92 *
93 * Sometimes it is not desirable to have to link to that library. This option
94 * removes the dependency of that library on platforms that lack a hardware
95 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
96 *
97 * Note that depending on the compiler, this may decrease performance compared
98 * to using the library function provided by the toolchain.
99 */
100//#define MBEDTLS_NO_64BIT_MULTIPLICATION
101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000104 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000105 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200113 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200114 * System has time.h and time().
115 * The time does not need to be correct, only time differences are used,
116 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200117 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100118 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
119 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
120 * MBEDTLS_PLATFORM_STD_TIME.
121 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400122 * Comment if your system does not support time functions.
123 *
124 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
125 * interface - timing.c will include time.h on suitable platforms
126 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
127 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100130
131/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200132 * \def MBEDTLS_HAVE_TIME_DATE
133 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100134 * System has time.h, time(), and an implementation for
135 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100136 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200137 * the date should be correct). This is used to verify the validity period of
138 * X.509 certificates.
139 *
140 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100141 *
Hanno Becker6a739782018-09-05 15:06:19 +0100142 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100143 * behaves similarly to the gmtime_r() function from the C standard. Refer to
144 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100145 *
146 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100147 * mbedtls_platform_gmtime_r() at compile-time by using the macro
148 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200149 */
150#define MBEDTLS_HAVE_TIME_DATE
151
152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100154 *
155 * Enable the memory allocation layer.
156 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200157 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 * This allows different allocators (self-implemented or provided) to be
159 * provided to the platform abstraction layer.
160 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400161 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200162 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
163 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000164 * free() function pointer at runtime.
165 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400166 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100169 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400170 * An overview of how the value of mbedtls_calloc is determined:
171 *
172 * - if !MBEDTLS_PLATFORM_MEMORY
173 * - mbedtls_calloc = calloc
174 * - if MBEDTLS_PLATFORM_MEMORY
175 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
176 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
177 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
179 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
180 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
182 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
183 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
184 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
185 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
186 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
187 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
188 *
189 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
190 * - if !MBEDTLS_PLATFORM_STD_CALLOC
191 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
192 *
193 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
194 *
195 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
196 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
197 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
198 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
199 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
200 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100203 *
204 * Enable this layer to allow use of alternative memory allocators.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100207
208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200211 * Do not assign standard functions in the platform layer (e.g. calloc() to
212 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200213 *
214 * This makes sure there are no linking errors on platforms that do not support
215 * these functions. You will HAVE to provide alternatives, either at runtime
216 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
218 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
222 * Uncomment to prevent default assignment of standard functions in the
223 * platform layer.
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200226
227/**
Janos Follathc351d182016-03-21 08:43:59 +0000228 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200230 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100231 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200233 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 * alternative printf function pointer.
236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200239 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
240 * it will be enabled automatically by check_config.h
241 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200242 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000244 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100245 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
246 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 * Uncomment a macro to enable alternate implementation of specific base
248 * platform function
249 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200250//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100252//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_FPRINTF_ALT
254//#define MBEDTLS_PLATFORM_PRINTF_ALT
255//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200256//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100257//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100258//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800259//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260
261/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200262 * Uncomment the macro to let Mbed TLS use your alternate implementation of
263 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
264 * platform_util.c.
265 *
266 * gmtime() is not a thread-safe function as defined in the C standard. The
267 * library will try to use safer implementations of this function, such as
268 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
269 * system, the implementation of mbedtls_platform_gmtime_r() will default to
270 * using the standard gmtime(). In this case, calls from the library to
271 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
272 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
273 * library are also guarded with this mutex to avoid race conditions. However,
274 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
275 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
276 * supplied at compile time.
277 */
278//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
279
280/**
Gilles Peskine86733832023-09-07 15:02:39 +0200281 * Uncomment the macro to let Mbed TLS use your alternate implementation of
282 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
283 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200284 *
Gilles Peskine86733832023-09-07 15:02:39 +0200285 * By default, the library uses a system function such as memset_s()
286 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
287 * SecureZeroMemory (Windows). If no such function is detected, the library
288 * falls back to a plain C implementation. Compilers are technically
289 * permitted to optimize this implementation out, meaning that the memory is
290 * not actually wiped. The library tries to prevent that, but the C language
291 * makes it impossible to guarantee that the memory will always be wiped.
292 *
293 * If your platform provides a guaranteed method to wipe memory which
294 * `platform_util.c` does not detect, define this macro to the name of
295 * a function that takes two arguments, a `void *` pointer and a length,
296 * and wipes that many bytes starting at the specified address. For example,
297 * if your platform has explicit_bzero() but `platform_util.c` does not
298 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
299 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200300 */
301//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
302
303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Mark deprecated functions and features so that they generate a warning if
307 * used. Functionality deprecated in one version will usually be removed in the
308 * next version. You can enable this to help you prepare the transition to a
309 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100310 *
311 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100313 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000314 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317
318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100320 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000321 * Remove deprecated functions and features so that they generate an error if
322 * used. Functionality deprecated in one version will usually be removed in the
323 * next version. You can enable this to help you prepare the transition to a
324 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100325 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000326 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100330/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000331
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000332/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200333 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000334 *
335 * This section sets support for features that are or are not needed
336 * within the modules that are enabled.
337 * \{
338 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
TRodziewiczd8540832021-06-10 15:16:50 +0200343 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200344 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
348 * You will need to provide a header "timing_alt.h" and an implementation at
349 * compile time.
350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100352
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200353//#define MBEDTLS_DES_CRYPT_ECB_ALT
354//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200355//#define MBEDTLS_AES_SETKEY_ENC_ALT
356//#define MBEDTLS_AES_SETKEY_DEC_ALT
357//#define MBEDTLS_AES_ENCRYPT_ALT
358//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300359//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300360//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300361//#define MBEDTLS_ECDSA_VERIFY_ALT
362//#define MBEDTLS_ECDSA_SIGN_ALT
363//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200364
365/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200366 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200367 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200368 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200369 * hardware entropy collector.
370 *
371 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000372 * prototype as declared in library/entropy_poll.h, and accept NULL as first
373 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200374 *
375 * Uncomment to use your own hardware entropy collector.
376 */
377//#define MBEDTLS_ENTROPY_HARDWARE_ALT
378
379/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000381 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100382 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000383 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100384 * Uncomment this macro to use precomputed AES tables stored in ROM.
385 * Comment this macro to generate AES tables in RAM at runtime.
386 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100387 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
388 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100389 * initialization time before the first AES operation can be performed.
390 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
391 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
392 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100393 *
394 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000395 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200396//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000397
398/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100399 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200400 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100401 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200402 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100403 * Uncommenting this macro omits 75% of the AES tables from
404 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
405 * by computing their values on the fly during operations
406 * (the tables are entry-wise rotations of one another).
407 *
408 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100409 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100410 * runtime. Specifically, one has to compare 4 accesses within
411 * different tables to 4 accesses with additional arithmetic
412 * operations within the same table. The performance gain/loss
413 * depends on the system and memory details.
414 *
415 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200416 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100417//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200418
419/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800420 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
421 *
422 * Use only 128-bit keys in AES operations to save ROM.
423 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800424 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800425 * or 256-bit keys.
426 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800427 * Uncommenting this macro reduces the size of AES code by ~300 bytes
428 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800429 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800430 * Module: library/aes.c
431 *
432 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800433 */
434//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
435
Gilles Peskinea8861e02023-09-05 20:20:51 +0200436/*
437 * Disable plain C implementation for AES.
438 *
439 * When the plain C implementation is enabled, and an implementation using a
440 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
441 * detection will be used to select between them.
442 *
443 * If only one implementation is present, runtime detection will not be used.
444 * This configuration will crash at runtime if running on a CPU without the
445 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
446 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
447 */
448//#define MBEDTLS_AES_USE_HARDWARE_ONLY
449
Arto Kinnunen732ca322023-04-14 14:26:10 +0800450/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200451 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200452 *
453 * Use less ROM for the Camellia implementation (saves about 768 bytes).
454 *
455 * Uncomment this macro to use less memory for Camellia.
456 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200457//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200458
459/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200460 * \def MBEDTLS_CHECK_RETURN_WARNING
461 *
462 * If this macro is defined, emit a compile-time warning if application code
463 * calls a function without checking its return value, but the return value
464 * should generally be checked in portable applications.
465 *
466 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
467 * implemented. Otherwise this option has no effect.
468 *
469 * Uncomment to get warnings on using fallible functions without checking
470 * their return value.
471 *
472 * \note This feature is a work in progress.
473 * Warnings will be added to more functions in the future.
474 *
475 * \note A few functions are considered critical, and ignoring the return
476 * value of these functions will trigger a warning even if this
477 * macro is not defined. To completely disable return value check
478 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
479 */
480//#define MBEDTLS_CHECK_RETURN_WARNING
481
482/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200483 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200484 *
485 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200487#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200488
489/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200490 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000491 *
492 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200494#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000495
496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200497 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000498 *
499 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200501#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000502
503/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100504 * \def MBEDTLS_CIPHER_MODE_OFB
505 *
506 * Enable Output Feedback mode (OFB) for symmetric ciphers.
507 */
508#define MBEDTLS_CIPHER_MODE_OFB
509
510/**
511 * \def MBEDTLS_CIPHER_MODE_XTS
512 *
513 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
514 */
515#define MBEDTLS_CIPHER_MODE_XTS
516
517/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200518 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000519 *
520 * Enable NULL cipher.
521 * Warning: Only do so when you know what you are doing. This allows for
522 * encryption or channels without any security!
523 *
Ronald Croncee42702021-04-26 11:34:44 +0200524 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
526 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
527 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
528 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
529 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
530 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
531 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
532 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
533 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
534 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
535 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
536 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
537 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
538 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
539 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
540 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
541 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
542 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
543 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000544 *
545 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200547//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000548
549/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100550 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200551 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100552 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
553 * specific padding modes in the cipher layer with cipher modes that support
554 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200555 *
556 * If you disable all padding modes, only full blocks can be used with CBC.
557 *
558 * Enable padding modes in the cipher layer.
559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560#define MBEDTLS_CIPHER_PADDING_PKCS7
561#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
562#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
563#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200564
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200565/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
566 *
567 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800568 * Without this, CTR_DRBG uses a 256-bit key
569 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200570 */
571//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
572
Paul Bakker48e93c82013-08-14 12:21:18 +0200573/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200574 * Enable the verified implementations of ECDH primitives from Project Everest
575 * (currently only Curve25519). This feature changes the layout of ECDH
576 * contexts and therefore is a compatibility break for applications that access
577 * fields of a mbedtls_ecdh_context structure directly. See also
578 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000579 *
580 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
581 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200582 */
583//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
584
585/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100586 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200587 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100588 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
589 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200590 *
591 * Comment macros to disable the curve and functions for it
592 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200593/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
595#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
596#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
597#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
598#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
599#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
600#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
601#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
602#define MBEDTLS_ECP_DP_BP256R1_ENABLED
603#define MBEDTLS_ECP_DP_BP384R1_ENABLED
604#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200605/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200606#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000607#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200608
609/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200611 *
612 * Enable specific 'modulo p' routines for each NIST prime.
613 * Depending on the prime and architecture, makes operations 4 to 8 times
614 * faster on the corresponding curve.
615 *
616 * Comment this macro to disable NIST curves optimisation.
617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200618#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200619
620/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200621 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100622 *
623 * Enable "non-blocking" ECC operations that can return early and be resumed.
624 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200625 * This allows various functions to pause by returning
626 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
627 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
628 * order to further progress and eventually complete their operation. This is
629 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
630 * number of ECC operations a function may perform before pausing; see
631 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100632 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200633 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200634 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100635 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100636 * This option:
637 * - Adds xxx_restartable() variants of existing operations in the
638 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100639 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
640 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100641 * - ECDSA: signature generation & verification;
642 * - PK: signature generation & verification;
643 * - X509: certificate chain verification.
644 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
645 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
646 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
647 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000648 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100649 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100650 * - verification of the server's key exchange signature;
651 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100652 * - generation of the client's signature if client authentication is used,
653 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100654 *
655 * \note In the cases above, the usual SSL/TLS functions, such as
656 * mbedtls_ssl_handshake(), can now return
657 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200658 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100659 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
660 * restartable operations in PK, X.509 and TLS (see above) are not
661 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100662 * PSA, and are not restartable. These are temporary limitations that
663 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200664 *
Ron Eldor19779c42018-11-05 16:58:13 +0200665 * \note This option only works with the default software implementation of
666 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100667 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100668 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100669 * Requires: MBEDTLS_ECP_C
670 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100671 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100672 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200673//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100674
675/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200676 * Uncomment to enable using new bignum code in the ECC modules.
677 *
678 * \warning This is currently experimental, incomplete and therefore should not
679 * be used in production.
680 */
681//#define MBEDTLS_ECP_WITH_MPI_UINT
682
683/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100685 *
686 * Enable deterministic ECDSA (RFC 6979).
687 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
688 * may result in a compromise of the long-term signing key. This is avoided by
689 * the deterministic variant.
690 *
John Durkop36a82e52020-10-26 09:39:05 -0700691 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100692 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100693 * Comment this macro to disable deterministic ECDSA.
694 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100696
697/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200698 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200699 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200700 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200701 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200702 * This enables the following ciphersuites (if other requisites are
703 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200704 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
705 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
706 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
707 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
708 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
709 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
710 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
711 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
712 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
713 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200714 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200716
717/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200718 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200719 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200720 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200721 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200723 *
724 * This enables the following ciphersuites (if other requisites are
725 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200726 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
727 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
728 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
729 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
730 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
731 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
732 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
733 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
734 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
735 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100736 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100737 * \warning Using DHE constitutes a security risk as it
738 * is not possible to validate custom DH parameters.
739 * If possible, it is recommended users should consider
740 * preferring other methods of key exchange.
741 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100742 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200743 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200744#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200745
746/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200747 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200748 *
749 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
750 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200751 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200752 *
753 * This enables the following ciphersuites (if other requisites are
754 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200755 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
756 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
757 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
758 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
759 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
760 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200763
764/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200766 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200767 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200768 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
770 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200771 *
772 * This enables the following ciphersuites (if other requisites are
773 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200774 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
775 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
776 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
777 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
778 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
779 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
780 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
781 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
782 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
783 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200784 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200786
787/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200788 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200789 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200790 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200791 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200792 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
793 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200794 *
795 * This enables the following ciphersuites (if other requisites are
796 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
798 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
799 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
800 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
801 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
802 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
803 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
804 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
805 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
806 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
807 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
808 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200811
812/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200814 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200815 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200816 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200817 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
818 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200819 *
820 * This enables the following ciphersuites (if other requisites are
821 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200822 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
823 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
824 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
825 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
826 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
827 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
828 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
829 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
830 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
831 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
832 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
833 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100834 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100835 * \warning Using DHE constitutes a security risk as it
836 * is not possible to validate custom DH parameters.
837 * If possible, it is recommended users should consider
838 * preferring other methods of key exchange.
839 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100840 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200841 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200843
844/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200846 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200847 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200848 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200849 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
850 * MBEDTLS_RSA_C
851 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200852 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200853 *
854 * This enables the following ciphersuites (if other requisites are
855 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200856 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
857 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
858 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
859 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
860 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
861 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
862 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
863 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
864 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
865 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200868
869/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200871 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200872 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200873 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200874 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
875 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
876 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200877 *
878 * This enables the following ciphersuites (if other requisites are
879 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200880 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
881 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
882 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
883 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
884 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
885 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
886 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
887 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
888 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
889 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200890 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200891#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200892
893/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100895 *
896 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
897 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200898 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
899 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
900 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100901 *
902 * This enables the following ciphersuites (if other requisites are
903 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200904 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
905 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
906 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
907 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
908 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
909 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
910 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
911 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
912 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
913 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100914 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100916
917/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100919 *
920 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
921 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200922 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
923 * MBEDTLS_RSA_C
924 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100925 *
926 * This enables the following ciphersuites (if other requisites are
927 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
929 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
930 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
931 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
932 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
933 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
934 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
935 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
936 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
937 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100940
941/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200942 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
943 *
944 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
945 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200946 * \warning This is currently experimental. EC J-PAKE support is based on the
947 * Thread v1.0.0 specification; incompatible changes to the specification
948 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200949 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200950 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100951 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200952 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
953 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100954 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800955 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100956 * MBEDTLS_USE_PSA_CRYPTO is disabled).
957 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200958 * This enables the following ciphersuites (if other requisites are
959 * enabled as well):
960 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
961 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200962//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200963
964/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100966 *
967 * Enhance support for reading EC keys using variants of SEC1 not allowed by
968 * RFC 5915 and RFC 5480.
969 *
970 * Currently this means parsing the SpecifiedECDomain choice of EC
971 * parameters (only known groups are supported, not arbitrary domains, to
972 * avoid validation issues).
973 *
974 * Disable if you only need to support RFC 5915 + 5480 key formats.
975 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200976#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100977
978/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200979 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
980 *
981 * Enable the support for parsing public keys of type Short Weierstrass
982 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200983 * compressed point format. This parsing is done through ECP module's functions.
984 *
985 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
986 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
987 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200988 */
989#define MBEDTLS_PK_PARSE_EC_COMPRESSED
990
991/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100993 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994 * Enable a dummy error function to make use of mbedtls_strerror() in
995 * third party libraries easier when MBEDTLS_ERROR_C is disabled
996 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200997 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
999 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001000 *
1001 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001002 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001003 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001005
1006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001008 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001009 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001010 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001014
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001015/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001017 *
1018 * Enable functions that use the filesystem.
1019 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001021
1022/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001024 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001025 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001026 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001027 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001028 * application.
1029 *
1030 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001031 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001032//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001033
1034/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001036 *
1037 * Do not use built-in platform entropy functions.
1038 * This is useful if your platform does not support
1039 * standards like the /dev/urandom or Windows CryptoAPI.
1040 *
1041 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001044
1045/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001046 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001047 *
1048 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1049 * default SHA-512 based one (if both are available).
1050 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001052 *
1053 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1054 * if you have performance concerns.
1055 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056 * This option is only useful if both MBEDTLS_SHA256_C and
1057 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001060
1061/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001062 * \def MBEDTLS_ENTROPY_NV_SEED
1063 *
1064 * Enable the non-volatile (NV) seed file-based entropy source.
1065 * (Also enables the NV seed read/write functions in the platform layer)
1066 *
1067 * This is crucial (if not required) on systems that do not have a
1068 * cryptographic entropy source (in hardware or kernel) available.
1069 *
1070 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1071 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001072 * \note The read/write functions that are used by the entropy source are
1073 * determined in the platform layer, and can be modified at runtime and/or
1074 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1075 *
1076 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001077 * with regular fopen(), please make sure you make a seedfile with the
1078 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1079 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001080 * and written to or you will get an entropy source error! The default
1081 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1082 * bytes from the file.
1083 *
1084 * \note The entropy collector will write to the seed file before entropy is
1085 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001086 */
1087//#define MBEDTLS_ENTROPY_NV_SEED
1088
Ronald Cron71016a92020-08-28 19:01:50 +02001089/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001090 *
Ronald Cron71016a92020-08-28 19:01:50 +02001091 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001092 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001093 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1094 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001095 *
1096 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001097 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001098 */
Ronald Cron71016a92020-08-28 19:01:50 +02001099//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001100
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001101/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001103 *
1104 * Enable debugging of buffer allocator memory issues. Automatically prints
1105 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1106 * function for 'debug output' of allocated memory.
1107 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001109 *
1110 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001111 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001113
1114/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001116 *
1117 * Include backtrace information with each allocated block.
1118 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001120 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001121 *
1122 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001123 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001124//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001125
1126/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001128 *
1129 * Support external private RSA keys (eg from a HSM) in the PK layer.
1130 *
1131 * Comment this macro to disable support for external private RSA keys.
1132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001134
1135/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001137 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001138 * Enable support for PKCS#1 v1.5 encoding.
1139 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001140 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001141 *
Paul Bakker48377d92013-08-30 12:06:24 +02001142 * This enables support for PKCS#1 v1.5 operations.
1143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001145
1146/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001147 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001148 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001149 * Enable support for PKCS#1 v2.1 encoding.
1150 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001151 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001152 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001153 * \warning If using a hash that is only provided by PSA drivers, you must
1154 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001155 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001156 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1157 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001159
Steven Cooreman6801f082021-02-19 17:21:22 +01001160/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1161 *
1162 * Enable support for platform built-in keys. If you enable this feature,
1163 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1164 * See the documentation of that function for more information.
1165 *
1166 * Built-in keys are typically derived from a hardware unique key or
1167 * stored in a secure element.
1168 *
1169 * Requires: MBEDTLS_PSA_CRYPTO_C.
1170 *
1171 * \warning This interface is experimental and may change or be removed
1172 * without notice.
1173 */
1174//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1175
Ronald Cron3768ac12021-01-26 16:58:00 +01001176/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1177 *
1178 * Enable support for PSA crypto client.
1179 *
1180 * \note This option allows to include the code necessary for a PSA
1181 * crypto client when the PSA crypto implementation is not included in
1182 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1183 * code to set and get PSA key attributes.
1184 * The development of PSA drivers partially relying on the library to
1185 * fulfill the hardware gaps is another possible usage of this option.
1186 *
1187 * \warning This interface is experimental and may change or be removed
1188 * without notice.
1189 */
1190//#define MBEDTLS_PSA_CRYPTO_CLIENT
1191
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001192/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1193 *
1194 * Make the PSA Crypto module use an external random generator provided
1195 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1196 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001197 * \note This random generator must deliver random numbers with cryptographic
1198 * quality and high performance. It must supply unpredictable numbers
1199 * with a uniform distribution. The implementation of this function
1200 * is responsible for ensuring that the random generator is seeded
1201 * with sufficient entropy. If you have a hardware TRNG which is slow
1202 * or delivers non-uniform output, declare it as an entropy source
1203 * with mbedtls_entropy_add_source() instead of enabling this option.
1204 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001205 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001206 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1207 * and define a function called mbedtls_psa_external_get_random()
1208 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001209 * ```
1210 * psa_status_t mbedtls_psa_external_get_random(
1211 * mbedtls_psa_external_random_context_t *context,
1212 * uint8_t *output, size_t output_size, size_t *output_length);
1213 * );
1214 * ```
1215 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001216 * The function must fill the \c output buffer with \c output_size bytes
1217 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001218 *
1219 * Requires: MBEDTLS_PSA_CRYPTO_C
1220 *
1221 * \warning If you enable this option, code that uses the PSA cryptography
1222 * interface will not use any of the entropy sources set up for
1223 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1224 * enables.
1225 *
1226 * \note This option is experimental and may be removed without notice.
1227 */
1228//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1229
Paul Bakker9dcc3222011-03-08 14:16:06 +00001230/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001231 * \def MBEDTLS_PSA_CRYPTO_SPM
1232 *
1233 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1234 * Partition Manager) integration which separates the code into two parts: a
1235 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1236 * Environment).
1237 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001238 * If you enable this option, your build environment must include a header
1239 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1240 * header files, or in another directory on the compiler's include search
1241 * path). Alternatively, your platform may customize the header
1242 * `psa/crypto_platform.h`, in which case it can skip or replace the
1243 * inclusion of `"crypto_spe.h"`.
1244 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001245 * Module: library/psa_crypto.c
1246 * Requires: MBEDTLS_PSA_CRYPTO_C
1247 *
1248 */
1249//#define MBEDTLS_PSA_CRYPTO_SPM
1250
1251/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001252 * Uncomment to enable p256-m. This is an alternative implementation of
1253 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1254 * Compared to the default implementation:
1255 *
1256 * - p256-m has a much smaller code size and RAM footprint.
1257 * - p256-m is only available via the PSA API. This includes the pk module
1258 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1259 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1260 * over the core arithmetic, or deterministic derivation of keys.
1261 *
1262 * We recommend enabling this option if your application uses the PSA API
1263 * and the only elliptic curve support it needs is ECDH and ECDSA over
1264 * SECP256R1.
1265 *
1266 * If you enable this option, you do not need to enable any ECC-related
1267 * MBEDTLS_xxx option. You do need to separately request support for the
1268 * cryptographic mechanisms through the PSA API:
1269 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1270 * configuration;
1271 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1272 * - #PSA_WANT_ECC_SECP_R1_256;
1273 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1274 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1275 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1276 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1277 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001278 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001279 * \note To benefit from the smaller code size of p256-m, make sure that you
1280 * do not enable any ECC-related option not supported by p256-m: this
1281 * would cause the built-in ECC implementation to be built as well, in
1282 * order to provide the required option.
1283 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001284 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1285 * SECP256R1 are disabled as they are not supported by this driver.
1286 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1287 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001288 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001289 */
1290//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1291
1292/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001293 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001294 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001295 * Enable support for entropy injection at first boot. This feature is
1296 * required on systems that do not have a built-in entropy source (TRNG).
1297 * This feature is currently not supported on systems that have a built-in
1298 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001299 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001300 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001301 *
1302 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001303//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001304
1305/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001306 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001307 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001308 * Assume all buffers passed to PSA functions are owned exclusively by the
1309 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001310 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001311 * This option may be enabled if all buffers passed to any PSA function reside
1312 * in memory that is accessible only to the PSA function during its execution.
1313 *
1314 * This option MUST be disabled whenever buffer arguments are in memory shared
1315 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001316 * across a trust boundary.
1317 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001318 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001319 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001320 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001321 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001322 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001323//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001324
1325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001326 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001327 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001328 * Do not use the Chinese Remainder Theorem
1329 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001330 *
1331 * Uncomment this macro to disable the use of CRT in RSA.
1332 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001333 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001334//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001335
1336/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001337 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001338 *
1339 * Enable the checkup functions (*_self_test).
1340 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001341#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001342
1343/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001344 * \def MBEDTLS_SHA256_SMALLER
1345 *
1346 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1347 * lower performance.
1348 *
Adam Wolf039080f2019-09-10 09:53:08 -05001349 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001350 * performance and size. This version optimizes more aggressively for size at
1351 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1352 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1353 * 30%.
1354 *
1355 * Uncomment to enable the smaller implementation of SHA256.
1356 */
1357//#define MBEDTLS_SHA256_SMALLER
1358
1359/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001360 * \def MBEDTLS_SHA512_SMALLER
1361 *
1362 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1363 * lower performance.
1364 *
1365 * Uncomment to enable the smaller implementation of SHA512.
1366 */
1367//#define MBEDTLS_SHA512_SMALLER
1368
1369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001370 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001371 *
1372 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001373 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001374 * with other servers, only debugging of failures is harder.
1375 *
1376 * The advantage of not sending alert messages, is that no information is given
1377 * about reasons for failures thus preventing adversaries of gaining intel.
1378 *
1379 * Enable sending of all alert messages
1380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001381#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001382
1383/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001384 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1385 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001386 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001387 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001388 * in the underlying transport. The CID functionality is described
1389 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001390 *
1391 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001392 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1393 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1394 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001395 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001396 * The maximum lengths of outgoing and incoming CIDs can be configured
1397 * through the options
1398 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1399 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1400 *
1401 * Requires: MBEDTLS_SSL_PROTO_DTLS
1402 *
1403 * Uncomment to enable the Connection ID extension.
1404 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001405#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1406
1407
1408/**
1409 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1410 *
1411 * Defines whether RFC 9146 (default) or the legacy version
1412 * (version draft-ietf-tls-dtls-connection-id-05,
1413 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1414 * is used.
1415 *
1416 * Set the value to 0 for the standard version, and
1417 * 1 for the legacy draft version.
1418 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001419 * \deprecated Support for the legacy version of the DTLS
1420 * Connection ID feature is deprecated. Please
1421 * switch to the standardized version defined
1422 * in RFC 9146 enabled by utilizing
1423 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1424 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1425 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001426 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1427 */
1428#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001429
1430/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001431 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1432 *
1433 * Enable asynchronous external private key operations in SSL. This allows
1434 * you to configure an SSL connection to call an external cryptographic
1435 * module to perform private key operations instead of performing the
1436 * operation inside the library.
1437 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001438 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001439 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001440//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001441
1442/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001443 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1444 *
1445 * Enable serialization of the TLS context structures, through use of the
1446 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1447 *
1448 * This pair of functions allows one side of a connection to serialize the
1449 * context associated with the connection, then free or re-use that context
1450 * while the serialized state is persisted elsewhere, and finally deserialize
1451 * that state to a live context for resuming read/write operations on the
1452 * connection. From a protocol perspective, the state of the connection is
1453 * unaffected, in particular this is entirely transparent to the peer.
1454 *
1455 * Note: this is distinct from TLS session resumption, which is part of the
1456 * protocol and fully visible by the peer. TLS session resumption enables
1457 * establishing new connections associated to a saved session with shorter,
1458 * lighter handshakes, while context serialization is a local optimization in
1459 * handling a single, potentially long-lived connection.
1460 *
1461 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1462 * saved after the handshake to allow for more efficient serialization, so if
1463 * you don't need this feature you'll save RAM by disabling it.
1464 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001465 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1466 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001467 * Comment to disable the context serialization APIs.
1468 */
1469#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1470
1471/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001472 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001473 *
1474 * Enable the debug messages in SSL module for all issues.
1475 * Debug messages have been disabled in some places to prevent timing
1476 * attacks due to (unbalanced) debugging function calls.
1477 *
1478 * If you need all error reporting you should enable this during debugging,
1479 * but remove this for production servers that should log as well.
1480 *
1481 * Uncomment this macro to report all debug messages on errors introducing
1482 * a timing side-channel.
1483 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001485//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001486
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001487/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001488 *
1489 * Enable support for Encrypt-then-MAC, RFC 7366.
1490 *
1491 * This allows peers that both support it to use a more robust protection for
1492 * ciphersuites using CBC, providing deep resistance against timing attacks
1493 * on the padding or underlying cipher.
1494 *
1495 * This only affects CBC ciphersuites, and is useless if none is defined.
1496 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001497 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001498 *
1499 * Comment this macro to disable support for Encrypt-then-MAC
1500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001501#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001502
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001503/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001504 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001505 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1506 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001507 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001508 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001509 * attacks, but it is recommended to always use it (even if you disable
1510 * renegotiation), since it actually fixes a more fundamental issue in the
1511 * original SSL/TLS design, and has implications beyond Triple Handshake.
1512 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001513 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001514 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001515 * Comment this macro to disable support for Extended Master Secret.
1516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001517#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001518
Paul Bakkerd66f0702013-01-31 16:57:45 +01001519/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001520 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1521 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001522 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001523 * giving access to the peer's certificate after completion of the handshake.
1524 *
1525 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1526 * recommended to disable this option for reduced RAM usage.
1527 *
1528 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1529 * defined, but always returns \c NULL.
1530 *
1531 * \note This option has no influence on the protection against the
1532 * triple handshake attack. Even if it is disabled, Mbed TLS will
1533 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001534 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001535 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001536 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001537 *
1538 * Comment this macro to disable storing the peer's certificate
1539 * after the handshake.
1540 */
1541#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1542
1543/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001544 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001545 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001546 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001547 *
1548 * The two main uses of renegotiation are (1) refresh keys on long-lived
1549 * connections and (2) client authentication after the initial handshake.
1550 * If you don't need renegotiation, it's probably better to disable it, since
1551 * it has been associated with security issues in the past and is easy to
1552 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001553 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001554 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1555 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001556 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001557 *
1558 * \note Even if this option is disabled, both client and server are aware
1559 * of the Renegotiation Indication Extension (RFC 5746) used to
1560 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1561 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1562 * configuration of this extension).
1563 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001564 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001565#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001566
1567/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001568 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001569 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001570 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001571 *
1572 * Comment this macro to disable support for the max_fragment_length extension
1573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001575
1576/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001577 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1578 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001579 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001580 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001581 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1582 *
1583 * Uncomment this macro to enable support for the record_size_limit extension
1584 */
1585//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1586
1587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001588 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001589 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001590 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001591 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001592 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001593 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1594 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001595 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001596 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001597 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001598 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1599 * are only provided by PSA drivers, you must call psa_crypto_init() before
1600 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001601 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001602 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001604#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001605
1606/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001607 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001608 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001609 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001610 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001611 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001612 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001613 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001614 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001615 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001616 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001617 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1618 * directly performed by TLS 1.3 code. As a consequence, you must
1619 * call psa_crypto_init() before the first TLS 1.3 handshake.
1620 *
1621 * \note Cryptographic operations performed indirectly via another module
1622 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1623 * running handshake hash) only use PSA crypto if
1624 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001625 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001626 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001627 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001628#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001629
1630/**
Ronald Cronab65c522021-11-24 10:47:20 +01001631 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1632 *
1633 * Enable TLS 1.3 middlebox compatibility mode.
1634 *
1635 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1636 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1637 * expecting TLS 1.2 traffic.
1638 *
1639 * Turning on the compatibility mode comes at the cost of a few added bytes
1640 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1641 * that don't use it. Therefore, unless transmission bandwidth is critical and
1642 * you know that middlebox compatibility issues won't occur, it is therefore
1643 * recommended to set this option.
1644 *
1645 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001646 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1647 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001648 *
1649 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001650#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001651
1652/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001653 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1654 *
1655 * Enable TLS 1.3 PSK key exchange mode.
1656 *
1657 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1658 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1659 * effect on the build.
1660 *
1661 */
1662#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1663
1664/**
1665 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1666 *
1667 * Enable TLS 1.3 ephemeral key exchange mode.
1668 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001669 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001670 * MBEDTLS_X509_CRT_PARSE_C
1671 * and at least one of:
1672 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1673 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001674 *
1675 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1676 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1677 * effect on the build.
1678 *
1679 */
1680#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1681
1682/**
1683 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1684 *
1685 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1686 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001687 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001688 *
1689 * Comment to disable support for the PSK ephemeral key exchange mode in
1690 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1691 * have any effect on the build.
1692 *
1693 */
1694#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1695
1696/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 * \def MBEDTLS_SSL_EARLY_DATA
1698 *
1699 * Enable support for RFC 8446 TLS 1.3 early data.
1700 *
1701 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1702 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1703 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1704 *
1705 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1706 * is not enabled, this option does not have any effect on the build.
1707 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001708 * \note The maximum amount of early data can be set with
1709 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1710 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001712//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001713
1714/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001716 *
1717 * Enable support for DTLS (all available versions).
1718 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001719 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001720 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001721 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001722 *
1723 * Comment this macro to disable support for DTLS
1724 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001726
1727/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001729 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001730 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001731 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001732 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001733 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001735
1736/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001737 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001738 *
1739 * Enable support for the anti-replay mechanism in DTLS.
1740 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001741 * Requires: MBEDTLS_SSL_TLS_C
1742 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001743 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001744 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001745 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001746 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001747 * Comment this to disable anti-replay in DTLS.
1748 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001749#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001750
1751/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001753 *
1754 * Enable support for HelloVerifyRequest on DTLS servers.
1755 *
1756 * This feature is highly recommended to prevent DTLS servers being used as
1757 * amplifiers in DoS attacks against other hosts. It should always be enabled
1758 * unless you know for sure amplification cannot be a problem in the
1759 * environment in which your server operates.
1760 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001761 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001762 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001763 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001764 *
1765 * Comment this to disable support for HelloVerifyRequest.
1766 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001768
1769/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001770 * \def MBEDTLS_SSL_DTLS_SRTP
1771 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001772 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001773 * through the use_srtp extension.
1774 *
1775 * \note This feature provides the minimum functionality required
1776 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1777 * the associated SRTP packet protection key material.
1778 * In particular, the SRTP packet protection itself, as well as the
1779 * demultiplexing of RTP and DTLS packets at the datagram layer
1780 * (see Section 5 of RFC 5764), are not handled by this feature.
1781 * Instead, after successful completion of a handshake negotiating
1782 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001783 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001784 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1785 * (this is implemented in the SSL example programs).
1786 * The resulting key should then be passed to an SRTP stack.
1787 *
1788 * Setting this option enables the runtime API
1789 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1790 * through which the supported DTLS-SRTP protection
1791 * profiles can be configured. You must call this API at
1792 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001793 *
1794 * Requires: MBEDTLS_SSL_PROTO_DTLS
1795 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001796 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001797 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001798//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001799
1800/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001801 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1802 *
1803 * Enable server-side support for clients that reconnect from the same port.
1804 *
1805 * Some clients unexpectedly close the connection and try to reconnect using the
1806 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001807 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001808 * flag enables that support.
1809 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001810 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001811 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001812 * Comment this to disable support for clients reusing the source port.
1813 */
1814#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1815
1816/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001818 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001819 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001820 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001821 * session store remains the responsibility of the application, though).
1822 * Server-side, you also need to provide callbacks for writing and parsing
1823 * tickets, including authenticated encryption and key management. Example
1824 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001825 *
1826 * Comment this macro to disable support for SSL session tickets
1827 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001828#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001829
1830/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001831 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001832 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001833 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001834 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001835 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001836 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001837 * Comment this macro to disable support for server name indication in SSL
1838 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001839#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001840
1841/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001842 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1843 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001844 * When this option is enabled, the SSL buffer will be resized automatically
1845 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001846 *
1847 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001848 */
1849//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1850
1851/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001852 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1853 *
1854 * Enable testing of the constant-flow nature of some sensitive functions with
1855 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001856 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001857 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001858 * This setting requires compiling with clang -fsanitize=memory. The test
1859 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001860 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001861 * \warning This macro is only used for extended testing; it is not considered
1862 * part of the library's API, so it may change or disappear at any time.
1863 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001864 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001865 */
1866//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1867
1868/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001869 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1870 *
1871 * Enable testing of the constant-flow nature of some sensitive functions with
1872 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001873 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001874 *
1875 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001876 * testing if the tests suites are run with valgrind's memcheck. This can be
1877 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1878 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001879 *
1880 * \warning This macro is only used for extended testing; it is not considered
1881 * part of the library's API, so it may change or disappear at any time.
1882 *
1883 * Uncomment to enable testing of the constant-flow nature of selected code.
1884 */
1885//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1886
1887/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001888 * \def MBEDTLS_TEST_HOOKS
1889 *
1890 * Enable features for invasive testing such as introspection functions and
1891 * hooks for fault injection. This enables additional unit tests.
1892 *
1893 * Merely enabling this feature should not change the behavior of the product.
1894 * It only adds new code, and new branching points where the default behavior
1895 * is the same as when this feature is disabled.
1896 * However, this feature increases the attack surface: there is an added
1897 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1898 * Therefore this feature must never be enabled in production.
1899 *
1900 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1901 * information.
1902 *
1903 * Uncomment to enable invasive tests.
1904 */
1905//#define MBEDTLS_TEST_HOOKS
1906
1907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001909 *
1910 * Provide your own alternate threading implementation.
1911 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001913 *
1914 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001915 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001917
1918/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001920 *
1921 * Enable the pthread wrapper layer for the threading layer.
1922 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001924 *
1925 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001926 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001927//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001928
1929/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001930 * \def MBEDTLS_USE_PSA_CRYPTO
1931 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001932 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1933 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001934 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001935 * \note Development of this option is currently in progress, and parts of Mbed
1936 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001937 * will still continue to work as usual, so enabling this option should not
1938 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001939 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001940 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001941 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1942 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001943 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001944 * \note An important and desirable effect of this option is that it allows
1945 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1946 * 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 +02001947 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001948 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1949 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001950 *
1951 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001952 *
1953 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001954 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001955 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001957//#define MBEDTLS_USE_PSA_CRYPTO
1958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001960 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1961 *
John Durkop185764f2020-10-12 21:32:12 -07001962 * This setting allows support for cryptographic mechanisms through the PSA
1963 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001964 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001965 * When this option is disabled, the PSA API exposes the cryptographic
1966 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1967 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001968 *
1969 * When this option is enabled, the PSA API exposes the cryptographic
1970 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1971 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1972 * automatically enabled if required (i.e. if no PSA driver provides the
1973 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1974 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001975 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001976 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001977 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001978 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001979 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1980 * symbols is not completely finalized yet, and the configuration
1981 * tooling is not ideally adapted to having two separate configuration
1982 * files.
1983 * Future minor releases of Mbed TLS may make minor changes to those
1984 * symbols, but we will endeavor to provide a transition path.
1985 * Nonetheless, this option is considered mature enough to use in
1986 * production, as long as you accept that you may need to make
1987 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001988 */
1989//#define MBEDTLS_PSA_CRYPTO_CONFIG
1990
1991/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001992 * \def MBEDTLS_VERSION_FEATURES
1993 *
1994 * Allow run-time checking of compile-time enabled features. Thus allowing users
1995 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001996 * support via mbedtls_version_check_feature().
1997 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001998 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00001999 *
2000 * Comment this to disable run-time checking and save ROM space
2001 */
2002#define MBEDTLS_VERSION_FEATURES
2003
2004/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002005 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2006 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002007 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002008 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2009 * the set of trusted certificates through a callback instead of a linked
2010 * list.
2011 *
2012 * This is useful for example in environments where a large number of trusted
2013 * certificates is present and storing them in a linked list isn't efficient
2014 * enough, or when the set of trusted certificates changes frequently.
2015 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002016 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002017 * `mbedtls_ssl_conf_ca_cb()` for more information.
2018 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002019 * Requires: MBEDTLS_X509_CRT_PARSE_C
2020 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002021 * Uncomment to enable trusted certificate callbacks.
2022 */
2023//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2024
2025/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002026 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002027 *
Chris Jones2c745862020-12-16 11:41:06 +00002028 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002029 *
Chris Jones2c745862020-12-16 11:41:06 +00002030 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002031 * and other functions/constants only used by these functions, thus reducing
2032 * the code footprint by several KB.
2033 */
Chris Jones2c745862020-12-16 11:41:06 +00002034//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002035
2036/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002038 *
2039 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2040 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2041 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002042 * Requires: MBEDTLS_PKCS1_V21
2043 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002044 * Comment this macro to disallow using RSASSA-PSS in certificates.
2045 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002047/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002048
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002049/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002050 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002051 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002052 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002053 * \{
2054 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002055
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002056/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002058 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002059 * Enable AES-NI support on x86-64 or x86-32.
2060 *
2061 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002062 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002063 * - GCC, x86-64, target not explicitly supporting AESNI:
2064 * requires MBEDTLS_HAVE_ASM.
2065 * - GCC, x86-32, target not explicitly supporting AESNI:
2066 * not supported.
2067 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2068 * For this assembly-less implementation, you must currently compile
2069 * `library/aesni.c` and `library/aes.c` with machine options to enable
2070 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2071 * `clang -maes -mpclmul`.
2072 * - Non-x86 targets: this option is silently ignored.
2073 * - Other compilers: this option is silently ignored.
2074 *
2075 * \note
2076 * Above, "GCC" includes compatible compilers such as Clang.
2077 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002078 *
2079 * Module: library/aesni.c
2080 * Caller: library/aes.c
2081 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002082 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002083 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002084 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002087
2088/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002089 * \def MBEDTLS_AESCE_C
2090 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002091 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002092 *
2093 * Module: library/aesce.c
2094 * Caller: library/aes.c
2095 *
Jerry Yuf015a932023-04-25 10:38:03 +08002096 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002097 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002098 * \warning Runtime detection only works on Linux. For non-Linux operating
2099 * system, Armv8-A Cryptographic Extensions must be supported by
2100 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002101 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002102 * \note Minimum compiler versions for this feature when targeting aarch64
2103 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2104 * Minimum compiler versions for this feature when targeting 32-bit
2105 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002106 *
2107 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2108 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002109 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002110 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002111 */
2112#define MBEDTLS_AESCE_C
2113
2114/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002115 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002116 *
2117 * Enable the AES block cipher.
2118 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002119 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002120 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002121 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002122 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002123 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002124 * This module enables the following ciphersuites (if other requisites are
2125 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2127 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2128 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2129 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2130 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2131 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2132 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2133 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2134 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2135 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2136 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2137 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2138 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2139 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2140 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2141 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2142 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2143 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2144 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2145 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2146 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2147 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2148 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2149 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2150 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2151 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2152 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2153 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2154 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2155 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2156 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2157 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2158 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2159 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2160 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2161 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2162 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2163 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2164 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2165 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2166 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2167 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2168 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2169 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2170 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2171 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2172 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2173 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2174 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2175 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2176 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2177 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2178 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2179 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2180 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2181 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2182 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2183 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002184 *
Paul Bakkercff68422013-09-15 20:43:33 +02002185 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002187#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002188
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002189/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002190 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002191 *
2192 * Enable the generic ASN1 parser.
2193 *
2194 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002195 * Caller: library/x509.c
2196 * library/dhm.c
2197 * library/pkcs12.c
2198 * library/pkcs5.c
2199 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002201#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002202
2203/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002205 *
2206 * Enable the generic ASN1 writer.
2207 *
2208 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002209 * Caller: library/ecdsa.c
2210 * library/pkwrite.c
2211 * library/x509_create.c
2212 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002213 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002215#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002216
2217/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002218 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002219 *
2220 * Enable the Base64 module.
2221 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002222 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002223 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002224 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002225 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002228
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002229/**
Yanray Wange367e472023-10-31 17:23:04 +08002230 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2231 *
2232 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2233 *
2234 * \note This feature is incompatible with insecure block cipher,
2235 * MBEDTLS_DES_C, and cipher modes which always require decryption
2236 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002237 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2238 * this feature is incompatible with following supported PSA equivalence,
2239 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2240 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002241 *
2242 * Module: library/aes.c
2243 * library/aesce.c
2244 * library/aesni.c
2245 * library/aria.c
2246 * library/camellia.c
2247 * library/cipher.c
2248 */
2249//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2250
2251/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002252 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002253 *
Paul Bakker9a736322012-11-14 12:39:52 +00002254 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002255 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002256 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002257 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002258 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002259 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002260 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002261 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002262 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002263 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002264 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002265 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002266 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002267 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002270
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002271/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002273 *
2274 * Enable the Camellia block cipher.
2275 *
Paul Bakker38119b12009-01-10 23:31:23 +00002276 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002277 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002278 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002279 * This module enables the following ciphersuites (if other requisites are
2280 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002281 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2282 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2283 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2284 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2285 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2286 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2287 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2288 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2289 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2290 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2291 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2292 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2293 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2294 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2295 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2296 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2297 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2298 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2299 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2300 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2301 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2302 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2303 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2304 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2305 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2306 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2307 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2308 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2309 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2310 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2311 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2312 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2313 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2314 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2315 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2316 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2317 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2318 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2319 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2320 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2321 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2322 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002323 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002325
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002326/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002327 * \def MBEDTLS_ARIA_C
2328 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002329 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002330 *
2331 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002332 * Caller: library/cipher.c
2333 *
2334 * This module enables the following ciphersuites (if other requisites are
2335 * enabled as well):
2336 *
2337 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2338 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2339 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2340 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2341 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2342 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2343 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2344 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2345 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2346 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2347 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2348 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2349 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2350 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2351 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2352 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2353 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2354 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2355 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2356 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2357 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2358 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2359 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2360 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2361 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2362 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2363 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2364 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2365 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2366 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2367 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2368 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2369 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2370 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2371 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2372 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2373 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2374 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002375 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002376#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002377
2378/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002380 *
2381 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2382 *
2383 * Module: library/ccm.c
2384 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002385 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2386 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002387 *
2388 * This module enables the AES-CCM ciphersuites, if other requisites are
2389 * enabled as well.
2390 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002391#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002392
2393/**
Daniel King34b822c2016-05-15 17:28:08 -03002394 * \def MBEDTLS_CHACHA20_C
2395 *
2396 * Enable the ChaCha20 stream cipher.
2397 *
2398 * Module: library/chacha20.c
2399 */
2400#define MBEDTLS_CHACHA20_C
2401
2402/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002403 * \def MBEDTLS_CHACHAPOLY_C
2404 *
2405 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2406 *
2407 * Module: library/chachapoly.c
2408 *
2409 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2410 */
2411#define MBEDTLS_CHACHAPOLY_C
2412
2413/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002414 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002415 *
2416 * Enable the generic cipher layer.
2417 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002418 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002419 * Caller: library/ccm.c
2420 * library/cmac.c
2421 * library/gcm.c
2422 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002423 * library/pkcs12.c
2424 * library/pkcs5.c
2425 * library/psa_crypto_aead.c
2426 * library/psa_crypto_mac.c
2427 * library/ssl_ciphersuites.c
2428 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002429 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002430 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2431 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002432 *
2433 * Uncomment to enable generic cipher wrappers.
2434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002435#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002436
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002437/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002438 * \def MBEDTLS_CMAC_C
2439 *
Simon Butcher327398a2016-10-05 14:09:11 +01002440 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2441 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002442 *
2443 * Module: library/cmac.c
2444 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002445 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002446 *
2447 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002448#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002449
2450/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002451 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002452 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002453 * Enable the CTR_DRBG AES-based random generator.
2454 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002455 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002456 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002457 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002458 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2459 * is used.
2460 *
2461 * \warning When using PSA, the user should call `psa_crypto_init()` before
2462 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2463 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002464 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2465 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002466 * \note To achieve a 256-bit security strength with CTR_DRBG,
2467 * you must use AES-256 *and* use sufficient entropy.
2468 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002469 *
2470 * Module: library/ctr_drbg.c
2471 * Caller:
2472 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002473 * Requires: MBEDTLS_AES_C or
2474 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2475 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002476 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002477 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002479#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002480
2481/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002482 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002483 *
2484 * Enable the debug functions.
2485 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002486 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002487 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002488 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002489 * library/ssl_tls12_*.c
2490 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002491 *
2492 * This module provides debugging functions.
2493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002495
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002498 *
2499 * Enable the DES block cipher.
2500 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002501 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002502 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002503 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002504 *
Paul Bakkercff68422013-09-15 20:43:33 +02002505 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002506 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002507 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002508 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002510#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002511
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002512/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002513 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002514 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002515 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002516 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002517 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002518 * Caller: library/ssl_tls.c
2519 * library/ssl*_client.c
2520 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002521 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002522 * This module is used by the following key exchanges:
2523 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002524 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002525 * \warning Using DHE constitutes a security risk as it
2526 * is not possible to validate custom DH parameters.
2527 * If possible, it is recommended users should consider
2528 * preferring other methods of key exchange.
2529 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002530 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002531 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002533
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002534/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002535 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002536 *
2537 * Enable the elliptic curve Diffie-Hellman library.
2538 *
2539 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002540 * Caller: library/psa_crypto.c
2541 * library/ssl_tls.c
2542 * library/ssl*_client.c
2543 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002544 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002545 * This module is used by the following key exchanges:
2546 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002547 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002550#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002551
2552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002554 *
2555 * Enable the elliptic curve DSA library.
2556 *
2557 * Module: library/ecdsa.c
2558 * Caller:
2559 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002560 * This module is used by the following key exchanges:
2561 * ECDHE-ECDSA
2562 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002563 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2564 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2565 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002568
2569/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002570 * \def MBEDTLS_ECJPAKE_C
2571 *
2572 * Enable the elliptic curve J-PAKE library.
2573 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002574 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2575 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002576 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002577 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002578 * Module: library/ecjpake.c
2579 * Caller:
2580 *
2581 * This module is used by the following key exchanges:
2582 * ECJPAKE
2583 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002584 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002585 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002586 * \warning If using a hash that is only provided by PSA drivers, you must
2587 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002588 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002589#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002590
2591/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002593 *
2594 * Enable the elliptic curve over GF(p) library.
2595 *
2596 * Module: library/ecp.c
2597 * Caller: library/ecdh.c
2598 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002599 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002600 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002602 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002604
2605/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002606 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002607 *
2608 * Enable the platform-specific entropy code.
2609 *
2610 * Module: library/entropy.c
2611 * Caller:
2612 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002614 *
2615 * This module provides a generic entropy pool
2616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002618
2619/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002621 *
2622 * Enable error code to error string conversion.
2623 *
2624 * Module: library/error.c
2625 * Caller:
2626 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002627 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002630
2631/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002632 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002633 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002634 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002635 *
2636 * Module: library/gcm.c
2637 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002638 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2639 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002640 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002641 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2642 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002643 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002645
2646/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002647 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002648 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002649 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002650 * Can significantly increase throughput on systems without GCM hardware
2651 * acceleration (e.g., AESNI, AESCE).
2652 *
Matthias Schulz78266782024-02-08 13:54:48 +01002653 * The mbedtls_gcm_context size will increase by 3840 bytes.
2654 * The code size will increase by roughly 344 bytes.
2655 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002656 * Module: library/gcm.c
2657 *
2658 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002659 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002660//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002661
2662/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002663 * \def MBEDTLS_HKDF_C
2664 *
2665 * Enable the HKDF algorithm (RFC 5869).
2666 *
2667 * Module: library/hkdf.c
2668 * Caller:
2669 *
2670 * Requires: MBEDTLS_MD_C
2671 *
2672 * This module adds support for the Hashed Message Authentication Code
2673 * (HMAC)-based key derivation function (HKDF).
2674 */
2675#define MBEDTLS_HKDF_C
2676
2677/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002678 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002679 *
2680 * Enable the HMAC_DRBG random generator.
2681 *
2682 * Module: library/hmac_drbg.c
2683 * Caller:
2684 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002686 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002687 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002688 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002690
2691/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002692 * \def MBEDTLS_LMS_C
2693 *
2694 * Enable the LMS stateful-hash asymmetric signature algorithm.
2695 *
2696 * Module: library/lms.c
2697 * Caller:
2698 *
Raef Colesab4f8742022-09-01 12:24:31 +01002699 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002700 *
Raef Colesab4f8742022-09-01 12:24:31 +01002701 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002702 */
2703#define MBEDTLS_LMS_C
2704
2705/**
Raef Colesab4f8742022-09-01 12:24:31 +01002706 * \def MBEDTLS_LMS_PRIVATE
2707 *
2708 * Enable LMS private-key operations and signing code. Functions enabled by this
2709 * option are experimental, and should not be used in production.
2710 *
2711 * Requires: MBEDTLS_LMS_C
2712 *
2713 * Uncomment to enable the LMS signature algorithm and private key operations.
2714 */
Raef Coles5127e852022-10-07 10:35:56 +01002715//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002716
2717/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002718 * \def MBEDTLS_NIST_KW_C
2719 *
2720 * Enable the Key Wrapping mode for 128-bit block ciphers,
2721 * as defined in NIST SP 800-38F. Only KW and KWP modes
2722 * are supported. At the moment, only AES is approved by NIST.
2723 *
2724 * Module: library/nist_kw.c
2725 *
2726 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2727 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002728#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002729
2730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002732 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002733 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002734 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002735 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2736 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002737 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002738 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002739 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002740 * Caller: library/constant_time.c
2741 * library/ecdsa.c
2742 * library/ecjpake.c
2743 * library/hkdf.c
2744 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002745 * library/pk.c
2746 * library/pkcs5.c
2747 * library/pkcs12.c
2748 * library/psa_crypto_ecp.c
2749 * library/psa_crypto_rsa.c
2750 * library/rsa.c
2751 * library/ssl_cookie.c
2752 * library/ssl_msg.c
2753 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002754 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002755 * library/x509_crt.c
2756 * library/x509write_crt.c
2757 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002758 *
2759 * Uncomment to enable generic message digest wrappers.
2760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002762
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002763/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002764 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002765 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002766 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002767 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002768 * Module: library/md5.c
2769 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002770 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002771 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002772 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002773 * This module is required for TLS 1.2 depending on the handshake parameters.
2774 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2775 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002776 *
2777 * \warning MD5 is considered a weak message digest and its use constitutes a
2778 * security risk. If possible, we recommend avoiding dependencies on
2779 * it, and considering stronger message digests instead.
2780 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002781 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002782#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002783
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002784/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002785 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002786 *
2787 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002788 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002789 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002790 *
2791 * Module: library/memory_buffer_alloc.c
2792 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002793 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002794 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002795 *
2796 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002799
2800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002802 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002803 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2804 *
Simon Butcherd567a232016-03-09 20:19:21 +00002805 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2806 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002807 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002808 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002809 * \note See also our Knowledge Base article about porting to a new
2810 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002811 * 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 +00002812 *
Andres AG788aa4a2016-09-14 14:32:09 +01002813 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002814 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002815 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002816 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002817#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002818
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002819/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002821 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002822 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002823 *
2824 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002825 * Caller: library/asn1write.c
2826 * library/pkcs5.c
2827 * library/pkparse.c
2828 * library/pkwrite.c
2829 * library/rsa.c
2830 * library/x509.c
2831 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002832 * library/x509_crl.c
2833 * library/x509_crt.c
2834 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002835 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002836 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002837 *
2838 * This modules translates between OIDs and internal values.
2839 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002840#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002841
2842/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002844 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002845 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002846 *
2847 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002848 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002849 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002850 * library/x509_crl.c
2851 * library/x509_crt.c
2852 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002853 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002855 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2856 *
2857 * \warning When parsing password-protected files, if MD5 is provided only by
2858 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002859 *
Paul Bakkercff68422013-09-15 20:43:33 +02002860 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002863
2864/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002866 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002867 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002868 *
2869 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002870 * Caller: library/pkwrite.c
2871 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002872 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002873 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002875 *
2876 * This modules adds support for encoding / writing PEM files.
2877 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002879
2880/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002881 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002882 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002883 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002884 *
2885 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002886 * Caller: library/psa_crypto_rsa.c
2887 * library/ssl_tls.c
2888 * library/ssl*_client.c
2889 * library/ssl*_server.c
2890 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002891 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002892 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002893 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002894 * Uncomment to enable generic public key wrappers.
2895 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002897
2898/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002899 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002900 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002901 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002902 *
2903 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002904 * Caller: library/x509_crt.c
2905 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002906 *
Yanray Wang072a0682023-12-05 10:53:04 +08002907 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002908 *
2909 * Uncomment to enable generic public key parse functions.
2910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002912
2913/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002915 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002916 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002917 *
2918 * Module: library/pkwrite.c
2919 * Caller: library/x509write.c
2920 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002921 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002922 *
2923 * Uncomment to enable generic public key write functions.
2924 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002926
2927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002929 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002930 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002931 *
2932 * Module: library/pkcs5.c
2933 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002934 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002935 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002936 * \warning If using a hash that is only provided by PSA drivers, you must
2937 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002938 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002939 * This module adds support for the PKCS#5 functions.
2940 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002942
2943/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002944 * \def MBEDTLS_PKCS7_C
2945 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002946 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002947 * RFC Link - https://tools.ietf.org/html/rfc2315
2948 *
2949 * Module: library/pkcs7.c
2950 *
2951 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002952 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2953 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002954 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002955 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002956 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002957#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002958
2959/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002961 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002962 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002963 * Adds algorithms for parsing PKCS#8 encrypted private keys
2964 *
2965 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002966 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002967 *
Valerio Settie98ad592023-12-28 10:42:12 +01002968 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2969 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002970 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002971 * \warning If using a hash that is only provided by PSA drivers, you must
2972 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002973 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002974 * This module enables PKCS#12 functions.
2975 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002977
2978/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002980 *
2981 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002982 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002983 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2985 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002986 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002987 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002988 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002989 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002990 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002991 * Module: library/platform.c
2992 * Caller: Most other .c files
2993 *
2994 * This module enables abstraction of common (libc) functions.
2995 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002996#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002997
2998/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002999 * \def MBEDTLS_POLY1305_C
3000 *
3001 * Enable the Poly1305 MAC algorithm.
3002 *
3003 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003004 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003005 */
3006#define MBEDTLS_POLY1305_C
3007
3008/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003009 * \def MBEDTLS_PSA_CRYPTO_C
3010 *
3011 * Enable the Platform Security Architecture cryptography API.
3012 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003013 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003014 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003015 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003016 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003017 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3018 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3019 * is enabled in PSA (unless it's fully accelerated, see
3020 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003021 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003022#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003023
3024/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003025 * \def MBEDTLS_PSA_CRYPTO_SE_C
3026 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003027 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003028 * cryptography API.
3029 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003030 * \deprecated This feature is deprecated. Please switch to the PSA driver
3031 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003032 *
Ryan Everett32a64582024-03-05 18:16:18 +00003033 * \warning This feature is not thread-safe, and should not be used in a
3034 * multi-threaded environment.
3035 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003036 * Module: library/psa_crypto_se.c
3037 *
3038 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3039 *
3040 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003041//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003042
3043/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003044 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3045 *
3046 * Enable the Platform Security Architecture persistent key storage.
3047 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003048 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003049 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003050 * Requires: MBEDTLS_PSA_CRYPTO_C,
3051 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3052 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003053 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003054#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003055
3056/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003057 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003058 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003059 * Enable the emulation of the Platform Security Architecture
3060 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003061 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003062 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003063 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003064 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003065 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003066#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003067
3068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003070 *
3071 * Enable the RIPEMD-160 hash algorithm.
3072 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003073 * Module: library/ripemd160.c
3074 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003075 *
3076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003078
3079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003080 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003081 *
3082 * Enable the RSA public-key cryptosystem.
3083 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003084 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003085 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003086 * Caller: library/pk.c
3087 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003088 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003089 * library/ssl*_client.c
3090 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003091 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003092 * This module is used by the following key exchanges:
3093 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003094 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003095 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003098
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003099/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003101 *
3102 * Enable the SHA1 cryptographic hash algorithm.
3103 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003104 * Module: library/sha1.c
3105 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003106 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003107 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003108 * This module is required for TLS 1.2 depending on the handshake parameters,
3109 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003110 *
3111 * \warning SHA-1 is considered a weak message digest and its use constitutes
3112 * a security risk. If possible, we recommend avoiding dependencies
3113 * on it, and considering stronger message digests instead.
3114 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003117
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003118/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003119 * \def MBEDTLS_SHA224_C
3120 *
3121 * Enable the SHA-224 cryptographic hash algorithm.
3122 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003123 * Module: library/sha256.c
3124 * Caller: library/md.c
3125 * library/ssl_cookie.c
3126 *
3127 * This module adds support for SHA-224.
3128 */
3129#define MBEDTLS_SHA224_C
3130
3131/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003132 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003133 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003134 * Enable the SHA-256 cryptographic hash algorithm.
3135 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003136 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003137 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003138 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003139 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003140 * library/ssl*_client.c
3141 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003142 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003143 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003144 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003145 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003147
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003148/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003149 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003150 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003151 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3152 * with the ARMv8 cryptographic extensions if they are available at runtime.
3153 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003154 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003155 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003156 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003157 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003158 * \note Minimum compiler versions for this feature are Clang 4.0,
3159 * armclang 6.6 or GCC 6.0.
3160 *
3161 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3162 * armclang <= 6.9
3163 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003164 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3165 * That name is deprecated, but may still be used as an alternative form for this
3166 * option.
3167 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003168 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3169 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003170 *
3171 * Requires: MBEDTLS_SHA256_C.
3172 *
3173 * Module: library/sha256.c
3174 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003175 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003176 * and use them if available.
3177 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003178//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003179
Dave Rodgmand85277c2023-10-13 09:22:54 +01003180/**
3181 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3182 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003183 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003184 * This name is now deprecated, but may still be used as an alternative form for
3185 * this option.
3186 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003187//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3188
3189/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003190 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003191 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003192 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3193 * with the ARMv8 cryptographic extensions, which must be available at runtime
3194 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003195 *
3196 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003197 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003198 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003199 * \note Minimum compiler versions for this feature are Clang 4.0,
3200 * armclang 6.6 or GCC 6.0.
3201 *
3202 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3203 * armclang <= 6.9
3204 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003205 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003206 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003207 * option.
3208 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003209 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3210 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003211 *
3212 * Requires: MBEDTLS_SHA256_C.
3213 *
3214 * Module: library/sha256.c
3215 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003216 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003217 * unconditionally.
3218 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003219//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003220
Dave Rodgmand85277c2023-10-13 09:22:54 +01003221/**
3222 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3223 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003224 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003225 * This name is now deprecated, but may still be used as an alternative form for
3226 * this option.
3227 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003228//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3229
3230/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003231 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003232 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003233 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003234 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003235 * Module: library/sha512.c
3236 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003237 * library/psa_crypto_hash.c
3238 * library/ssl_tls.c
3239 * library/ssl*_client.c
3240 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003241 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003242 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003243 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003244#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003245
3246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003248 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003249 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003250 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003251 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003252 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003253 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003254 * library/ssl_tls.c
3255 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003256 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003257 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003260
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003261/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003262 * \def MBEDTLS_SHA3_C
3263 *
3264 * Enable the SHA3 cryptographic hash algorithm.
3265 *
3266 * Module: library/sha3.c
3267 *
3268 * This module adds support for SHA3.
3269 */
3270#define MBEDTLS_SHA3_C
3271
3272/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003273 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3274 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003275 * Enable acceleration of the SHA-512 and SHA-384 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 Cosgrove87fbfb52022-03-15 10:51:52 +00003278 *
3279 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3280 * for a non-Aarch64 build it will be silently ignored.
3281 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003282 * \note Minimum compiler versions for this feature are Clang 7.0,
3283 * armclang 6.9 or GCC 8.0.
3284 *
3285 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3286 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003287 *
3288 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3289 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3290 *
3291 * Requires: MBEDTLS_SHA512_C.
3292 *
3293 * Module: library/sha512.c
3294 *
3295 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3296 * and use them if available.
3297 */
3298//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3299
3300/**
3301 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3302 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003303 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3304 * with the ARMv8 cryptographic extensions, which must be available at runtime
3305 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003306 *
3307 * \note This allows builds with a smaller code size than with
3308 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3309 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003310 * \note Minimum compiler versions for this feature are Clang 7.0,
3311 * armclang 6.9 or GCC 8.0.
3312 *
3313 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3314 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003315 *
3316 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3317 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3318 *
3319 * Requires: MBEDTLS_SHA512_C.
3320 *
3321 * Module: library/sha512.c
3322 *
3323 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3324 * unconditionally.
3325 */
3326//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3327
3328/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003330 *
3331 * Enable simple SSL cache implementation.
3332 *
3333 * Module: library/ssl_cache.c
3334 * Caller:
3335 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003336 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003337 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003339
3340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003341 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003342 *
3343 * Enable basic implementation of DTLS cookies for hello verification.
3344 *
3345 * Module: library/ssl_cookie.c
3346 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003347 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003349
3350/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003351 * \def MBEDTLS_SSL_TICKET_C
3352 *
3353 * Enable an implementation of TLS server-side callbacks for session tickets.
3354 *
3355 * Module: library/ssl_ticket.c
3356 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003357 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003358 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3359 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003360 */
3361#define MBEDTLS_SSL_TICKET_C
3362
3363/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003364 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003365 *
3366 * Enable the SSL/TLS client code.
3367 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003368 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003369 * Caller:
3370 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003372 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003373 * This module is required for SSL/TLS client support.
3374 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003376
Paul Bakker9a736322012-11-14 12:39:52 +00003377/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003379 *
3380 * Enable the SSL/TLS server code.
3381 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003382 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003383 * Caller:
3384 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003385 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003386 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003387 * This module is required for SSL/TLS server support.
3388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003390
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003391/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003393 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003394 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003395 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003396 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003397 * Caller: library/ssl*_client.c
3398 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003399 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3401 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003402 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003403 * This module is required for SSL/TLS.
3404 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003406
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003407/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003408 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003409 *
3410 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003411 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003412 * contexts are not shared between threads. If you do intend to use contexts
3413 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003414 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003415 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003416 *
3417 * Module: library/threading.c
3418 *
3419 * This allows different threading implementations (self-implemented or
3420 * provided).
3421 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422 * You will have to enable either MBEDTLS_THREADING_ALT or
3423 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003424 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003425 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003428
3429/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003431 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003432 * Enable the semi-portable timing interface.
3433 *
Simon Butcherd567a232016-03-09 20:19:21 +00003434 * \note The provided implementation only works on POSIX/Unix (including Linux,
3435 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003436 * module and provide your own implementations of the callbacks needed by
3437 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3438 * your own implementation of the whole module by setting
3439 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003440 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003441 * \note The timing module will include time.h on suitable platforms
3442 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3443 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3444 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003445 * \note See also our Knowledge Base article about porting to a new
3446 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003447 * 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 +00003448 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003449 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003451#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003452
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003453/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003454 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003455 *
3456 * Enable run-time version information.
3457 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003458 * Module: library/version.c
3459 *
3460 * This module provides run-time version information.
3461 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003463
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003464/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003466 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003467 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003468 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003469 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003470 * Caller: library/x509_crl.c
3471 * library/x509_crt.c
3472 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003473 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003474 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003475 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3476 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003477 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3478 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003479 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003480 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003483
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003485 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003486 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003487 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003488 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003489 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003490 * Caller: library/ssl_tls.c
3491 * library/ssl*_client.c
3492 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003493 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003495 *
3496 * This module is required for X.509 certificate parsing.
3497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003499
3500/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003501 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003502 *
3503 * Enable X.509 CRL parsing.
3504 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003505 * Module: library/x509_crl.c
3506 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003507 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003509 *
3510 * This module is required for X.509 CRL parsing.
3511 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003513
3514/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003515 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003516 *
3517 * Enable X.509 Certificate Signing Request (CSR) parsing.
3518 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003519 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003520 * Caller: library/x509_crt_write.c
3521 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003523 *
3524 * This module is used for reading X.509 certificate request.
3525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003526#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003527
3528/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003529 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003530 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003531 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003532 *
3533 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003534 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003535 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003536 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3537 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003538 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3539 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003540 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003541 * This module is the basis for creating X.509 certificates and CSRs.
3542 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003544
3545/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003546 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003547 *
3548 * Enable creating X.509 certificates.
3549 *
3550 * Module: library/x509_crt_write.c
3551 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003553 *
3554 * This module is required for X.509 certificate creation.
3555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003556#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003557
3558/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003559 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003560 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003561 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003562 *
3563 * Module: library/x509_csr_write.c
3564 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003565 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003566 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003567 * This module is required for X.509 certificate request writing.
3568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003570
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003571/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003572
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003573/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003574 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003575 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003576 * This section contains Mbed TLS build settings that are not associated
3577 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003578 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003579 * \{
3580 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003581
Gilles Peskinea02c1242022-03-16 17:03:19 +01003582/**
3583 * \def MBEDTLS_CONFIG_FILE
3584 *
3585 * If defined, this is a header which will be included instead of
3586 * `"mbedtls/mbedtls_config.h"`.
3587 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003588 * Unlike other configuration options, this one must be defined on the
3589 * compiler command line: a definition in `mbedtls_config.h` would have
3590 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003591 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003592 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003593 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003594 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003595 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003596 * The value of this symbol is typically a path in double quotes, either
3597 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003598 */
3599//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3600
3601/**
3602 * \def MBEDTLS_USER_CONFIG_FILE
3603 *
3604 * If defined, this is a header which will be included after
3605 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003606 * This allows you to modify the default configuration, including the ability
3607 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003608 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003609 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003610 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003611 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003612 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003613 * The value of this symbol is typically a path in double quotes, either
3614 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003615 */
3616//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3617
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003618/**
3619 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3620 *
3621 * If defined, this is a header which will be included instead of
3622 * `"psa/crypto_config.h"`.
3623 * This header file specifies which cryptographic mechanisms are available
3624 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3625 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3626 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003627 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003628 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003629 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003630 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003631 * The value of this symbol is typically a path in double quotes, either
3632 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003633 */
3634//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3635
3636/**
3637 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3638 *
3639 * If defined, this is a header which will be included after
3640 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003641 * This allows you to modify the default configuration, including the ability
3642 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003643 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003644 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003645 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003646 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003647 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003648 * The value of this symbol is typically a path in double quotes, either
3649 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003650 */
3651//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3652
Gilles Peskineb1176f22023-02-22 22:07:28 +01003653/**
3654 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3655 *
3656 * If defined, this is a header which will be included instead of
3657 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3658 * as the one in Mbed TLS, but with definitions adapted to the platform on
3659 * which the library code will run.
3660 *
3661 * \note The required content of this header can vary from one version of
3662 * Mbed TLS to the next. Integrators who provide an alternative file
3663 * should review the changes in the original file whenever they
3664 * upgrade Mbed TLS.
3665 *
3666 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3667 * non-standard feature of the C language, so this feature is only available
3668 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3669 *
3670 * The value of this symbol is typically a path in double quotes, either
3671 * absolute or relative to a directory on the include search path.
3672 */
3673//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3674
3675/**
3676 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3677 *
3678 * If defined, this is a header which will be included instead of
3679 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3680 * as the one in Mbed TLS, but with definitions adapted to the environment
3681 * in which the library code will run. The typical use for this feature
3682 * is to provide alternative type definitions on the client side in
3683 * client-server integrations of PSA crypto, where operation structures
3684 * contain handles instead of cryptographic data.
3685 *
3686 * \note The required content of this header can vary from one version of
3687 * Mbed TLS to the next. Integrators who provide an alternative file
3688 * should review the changes in the original file whenever they
3689 * upgrade Mbed TLS.
3690 *
3691 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3692 * non-standard feature of the C language, so this feature is only available
3693 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3694 *
3695 * The value of this symbol is typically a path in double quotes, either
3696 * absolute or relative to a directory on the include search path.
3697 */
3698//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3699
Gilles Peskineba4162a2022-04-11 17:04:38 +02003700/** \} name SECTION: General configuration options */
3701
3702/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003703 * \name SECTION: Module configuration options
3704 *
3705 * This section allows for the setting of module specific sizes and
3706 * configuration options. The default values are already present in the
3707 * relevant header files and should suffice for the regular use cases.
3708 *
3709 * Our advice is to enable options and change their values here
3710 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003711 * \{
3712 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003713/* The Doxygen documentation here is used when a user comments out a
3714 * setting and runs doxygen themselves. On the other hand, when we typeset
3715 * the full documentation including disabled settings, the documentation
3716 * in specific modules' header files is used if present. When editing this
3717 * file, make sure that each option is documented in exactly one place,
3718 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3719 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003720
Paul Bakker088c5c52014-04-25 11:11:10 +02003721/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003722//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003723//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003724
Paul Bakker088c5c52014-04-25 11:11:10 +02003725/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003726//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3727//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3728//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3729//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3730//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003731
Paul Bakker088c5c52014-04-25 11:11:10 +02003732/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003733//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3734//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3735//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3736//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003737
Paul Bakker088c5c52014-04-25 11:11:10 +02003738/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003739//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003740//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003741
Paul Bakker088c5c52014-04-25 11:11:10 +02003742/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003743//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3744//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003745//#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 +01003746
Paul Bakker088c5c52014-04-25 11:11:10 +02003747/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003748//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003749
Paul Bakker088c5c52014-04-25 11:11:10 +02003750/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003751//#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 -04003752
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003753/** \def MBEDTLS_PLATFORM_STD_CALLOC
3754 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003755 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003756 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003757 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003758 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003759 * 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 -04003760 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3761 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003762 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003763 */
3764//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003765
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003766/** \def MBEDTLS_PLATFORM_STD_FREE
3767 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003768 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003769 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003770 * 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 -04003771 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3772 * 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 -04003773 */
3774//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003775//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003776//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003777//#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 +02003778//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3779//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003780/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003781//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003782//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3783//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003784//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3785//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3786//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003787
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003788/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003789/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003790//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3791//#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 +02003792//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003793//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003794//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3795//#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 +02003796//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3797//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003798/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003799//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003800//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003801//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3802//#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 +08003803//#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 +08003804//#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 +02003805
Gilles Peskine3f106f72021-09-23 17:42:39 +02003806/** \def MBEDTLS_CHECK_RETURN
3807 *
3808 * This macro is used at the beginning of the declaration of a function
3809 * to indicate that its return value should be checked. It should
3810 * instruct the compiler to emit a warning or an error if the function
3811 * is called without checking its return value.
3812 *
3813 * There is a default implementation for popular compilers in platform_util.h.
3814 * You can override the default implementation by defining your own here.
3815 *
3816 * If the implementation here is empty, this will effectively disable the
3817 * checking of functions' return values.
3818 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003819//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003820
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003821/** \def MBEDTLS_IGNORE_RETURN
3822 *
3823 * This macro requires one argument, which should be a C function call.
3824 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3825 * warning is suppressed.
3826 */
3827//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3828
Gilles Peskineed038902020-11-13 21:33:21 +01003829/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003830/**
Gilles Peskineed038902020-11-13 21:33:21 +01003831 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3832 * PSA crypto subsystem.
3833 *
3834 * If this option is unset:
3835 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003836 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003837 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3838 * on unspecified heuristics.
3839 */
3840//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3841
Steven Cooreman863470a2021-02-15 14:03:19 +01003842/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003843 * Restrict the PSA library to supporting a maximum amount of simultaneously
3844 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3845 * volatile key, or a persistent key which is loaded temporarily by the
3846 * library as part of a crypto operation in flight.
3847 *
3848 * If this option is unset, the library will fall back to a default value of
3849 * 32 keys.
3850 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003851//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003852
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003853/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003854//#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 +00003855
Paul Bakker088c5c52014-04-25 11:11:10 +02003856/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003857//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3858//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003859
Paul Bakker088c5c52014-04-25 11:11:10 +02003860/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003861
Angus Grattond8213d02016-05-25 20:56:48 +10003862/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3863 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003864 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003865 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003866 * This determines the size of the incoming TLS I/O buffer in such a way
3867 * that it is capable of holding the specified amount of plaintext data,
3868 * regardless of the protection mechanism used.
3869 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003870 * \note When using a value less than the default of 16KB on the client, it is
3871 * recommended to use the Maximum Fragment Length (MFL) extension to
3872 * inform the server about this limitation. On the server, there
3873 * is no supported, standardized way of informing the client about
3874 * restriction on the maximum size of incoming messages, and unless
3875 * the limitation has been communicated by other means, it is recommended
3876 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3877 * while keeping the default value of 16KB for the incoming buffer.
3878 *
David Horstmann95d516f2021-05-04 18:36:56 +01003879 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003880 */
3881//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3882
Gilles Peskined3d02902020-03-04 21:35:27 +01003883/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3884 *
3885 * The maximum length of CIDs used for incoming DTLS messages.
3886 *
3887 */
3888//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3889
3890/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3891 *
3892 * The maximum length of CIDs used for outgoing DTLS messages.
3893 *
3894 */
3895//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3896
TRodziewicze8dd7092021-05-12 14:19:11 +02003897/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003898 *
3899 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003900 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003901 *
3902 * The padding will always be chosen so that the length of the
3903 * padded plaintext is a multiple of the value of this option.
3904 *
3905 * Note: A value of \c 1 means that no padding will be used
3906 * for outgoing records.
3907 *
3908 * Note: On systems lacking division instructions,
3909 * a power of two should be preferred.
3910 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003911//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003912
Angus Grattond8213d02016-05-25 20:56:48 +10003913/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3914 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003915 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003916 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003917 * This determines the size of the outgoing TLS I/O buffer in such a way
3918 * that it is capable of holding the specified amount of plaintext data,
3919 * regardless of the protection mechanism used.
3920 *
Angus Grattond8213d02016-05-25 20:56:48 +10003921 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3922 * the default inward 16384 byte buffer to conform to the TLS specification.
3923 *
3924 * The minimum required outward buffer size is determined by the handshake
3925 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3926 * The specific size requirement depends on the configured ciphers and any
3927 * certificate data which is sent during the handshake.
3928 *
David Horstmann95d516f2021-05-04 18:36:56 +01003929 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003930 */
3931//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3932
Hanno Beckere0b150f2018-08-21 15:51:03 +01003933/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3934 *
3935 * Maximum number of heap-allocated bytes for the purpose of
3936 * DTLS handshake message reassembly and future message buffering.
3937 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003938 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003939 * to account for a reassembled handshake message of maximum size,
3940 * together with its reassembly bitmap.
3941 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003942 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003943 * should be sufficient for all practical situations as it allows
3944 * to reassembly a large handshake message (such as a certificate)
3945 * while buffering multiple smaller handshake messages.
3946 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003947 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003948//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003949
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003950//#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 +02003951//#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 +02003952
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003953/**
3954 * Complete list of ciphersuites to use, in order of preference.
3955 *
3956 * \warning No dependency checking is done on that field! This option can only
3957 * be used to restrict the set of available ciphersuites. It is your
3958 * responsibility to make sure the needed modules are active.
3959 *
3960 * Use this to save a few hundred bytes of ROM (default ordering of all
3961 * available ciphersuites) and a few to a few hundred bytes of RAM.
3962 *
3963 * The value below is only an example, not the default.
3964 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003965//#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 +02003966
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003967/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003968 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3969 *
3970 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003971 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003972 *
3973 * It must be positive and smaller than UINT32_MAX.
3974 *
3975 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3976 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003977 */
3978//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3979
3980/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003981 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3982 *
Jerry Yucf913512023-11-14 11:06:52 +08003983 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003984 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003985 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003986 * - The client ticket age is the time difference between the time when the
3987 * client proposes to the server to use the ticket and the time the client
3988 * received the ticket from the server.
3989 * - The server ticket age is the time difference between the time when the
3990 * server receives a proposition from the client to use the ticket and the
3991 * time when the ticket was created by the server.
3992 *
Jerry Yucf913512023-11-14 11:06:52 +08003993 * The ages might be different due to the client and server clocks not running
3994 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3995 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3996 * 6s, thus in the worst case clients and servers must sync up their system time
3997 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003998 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003999 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004000 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004001//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004002
4003/**
4004 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4005 *
4006 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4007 *
4008 * This must be less than 256.
4009 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004010//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004011
4012/**
4013 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4014 *
4015 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4016 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4017 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4018 *
4019 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004020//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004021
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004022/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004023//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004024//#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 +01004025
Gilles Peskine611179c2022-04-13 23:04:48 +02004026/** \} name SECTION: Module configuration options */