blob: b8e6065f36380362c313d2e7947d7cf8be9dc152 [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é-Gonnard31993f22015-05-12 15:41:08 +0200353//#define MBEDTLS_AES_SETKEY_DEC_ALT
354//#define MBEDTLS_AES_ENCRYPT_ALT
355//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300356//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300357//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300358//#define MBEDTLS_ECDSA_VERIFY_ALT
359//#define MBEDTLS_ECDSA_SIGN_ALT
360//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200361
362/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200363 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200364 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200365 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200366 * hardware entropy collector.
367 *
368 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000369 * prototype as declared in library/entropy_poll.h, and accept NULL as first
370 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200371 *
372 * Uncomment to use your own hardware entropy collector.
373 */
374//#define MBEDTLS_ENTROPY_HARDWARE_ALT
375
376/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000378 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100379 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000380 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100381 * Uncomment this macro to use precomputed AES tables stored in ROM.
382 * Comment this macro to generate AES tables in RAM at runtime.
383 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100384 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
385 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100386 * initialization time before the first AES operation can be performed.
387 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
388 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
389 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100390 *
391 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200393//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000394
395/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100396 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200397 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100398 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200399 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100400 * Uncommenting this macro omits 75% of the AES tables from
401 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
402 * by computing their values on the fly during operations
403 * (the tables are entry-wise rotations of one another).
404 *
405 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100406 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100407 * runtime. Specifically, one has to compare 4 accesses within
408 * different tables to 4 accesses with additional arithmetic
409 * operations within the same table. The performance gain/loss
410 * depends on the system and memory details.
411 *
412 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200413 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100414//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200415
416/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800417 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
418 *
419 * Use only 128-bit keys in AES operations to save ROM.
420 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800421 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800422 * or 256-bit keys.
423 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800424 * Uncommenting this macro reduces the size of AES code by ~300 bytes
425 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800426 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800427 * Module: library/aes.c
428 *
429 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800430 */
431//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
432
Gilles Peskinea8861e02023-09-05 20:20:51 +0200433/*
434 * Disable plain C implementation for AES.
435 *
436 * When the plain C implementation is enabled, and an implementation using a
437 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
438 * detection will be used to select between them.
439 *
440 * If only one implementation is present, runtime detection will not be used.
441 * This configuration will crash at runtime if running on a CPU without the
442 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
443 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
444 */
445//#define MBEDTLS_AES_USE_HARDWARE_ONLY
446
Arto Kinnunen732ca322023-04-14 14:26:10 +0800447/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200448 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200449 *
450 * Use less ROM for the Camellia implementation (saves about 768 bytes).
451 *
452 * Uncomment this macro to use less memory for Camellia.
453 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200454//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200455
456/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200457 * \def MBEDTLS_CHECK_RETURN_WARNING
458 *
459 * If this macro is defined, emit a compile-time warning if application code
460 * calls a function without checking its return value, but the return value
461 * should generally be checked in portable applications.
462 *
463 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
464 * implemented. Otherwise this option has no effect.
465 *
466 * Uncomment to get warnings on using fallible functions without checking
467 * their return value.
468 *
469 * \note This feature is a work in progress.
470 * Warnings will be added to more functions in the future.
471 *
472 * \note A few functions are considered critical, and ignoring the return
473 * value of these functions will trigger a warning even if this
474 * macro is not defined. To completely disable return value check
475 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
476 */
477//#define MBEDTLS_CHECK_RETURN_WARNING
478
479/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200480 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200481 *
482 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200485
486/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200487 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000488 *
489 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
490 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200491#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000492
493/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200494 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000495 *
496 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200498#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000499
500/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100501 * \def MBEDTLS_CIPHER_MODE_OFB
502 *
503 * Enable Output Feedback mode (OFB) for symmetric ciphers.
504 */
505#define MBEDTLS_CIPHER_MODE_OFB
506
507/**
508 * \def MBEDTLS_CIPHER_MODE_XTS
509 *
510 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
511 */
512#define MBEDTLS_CIPHER_MODE_XTS
513
514/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200515 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000516 *
517 * Enable NULL cipher.
518 * Warning: Only do so when you know what you are doing. This allows for
519 * encryption or channels without any security!
520 *
Ronald Croncee42702021-04-26 11:34:44 +0200521 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200522 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
523 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
524 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
525 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
526 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
527 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
528 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
529 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
530 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
531 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
532 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
533 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
534 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
535 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
536 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
537 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
538 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
539 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
540 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000541 *
542 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000545
546/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100547 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200548 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100549 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
550 * specific padding modes in the cipher layer with cipher modes that support
551 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200552 *
553 * If you disable all padding modes, only full blocks can be used with CBC.
554 *
555 * Enable padding modes in the cipher layer.
556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200557#define MBEDTLS_CIPHER_PADDING_PKCS7
558#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
559#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
560#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200561
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200562/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
563 *
564 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800565 * Without this, CTR_DRBG uses a 256-bit key
566 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200567 */
568//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
569
Paul Bakker48e93c82013-08-14 12:21:18 +0200570/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200571 * Enable the verified implementations of ECDH primitives from Project Everest
572 * (currently only Curve25519). This feature changes the layout of ECDH
573 * contexts and therefore is a compatibility break for applications that access
574 * fields of a mbedtls_ecdh_context structure directly. See also
575 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000576 *
577 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
578 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200579 */
580//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
581
582/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100583 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200584 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100585 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
586 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200587 *
588 * Comment macros to disable the curve and functions for it
589 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200590/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
592#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
593#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
594#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
595#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
596#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
597#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
598#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
599#define MBEDTLS_ECP_DP_BP256R1_ENABLED
600#define MBEDTLS_ECP_DP_BP384R1_ENABLED
601#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200602/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200603#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000604#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200605
606/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200608 *
609 * Enable specific 'modulo p' routines for each NIST prime.
610 * Depending on the prime and architecture, makes operations 4 to 8 times
611 * faster on the corresponding curve.
612 *
613 * Comment this macro to disable NIST curves optimisation.
614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200615#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200616
617/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200618 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100619 *
620 * Enable "non-blocking" ECC operations that can return early and be resumed.
621 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200622 * This allows various functions to pause by returning
623 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
624 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
625 * order to further progress and eventually complete their operation. This is
626 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
627 * number of ECC operations a function may perform before pausing; see
628 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100629 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200630 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200631 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100632 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100633 * This option:
634 * - Adds xxx_restartable() variants of existing operations in the
635 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100636 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
637 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100638 * - ECDSA: signature generation & verification;
639 * - PK: signature generation & verification;
640 * - X509: certificate chain verification.
641 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
642 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
643 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
644 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000645 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100646 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100647 * - verification of the server's key exchange signature;
648 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100649 * - generation of the client's signature if client authentication is used,
650 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100651 *
652 * \note In the cases above, the usual SSL/TLS functions, such as
653 * mbedtls_ssl_handshake(), can now return
654 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200655 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100656 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
657 * restartable operations in PK, X.509 and TLS (see above) are not
658 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100659 * PSA, and are not restartable. These are temporary limitations that
660 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200661 *
Ron Eldor19779c42018-11-05 16:58:13 +0200662 * \note This option only works with the default software implementation of
663 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100664 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100665 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100666 * Requires: MBEDTLS_ECP_C
667 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100668 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100669 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200670//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100671
672/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200673 * Uncomment to enable using new bignum code in the ECC modules.
674 *
675 * \warning This is currently experimental, incomplete and therefore should not
676 * be used in production.
677 */
678//#define MBEDTLS_ECP_WITH_MPI_UINT
679
680/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200681 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100682 *
683 * Enable deterministic ECDSA (RFC 6979).
684 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
685 * may result in a compromise of the long-term signing key. This is avoided by
686 * the deterministic variant.
687 *
John Durkop36a82e52020-10-26 09:39:05 -0700688 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100689 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100690 * Comment this macro to disable deterministic ECDSA.
691 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200692#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100693
694/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200696 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200697 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200698 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200699 * This enables the following ciphersuites (if other requisites are
700 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
702 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
703 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
704 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
705 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
706 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
707 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
708 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
709 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
710 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200711 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200713
714/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200716 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200717 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200718 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200719 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200720 *
721 * This enables the following ciphersuites (if other requisites are
722 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200723 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
724 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
725 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
726 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
727 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
728 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
729 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
730 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
731 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
732 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100733 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100734 * \warning Using DHE constitutes a security risk as it
735 * is not possible to validate custom DH parameters.
736 * If possible, it is recommended users should consider
737 * preferring other methods of key exchange.
738 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100739 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200740 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200741#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200742
743/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200744 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200745 *
746 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
747 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200748 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200749 *
750 * This enables the following ciphersuites (if other requisites are
751 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200752 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
753 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
754 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
755 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
756 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
757 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200758 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200759#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200760
761/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200763 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200764 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200765 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
767 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200768 *
769 * This enables the following ciphersuites (if other requisites are
770 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200771 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
772 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
773 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
774 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
775 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
776 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
777 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
778 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
779 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
780 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200781 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200783
784/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200786 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200787 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200788 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200789 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
790 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200791 *
792 * This enables the following ciphersuites (if other requisites are
793 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200794 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
795 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
796 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
797 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
798 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
799 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
800 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
801 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
802 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
803 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
804 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
805 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200806 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200808
809/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200811 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200812 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200813 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
815 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200816 *
817 * This enables the following ciphersuites (if other requisites are
818 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200819 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
820 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
821 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
822 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
823 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
824 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
825 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
826 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
827 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
828 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
829 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
830 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100831 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100832 * \warning Using DHE constitutes a security risk as it
833 * is not possible to validate custom DH parameters.
834 * If possible, it is recommended users should consider
835 * preferring other methods of key exchange.
836 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100837 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200840
841/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200843 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200844 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200845 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200846 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
847 * MBEDTLS_RSA_C
848 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200849 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200850 *
851 * This enables the following ciphersuites (if other requisites are
852 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200853 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
854 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
855 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
856 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
857 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
858 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
859 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
860 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
861 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
862 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200864#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200865
866/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200868 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200869 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200870 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200871 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
872 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
873 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200874 *
875 * This enables the following ciphersuites (if other requisites are
876 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200877 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
878 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
879 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
880 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
881 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
882 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
883 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
884 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
885 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
886 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200887 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200889
890/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200891 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100892 *
893 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
894 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200895 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
896 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
897 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100898 *
899 * This enables the following ciphersuites (if other requisites are
900 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
902 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
903 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
904 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
905 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
906 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
907 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
908 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
909 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
910 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100913
914/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100916 *
917 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
918 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200919 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
920 * MBEDTLS_RSA_C
921 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100922 *
923 * This enables the following ciphersuites (if other requisites are
924 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
926 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
927 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
928 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
929 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
930 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
931 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
932 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
933 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
934 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100937
938/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200939 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
940 *
941 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
942 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200943 * \warning This is currently experimental. EC J-PAKE support is based on the
944 * Thread v1.0.0 specification; incompatible changes to the specification
945 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200946 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200947 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100948 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200949 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
950 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100951 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800952 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100953 * MBEDTLS_USE_PSA_CRYPTO is disabled).
954 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200955 * This enables the following ciphersuites (if other requisites are
956 * enabled as well):
957 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
958 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200959//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200960
961/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200962 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100963 *
964 * Enhance support for reading EC keys using variants of SEC1 not allowed by
965 * RFC 5915 and RFC 5480.
966 *
967 * Currently this means parsing the SpecifiedECDomain choice of EC
968 * parameters (only known groups are supported, not arbitrary domains, to
969 * avoid validation issues).
970 *
971 * Disable if you only need to support RFC 5915 + 5480 key formats.
972 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200973#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100974
975/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200976 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
977 *
978 * Enable the support for parsing public keys of type Short Weierstrass
979 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200980 * compressed point format. This parsing is done through ECP module's functions.
981 *
982 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
983 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
984 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200985 */
986#define MBEDTLS_PK_PARSE_EC_COMPRESSED
987
988/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100990 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991 * Enable a dummy error function to make use of mbedtls_strerror() in
992 * third party libraries easier when MBEDTLS_ERROR_C is disabled
993 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200994 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200995 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
996 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100997 *
998 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200999 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001000 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001002
1003/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001005 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001006 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001007 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001010#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001011
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001012/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001014 *
1015 * Enable functions that use the filesystem.
1016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001018
1019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001021 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001022 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001023 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001024 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001025 * application.
1026 *
1027 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001028 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001029//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001030
1031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001032 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001033 *
1034 * Do not use built-in platform entropy functions.
1035 * This is useful if your platform does not support
1036 * standards like the /dev/urandom or Windows CryptoAPI.
1037 *
1038 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001039 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001041
1042/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001044 *
1045 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1046 * default SHA-512 based one (if both are available).
1047 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001049 *
1050 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1051 * if you have performance concerns.
1052 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 * This option is only useful if both MBEDTLS_SHA256_C and
1054 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001057
1058/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001059 * \def MBEDTLS_ENTROPY_NV_SEED
1060 *
1061 * Enable the non-volatile (NV) seed file-based entropy source.
1062 * (Also enables the NV seed read/write functions in the platform layer)
1063 *
1064 * This is crucial (if not required) on systems that do not have a
1065 * cryptographic entropy source (in hardware or kernel) available.
1066 *
1067 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1068 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001069 * \note The read/write functions that are used by the entropy source are
1070 * determined in the platform layer, and can be modified at runtime and/or
1071 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1072 *
1073 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001074 * with regular fopen(), please make sure you make a seedfile with the
1075 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1076 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001077 * and written to or you will get an entropy source error! The default
1078 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1079 * bytes from the file.
1080 *
1081 * \note The entropy collector will write to the seed file before entropy is
1082 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001083 */
1084//#define MBEDTLS_ENTROPY_NV_SEED
1085
Ronald Cron71016a92020-08-28 19:01:50 +02001086/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001087 *
Ronald Cron71016a92020-08-28 19:01:50 +02001088 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001089 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001090 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1091 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001092 *
1093 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001094 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001095 */
Ronald Cron71016a92020-08-28 19:01:50 +02001096//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001097
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001098/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001099 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001100 *
1101 * Enable debugging of buffer allocator memory issues. Automatically prints
1102 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1103 * function for 'debug output' of allocated memory.
1104 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001106 *
1107 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001110
1111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001113 *
1114 * Include backtrace information with each allocated block.
1115 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001117 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001118 *
1119 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001120 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001121//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001122
1123/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001124 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001125 *
1126 * Support external private RSA keys (eg from a HSM) in the PK layer.
1127 *
1128 * Comment this macro to disable support for external private RSA keys.
1129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001131
1132/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001134 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001135 * Enable support for PKCS#1 v1.5 encoding.
1136 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001137 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001138 *
Paul Bakker48377d92013-08-30 12:06:24 +02001139 * This enables support for PKCS#1 v1.5 operations.
1140 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001141#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001142
1143/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001145 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001146 * Enable support for PKCS#1 v2.1 encoding.
1147 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001148 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001149 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001150 * \warning If using a hash that is only provided by PSA drivers, you must
1151 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001152 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001153 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1154 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001156
Steven Cooreman6801f082021-02-19 17:21:22 +01001157/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1158 *
1159 * Enable support for platform built-in keys. If you enable this feature,
1160 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1161 * See the documentation of that function for more information.
1162 *
1163 * Built-in keys are typically derived from a hardware unique key or
1164 * stored in a secure element.
1165 *
1166 * Requires: MBEDTLS_PSA_CRYPTO_C.
1167 *
1168 * \warning This interface is experimental and may change or be removed
1169 * without notice.
1170 */
1171//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1172
Ronald Cron3768ac12021-01-26 16:58:00 +01001173/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1174 *
1175 * Enable support for PSA crypto client.
1176 *
1177 * \note This option allows to include the code necessary for a PSA
1178 * crypto client when the PSA crypto implementation is not included in
1179 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1180 * code to set and get PSA key attributes.
1181 * The development of PSA drivers partially relying on the library to
1182 * fulfill the hardware gaps is another possible usage of this option.
1183 *
1184 * \warning This interface is experimental and may change or be removed
1185 * without notice.
1186 */
1187//#define MBEDTLS_PSA_CRYPTO_CLIENT
1188
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001189/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1190 *
1191 * Make the PSA Crypto module use an external random generator provided
1192 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1193 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001194 * \note This random generator must deliver random numbers with cryptographic
1195 * quality and high performance. It must supply unpredictable numbers
1196 * with a uniform distribution. The implementation of this function
1197 * is responsible for ensuring that the random generator is seeded
1198 * with sufficient entropy. If you have a hardware TRNG which is slow
1199 * or delivers non-uniform output, declare it as an entropy source
1200 * with mbedtls_entropy_add_source() instead of enabling this option.
1201 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001202 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001203 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1204 * and define a function called mbedtls_psa_external_get_random()
1205 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001206 * ```
1207 * psa_status_t mbedtls_psa_external_get_random(
1208 * mbedtls_psa_external_random_context_t *context,
1209 * uint8_t *output, size_t output_size, size_t *output_length);
1210 * );
1211 * ```
1212 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001213 * The function must fill the \c output buffer with \c output_size bytes
1214 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001215 *
1216 * Requires: MBEDTLS_PSA_CRYPTO_C
1217 *
1218 * \warning If you enable this option, code that uses the PSA cryptography
1219 * interface will not use any of the entropy sources set up for
1220 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1221 * enables.
1222 *
1223 * \note This option is experimental and may be removed without notice.
1224 */
1225//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1226
Paul Bakker9dcc3222011-03-08 14:16:06 +00001227/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001228 * \def MBEDTLS_PSA_CRYPTO_SPM
1229 *
1230 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1231 * Partition Manager) integration which separates the code into two parts: a
1232 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1233 * Environment).
1234 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001235 * If you enable this option, your build environment must include a header
1236 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1237 * header files, or in another directory on the compiler's include search
1238 * path). Alternatively, your platform may customize the header
1239 * `psa/crypto_platform.h`, in which case it can skip or replace the
1240 * inclusion of `"crypto_spe.h"`.
1241 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001242 * Module: library/psa_crypto.c
1243 * Requires: MBEDTLS_PSA_CRYPTO_C
1244 *
1245 */
1246//#define MBEDTLS_PSA_CRYPTO_SPM
1247
1248/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001249 * Uncomment to enable p256-m. This is an alternative implementation of
1250 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1251 * Compared to the default implementation:
1252 *
1253 * - p256-m has a much smaller code size and RAM footprint.
1254 * - p256-m is only available via the PSA API. This includes the pk module
1255 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1256 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1257 * over the core arithmetic, or deterministic derivation of keys.
1258 *
1259 * We recommend enabling this option if your application uses the PSA API
1260 * and the only elliptic curve support it needs is ECDH and ECDSA over
1261 * SECP256R1.
1262 *
1263 * If you enable this option, you do not need to enable any ECC-related
1264 * MBEDTLS_xxx option. You do need to separately request support for the
1265 * cryptographic mechanisms through the PSA API:
1266 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1267 * configuration;
1268 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1269 * - #PSA_WANT_ECC_SECP_R1_256;
1270 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1271 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1272 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1273 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1274 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001275 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001276 * \note To benefit from the smaller code size of p256-m, make sure that you
1277 * do not enable any ECC-related option not supported by p256-m: this
1278 * would cause the built-in ECC implementation to be built as well, in
1279 * order to provide the required option.
1280 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001281 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1282 * SECP256R1 are disabled as they are not supported by this driver.
1283 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1284 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001285 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001286 */
1287//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1288
1289/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001290 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001291 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001292 * Enable support for entropy injection at first boot. This feature is
1293 * required on systems that do not have a built-in entropy source (TRNG).
1294 * This feature is currently not supported on systems that have a built-in
1295 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001296 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001297 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001298 *
1299 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001300//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001301
1302/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001303 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001304 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001305 * Assume all buffers passed to PSA functions are owned exclusively by the
1306 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001307 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001308 * This option may be enabled if all buffers passed to any PSA function reside
1309 * in memory that is accessible only to the PSA function during its execution.
1310 *
1311 * This option MUST be disabled whenever buffer arguments are in memory shared
1312 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001313 * across a trust boundary.
1314 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001315 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001316 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001317 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001318 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001319 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001320//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001321
1322/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001323 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001324 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001325 * Do not use the Chinese Remainder Theorem
1326 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001327 *
1328 * Uncomment this macro to disable the use of CRT in RSA.
1329 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001330 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001331//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001332
1333/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001334 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001335 *
1336 * Enable the checkup functions (*_self_test).
1337 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001339
1340/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001341 * \def MBEDTLS_SHA256_SMALLER
1342 *
1343 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1344 * lower performance.
1345 *
Adam Wolf039080f2019-09-10 09:53:08 -05001346 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001347 * performance and size. This version optimizes more aggressively for size at
1348 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1349 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1350 * 30%.
1351 *
1352 * Uncomment to enable the smaller implementation of SHA256.
1353 */
1354//#define MBEDTLS_SHA256_SMALLER
1355
1356/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001357 * \def MBEDTLS_SHA512_SMALLER
1358 *
1359 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1360 * lower performance.
1361 *
1362 * Uncomment to enable the smaller implementation of SHA512.
1363 */
1364//#define MBEDTLS_SHA512_SMALLER
1365
1366/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001367 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001368 *
1369 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001370 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001371 * with other servers, only debugging of failures is harder.
1372 *
1373 * The advantage of not sending alert messages, is that no information is given
1374 * about reasons for failures thus preventing adversaries of gaining intel.
1375 *
1376 * Enable sending of all alert messages
1377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001378#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001379
1380/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001381 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1382 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001383 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001384 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001385 * in the underlying transport. The CID functionality is described
1386 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001387 *
1388 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001389 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1390 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1391 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001392 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001393 * The maximum lengths of outgoing and incoming CIDs can be configured
1394 * through the options
1395 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1396 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1397 *
1398 * Requires: MBEDTLS_SSL_PROTO_DTLS
1399 *
1400 * Uncomment to enable the Connection ID extension.
1401 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001402#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1403
1404
1405/**
1406 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1407 *
1408 * Defines whether RFC 9146 (default) or the legacy version
1409 * (version draft-ietf-tls-dtls-connection-id-05,
1410 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1411 * is used.
1412 *
1413 * Set the value to 0 for the standard version, and
1414 * 1 for the legacy draft version.
1415 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001416 * \deprecated Support for the legacy version of the DTLS
1417 * Connection ID feature is deprecated. Please
1418 * switch to the standardized version defined
1419 * in RFC 9146 enabled by utilizing
1420 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1421 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1422 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001423 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1424 */
1425#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001426
1427/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001428 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1429 *
1430 * Enable asynchronous external private key operations in SSL. This allows
1431 * you to configure an SSL connection to call an external cryptographic
1432 * module to perform private key operations instead of performing the
1433 * operation inside the library.
1434 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001435 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001436 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001437//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001438
1439/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001440 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1441 *
1442 * Enable serialization of the TLS context structures, through use of the
1443 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1444 *
1445 * This pair of functions allows one side of a connection to serialize the
1446 * context associated with the connection, then free or re-use that context
1447 * while the serialized state is persisted elsewhere, and finally deserialize
1448 * that state to a live context for resuming read/write operations on the
1449 * connection. From a protocol perspective, the state of the connection is
1450 * unaffected, in particular this is entirely transparent to the peer.
1451 *
1452 * Note: this is distinct from TLS session resumption, which is part of the
1453 * protocol and fully visible by the peer. TLS session resumption enables
1454 * establishing new connections associated to a saved session with shorter,
1455 * lighter handshakes, while context serialization is a local optimization in
1456 * handling a single, potentially long-lived connection.
1457 *
1458 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1459 * saved after the handshake to allow for more efficient serialization, so if
1460 * you don't need this feature you'll save RAM by disabling it.
1461 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001462 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1463 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001464 * Comment to disable the context serialization APIs.
1465 */
1466#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1467
1468/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001470 *
1471 * Enable the debug messages in SSL module for all issues.
1472 * Debug messages have been disabled in some places to prevent timing
1473 * attacks due to (unbalanced) debugging function calls.
1474 *
1475 * If you need all error reporting you should enable this during debugging,
1476 * but remove this for production servers that should log as well.
1477 *
1478 * Uncomment this macro to report all debug messages on errors introducing
1479 * a timing side-channel.
1480 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001483
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001484/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001485 *
1486 * Enable support for Encrypt-then-MAC, RFC 7366.
1487 *
1488 * This allows peers that both support it to use a more robust protection for
1489 * ciphersuites using CBC, providing deep resistance against timing attacks
1490 * on the padding or underlying cipher.
1491 *
1492 * This only affects CBC ciphersuites, and is useless if none is defined.
1493 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001494 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001495 *
1496 * Comment this macro to disable support for Encrypt-then-MAC
1497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001500/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001501 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001502 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1503 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001504 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001505 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001506 * attacks, but it is recommended to always use it (even if you disable
1507 * renegotiation), since it actually fixes a more fundamental issue in the
1508 * original SSL/TLS design, and has implications beyond Triple Handshake.
1509 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001510 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001511 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001512 * Comment this macro to disable support for Extended Master Secret.
1513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001514#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001515
Paul Bakkerd66f0702013-01-31 16:57:45 +01001516/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001517 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1518 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001519 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001520 * giving access to the peer's certificate after completion of the handshake.
1521 *
1522 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1523 * recommended to disable this option for reduced RAM usage.
1524 *
1525 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1526 * defined, but always returns \c NULL.
1527 *
1528 * \note This option has no influence on the protection against the
1529 * triple handshake attack. Even if it is disabled, Mbed TLS will
1530 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001531 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001532 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001533 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001534 *
1535 * Comment this macro to disable storing the peer's certificate
1536 * after the handshake.
1537 */
1538#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1539
1540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001541 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001542 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001543 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001544 *
1545 * The two main uses of renegotiation are (1) refresh keys on long-lived
1546 * connections and (2) client authentication after the initial handshake.
1547 * If you don't need renegotiation, it's probably better to disable it, since
1548 * it has been associated with security issues in the past and is easy to
1549 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001550 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001551 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1552 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001553 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001554 *
1555 * \note Even if this option is disabled, both client and server are aware
1556 * of the Renegotiation Indication Extension (RFC 5746) used to
1557 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1558 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1559 * configuration of this extension).
1560 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001563
1564/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001565 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001566 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001567 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001568 *
1569 * Comment this macro to disable support for the max_fragment_length extension
1570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001572
1573/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001574 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1575 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001576 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001577 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001578 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1579 *
1580 * Uncomment this macro to enable support for the record_size_limit extension
1581 */
1582//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1583
1584/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001586 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001587 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001588 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001589 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001590 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1591 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001592 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001593 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001594 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001595 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1596 * are only provided by PSA drivers, you must call psa_crypto_init() before
1597 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001598 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001599 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001601#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001602
1603/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001604 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001605 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001606 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001607 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001608 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001609 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001610 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001611 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001612 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001613 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001614 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1615 * directly performed by TLS 1.3 code. As a consequence, you must
1616 * call psa_crypto_init() before the first TLS 1.3 handshake.
1617 *
1618 * \note Cryptographic operations performed indirectly via another module
1619 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1620 * running handshake hash) only use PSA crypto if
1621 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001622 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001623 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001624 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001625#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001626
1627/**
Ronald Cronab65c522021-11-24 10:47:20 +01001628 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1629 *
1630 * Enable TLS 1.3 middlebox compatibility mode.
1631 *
1632 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1633 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1634 * expecting TLS 1.2 traffic.
1635 *
1636 * Turning on the compatibility mode comes at the cost of a few added bytes
1637 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1638 * that don't use it. Therefore, unless transmission bandwidth is critical and
1639 * you know that middlebox compatibility issues won't occur, it is therefore
1640 * recommended to set this option.
1641 *
1642 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001643 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1644 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001645 *
1646 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001647#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001648
1649/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001650 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1651 *
1652 * Enable TLS 1.3 PSK key exchange mode.
1653 *
1654 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1655 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1656 * effect on the build.
1657 *
1658 */
1659#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1660
1661/**
1662 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1663 *
1664 * Enable TLS 1.3 ephemeral key exchange mode.
1665 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001666 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001667 * MBEDTLS_X509_CRT_PARSE_C
1668 * and at least one of:
1669 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1670 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001671 *
1672 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1673 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1674 * effect on the build.
1675 *
1676 */
1677#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1678
1679/**
1680 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1681 *
1682 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1683 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001684 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001685 *
1686 * Comment to disable support for the PSK ephemeral key exchange mode in
1687 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1688 * have any effect on the build.
1689 *
1690 */
1691#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1692
1693/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 * \def MBEDTLS_SSL_EARLY_DATA
1695 *
1696 * Enable support for RFC 8446 TLS 1.3 early data.
1697 *
1698 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1699 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1700 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1701 *
1702 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1703 * is not enabled, this option does not have any effect on the build.
1704 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001705 * \note The maximum amount of early data can be set with
1706 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1707 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001709//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001710
1711/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001713 *
1714 * Enable support for DTLS (all available versions).
1715 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001716 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001717 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001718 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001719 *
1720 * Comment this macro to disable support for DTLS
1721 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001723
1724/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001726 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001727 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001728 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001729 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001730 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001732
1733/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001735 *
1736 * Enable support for the anti-replay mechanism in DTLS.
1737 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738 * Requires: MBEDTLS_SSL_TLS_C
1739 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001740 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001741 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001742 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001743 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001744 * Comment this to disable anti-replay in DTLS.
1745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001747
1748/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001749 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001750 *
1751 * Enable support for HelloVerifyRequest on DTLS servers.
1752 *
1753 * This feature is highly recommended to prevent DTLS servers being used as
1754 * amplifiers in DoS attacks against other hosts. It should always be enabled
1755 * unless you know for sure amplification cannot be a problem in the
1756 * environment in which your server operates.
1757 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001758 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001759 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001760 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001761 *
1762 * Comment this to disable support for HelloVerifyRequest.
1763 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001764#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001765
1766/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001767 * \def MBEDTLS_SSL_DTLS_SRTP
1768 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001769 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001770 * through the use_srtp extension.
1771 *
1772 * \note This feature provides the minimum functionality required
1773 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1774 * the associated SRTP packet protection key material.
1775 * In particular, the SRTP packet protection itself, as well as the
1776 * demultiplexing of RTP and DTLS packets at the datagram layer
1777 * (see Section 5 of RFC 5764), are not handled by this feature.
1778 * Instead, after successful completion of a handshake negotiating
1779 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001780 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001781 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1782 * (this is implemented in the SSL example programs).
1783 * The resulting key should then be passed to an SRTP stack.
1784 *
1785 * Setting this option enables the runtime API
1786 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1787 * through which the supported DTLS-SRTP protection
1788 * profiles can be configured. You must call this API at
1789 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001790 *
1791 * Requires: MBEDTLS_SSL_PROTO_DTLS
1792 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001793 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001794 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001795//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001796
1797/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001798 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1799 *
1800 * Enable server-side support for clients that reconnect from the same port.
1801 *
1802 * Some clients unexpectedly close the connection and try to reconnect using the
1803 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001804 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001805 * flag enables that support.
1806 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001807 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001808 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001809 * Comment this to disable support for clients reusing the source port.
1810 */
1811#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1812
1813/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001815 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001816 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001817 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001818 * session store remains the responsibility of the application, though).
1819 * Server-side, you also need to provide callbacks for writing and parsing
1820 * tickets, including authenticated encryption and key management. Example
1821 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001822 *
1823 * Comment this macro to disable support for SSL session tickets
1824 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001826
1827/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001828 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001829 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001830 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001831 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001832 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001833 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001834 * Comment this macro to disable support for server name indication in SSL
1835 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001836#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001837
1838/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001839 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1840 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001841 * When this option is enabled, the SSL buffer will be resized automatically
1842 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001843 *
1844 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001845 */
1846//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1847
1848/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001849 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1850 *
1851 * Enable testing of the constant-flow nature of some sensitive functions with
1852 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001853 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001854 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001855 * This setting requires compiling with clang -fsanitize=memory. The test
1856 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001857 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001858 * \warning This macro is only used for extended testing; it is not considered
1859 * part of the library's API, so it may change or disappear at any time.
1860 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001861 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001862 */
1863//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1864
1865/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001866 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1867 *
1868 * Enable testing of the constant-flow nature of some sensitive functions with
1869 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001870 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001871 *
1872 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001873 * testing if the tests suites are run with valgrind's memcheck. This can be
1874 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1875 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001876 *
1877 * \warning This macro is only used for extended testing; it is not considered
1878 * part of the library's API, so it may change or disappear at any time.
1879 *
1880 * Uncomment to enable testing of the constant-flow nature of selected code.
1881 */
1882//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1883
1884/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001885 * \def MBEDTLS_TEST_HOOKS
1886 *
1887 * Enable features for invasive testing such as introspection functions and
1888 * hooks for fault injection. This enables additional unit tests.
1889 *
1890 * Merely enabling this feature should not change the behavior of the product.
1891 * It only adds new code, and new branching points where the default behavior
1892 * is the same as when this feature is disabled.
1893 * However, this feature increases the attack surface: there is an added
1894 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1895 * Therefore this feature must never be enabled in production.
1896 *
1897 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1898 * information.
1899 *
1900 * Uncomment to enable invasive tests.
1901 */
1902//#define MBEDTLS_TEST_HOOKS
1903
1904/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001906 *
1907 * Provide your own alternate threading implementation.
1908 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001910 *
1911 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001912 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001914
1915/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001917 *
1918 * Enable the pthread wrapper layer for the threading layer.
1919 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001921 *
1922 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001923 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001924//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001925
1926/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001927 * \def MBEDTLS_USE_PSA_CRYPTO
1928 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001929 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1930 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001931 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001932 * \note Development of this option is currently in progress, and parts of Mbed
1933 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001934 * will still continue to work as usual, so enabling this option should not
1935 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001936 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001937 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001938 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1939 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001940 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001941 * \note An important and desirable effect of this option is that it allows
1942 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1943 * 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 +02001944 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001945 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1946 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001947 *
1948 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001949 *
1950 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001951 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001952 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001954//#define MBEDTLS_USE_PSA_CRYPTO
1955
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001957 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1958 *
John Durkop185764f2020-10-12 21:32:12 -07001959 * This setting allows support for cryptographic mechanisms through the PSA
1960 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001961 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001962 * When this option is disabled, the PSA API exposes the cryptographic
1963 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1964 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001965 *
1966 * When this option is enabled, the PSA API exposes the cryptographic
1967 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1968 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1969 * automatically enabled if required (i.e. if no PSA driver provides the
1970 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1971 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001972 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001973 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001974 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001975 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001976 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1977 * symbols is not completely finalized yet, and the configuration
1978 * tooling is not ideally adapted to having two separate configuration
1979 * files.
1980 * Future minor releases of Mbed TLS may make minor changes to those
1981 * symbols, but we will endeavor to provide a transition path.
1982 * Nonetheless, this option is considered mature enough to use in
1983 * production, as long as you accept that you may need to make
1984 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001985 */
1986//#define MBEDTLS_PSA_CRYPTO_CONFIG
1987
1988/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001989 * \def MBEDTLS_VERSION_FEATURES
1990 *
1991 * Allow run-time checking of compile-time enabled features. Thus allowing users
1992 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001993 * support via mbedtls_version_check_feature().
1994 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001995 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00001996 *
1997 * Comment this to disable run-time checking and save ROM space
1998 */
1999#define MBEDTLS_VERSION_FEATURES
2000
2001/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002002 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2003 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002004 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002005 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2006 * the set of trusted certificates through a callback instead of a linked
2007 * list.
2008 *
2009 * This is useful for example in environments where a large number of trusted
2010 * certificates is present and storing them in a linked list isn't efficient
2011 * enough, or when the set of trusted certificates changes frequently.
2012 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002013 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002014 * `mbedtls_ssl_conf_ca_cb()` for more information.
2015 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002016 * Requires: MBEDTLS_X509_CRT_PARSE_C
2017 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002018 * Uncomment to enable trusted certificate callbacks.
2019 */
2020//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2021
2022/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002023 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002024 *
Chris Jones2c745862020-12-16 11:41:06 +00002025 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002026 *
Chris Jones2c745862020-12-16 11:41:06 +00002027 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002028 * and other functions/constants only used by these functions, thus reducing
2029 * the code footprint by several KB.
2030 */
Chris Jones2c745862020-12-16 11:41:06 +00002031//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002032
2033/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002035 *
2036 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2037 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2038 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002039 * Requires: MBEDTLS_PKCS1_V21
2040 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002041 * Comment this macro to disallow using RSASSA-PSS in certificates.
2042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002044/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002045
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002046/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002047 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002048 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002049 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002050 * \{
2051 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002052
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002053/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002055 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002056 * Enable AES-NI support on x86-64 or x86-32.
2057 *
2058 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002059 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002060 * - GCC, x86-64, target not explicitly supporting AESNI:
2061 * requires MBEDTLS_HAVE_ASM.
2062 * - GCC, x86-32, target not explicitly supporting AESNI:
2063 * not supported.
2064 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2065 * For this assembly-less implementation, you must currently compile
2066 * `library/aesni.c` and `library/aes.c` with machine options to enable
2067 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2068 * `clang -maes -mpclmul`.
2069 * - Non-x86 targets: this option is silently ignored.
2070 * - Other compilers: this option is silently ignored.
2071 *
2072 * \note
2073 * Above, "GCC" includes compatible compilers such as Clang.
2074 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002075 *
2076 * Module: library/aesni.c
2077 * Caller: library/aes.c
2078 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002079 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002080 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002081 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002082 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002083#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002084
2085/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002086 * \def MBEDTLS_AESCE_C
2087 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002088 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002089 *
2090 * Module: library/aesce.c
2091 * Caller: library/aes.c
2092 *
Jerry Yuf015a932023-04-25 10:38:03 +08002093 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002094 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002095 * \warning Runtime detection only works on Linux. For non-Linux operating
2096 * system, Armv8-A Cryptographic Extensions must be supported by
2097 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002098 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002099 * \note Minimum compiler versions for this feature when targeting aarch64
2100 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2101 * Minimum compiler versions for this feature when targeting 32-bit
2102 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002103 *
2104 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2105 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002106 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002107 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002108 */
2109#define MBEDTLS_AESCE_C
2110
2111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002112 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002113 *
2114 * Enable the AES block cipher.
2115 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002116 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002117 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002118 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002119 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002120 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002121 * This module enables the following ciphersuites (if other requisites are
2122 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002123 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2124 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2125 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2126 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2127 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2128 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2129 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2130 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2131 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2132 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2133 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2134 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2135 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2136 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2137 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2138 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2139 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2140 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2141 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2142 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2143 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2144 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2145 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2146 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2147 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2148 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2149 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2150 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2151 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2152 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2153 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2154 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2155 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2156 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2157 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2158 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2159 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2160 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2161 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2162 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2163 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2164 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2165 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2166 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2167 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2168 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2169 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2170 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2171 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2172 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2173 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2174 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2175 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2176 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2177 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2178 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2179 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2180 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002181 *
Paul Bakkercff68422013-09-15 20:43:33 +02002182 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002184#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002185
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002187 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002188 *
2189 * Enable the generic ASN1 parser.
2190 *
2191 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002192 * Caller: library/x509.c
2193 * library/dhm.c
2194 * library/pkcs12.c
2195 * library/pkcs5.c
2196 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002197 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002198#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002199
2200/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002201 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002202 *
2203 * Enable the generic ASN1 writer.
2204 *
2205 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002206 * Caller: library/ecdsa.c
2207 * library/pkwrite.c
2208 * library/x509_create.c
2209 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002210 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002211 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002212#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002213
2214/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002215 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002216 *
2217 * Enable the Base64 module.
2218 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002219 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002220 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002221 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002222 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002223 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002224#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002225
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002226/**
Yanray Wange367e472023-10-31 17:23:04 +08002227 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2228 *
2229 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2230 *
2231 * \note This feature is incompatible with insecure block cipher,
2232 * MBEDTLS_DES_C, and cipher modes which always require decryption
2233 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002234 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2235 * this feature is incompatible with following supported PSA equivalence,
2236 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2237 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002238 *
2239 * Module: library/aes.c
2240 * library/aesce.c
2241 * library/aesni.c
2242 * library/aria.c
2243 * library/camellia.c
2244 * library/cipher.c
2245 */
2246//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2247
2248/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002250 *
Paul Bakker9a736322012-11-14 12:39:52 +00002251 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002252 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002253 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002254 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002255 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002256 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002257 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002258 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002259 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002260 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002261 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002262 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002263 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002264 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002265 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002266#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002267
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002268/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002270 *
2271 * Enable the Camellia block cipher.
2272 *
Paul Bakker38119b12009-01-10 23:31:23 +00002273 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002274 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002275 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002276 * This module enables the following ciphersuites (if other requisites are
2277 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002278 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2279 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2280 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2281 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2282 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2283 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2284 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2285 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2286 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2287 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2288 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2289 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2290 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2291 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2292 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2293 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2294 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2295 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2296 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2297 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2298 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2299 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2300 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2301 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2302 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2303 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2304 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2305 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2306 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2307 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2308 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2309 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2310 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2311 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2312 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2313 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2314 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2315 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2316 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2317 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2318 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2319 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002320 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002322
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002323/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002324 * \def MBEDTLS_ARIA_C
2325 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002326 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002327 *
2328 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002329 * Caller: library/cipher.c
2330 *
2331 * This module enables the following ciphersuites (if other requisites are
2332 * enabled as well):
2333 *
2334 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2335 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2336 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2337 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2338 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2339 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2340 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2341 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2342 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2343 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2344 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2345 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2346 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2347 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2348 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2349 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2350 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2351 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2352 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2353 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2354 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2355 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2356 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2357 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2358 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2359 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2360 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2361 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2362 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2363 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2364 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2365 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2366 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2367 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2368 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2369 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2370 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2371 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002372 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002373#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002374
2375/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002376 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002377 *
2378 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2379 *
2380 * Module: library/ccm.c
2381 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002382 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2383 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002384 *
2385 * This module enables the AES-CCM ciphersuites, if other requisites are
2386 * enabled as well.
2387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002388#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002389
2390/**
Daniel King34b822c2016-05-15 17:28:08 -03002391 * \def MBEDTLS_CHACHA20_C
2392 *
2393 * Enable the ChaCha20 stream cipher.
2394 *
2395 * Module: library/chacha20.c
2396 */
2397#define MBEDTLS_CHACHA20_C
2398
2399/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002400 * \def MBEDTLS_CHACHAPOLY_C
2401 *
2402 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2403 *
2404 * Module: library/chachapoly.c
2405 *
2406 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2407 */
2408#define MBEDTLS_CHACHAPOLY_C
2409
2410/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002411 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002412 *
2413 * Enable the generic cipher layer.
2414 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002415 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002416 * Caller: library/ccm.c
2417 * library/cmac.c
2418 * library/gcm.c
2419 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002420 * library/pkcs12.c
2421 * library/pkcs5.c
2422 * library/psa_crypto_aead.c
2423 * library/psa_crypto_mac.c
2424 * library/ssl_ciphersuites.c
2425 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002426 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002427 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2428 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002429 *
2430 * Uncomment to enable generic cipher wrappers.
2431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002433
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002434/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002435 * \def MBEDTLS_CMAC_C
2436 *
Simon Butcher327398a2016-10-05 14:09:11 +01002437 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2438 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002439 *
2440 * Module: library/cmac.c
2441 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002442 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002443 *
2444 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002445#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002446
2447/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002448 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002449 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002450 * Enable the CTR_DRBG AES-based random generator.
2451 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002452 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002453 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002454 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002455 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2456 * is used.
2457 *
2458 * \warning When using PSA, the user should call `psa_crypto_init()` before
2459 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2460 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002461 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2462 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002463 * \note To achieve a 256-bit security strength with CTR_DRBG,
2464 * you must use AES-256 *and* use sufficient entropy.
2465 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002466 *
2467 * Module: library/ctr_drbg.c
2468 * Caller:
2469 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002470 * Requires: MBEDTLS_AES_C or
2471 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2472 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002473 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002474 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002475 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002476#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002477
2478/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002479 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002480 *
2481 * Enable the debug functions.
2482 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002483 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002484 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002485 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002486 * library/ssl_tls12_*.c
2487 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002488 *
2489 * This module provides debugging functions.
2490 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002492
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002493/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002495 *
2496 * Enable the DES block cipher.
2497 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002498 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002499 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002500 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002501 *
Paul Bakkercff68422013-09-15 20:43:33 +02002502 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002503 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002504 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002505 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002508
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002509/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002510 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002511 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002512 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002513 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002514 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002515 * Caller: library/ssl_tls.c
2516 * library/ssl*_client.c
2517 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002518 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002519 * This module is used by the following key exchanges:
2520 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002521 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002522 * \warning Using DHE constitutes a security risk as it
2523 * is not possible to validate custom DH parameters.
2524 * If possible, it is recommended users should consider
2525 * preferring other methods of key exchange.
2526 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002527 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002528 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002529#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002530
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002531/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002533 *
2534 * Enable the elliptic curve Diffie-Hellman library.
2535 *
2536 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002537 * Caller: library/psa_crypto.c
2538 * library/ssl_tls.c
2539 * library/ssl*_client.c
2540 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002541 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002542 * This module is used by the following key exchanges:
2543 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002544 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002547#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002548
2549/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002550 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002551 *
2552 * Enable the elliptic curve DSA library.
2553 *
2554 * Module: library/ecdsa.c
2555 * Caller:
2556 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002557 * This module is used by the following key exchanges:
2558 * ECDHE-ECDSA
2559 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002560 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2561 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2562 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002565
2566/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002567 * \def MBEDTLS_ECJPAKE_C
2568 *
2569 * Enable the elliptic curve J-PAKE library.
2570 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002571 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2572 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002573 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002574 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002575 * Module: library/ecjpake.c
2576 * Caller:
2577 *
2578 * This module is used by the following key exchanges:
2579 * ECJPAKE
2580 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002581 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002582 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002583 * \warning If using a hash that is only provided by PSA drivers, you must
2584 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002585 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002586#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002587
2588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002590 *
2591 * Enable the elliptic curve over GF(p) library.
2592 *
2593 * Module: library/ecp.c
2594 * Caller: library/ecdh.c
2595 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002596 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002597 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002601
2602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002604 *
2605 * Enable the platform-specific entropy code.
2606 *
2607 * Module: library/entropy.c
2608 * Caller:
2609 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002610 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002611 *
2612 * This module provides a generic entropy pool
2613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002614#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002615
2616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002618 *
2619 * Enable error code to error string conversion.
2620 *
2621 * Module: library/error.c
2622 * Caller:
2623 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002625 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002627
2628/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002630 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002631 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002632 *
2633 * Module: library/gcm.c
2634 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002635 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2636 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002637 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002638 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2639 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002640 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002642
2643/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002644 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002645 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002646 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002647 * Can significantly increase throughput on systems without GCM hardware
2648 * acceleration (e.g., AESNI, AESCE).
2649 *
Matthias Schulz78266782024-02-08 13:54:48 +01002650 * The mbedtls_gcm_context size will increase by 3840 bytes.
2651 * The code size will increase by roughly 344 bytes.
2652 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002653 * Module: library/gcm.c
2654 *
2655 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002656 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002657//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002658
2659/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002660 * \def MBEDTLS_HKDF_C
2661 *
2662 * Enable the HKDF algorithm (RFC 5869).
2663 *
2664 * Module: library/hkdf.c
2665 * Caller:
2666 *
2667 * Requires: MBEDTLS_MD_C
2668 *
2669 * This module adds support for the Hashed Message Authentication Code
2670 * (HMAC)-based key derivation function (HKDF).
2671 */
2672#define MBEDTLS_HKDF_C
2673
2674/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002676 *
2677 * Enable the HMAC_DRBG random generator.
2678 *
2679 * Module: library/hmac_drbg.c
2680 * Caller:
2681 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002683 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002684 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002687
2688/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002689 * \def MBEDTLS_LMS_C
2690 *
2691 * Enable the LMS stateful-hash asymmetric signature algorithm.
2692 *
2693 * Module: library/lms.c
2694 * Caller:
2695 *
Raef Colesab4f8742022-09-01 12:24:31 +01002696 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002697 *
Raef Colesab4f8742022-09-01 12:24:31 +01002698 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002699 */
2700#define MBEDTLS_LMS_C
2701
2702/**
Raef Colesab4f8742022-09-01 12:24:31 +01002703 * \def MBEDTLS_LMS_PRIVATE
2704 *
2705 * Enable LMS private-key operations and signing code. Functions enabled by this
2706 * option are experimental, and should not be used in production.
2707 *
2708 * Requires: MBEDTLS_LMS_C
2709 *
2710 * Uncomment to enable the LMS signature algorithm and private key operations.
2711 */
Raef Coles5127e852022-10-07 10:35:56 +01002712//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002713
2714/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002715 * \def MBEDTLS_NIST_KW_C
2716 *
2717 * Enable the Key Wrapping mode for 128-bit block ciphers,
2718 * as defined in NIST SP 800-38F. Only KW and KWP modes
2719 * are supported. At the moment, only AES is approved by NIST.
2720 *
2721 * Module: library/nist_kw.c
2722 *
2723 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2724 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002725#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002726
2727/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002729 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002730 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002731 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002732 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2733 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002734 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002735 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002736 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002737 * Caller: library/constant_time.c
2738 * library/ecdsa.c
2739 * library/ecjpake.c
2740 * library/hkdf.c
2741 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002742 * library/pk.c
2743 * library/pkcs5.c
2744 * library/pkcs12.c
2745 * library/psa_crypto_ecp.c
2746 * library/psa_crypto_rsa.c
2747 * library/rsa.c
2748 * library/ssl_cookie.c
2749 * library/ssl_msg.c
2750 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002751 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002752 * library/x509_crt.c
2753 * library/x509write_crt.c
2754 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002755 *
2756 * Uncomment to enable generic message digest wrappers.
2757 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002758#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002759
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002760/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002762 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002763 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002764 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002765 * Module: library/md5.c
2766 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002767 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002768 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002769 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002770 * This module is required for TLS 1.2 depending on the handshake parameters.
2771 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2772 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002773 *
2774 * \warning MD5 is considered a weak message digest and its use constitutes a
2775 * security risk. If possible, we recommend avoiding dependencies on
2776 * it, and considering stronger message digests instead.
2777 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002780
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002781/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002782 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002783 *
2784 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002785 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002786 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002787 *
2788 * Module: library/memory_buffer_alloc.c
2789 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002790 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002791 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002792 *
2793 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002794 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002795//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002796
2797/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002799 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002800 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2801 *
Simon Butcherd567a232016-03-09 20:19:21 +00002802 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2803 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002804 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002805 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002806 * \note See also our Knowledge Base article about porting to a new
2807 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002808 * 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 +00002809 *
Andres AG788aa4a2016-09-14 14:32:09 +01002810 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002811 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002812 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002815
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002816/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002817 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002818 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002819 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002820 *
2821 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002822 * Caller: library/asn1write.c
2823 * library/pkcs5.c
2824 * library/pkparse.c
2825 * library/pkwrite.c
2826 * library/rsa.c
2827 * library/x509.c
2828 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002829 * library/x509_crl.c
2830 * library/x509_crt.c
2831 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002832 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002833 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002834 *
2835 * This modules translates between OIDs and internal values.
2836 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002838
2839/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002840 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002841 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002842 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002843 *
2844 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002845 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002846 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002847 * library/x509_crl.c
2848 * library/x509_crt.c
2849 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002850 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002852 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2853 *
2854 * \warning When parsing password-protected files, if MD5 is provided only by
2855 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002856 *
Paul Bakkercff68422013-09-15 20:43:33 +02002857 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002858 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002860
2861/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002863 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002864 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002865 *
2866 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002867 * Caller: library/pkwrite.c
2868 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002869 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002870 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002872 *
2873 * This modules adds support for encoding / writing PEM files.
2874 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002876
2877/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002879 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002880 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002881 *
2882 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002883 * Caller: library/psa_crypto_rsa.c
2884 * library/ssl_tls.c
2885 * library/ssl*_client.c
2886 * library/ssl*_server.c
2887 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002888 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002889 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002890 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002891 * Uncomment to enable generic public key wrappers.
2892 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002894
2895/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002897 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002898 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002899 *
2900 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002901 * Caller: library/x509_crt.c
2902 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002903 *
Yanray Wang072a0682023-12-05 10:53:04 +08002904 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002905 *
2906 * Uncomment to enable generic public key parse functions.
2907 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002909
2910/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002912 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002913 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002914 *
2915 * Module: library/pkwrite.c
2916 * Caller: library/x509write.c
2917 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002918 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002919 *
2920 * Uncomment to enable generic public key write functions.
2921 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002923
2924/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002926 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002927 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002928 *
2929 * Module: library/pkcs5.c
2930 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002931 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002932 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002933 * \warning If using a hash that is only provided by PSA drivers, you must
2934 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002935 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002936 * This module adds support for the PKCS#5 functions.
2937 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002939
2940/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002941 * \def MBEDTLS_PKCS7_C
2942 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002943 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002944 * RFC Link - https://tools.ietf.org/html/rfc2315
2945 *
2946 * Module: library/pkcs7.c
2947 *
2948 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002949 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2950 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002951 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002952 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002953 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002954#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002955
2956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002958 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002959 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002960 * Adds algorithms for parsing PKCS#8 encrypted private keys
2961 *
2962 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002963 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002964 *
Valerio Settie98ad592023-12-28 10:42:12 +01002965 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2966 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002967 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002968 * \warning If using a hash that is only provided by PSA drivers, you must
2969 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002970 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002971 * This module enables PKCS#12 functions.
2972 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002974
2975/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002977 *
2978 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002979 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002980 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2982 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002983 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002984 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002985 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002986 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002987 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002988 * Module: library/platform.c
2989 * Caller: Most other .c files
2990 *
2991 * This module enables abstraction of common (libc) functions.
2992 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002993#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002994
2995/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002996 * \def MBEDTLS_POLY1305_C
2997 *
2998 * Enable the Poly1305 MAC algorithm.
2999 *
3000 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003001 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003002 */
3003#define MBEDTLS_POLY1305_C
3004
3005/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003006 * \def MBEDTLS_PSA_CRYPTO_C
3007 *
3008 * Enable the Platform Security Architecture cryptography API.
3009 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003010 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003011 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003012 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003013 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003014 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3015 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3016 * is enabled in PSA (unless it's fully accelerated, see
3017 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003018 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003019#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003020
3021/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003022 * \def MBEDTLS_PSA_CRYPTO_SE_C
3023 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003024 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003025 * cryptography API.
3026 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003027 * \deprecated This feature is deprecated. Please switch to the PSA driver
3028 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003029 *
Ryan Everett32a64582024-03-05 18:16:18 +00003030 * \warning This feature is not thread-safe, and should not be used in a
3031 * multi-threaded environment.
3032 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003033 * Module: library/psa_crypto_se.c
3034 *
3035 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3036 *
3037 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003038//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003039
3040/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003041 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3042 *
3043 * Enable the Platform Security Architecture persistent key storage.
3044 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003045 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003046 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003047 * Requires: MBEDTLS_PSA_CRYPTO_C,
3048 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3049 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003050 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003051#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003052
3053/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003054 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003055 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003056 * Enable the emulation of the Platform Security Architecture
3057 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003058 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003059 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003060 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003061 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003062 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003063#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003064
3065/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003067 *
3068 * Enable the RIPEMD-160 hash algorithm.
3069 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003070 * Module: library/ripemd160.c
3071 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003072 *
3073 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003074#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003075
3076/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003078 *
3079 * Enable the RSA public-key cryptosystem.
3080 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003081 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003082 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003083 * Caller: library/pk.c
3084 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003085 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003086 * library/ssl*_client.c
3087 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003088 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003089 * This module is used by the following key exchanges:
3090 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003091 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003093 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003095
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003096/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003098 *
3099 * Enable the SHA1 cryptographic hash algorithm.
3100 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003101 * Module: library/sha1.c
3102 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003103 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003104 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003105 * This module is required for TLS 1.2 depending on the handshake parameters,
3106 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003107 *
3108 * \warning SHA-1 is considered a weak message digest and its use constitutes
3109 * a security risk. If possible, we recommend avoiding dependencies
3110 * on it, and considering stronger message digests instead.
3111 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003112 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003114
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003115/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003116 * \def MBEDTLS_SHA224_C
3117 *
3118 * Enable the SHA-224 cryptographic hash algorithm.
3119 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003120 * Module: library/sha256.c
3121 * Caller: library/md.c
3122 * library/ssl_cookie.c
3123 *
3124 * This module adds support for SHA-224.
3125 */
3126#define MBEDTLS_SHA224_C
3127
3128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003130 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003131 * Enable the SHA-256 cryptographic hash algorithm.
3132 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003133 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003134 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003135 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003136 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003137 * library/ssl*_client.c
3138 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003139 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003140 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003141 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003144
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003145/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003146 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003147 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003148 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3149 * with the ARMv8 cryptographic extensions if they are available at runtime.
3150 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003151 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003152 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003153 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003154 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003155 * \note Minimum compiler versions for this feature are Clang 4.0,
3156 * armclang 6.6 or GCC 6.0.
3157 *
3158 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3159 * armclang <= 6.9
3160 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003161 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3162 * That name is deprecated, but may still be used as an alternative form for this
3163 * option.
3164 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003165 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3166 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003167 *
3168 * Requires: MBEDTLS_SHA256_C.
3169 *
3170 * Module: library/sha256.c
3171 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003172 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003173 * and use them if available.
3174 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003175//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003176
Dave Rodgmand85277c2023-10-13 09:22:54 +01003177/**
3178 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3179 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003180 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003181 * This name is now deprecated, but may still be used as an alternative form for
3182 * this option.
3183 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003184//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3185
3186/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003187 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003188 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003189 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3190 * with the ARMv8 cryptographic extensions, which must be available at runtime
3191 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003192 *
3193 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003194 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003195 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003196 * \note Minimum compiler versions for this feature are Clang 4.0,
3197 * armclang 6.6 or GCC 6.0.
3198 *
3199 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3200 * armclang <= 6.9
3201 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003202 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003203 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003204 * option.
3205 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003206 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3207 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003208 *
3209 * Requires: MBEDTLS_SHA256_C.
3210 *
3211 * Module: library/sha256.c
3212 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003213 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003214 * unconditionally.
3215 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003216//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003217
Dave Rodgmand85277c2023-10-13 09:22:54 +01003218/**
3219 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3220 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003221 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003222 * This name is now deprecated, but may still be used as an alternative form for
3223 * this option.
3224 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003225//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3226
3227/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003228 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003229 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003230 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003231 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003232 * Module: library/sha512.c
3233 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003234 * library/psa_crypto_hash.c
3235 * library/ssl_tls.c
3236 * library/ssl*_client.c
3237 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003238 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003239 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003240 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003241#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003242
3243/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003244 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003245 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003246 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003247 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003248 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003249 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003250 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003251 * library/ssl_tls.c
3252 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003253 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003254 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003256#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003257
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003258/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003259 * \def MBEDTLS_SHA3_C
3260 *
3261 * Enable the SHA3 cryptographic hash algorithm.
3262 *
3263 * Module: library/sha3.c
3264 *
3265 * This module adds support for SHA3.
3266 */
3267#define MBEDTLS_SHA3_C
3268
3269/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003270 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3271 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003272 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3273 * with the ARMv8 cryptographic extensions if they are available at runtime.
3274 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003275 *
3276 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3277 * for a non-Aarch64 build it will be silently ignored.
3278 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003279 * \note Minimum compiler versions for this feature are Clang 7.0,
3280 * armclang 6.9 or GCC 8.0.
3281 *
3282 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3283 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003284 *
3285 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3286 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3287 *
3288 * Requires: MBEDTLS_SHA512_C.
3289 *
3290 * Module: library/sha512.c
3291 *
3292 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3293 * and use them if available.
3294 */
3295//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3296
3297/**
3298 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3299 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003300 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3301 * with the ARMv8 cryptographic extensions, which must be available at runtime
3302 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003303 *
3304 * \note This allows builds with a smaller code size than with
3305 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3306 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003307 * \note Minimum compiler versions for this feature are Clang 7.0,
3308 * armclang 6.9 or GCC 8.0.
3309 *
3310 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3311 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003312 *
3313 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3314 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3315 *
3316 * Requires: MBEDTLS_SHA512_C.
3317 *
3318 * Module: library/sha512.c
3319 *
3320 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3321 * unconditionally.
3322 */
3323//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3324
3325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003327 *
3328 * Enable simple SSL cache implementation.
3329 *
3330 * Module: library/ssl_cache.c
3331 * Caller:
3332 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003333 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003336
3337/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003339 *
3340 * Enable basic implementation of DTLS cookies for hello verification.
3341 *
3342 * Module: library/ssl_cookie.c
3343 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003344 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003345#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003346
3347/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003348 * \def MBEDTLS_SSL_TICKET_C
3349 *
3350 * Enable an implementation of TLS server-side callbacks for session tickets.
3351 *
3352 * Module: library/ssl_ticket.c
3353 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003354 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003355 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3356 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003357 */
3358#define MBEDTLS_SSL_TICKET_C
3359
3360/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003362 *
3363 * Enable the SSL/TLS client code.
3364 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003365 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003366 * Caller:
3367 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003369 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003370 * This module is required for SSL/TLS client support.
3371 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003372#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003373
Paul Bakker9a736322012-11-14 12:39:52 +00003374/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003376 *
3377 * Enable the SSL/TLS server code.
3378 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003379 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003380 * Caller:
3381 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003383 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003384 * This module is required for SSL/TLS server support.
3385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003387
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003388/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003390 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003391 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003392 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003393 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003394 * Caller: library/ssl*_client.c
3395 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003396 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3398 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003399 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003400 * This module is required for SSL/TLS.
3401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003402#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003403
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003404/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003406 *
3407 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003408 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003409 * contexts are not shared between threads. If you do intend to use contexts
3410 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003411 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003412 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003413 *
3414 * Module: library/threading.c
3415 *
3416 * This allows different threading implementations (self-implemented or
3417 * provided).
3418 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419 * You will have to enable either MBEDTLS_THREADING_ALT or
3420 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003421 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003422 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003423 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003425
3426/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003428 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003429 * Enable the semi-portable timing interface.
3430 *
Simon Butcherd567a232016-03-09 20:19:21 +00003431 * \note The provided implementation only works on POSIX/Unix (including Linux,
3432 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003433 * module and provide your own implementations of the callbacks needed by
3434 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3435 * your own implementation of the whole module by setting
3436 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003437 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003438 * \note The timing module will include time.h on suitable platforms
3439 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3440 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3441 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003442 * \note See also our Knowledge Base article about porting to a new
3443 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003444 * 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 +00003445 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003446 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003447 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003449
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003450/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003451 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003452 *
3453 * Enable run-time version information.
3454 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003455 * Module: library/version.c
3456 *
3457 * This module provides run-time version information.
3458 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003460
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003461/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003463 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003464 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003465 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003466 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003467 * Caller: library/x509_crl.c
3468 * library/x509_crt.c
3469 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003470 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003471 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003472 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3473 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003474 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3475 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003476 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003477 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003479#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003480
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003481/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003483 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003484 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003485 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003486 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003487 * Caller: library/ssl_tls.c
3488 * library/ssl*_client.c
3489 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003490 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003491 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003492 *
3493 * This module is required for X.509 certificate parsing.
3494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003496
3497/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003499 *
3500 * Enable X.509 CRL parsing.
3501 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003502 * Module: library/x509_crl.c
3503 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003504 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003506 *
3507 * This module is required for X.509 CRL parsing.
3508 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003509#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003510
3511/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003513 *
3514 * Enable X.509 Certificate Signing Request (CSR) parsing.
3515 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003516 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003517 * Caller: library/x509_crt_write.c
3518 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003520 *
3521 * This module is used for reading X.509 certificate request.
3522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003523#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003524
3525/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003526 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003527 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003528 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003529 *
3530 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003531 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003532 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003533 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3534 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003535 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3536 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003537 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003538 * This module is the basis for creating X.509 certificates and CSRs.
3539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003541
3542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003544 *
3545 * Enable creating X.509 certificates.
3546 *
3547 * Module: library/x509_crt_write.c
3548 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003550 *
3551 * This module is required for X.509 certificate creation.
3552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003553#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003554
3555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003556 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003557 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003558 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003559 *
3560 * Module: library/x509_csr_write.c
3561 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003562 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003563 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003564 * This module is required for X.509 certificate request writing.
3565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003567
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003568/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003569
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003570/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003571 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003572 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003573 * This section contains Mbed TLS build settings that are not associated
3574 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003575 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003576 * \{
3577 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003578
Gilles Peskinea02c1242022-03-16 17:03:19 +01003579/**
3580 * \def MBEDTLS_CONFIG_FILE
3581 *
3582 * If defined, this is a header which will be included instead of
3583 * `"mbedtls/mbedtls_config.h"`.
3584 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003585 * Unlike other configuration options, this one must be defined on the
3586 * compiler command line: a definition in `mbedtls_config.h` would have
3587 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003588 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003589 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003590 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003591 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003592 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003593 * The value of this symbol is typically a path in double quotes, either
3594 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003595 */
3596//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3597
3598/**
3599 * \def MBEDTLS_USER_CONFIG_FILE
3600 *
3601 * If defined, this is a header which will be included after
3602 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003603 * This allows you to modify the default configuration, including the ability
3604 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003605 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003606 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003607 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003608 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003609 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003610 * The value of this symbol is typically a path in double quotes, either
3611 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003612 */
3613//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3614
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003615/**
3616 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3617 *
3618 * If defined, this is a header which will be included instead of
3619 * `"psa/crypto_config.h"`.
3620 * This header file specifies which cryptographic mechanisms are available
3621 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3622 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3623 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003624 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003625 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003626 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003627 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003628 * The value of this symbol is typically a path in double quotes, either
3629 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003630 */
3631//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3632
3633/**
3634 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3635 *
3636 * If defined, this is a header which will be included after
3637 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003638 * This allows you to modify the default configuration, including the ability
3639 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003640 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003641 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003642 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003643 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003644 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003645 * The value of this symbol is typically a path in double quotes, either
3646 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003647 */
3648//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3649
Gilles Peskineb1176f22023-02-22 22:07:28 +01003650/**
3651 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3652 *
3653 * If defined, this is a header which will be included instead of
3654 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3655 * as the one in Mbed TLS, but with definitions adapted to the platform on
3656 * which the library code will run.
3657 *
3658 * \note The required content of this header can vary from one version of
3659 * Mbed TLS to the next. Integrators who provide an alternative file
3660 * should review the changes in the original file whenever they
3661 * upgrade Mbed TLS.
3662 *
3663 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3664 * non-standard feature of the C language, so this feature is only available
3665 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3666 *
3667 * The value of this symbol is typically a path in double quotes, either
3668 * absolute or relative to a directory on the include search path.
3669 */
3670//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3671
3672/**
3673 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3674 *
3675 * If defined, this is a header which will be included instead of
3676 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3677 * as the one in Mbed TLS, but with definitions adapted to the environment
3678 * in which the library code will run. The typical use for this feature
3679 * is to provide alternative type definitions on the client side in
3680 * client-server integrations of PSA crypto, where operation structures
3681 * contain handles instead of cryptographic data.
3682 *
3683 * \note The required content of this header can vary from one version of
3684 * Mbed TLS to the next. Integrators who provide an alternative file
3685 * should review the changes in the original file whenever they
3686 * upgrade Mbed TLS.
3687 *
3688 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3689 * non-standard feature of the C language, so this feature is only available
3690 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3691 *
3692 * The value of this symbol is typically a path in double quotes, either
3693 * absolute or relative to a directory on the include search path.
3694 */
3695//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3696
Gilles Peskineba4162a2022-04-11 17:04:38 +02003697/** \} name SECTION: General configuration options */
3698
3699/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003700 * \name SECTION: Module configuration options
3701 *
3702 * This section allows for the setting of module specific sizes and
3703 * configuration options. The default values are already present in the
3704 * relevant header files and should suffice for the regular use cases.
3705 *
3706 * Our advice is to enable options and change their values here
3707 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003708 * \{
3709 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003710/* The Doxygen documentation here is used when a user comments out a
3711 * setting and runs doxygen themselves. On the other hand, when we typeset
3712 * the full documentation including disabled settings, the documentation
3713 * in specific modules' header files is used if present. When editing this
3714 * file, make sure that each option is documented in exactly one place,
3715 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3716 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003717
Paul Bakker088c5c52014-04-25 11:11:10 +02003718/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003719//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003720//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003721
Paul Bakker088c5c52014-04-25 11:11:10 +02003722/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003723//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3724//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3725//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3726//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3727//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003728
Paul Bakker088c5c52014-04-25 11:11:10 +02003729/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003730//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3731//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3732//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3733//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003734
Paul Bakker088c5c52014-04-25 11:11:10 +02003735/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003736//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003737//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003738
Paul Bakker088c5c52014-04-25 11:11:10 +02003739/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003740//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3741//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003742//#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 +01003743
Paul Bakker088c5c52014-04-25 11:11:10 +02003744/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003745//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003746
Paul Bakker088c5c52014-04-25 11:11:10 +02003747/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003748//#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 -04003749
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003750/** \def MBEDTLS_PLATFORM_STD_CALLOC
3751 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003752 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003753 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003754 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003755 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003756 * 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 -04003757 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3758 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003759 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003760 */
3761//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003762
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003763/** \def MBEDTLS_PLATFORM_STD_FREE
3764 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003765 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003766 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003767 * 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 -04003768 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3769 * 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 -04003770 */
3771//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003772//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003773//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003774//#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 +02003775//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3776//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003777/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003778//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003779//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3780//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003781//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3782//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3783//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003784
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003785/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003786/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003787//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3788//#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 +02003789//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003790//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003791//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3792//#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 +02003793//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3794//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003795/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003796//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003797//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003798//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3799//#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 +08003800//#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 +08003801//#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 +02003802
Gilles Peskine3f106f72021-09-23 17:42:39 +02003803/** \def MBEDTLS_CHECK_RETURN
3804 *
3805 * This macro is used at the beginning of the declaration of a function
3806 * to indicate that its return value should be checked. It should
3807 * instruct the compiler to emit a warning or an error if the function
3808 * is called without checking its return value.
3809 *
3810 * There is a default implementation for popular compilers in platform_util.h.
3811 * You can override the default implementation by defining your own here.
3812 *
3813 * If the implementation here is empty, this will effectively disable the
3814 * checking of functions' return values.
3815 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003816//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003817
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003818/** \def MBEDTLS_IGNORE_RETURN
3819 *
3820 * This macro requires one argument, which should be a C function call.
3821 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3822 * warning is suppressed.
3823 */
3824//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3825
Gilles Peskineed038902020-11-13 21:33:21 +01003826/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003827/**
Gilles Peskineed038902020-11-13 21:33:21 +01003828 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3829 * PSA crypto subsystem.
3830 *
3831 * If this option is unset:
3832 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003833 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003834 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3835 * on unspecified heuristics.
3836 */
3837//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3838
Steven Cooreman863470a2021-02-15 14:03:19 +01003839/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003840 * Restrict the PSA library to supporting a maximum amount of simultaneously
3841 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3842 * volatile key, or a persistent key which is loaded temporarily by the
3843 * library as part of a crypto operation in flight.
3844 *
3845 * If this option is unset, the library will fall back to a default value of
3846 * 32 keys.
3847 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003848//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003849
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003850/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003851//#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 +00003852
Paul Bakker088c5c52014-04-25 11:11:10 +02003853/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003854//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3855//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003856
Paul Bakker088c5c52014-04-25 11:11:10 +02003857/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003858
Angus Grattond8213d02016-05-25 20:56:48 +10003859/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3860 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003861 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003862 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003863 * This determines the size of the incoming TLS I/O buffer in such a way
3864 * that it is capable of holding the specified amount of plaintext data,
3865 * regardless of the protection mechanism used.
3866 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003867 * \note When using a value less than the default of 16KB on the client, it is
3868 * recommended to use the Maximum Fragment Length (MFL) extension to
3869 * inform the server about this limitation. On the server, there
3870 * is no supported, standardized way of informing the client about
3871 * restriction on the maximum size of incoming messages, and unless
3872 * the limitation has been communicated by other means, it is recommended
3873 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3874 * while keeping the default value of 16KB for the incoming buffer.
3875 *
David Horstmann95d516f2021-05-04 18:36:56 +01003876 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003877 */
3878//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3879
Gilles Peskined3d02902020-03-04 21:35:27 +01003880/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3881 *
3882 * The maximum length of CIDs used for incoming DTLS messages.
3883 *
3884 */
3885//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3886
3887/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3888 *
3889 * The maximum length of CIDs used for outgoing DTLS messages.
3890 *
3891 */
3892//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3893
TRodziewicze8dd7092021-05-12 14:19:11 +02003894/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003895 *
3896 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003897 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003898 *
3899 * The padding will always be chosen so that the length of the
3900 * padded plaintext is a multiple of the value of this option.
3901 *
3902 * Note: A value of \c 1 means that no padding will be used
3903 * for outgoing records.
3904 *
3905 * Note: On systems lacking division instructions,
3906 * a power of two should be preferred.
3907 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003908//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003909
Angus Grattond8213d02016-05-25 20:56:48 +10003910/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3911 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003912 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003913 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003914 * This determines the size of the outgoing TLS I/O buffer in such a way
3915 * that it is capable of holding the specified amount of plaintext data,
3916 * regardless of the protection mechanism used.
3917 *
Angus Grattond8213d02016-05-25 20:56:48 +10003918 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3919 * the default inward 16384 byte buffer to conform to the TLS specification.
3920 *
3921 * The minimum required outward buffer size is determined by the handshake
3922 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3923 * The specific size requirement depends on the configured ciphers and any
3924 * certificate data which is sent during the handshake.
3925 *
David Horstmann95d516f2021-05-04 18:36:56 +01003926 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003927 */
3928//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3929
Hanno Beckere0b150f2018-08-21 15:51:03 +01003930/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3931 *
3932 * Maximum number of heap-allocated bytes for the purpose of
3933 * DTLS handshake message reassembly and future message buffering.
3934 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003935 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003936 * to account for a reassembled handshake message of maximum size,
3937 * together with its reassembly bitmap.
3938 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003939 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003940 * should be sufficient for all practical situations as it allows
3941 * to reassembly a large handshake message (such as a certificate)
3942 * while buffering multiple smaller handshake messages.
3943 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003944 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003945//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003946
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003947//#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 +02003948//#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 +02003949
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003950/**
3951 * Complete list of ciphersuites to use, in order of preference.
3952 *
3953 * \warning No dependency checking is done on that field! This option can only
3954 * be used to restrict the set of available ciphersuites. It is your
3955 * responsibility to make sure the needed modules are active.
3956 *
3957 * Use this to save a few hundred bytes of ROM (default ordering of all
3958 * available ciphersuites) and a few to a few hundred bytes of RAM.
3959 *
3960 * The value below is only an example, not the default.
3961 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003962//#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 +02003963
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003964/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003965 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3966 *
3967 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003968 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003969 *
3970 * It must be positive and smaller than UINT32_MAX.
3971 *
3972 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3973 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003974 */
3975//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3976
3977/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003978 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3979 *
Jerry Yucf913512023-11-14 11:06:52 +08003980 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003981 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003982 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003983 * - The client ticket age is the time difference between the time when the
3984 * client proposes to the server to use the ticket and the time the client
3985 * received the ticket from the server.
3986 * - The server ticket age is the time difference between the time when the
3987 * server receives a proposition from the client to use the ticket and the
3988 * time when the ticket was created by the server.
3989 *
Jerry Yucf913512023-11-14 11:06:52 +08003990 * The ages might be different due to the client and server clocks not running
3991 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3992 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3993 * 6s, thus in the worst case clients and servers must sync up their system time
3994 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003995 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003996 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003997 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003998//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003999
4000/**
4001 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4002 *
4003 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4004 *
4005 * This must be less than 256.
4006 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004007//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004008
4009/**
4010 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4011 *
4012 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4013 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4014 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4015 *
4016 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004017//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004018
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004019/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004020//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004021//#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 +01004022
Gilles Peskine611179c2022-04-13 23:04:48 +02004023/** \} name SECTION: Module configuration options */