blob: 530bc4fe16634126d67b808ae123ba300b6fcda0 [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_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300354//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300355//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300356//#define MBEDTLS_ECDSA_VERIFY_ALT
357//#define MBEDTLS_ECDSA_SIGN_ALT
358//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200359
360/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200361 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200362 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200363 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200364 * hardware entropy collector.
365 *
366 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000367 * prototype as declared in library/entropy_poll.h, and accept NULL as first
368 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200369 *
370 * Uncomment to use your own hardware entropy collector.
371 */
372//#define MBEDTLS_ENTROPY_HARDWARE_ALT
373
374/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000376 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100377 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000378 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100379 * Uncomment this macro to use precomputed AES tables stored in ROM.
380 * Comment this macro to generate AES tables in RAM at runtime.
381 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100382 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
383 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100384 * initialization time before the first AES operation can be performed.
385 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
386 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
387 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100388 *
389 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000390 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200391//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000392
393/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100394 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200395 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100396 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200397 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100398 * Uncommenting this macro omits 75% of the AES tables from
399 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
400 * by computing their values on the fly during operations
401 * (the tables are entry-wise rotations of one another).
402 *
403 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100404 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100405 * runtime. Specifically, one has to compare 4 accesses within
406 * different tables to 4 accesses with additional arithmetic
407 * operations within the same table. The performance gain/loss
408 * depends on the system and memory details.
409 *
410 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200411 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100412//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200413
414/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800415 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
416 *
417 * Use only 128-bit keys in AES operations to save ROM.
418 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800419 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800420 * or 256-bit keys.
421 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800422 * Uncommenting this macro reduces the size of AES code by ~300 bytes
423 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800424 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800425 * Module: library/aes.c
426 *
427 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800428 */
429//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
430
Gilles Peskinea8861e02023-09-05 20:20:51 +0200431/*
432 * Disable plain C implementation for AES.
433 *
434 * When the plain C implementation is enabled, and an implementation using a
435 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
436 * detection will be used to select between them.
437 *
438 * If only one implementation is present, runtime detection will not be used.
439 * This configuration will crash at runtime if running on a CPU without the
440 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
441 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
442 */
443//#define MBEDTLS_AES_USE_HARDWARE_ONLY
444
Arto Kinnunen732ca322023-04-14 14:26:10 +0800445/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200446 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200447 *
448 * Use less ROM for the Camellia implementation (saves about 768 bytes).
449 *
450 * Uncomment this macro to use less memory for Camellia.
451 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200452//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200453
454/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200455 * \def MBEDTLS_CHECK_RETURN_WARNING
456 *
457 * If this macro is defined, emit a compile-time warning if application code
458 * calls a function without checking its return value, but the return value
459 * should generally be checked in portable applications.
460 *
461 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
462 * implemented. Otherwise this option has no effect.
463 *
464 * Uncomment to get warnings on using fallible functions without checking
465 * their return value.
466 *
467 * \note This feature is a work in progress.
468 * Warnings will be added to more functions in the future.
469 *
470 * \note A few functions are considered critical, and ignoring the return
471 * value of these functions will trigger a warning even if this
472 * macro is not defined. To completely disable return value check
473 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
474 */
475//#define MBEDTLS_CHECK_RETURN_WARNING
476
477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200479 *
480 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200483
484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200485 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000486 *
487 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200489#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000490
491/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200492 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000493 *
494 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200496#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000497
498/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100499 * \def MBEDTLS_CIPHER_MODE_OFB
500 *
501 * Enable Output Feedback mode (OFB) for symmetric ciphers.
502 */
503#define MBEDTLS_CIPHER_MODE_OFB
504
505/**
506 * \def MBEDTLS_CIPHER_MODE_XTS
507 *
508 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
509 */
510#define MBEDTLS_CIPHER_MODE_XTS
511
512/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000514 *
515 * Enable NULL cipher.
516 * Warning: Only do so when you know what you are doing. This allows for
517 * encryption or channels without any security!
518 *
Ronald Croncee42702021-04-26 11:34:44 +0200519 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200520 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
521 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
522 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
523 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
524 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
525 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
526 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
527 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
528 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
529 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
530 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
531 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
532 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
533 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
534 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
535 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
536 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
537 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
538 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000539 *
540 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000543
544/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100545 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200546 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100547 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
548 * specific padding modes in the cipher layer with cipher modes that support
549 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200550 *
551 * If you disable all padding modes, only full blocks can be used with CBC.
552 *
553 * Enable padding modes in the cipher layer.
554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200555#define MBEDTLS_CIPHER_PADDING_PKCS7
556#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
557#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
558#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200559
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200560/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
561 *
562 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800563 * Without this, CTR_DRBG uses a 256-bit key
564 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200565 */
566//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
567
Paul Bakker48e93c82013-08-14 12:21:18 +0200568/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200569 * Enable the verified implementations of ECDH primitives from Project Everest
570 * (currently only Curve25519). This feature changes the layout of ECDH
571 * contexts and therefore is a compatibility break for applications that access
572 * fields of a mbedtls_ecdh_context structure directly. See also
573 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000574 *
575 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
576 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200577 */
578//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
579
580/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100581 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200582 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100583 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
584 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200585 *
586 * Comment macros to disable the curve and functions for it
587 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200588/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200589#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
590#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
591#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
592#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
593#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
594#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
595#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
596#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
597#define MBEDTLS_ECP_DP_BP256R1_ENABLED
598#define MBEDTLS_ECP_DP_BP384R1_ENABLED
599#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200600/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200601#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000602#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200603
604/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200605 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200606 *
607 * Enable specific 'modulo p' routines for each NIST prime.
608 * Depending on the prime and architecture, makes operations 4 to 8 times
609 * faster on the corresponding curve.
610 *
611 * Comment this macro to disable NIST curves optimisation.
612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200613#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200614
615/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200616 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100617 *
618 * Enable "non-blocking" ECC operations that can return early and be resumed.
619 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200620 * This allows various functions to pause by returning
621 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
622 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
623 * order to further progress and eventually complete their operation. This is
624 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
625 * number of ECC operations a function may perform before pausing; see
626 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100627 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200628 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200629 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100630 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100631 * This option:
632 * - Adds xxx_restartable() variants of existing operations in the
633 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100634 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
635 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100636 * - ECDSA: signature generation & verification;
637 * - PK: signature generation & verification;
638 * - X509: certificate chain verification.
639 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
640 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
641 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
642 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000643 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100644 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100645 * - verification of the server's key exchange signature;
646 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100647 * - generation of the client's signature if client authentication is used,
648 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100649 *
650 * \note In the cases above, the usual SSL/TLS functions, such as
651 * mbedtls_ssl_handshake(), can now return
652 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200653 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100654 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
655 * restartable operations in PK, X.509 and TLS (see above) are not
656 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100657 * PSA, and are not restartable. These are temporary limitations that
658 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200659 *
Ron Eldor19779c42018-11-05 16:58:13 +0200660 * \note This option only works with the default software implementation of
661 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100662 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100663 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100664 * Requires: MBEDTLS_ECP_C
665 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100666 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100667 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200668//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100669
670/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200671 * Uncomment to enable using new bignum code in the ECC modules.
672 *
673 * \warning This is currently experimental, incomplete and therefore should not
674 * be used in production.
675 */
676//#define MBEDTLS_ECP_WITH_MPI_UINT
677
678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100680 *
681 * Enable deterministic ECDSA (RFC 6979).
682 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
683 * may result in a compromise of the long-term signing key. This is avoided by
684 * the deterministic variant.
685 *
John Durkop36a82e52020-10-26 09:39:05 -0700686 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100687 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100688 * Comment this macro to disable deterministic ECDSA.
689 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200690#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100691
692/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200694 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200695 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200696 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200697 * This enables the following ciphersuites (if other requisites are
698 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200699 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
700 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
701 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
702 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
703 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
704 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
705 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
706 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
707 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
708 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200709 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200711
712/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200713 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200714 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200715 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200716 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200717 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200718 *
719 * This enables the following ciphersuites (if other requisites are
720 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200721 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
722 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
723 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
724 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
725 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
726 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
727 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
728 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
729 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
730 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100731 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100732 * \warning Using DHE constitutes a security risk as it
733 * is not possible to validate custom DH parameters.
734 * If possible, it is recommended users should consider
735 * preferring other methods of key exchange.
736 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100737 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200738 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200739#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200740
741/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200742 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200743 *
744 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
745 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200746 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200747 *
748 * This enables the following ciphersuites (if other requisites are
749 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200750 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
751 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
752 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
753 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
754 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
755 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200756 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200758
759/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200760 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200761 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200762 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200763 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
765 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200766 *
767 * This enables the following ciphersuites (if other requisites are
768 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
770 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
771 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
772 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
773 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
774 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
775 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
776 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
777 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
778 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200781
782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200784 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200785 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200786 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
788 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200789 *
790 * This enables the following ciphersuites (if other requisites are
791 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200792 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
793 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
794 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
795 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
796 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
797 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
798 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
799 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
800 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
801 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
802 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
803 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200804 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200806
807/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200808 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200809 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200810 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200811 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200812 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
813 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200814 *
815 * This enables the following ciphersuites (if other requisites are
816 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200817 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
818 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
819 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
820 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
821 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
822 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
823 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
824 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
825 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
826 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
827 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
828 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100829 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100830 * \warning Using DHE constitutes a security risk as it
831 * is not possible to validate custom DH parameters.
832 * If possible, it is recommended users should consider
833 * preferring other methods of key exchange.
834 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100835 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838
839/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200841 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200842 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200843 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200844 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
845 * MBEDTLS_RSA_C
846 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200847 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200848 *
849 * This enables the following ciphersuites (if other requisites are
850 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200851 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
852 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
853 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
854 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
855 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
856 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
857 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
858 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
859 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
860 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863
864/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200866 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200867 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200868 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200869 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
870 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
871 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200872 *
873 * This enables the following ciphersuites (if other requisites are
874 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
876 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
877 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
878 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
879 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
880 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
881 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
882 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
883 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
884 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200886#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200887
888/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100890 *
891 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
892 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200893 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
894 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
895 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100896 *
897 * This enables the following ciphersuites (if other requisites are
898 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200899 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
900 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
901 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
902 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
903 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
904 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
905 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
906 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
907 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
908 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100909 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100911
912/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200913 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100914 *
915 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
916 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200917 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
918 * MBEDTLS_RSA_C
919 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100920 *
921 * This enables the following ciphersuites (if other requisites are
922 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200923 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
924 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
925 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
926 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
927 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
928 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
929 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
930 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
931 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
932 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100935
936/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200937 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
938 *
939 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
940 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200941 * \warning This is currently experimental. EC J-PAKE support is based on the
942 * Thread v1.0.0 specification; incompatible changes to the specification
943 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200944 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200945 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100946 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200947 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
948 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100949 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800950 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100951 * MBEDTLS_USE_PSA_CRYPTO is disabled).
952 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200953 * This enables the following ciphersuites (if other requisites are
954 * enabled as well):
955 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
956 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200957//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200958
959/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200960 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100961 *
962 * Enhance support for reading EC keys using variants of SEC1 not allowed by
963 * RFC 5915 and RFC 5480.
964 *
965 * Currently this means parsing the SpecifiedECDomain choice of EC
966 * parameters (only known groups are supported, not arbitrary domains, to
967 * avoid validation issues).
968 *
969 * Disable if you only need to support RFC 5915 + 5480 key formats.
970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100972
973/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200974 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
975 *
976 * Enable the support for parsing public keys of type Short Weierstrass
977 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200978 * compressed point format. This parsing is done through ECP module's functions.
979 *
980 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
981 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
982 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200983 */
984#define MBEDTLS_PK_PARSE_EC_COMPRESSED
985
986/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100988 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989 * Enable a dummy error function to make use of mbedtls_strerror() in
990 * third party libraries easier when MBEDTLS_ERROR_C is disabled
991 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200992 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
994 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100995 *
996 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100998 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200999#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001000
1001/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001002 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001003 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001004 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001005 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001007 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001009
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001010/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001012 *
1013 * Enable functions that use the filesystem.
1014 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001016
1017/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001018 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001019 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001020 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001021 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001022 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001023 * application.
1024 *
1025 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001026 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001028
1029/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001031 *
1032 * Do not use built-in platform entropy functions.
1033 * This is useful if your platform does not support
1034 * standards like the /dev/urandom or Windows CryptoAPI.
1035 *
1036 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001037 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001039
1040/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001042 *
1043 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1044 * default SHA-512 based one (if both are available).
1045 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001046 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001047 *
1048 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1049 * if you have performance concerns.
1050 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 * This option is only useful if both MBEDTLS_SHA256_C and
1052 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001055
1056/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001057 * \def MBEDTLS_ENTROPY_NV_SEED
1058 *
1059 * Enable the non-volatile (NV) seed file-based entropy source.
1060 * (Also enables the NV seed read/write functions in the platform layer)
1061 *
1062 * This is crucial (if not required) on systems that do not have a
1063 * cryptographic entropy source (in hardware or kernel) available.
1064 *
1065 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1066 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001067 * \note The read/write functions that are used by the entropy source are
1068 * determined in the platform layer, and can be modified at runtime and/or
1069 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1070 *
1071 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001072 * with regular fopen(), please make sure you make a seedfile with the
1073 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1074 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001075 * and written to or you will get an entropy source error! The default
1076 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1077 * bytes from the file.
1078 *
1079 * \note The entropy collector will write to the seed file before entropy is
1080 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001081 */
1082//#define MBEDTLS_ENTROPY_NV_SEED
1083
Ronald Cron71016a92020-08-28 19:01:50 +02001084/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001085 *
Ronald Cron71016a92020-08-28 19:01:50 +02001086 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001087 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001088 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1089 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001090 *
1091 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001092 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001093 */
Ronald Cron71016a92020-08-28 19:01:50 +02001094//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001095
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001096/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001098 *
1099 * Enable debugging of buffer allocator memory issues. Automatically prints
1100 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1101 * function for 'debug output' of allocated memory.
1102 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001104 *
1105 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001108
1109/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001110 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001111 *
1112 * Include backtrace information with each allocated block.
1113 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001115 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001116 *
1117 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001120
1121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001123 *
1124 * Support external private RSA keys (eg from a HSM) in the PK layer.
1125 *
1126 * Comment this macro to disable support for external private RSA keys.
1127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001129
1130/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001131 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001132 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001133 * Enable support for PKCS#1 v1.5 encoding.
1134 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001135 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001136 *
Paul Bakker48377d92013-08-30 12:06:24 +02001137 * This enables support for PKCS#1 v1.5 operations.
1138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001140
1141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001142 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001143 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001144 * Enable support for PKCS#1 v2.1 encoding.
1145 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001146 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001147 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001148 * \warning If using a hash that is only provided by PSA drivers, you must
1149 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001150 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001151 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001154
Steven Cooreman6801f082021-02-19 17:21:22 +01001155/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1156 *
1157 * Enable support for platform built-in keys. If you enable this feature,
1158 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1159 * See the documentation of that function for more information.
1160 *
1161 * Built-in keys are typically derived from a hardware unique key or
1162 * stored in a secure element.
1163 *
1164 * Requires: MBEDTLS_PSA_CRYPTO_C.
1165 *
1166 * \warning This interface is experimental and may change or be removed
1167 * without notice.
1168 */
1169//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1170
Ronald Cron3768ac12021-01-26 16:58:00 +01001171/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1172 *
1173 * Enable support for PSA crypto client.
1174 *
1175 * \note This option allows to include the code necessary for a PSA
1176 * crypto client when the PSA crypto implementation is not included in
1177 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1178 * code to set and get PSA key attributes.
1179 * The development of PSA drivers partially relying on the library to
1180 * fulfill the hardware gaps is another possible usage of this option.
1181 *
1182 * \warning This interface is experimental and may change or be removed
1183 * without notice.
1184 */
1185//#define MBEDTLS_PSA_CRYPTO_CLIENT
1186
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001187/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1188 *
1189 * Make the PSA Crypto module use an external random generator provided
1190 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1191 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001192 * \note This random generator must deliver random numbers with cryptographic
1193 * quality and high performance. It must supply unpredictable numbers
1194 * with a uniform distribution. The implementation of this function
1195 * is responsible for ensuring that the random generator is seeded
1196 * with sufficient entropy. If you have a hardware TRNG which is slow
1197 * or delivers non-uniform output, declare it as an entropy source
1198 * with mbedtls_entropy_add_source() instead of enabling this option.
1199 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001200 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001201 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1202 * and define a function called mbedtls_psa_external_get_random()
1203 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001204 * ```
1205 * psa_status_t mbedtls_psa_external_get_random(
1206 * mbedtls_psa_external_random_context_t *context,
1207 * uint8_t *output, size_t output_size, size_t *output_length);
1208 * );
1209 * ```
1210 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001211 * The function must fill the \c output buffer with \c output_size bytes
1212 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001213 *
1214 * Requires: MBEDTLS_PSA_CRYPTO_C
1215 *
1216 * \warning If you enable this option, code that uses the PSA cryptography
1217 * interface will not use any of the entropy sources set up for
1218 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1219 * enables.
1220 *
1221 * \note This option is experimental and may be removed without notice.
1222 */
1223//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1224
Paul Bakker9dcc3222011-03-08 14:16:06 +00001225/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001226 * \def MBEDTLS_PSA_CRYPTO_SPM
1227 *
1228 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1229 * Partition Manager) integration which separates the code into two parts: a
1230 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1231 * Environment).
1232 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001233 * If you enable this option, your build environment must include a header
1234 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1235 * header files, or in another directory on the compiler's include search
1236 * path). Alternatively, your platform may customize the header
1237 * `psa/crypto_platform.h`, in which case it can skip or replace the
1238 * inclusion of `"crypto_spe.h"`.
1239 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001240 * Module: library/psa_crypto.c
1241 * Requires: MBEDTLS_PSA_CRYPTO_C
1242 *
1243 */
1244//#define MBEDTLS_PSA_CRYPTO_SPM
1245
1246/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001247 * Uncomment to enable p256-m. This is an alternative implementation of
1248 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1249 * Compared to the default implementation:
1250 *
1251 * - p256-m has a much smaller code size and RAM footprint.
1252 * - p256-m is only available via the PSA API. This includes the pk module
1253 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1254 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1255 * over the core arithmetic, or deterministic derivation of keys.
1256 *
1257 * We recommend enabling this option if your application uses the PSA API
1258 * and the only elliptic curve support it needs is ECDH and ECDSA over
1259 * SECP256R1.
1260 *
1261 * If you enable this option, you do not need to enable any ECC-related
1262 * MBEDTLS_xxx option. You do need to separately request support for the
1263 * cryptographic mechanisms through the PSA API:
1264 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1265 * configuration;
1266 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1267 * - #PSA_WANT_ECC_SECP_R1_256;
1268 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1269 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1270 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1271 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1272 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001273 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001274 * \note To benefit from the smaller code size of p256-m, make sure that you
1275 * do not enable any ECC-related option not supported by p256-m: this
1276 * would cause the built-in ECC implementation to be built as well, in
1277 * order to provide the required option.
1278 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001279 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1280 * SECP256R1 are disabled as they are not supported by this driver.
1281 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1282 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001283 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001284 */
1285//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1286
1287/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001288 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001289 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001290 * Enable support for entropy injection at first boot. This feature is
1291 * required on systems that do not have a built-in entropy source (TRNG).
1292 * This feature is currently not supported on systems that have a built-in
1293 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001294 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001295 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001296 *
1297 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001298//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001299
1300/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001301 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001302 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001303 * Assume all buffers passed to PSA functions are owned exclusively by the
1304 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001305 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001306 * This option may be enabled if all buffers passed to any PSA function reside
1307 * in memory that is accessible only to the PSA function during its execution.
1308 *
1309 * This option MUST be disabled whenever buffer arguments are in memory shared
1310 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001311 * across a trust boundary.
1312 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001313 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001314 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001315 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001316 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001317 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001318//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001319
1320/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001321 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001322 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001323 * Do not use the Chinese Remainder Theorem
1324 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001325 *
1326 * Uncomment this macro to disable the use of CRT in RSA.
1327 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001328 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001329//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001330
1331/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001332 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001333 *
1334 * Enable the checkup functions (*_self_test).
1335 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001336#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001337
1338/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001339 * \def MBEDTLS_SHA256_SMALLER
1340 *
1341 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1342 * lower performance.
1343 *
Adam Wolf039080f2019-09-10 09:53:08 -05001344 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001345 * performance and size. This version optimizes more aggressively for size at
1346 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1347 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1348 * 30%.
1349 *
1350 * Uncomment to enable the smaller implementation of SHA256.
1351 */
1352//#define MBEDTLS_SHA256_SMALLER
1353
1354/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001355 * \def MBEDTLS_SHA512_SMALLER
1356 *
1357 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1358 * lower performance.
1359 *
1360 * Uncomment to enable the smaller implementation of SHA512.
1361 */
1362//#define MBEDTLS_SHA512_SMALLER
1363
1364/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001365 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001366 *
1367 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001368 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001369 * with other servers, only debugging of failures is harder.
1370 *
1371 * The advantage of not sending alert messages, is that no information is given
1372 * about reasons for failures thus preventing adversaries of gaining intel.
1373 *
1374 * Enable sending of all alert messages
1375 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001376#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001377
1378/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001379 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1380 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001381 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001382 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001383 * in the underlying transport. The CID functionality is described
1384 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001385 *
1386 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001387 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1388 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1389 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001390 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001391 * The maximum lengths of outgoing and incoming CIDs can be configured
1392 * through the options
1393 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1394 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1395 *
1396 * Requires: MBEDTLS_SSL_PROTO_DTLS
1397 *
1398 * Uncomment to enable the Connection ID extension.
1399 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001400#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1401
1402
1403/**
1404 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1405 *
1406 * Defines whether RFC 9146 (default) or the legacy version
1407 * (version draft-ietf-tls-dtls-connection-id-05,
1408 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1409 * is used.
1410 *
1411 * Set the value to 0 for the standard version, and
1412 * 1 for the legacy draft version.
1413 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001414 * \deprecated Support for the legacy version of the DTLS
1415 * Connection ID feature is deprecated. Please
1416 * switch to the standardized version defined
1417 * in RFC 9146 enabled by utilizing
1418 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1419 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1420 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001421 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1422 */
1423#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001424
1425/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001426 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1427 *
1428 * Enable asynchronous external private key operations in SSL. This allows
1429 * you to configure an SSL connection to call an external cryptographic
1430 * module to perform private key operations instead of performing the
1431 * operation inside the library.
1432 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001433 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001434 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001435//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001436
1437/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001438 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1439 *
1440 * Enable serialization of the TLS context structures, through use of the
1441 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1442 *
1443 * This pair of functions allows one side of a connection to serialize the
1444 * context associated with the connection, then free or re-use that context
1445 * while the serialized state is persisted elsewhere, and finally deserialize
1446 * that state to a live context for resuming read/write operations on the
1447 * connection. From a protocol perspective, the state of the connection is
1448 * unaffected, in particular this is entirely transparent to the peer.
1449 *
1450 * Note: this is distinct from TLS session resumption, which is part of the
1451 * protocol and fully visible by the peer. TLS session resumption enables
1452 * establishing new connections associated to a saved session with shorter,
1453 * lighter handshakes, while context serialization is a local optimization in
1454 * handling a single, potentially long-lived connection.
1455 *
1456 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1457 * saved after the handshake to allow for more efficient serialization, so if
1458 * you don't need this feature you'll save RAM by disabling it.
1459 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001460 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1461 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001462 * Comment to disable the context serialization APIs.
1463 */
1464#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1465
1466/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001467 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001468 *
1469 * Enable the debug messages in SSL module for all issues.
1470 * Debug messages have been disabled in some places to prevent timing
1471 * attacks due to (unbalanced) debugging function calls.
1472 *
1473 * If you need all error reporting you should enable this during debugging,
1474 * but remove this for production servers that should log as well.
1475 *
1476 * Uncomment this macro to report all debug messages on errors introducing
1477 * a timing side-channel.
1478 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001480//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001483 *
1484 * Enable support for Encrypt-then-MAC, RFC 7366.
1485 *
1486 * This allows peers that both support it to use a more robust protection for
1487 * ciphersuites using CBC, providing deep resistance against timing attacks
1488 * on the padding or underlying cipher.
1489 *
1490 * This only affects CBC ciphersuites, and is useless if none is defined.
1491 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001492 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001493 *
1494 * Comment this macro to disable support for Encrypt-then-MAC
1495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001496#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001497
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001499 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001500 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1501 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001502 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001503 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001504 * attacks, but it is recommended to always use it (even if you disable
1505 * renegotiation), since it actually fixes a more fundamental issue in the
1506 * original SSL/TLS design, and has implications beyond Triple Handshake.
1507 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001508 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001509 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001510 * Comment this macro to disable support for Extended Master Secret.
1511 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001512#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001513
Paul Bakkerd66f0702013-01-31 16:57:45 +01001514/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001515 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1516 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001517 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001518 * giving access to the peer's certificate after completion of the handshake.
1519 *
1520 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1521 * recommended to disable this option for reduced RAM usage.
1522 *
1523 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1524 * defined, but always returns \c NULL.
1525 *
1526 * \note This option has no influence on the protection against the
1527 * triple handshake attack. Even if it is disabled, Mbed TLS will
1528 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001529 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001530 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001531 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001532 *
1533 * Comment this macro to disable storing the peer's certificate
1534 * after the handshake.
1535 */
1536#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1537
1538/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001539 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001540 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001541 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001542 *
1543 * The two main uses of renegotiation are (1) refresh keys on long-lived
1544 * connections and (2) client authentication after the initial handshake.
1545 * If you don't need renegotiation, it's probably better to disable it, since
1546 * it has been associated with security issues in the past and is easy to
1547 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001548 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001549 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1550 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001551 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001552 *
1553 * \note Even if this option is disabled, both client and server are aware
1554 * of the Renegotiation Indication Extension (RFC 5746) used to
1555 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1556 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1557 * configuration of this extension).
1558 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001561
1562/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001563 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001564 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001565 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001566 *
1567 * Comment this macro to disable support for the max_fragment_length extension
1568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001570
1571/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001572 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1573 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001574 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001575 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001576 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1577 *
1578 * Uncomment this macro to enable support for the record_size_limit extension
1579 */
1580//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1581
1582/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001583 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001584 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001585 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001586 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001587 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001588 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1589 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001590 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001591 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001592 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001593 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1594 * are only provided by PSA drivers, you must call psa_crypto_init() before
1595 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001596 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001597 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001599#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001600
1601/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001602 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001603 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001604 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001605 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001606 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001607 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001608 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001609 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001610 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001611 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001612 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1613 * directly performed by TLS 1.3 code. As a consequence, you must
1614 * call psa_crypto_init() before the first TLS 1.3 handshake.
1615 *
1616 * \note Cryptographic operations performed indirectly via another module
1617 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1618 * running handshake hash) only use PSA crypto if
1619 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001620 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001621 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001622 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001623#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001624
1625/**
Ronald Cronab65c522021-11-24 10:47:20 +01001626 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1627 *
1628 * Enable TLS 1.3 middlebox compatibility mode.
1629 *
1630 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1631 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1632 * expecting TLS 1.2 traffic.
1633 *
1634 * Turning on the compatibility mode comes at the cost of a few added bytes
1635 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1636 * that don't use it. Therefore, unless transmission bandwidth is critical and
1637 * you know that middlebox compatibility issues won't occur, it is therefore
1638 * recommended to set this option.
1639 *
1640 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001641 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1642 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001643 *
1644 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001645#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001646
1647/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001648 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1649 *
1650 * Enable TLS 1.3 PSK key exchange mode.
1651 *
1652 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1653 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1654 * effect on the build.
1655 *
1656 */
1657#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1658
1659/**
1660 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1661 *
1662 * Enable TLS 1.3 ephemeral key exchange mode.
1663 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001664 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001665 * MBEDTLS_X509_CRT_PARSE_C
1666 * and at least one of:
1667 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1668 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001669 *
1670 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1671 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1672 * effect on the build.
1673 *
1674 */
1675#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1676
1677/**
1678 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1679 *
1680 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1681 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001682 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001683 *
1684 * Comment to disable support for the PSK ephemeral key exchange mode in
1685 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1686 * have any effect on the build.
1687 *
1688 */
1689#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1690
1691/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 * \def MBEDTLS_SSL_EARLY_DATA
1693 *
1694 * Enable support for RFC 8446 TLS 1.3 early data.
1695 *
1696 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1697 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1698 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1699 *
1700 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1701 * is not enabled, this option does not have any effect on the build.
1702 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001703 * \note The maximum amount of early data can be set with
1704 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1705 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001707//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001708
1709/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001710 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001711 *
1712 * Enable support for DTLS (all available versions).
1713 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001714 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001715 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001716 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001717 *
1718 * Comment this macro to disable support for DTLS
1719 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001721
1722/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001724 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001725 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001726 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001727 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001730
1731/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001733 *
1734 * Enable support for the anti-replay mechanism in DTLS.
1735 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736 * Requires: MBEDTLS_SSL_TLS_C
1737 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001738 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001739 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001740 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001741 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001742 * Comment this to disable anti-replay in DTLS.
1743 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001744#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001745
1746/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001747 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001748 *
1749 * Enable support for HelloVerifyRequest on DTLS servers.
1750 *
1751 * This feature is highly recommended to prevent DTLS servers being used as
1752 * amplifiers in DoS attacks against other hosts. It should always be enabled
1753 * unless you know for sure amplification cannot be a problem in the
1754 * environment in which your server operates.
1755 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001756 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001757 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001758 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001759 *
1760 * Comment this to disable support for HelloVerifyRequest.
1761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001762#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001763
1764/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001765 * \def MBEDTLS_SSL_DTLS_SRTP
1766 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001767 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001768 * through the use_srtp extension.
1769 *
1770 * \note This feature provides the minimum functionality required
1771 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1772 * the associated SRTP packet protection key material.
1773 * In particular, the SRTP packet protection itself, as well as the
1774 * demultiplexing of RTP and DTLS packets at the datagram layer
1775 * (see Section 5 of RFC 5764), are not handled by this feature.
1776 * Instead, after successful completion of a handshake negotiating
1777 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001778 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001779 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1780 * (this is implemented in the SSL example programs).
1781 * The resulting key should then be passed to an SRTP stack.
1782 *
1783 * Setting this option enables the runtime API
1784 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1785 * through which the supported DTLS-SRTP protection
1786 * profiles can be configured. You must call this API at
1787 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001788 *
1789 * Requires: MBEDTLS_SSL_PROTO_DTLS
1790 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001791 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001792 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001793//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001794
1795/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001796 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1797 *
1798 * Enable server-side support for clients that reconnect from the same port.
1799 *
1800 * Some clients unexpectedly close the connection and try to reconnect using the
1801 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001802 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001803 * flag enables that support.
1804 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001805 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001806 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001807 * Comment this to disable support for clients reusing the source port.
1808 */
1809#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1810
1811/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001813 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001814 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001815 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001816 * session store remains the responsibility of the application, though).
1817 * Server-side, you also need to provide callbacks for writing and parsing
1818 * tickets, including authenticated encryption and key management. Example
1819 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001820 *
1821 * Comment this macro to disable support for SSL session tickets
1822 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001824
1825/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001827 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001828 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001829 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001831 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001832 * Comment this macro to disable support for server name indication in SSL
1833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001835
1836/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001837 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1838 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001839 * When this option is enabled, the SSL buffer will be resized automatically
1840 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001841 *
1842 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001843 */
1844//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1845
1846/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001847 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1848 *
1849 * Enable testing of the constant-flow nature of some sensitive functions with
1850 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001851 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001852 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001853 * This setting requires compiling with clang -fsanitize=memory. The test
1854 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001855 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001856 * \warning This macro is only used for extended testing; it is not considered
1857 * part of the library's API, so it may change or disappear at any time.
1858 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001859 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001860 */
1861//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1862
1863/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001864 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1865 *
1866 * Enable testing of the constant-flow nature of some sensitive functions with
1867 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001868 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001869 *
1870 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001871 * testing if the tests suites are run with valgrind's memcheck. This can be
1872 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1873 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001874 *
1875 * \warning This macro is only used for extended testing; it is not considered
1876 * part of the library's API, so it may change or disappear at any time.
1877 *
1878 * Uncomment to enable testing of the constant-flow nature of selected code.
1879 */
1880//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1881
1882/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001883 * \def MBEDTLS_TEST_HOOKS
1884 *
1885 * Enable features for invasive testing such as introspection functions and
1886 * hooks for fault injection. This enables additional unit tests.
1887 *
1888 * Merely enabling this feature should not change the behavior of the product.
1889 * It only adds new code, and new branching points where the default behavior
1890 * is the same as when this feature is disabled.
1891 * However, this feature increases the attack surface: there is an added
1892 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1893 * Therefore this feature must never be enabled in production.
1894 *
1895 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1896 * information.
1897 *
1898 * Uncomment to enable invasive tests.
1899 */
1900//#define MBEDTLS_TEST_HOOKS
1901
1902/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001904 *
1905 * Provide your own alternate threading implementation.
1906 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001908 *
1909 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001912
1913/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001915 *
1916 * Enable the pthread wrapper layer for the threading layer.
1917 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001918 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001919 *
1920 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001921 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001922//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001923
1924/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001925 * \def MBEDTLS_USE_PSA_CRYPTO
1926 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001927 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1928 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001929 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001930 * \note Development of this option is currently in progress, and parts of Mbed
1931 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001932 * will still continue to work as usual, so enabling this option should not
1933 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001934 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001935 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001936 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1937 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001938 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001939 * \note An important and desirable effect of this option is that it allows
1940 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1941 * 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 +02001942 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001943 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1944 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001945 *
1946 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001947 *
1948 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001949 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001950 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001951 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001952//#define MBEDTLS_USE_PSA_CRYPTO
1953
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001955 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1956 *
John Durkop185764f2020-10-12 21:32:12 -07001957 * This setting allows support for cryptographic mechanisms through the PSA
1958 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001959 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001960 * When this option is disabled, the PSA API exposes the cryptographic
1961 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1962 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001963 *
1964 * When this option is enabled, the PSA API exposes the cryptographic
1965 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1966 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1967 * automatically enabled if required (i.e. if no PSA driver provides the
1968 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1969 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001970 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001971 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001972 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001973 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001974 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1975 * symbols is not completely finalized yet, and the configuration
1976 * tooling is not ideally adapted to having two separate configuration
1977 * files.
1978 * Future minor releases of Mbed TLS may make minor changes to those
1979 * symbols, but we will endeavor to provide a transition path.
1980 * Nonetheless, this option is considered mature enough to use in
1981 * production, as long as you accept that you may need to make
1982 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001983 */
1984//#define MBEDTLS_PSA_CRYPTO_CONFIG
1985
1986/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001987 * \def MBEDTLS_VERSION_FEATURES
1988 *
1989 * Allow run-time checking of compile-time enabled features. Thus allowing users
1990 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001991 * support via mbedtls_version_check_feature().
1992 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001993 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00001994 *
1995 * Comment this to disable run-time checking and save ROM space
1996 */
1997#define MBEDTLS_VERSION_FEATURES
1998
1999/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002000 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2001 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002002 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002003 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2004 * the set of trusted certificates through a callback instead of a linked
2005 * list.
2006 *
2007 * This is useful for example in environments where a large number of trusted
2008 * certificates is present and storing them in a linked list isn't efficient
2009 * enough, or when the set of trusted certificates changes frequently.
2010 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002011 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002012 * `mbedtls_ssl_conf_ca_cb()` for more information.
2013 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002014 * Requires: MBEDTLS_X509_CRT_PARSE_C
2015 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002016 * Uncomment to enable trusted certificate callbacks.
2017 */
2018//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2019
2020/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002021 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002022 *
Chris Jones2c745862020-12-16 11:41:06 +00002023 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002024 *
Chris Jones2c745862020-12-16 11:41:06 +00002025 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002026 * and other functions/constants only used by these functions, thus reducing
2027 * the code footprint by several KB.
2028 */
Chris Jones2c745862020-12-16 11:41:06 +00002029//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002030
2031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002033 *
2034 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2035 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2036 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002037 * Requires: MBEDTLS_PKCS1_V21
2038 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002039 * Comment this macro to disallow using RSASSA-PSS in certificates.
2040 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002041#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002042/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002043
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002044/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002045 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002046 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002047 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002048 * \{
2049 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002050
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002051/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002052 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002053 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002054 * Enable AES-NI support on x86-64 or x86-32.
2055 *
2056 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002057 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002058 * - GCC, x86-64, target not explicitly supporting AESNI:
2059 * requires MBEDTLS_HAVE_ASM.
2060 * - GCC, x86-32, target not explicitly supporting AESNI:
2061 * not supported.
2062 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2063 * For this assembly-less implementation, you must currently compile
2064 * `library/aesni.c` and `library/aes.c` with machine options to enable
2065 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2066 * `clang -maes -mpclmul`.
2067 * - Non-x86 targets: this option is silently ignored.
2068 * - Other compilers: this option is silently ignored.
2069 *
2070 * \note
2071 * Above, "GCC" includes compatible compilers such as Clang.
2072 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002073 *
2074 * Module: library/aesni.c
2075 * Caller: library/aes.c
2076 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002077 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002078 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002079 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002080 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002081#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002082
2083/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002084 * \def MBEDTLS_AESCE_C
2085 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002086 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002087 *
2088 * Module: library/aesce.c
2089 * Caller: library/aes.c
2090 *
Jerry Yuf015a932023-04-25 10:38:03 +08002091 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002092 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002093 * \warning Runtime detection only works on Linux. For non-Linux operating
2094 * system, Armv8-A Cryptographic Extensions must be supported by
2095 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002096 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002097 * \note Minimum compiler versions for this feature when targeting aarch64
2098 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2099 * Minimum compiler versions for this feature when targeting 32-bit
2100 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002101 *
2102 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2103 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002104 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002105 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002106 */
2107#define MBEDTLS_AESCE_C
2108
2109/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002111 *
2112 * Enable the AES block cipher.
2113 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002114 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002115 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002116 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002117 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002118 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002119 * This module enables the following ciphersuites (if other requisites are
2120 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2122 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2123 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2124 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2125 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2126 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2127 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2128 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2129 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2130 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2131 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2132 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2133 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2134 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2135 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2136 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2137 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2138 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2139 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2140 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2141 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2142 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2143 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2144 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2145 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2146 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2147 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2148 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2149 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2150 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2151 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2152 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2153 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2154 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2155 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2156 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2157 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2158 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2159 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2160 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2161 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2162 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2163 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2164 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2165 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2166 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2167 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2168 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2169 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2170 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2171 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2172 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2173 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2174 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2175 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2176 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2177 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2178 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002179 *
Paul Bakkercff68422013-09-15 20:43:33 +02002180 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002183
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002186 *
2187 * Enable the generic ASN1 parser.
2188 *
2189 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002190 * Caller: library/x509.c
2191 * library/dhm.c
2192 * library/pkcs12.c
2193 * library/pkcs5.c
2194 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002196#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002197
2198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002200 *
2201 * Enable the generic ASN1 writer.
2202 *
2203 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002204 * Caller: library/ecdsa.c
2205 * library/pkwrite.c
2206 * library/x509_create.c
2207 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002208 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002209 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002211
2212/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002213 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002214 *
2215 * Enable the Base64 module.
2216 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002217 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002218 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002219 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002220 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002223
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002224/**
Yanray Wange367e472023-10-31 17:23:04 +08002225 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2226 *
2227 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2228 *
2229 * \note This feature is incompatible with insecure block cipher,
2230 * MBEDTLS_DES_C, and cipher modes which always require decryption
2231 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002232 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2233 * this feature is incompatible with following supported PSA equivalence,
2234 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2235 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002236 *
2237 * Module: library/aes.c
2238 * library/aesce.c
2239 * library/aesni.c
2240 * library/aria.c
2241 * library/camellia.c
2242 * library/cipher.c
2243 */
2244//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2245
2246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002247 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002248 *
Paul Bakker9a736322012-11-14 12:39:52 +00002249 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002250 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002251 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002252 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002253 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002254 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002255 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002256 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002257 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002258 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002259 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002260 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002261 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002262 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002263 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002265
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002266/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002268 *
2269 * Enable the Camellia block cipher.
2270 *
Paul Bakker38119b12009-01-10 23:31:23 +00002271 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002272 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002273 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002274 * This module enables the following ciphersuites (if other requisites are
2275 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002276 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2277 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2278 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2279 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2280 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2281 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2282 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2283 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2284 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2285 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2286 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2287 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2288 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2289 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2290 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2291 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2292 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2293 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2294 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2295 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2296 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2297 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2298 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2299 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2300 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2301 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2302 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2303 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2304 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2305 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2306 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2307 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2308 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2309 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2310 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2311 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2312 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2313 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2314 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2315 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2316 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2317 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002319#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002320
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002321/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002322 * \def MBEDTLS_ARIA_C
2323 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002324 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002325 *
2326 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002327 * Caller: library/cipher.c
2328 *
2329 * This module enables the following ciphersuites (if other requisites are
2330 * enabled as well):
2331 *
2332 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2333 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2334 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2335 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2336 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2337 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2338 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2339 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2340 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2341 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2342 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2343 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2344 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2345 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2346 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2347 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2348 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2349 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2350 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2351 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2352 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2353 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2354 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2355 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2356 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2357 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2358 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2359 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2360 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2361 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2362 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2363 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2364 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2365 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2366 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2367 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2368 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2369 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002370 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002371#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002372
2373/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002374 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002375 *
2376 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2377 *
2378 * Module: library/ccm.c
2379 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002380 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2381 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002382 *
2383 * This module enables the AES-CCM ciphersuites, if other requisites are
2384 * enabled as well.
2385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002386#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002387
2388/**
Daniel King34b822c2016-05-15 17:28:08 -03002389 * \def MBEDTLS_CHACHA20_C
2390 *
2391 * Enable the ChaCha20 stream cipher.
2392 *
2393 * Module: library/chacha20.c
2394 */
2395#define MBEDTLS_CHACHA20_C
2396
2397/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002398 * \def MBEDTLS_CHACHAPOLY_C
2399 *
2400 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2401 *
2402 * Module: library/chachapoly.c
2403 *
2404 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2405 */
2406#define MBEDTLS_CHACHAPOLY_C
2407
2408/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002410 *
2411 * Enable the generic cipher layer.
2412 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002413 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002414 * Caller: library/ccm.c
2415 * library/cmac.c
2416 * library/gcm.c
2417 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002418 * library/pkcs12.c
2419 * library/pkcs5.c
2420 * library/psa_crypto_aead.c
2421 * library/psa_crypto_mac.c
2422 * library/ssl_ciphersuites.c
2423 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002424 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002425 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2426 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002427 *
2428 * Uncomment to enable generic cipher wrappers.
2429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002431
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002432/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002433 * \def MBEDTLS_CMAC_C
2434 *
Simon Butcher327398a2016-10-05 14:09:11 +01002435 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2436 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002437 *
2438 * Module: library/cmac.c
2439 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002440 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002441 *
2442 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002443#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002444
2445/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002447 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002448 * Enable the CTR_DRBG AES-based random generator.
2449 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002450 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002451 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002452 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002453 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2454 * is used.
2455 *
2456 * \warning When using PSA, the user should call `psa_crypto_init()` before
2457 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2458 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002459 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2460 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002461 * \note To achieve a 256-bit security strength with CTR_DRBG,
2462 * you must use AES-256 *and* use sufficient entropy.
2463 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002464 *
2465 * Module: library/ctr_drbg.c
2466 * Caller:
2467 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002468 * Requires: MBEDTLS_AES_C or
2469 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2470 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002471 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002472 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002473 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002474#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002475
2476/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002477 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002478 *
2479 * Enable the debug functions.
2480 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002481 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002482 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002483 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002484 * library/ssl_tls12_*.c
2485 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002486 *
2487 * This module provides debugging functions.
2488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002489#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002490
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002491/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002492 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002493 *
2494 * Enable the DES block cipher.
2495 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002496 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002497 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002498 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002499 *
Paul Bakkercff68422013-09-15 20:43:33 +02002500 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002501 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002502 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002503 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002506
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002508 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002509 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002510 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002511 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002512 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002513 * Caller: library/ssl_tls.c
2514 * library/ssl*_client.c
2515 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002516 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002517 * This module is used by the following key exchanges:
2518 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002519 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002520 * \warning Using DHE constitutes a security risk as it
2521 * is not possible to validate custom DH parameters.
2522 * If possible, it is recommended users should consider
2523 * preferring other methods of key exchange.
2524 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002525 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002527#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002528
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002529/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002530 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002531 *
2532 * Enable the elliptic curve Diffie-Hellman library.
2533 *
2534 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002535 * Caller: library/psa_crypto.c
2536 * library/ssl_tls.c
2537 * library/ssl*_client.c
2538 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002539 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002540 * This module is used by the following key exchanges:
2541 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002542 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002546
2547/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002549 *
2550 * Enable the elliptic curve DSA library.
2551 *
2552 * Module: library/ecdsa.c
2553 * Caller:
2554 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002555 * This module is used by the following key exchanges:
2556 * ECDHE-ECDSA
2557 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002558 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2559 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2560 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002563
2564/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002565 * \def MBEDTLS_ECJPAKE_C
2566 *
2567 * Enable the elliptic curve J-PAKE library.
2568 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002569 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2570 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002571 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002572 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002573 * Module: library/ecjpake.c
2574 * Caller:
2575 *
2576 * This module is used by the following key exchanges:
2577 * ECJPAKE
2578 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002579 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002580 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002581 * \warning If using a hash that is only provided by PSA drivers, you must
2582 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002583 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002584#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002585
2586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002588 *
2589 * Enable the elliptic curve over GF(p) library.
2590 *
2591 * Module: library/ecp.c
2592 * Caller: library/ecdh.c
2593 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002594 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002595 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002599
2600/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002602 *
2603 * Enable the platform-specific entropy code.
2604 *
2605 * Module: library/entropy.c
2606 * Caller:
2607 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002609 *
2610 * This module provides a generic entropy pool
2611 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002613
2614/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002616 *
2617 * Enable error code to error string conversion.
2618 *
2619 * Module: library/error.c
2620 * Caller:
2621 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002625
2626/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002627 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002628 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002629 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002630 *
2631 * Module: library/gcm.c
2632 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002633 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2634 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002635 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002636 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2637 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002638 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002639#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002640
2641/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002642 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002643 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002644 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002645 * Can significantly increase throughput on systems without GCM hardware
2646 * acceleration (e.g., AESNI, AESCE).
2647 *
Matthias Schulz78266782024-02-08 13:54:48 +01002648 * The mbedtls_gcm_context size will increase by 3840 bytes.
2649 * The code size will increase by roughly 344 bytes.
2650 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002651 * Module: library/gcm.c
2652 *
2653 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002654 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002655//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002656
2657/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002658 * \def MBEDTLS_HKDF_C
2659 *
2660 * Enable the HKDF algorithm (RFC 5869).
2661 *
2662 * Module: library/hkdf.c
2663 * Caller:
2664 *
2665 * Requires: MBEDTLS_MD_C
2666 *
2667 * This module adds support for the Hashed Message Authentication Code
2668 * (HMAC)-based key derivation function (HKDF).
2669 */
2670#define MBEDTLS_HKDF_C
2671
2672/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002674 *
2675 * Enable the HMAC_DRBG random generator.
2676 *
2677 * Module: library/hmac_drbg.c
2678 * Caller:
2679 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002681 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002682 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002683 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002685
2686/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002687 * \def MBEDTLS_LMS_C
2688 *
2689 * Enable the LMS stateful-hash asymmetric signature algorithm.
2690 *
2691 * Module: library/lms.c
2692 * Caller:
2693 *
Raef Colesab4f8742022-09-01 12:24:31 +01002694 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002695 *
Raef Colesab4f8742022-09-01 12:24:31 +01002696 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002697 */
2698#define MBEDTLS_LMS_C
2699
2700/**
Raef Colesab4f8742022-09-01 12:24:31 +01002701 * \def MBEDTLS_LMS_PRIVATE
2702 *
2703 * Enable LMS private-key operations and signing code. Functions enabled by this
2704 * option are experimental, and should not be used in production.
2705 *
2706 * Requires: MBEDTLS_LMS_C
2707 *
2708 * Uncomment to enable the LMS signature algorithm and private key operations.
2709 */
Raef Coles5127e852022-10-07 10:35:56 +01002710//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002711
2712/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002713 * \def MBEDTLS_NIST_KW_C
2714 *
2715 * Enable the Key Wrapping mode for 128-bit block ciphers,
2716 * as defined in NIST SP 800-38F. Only KW and KWP modes
2717 * are supported. At the moment, only AES is approved by NIST.
2718 *
2719 * Module: library/nist_kw.c
2720 *
2721 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2722 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002723#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002724
2725/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002727 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002728 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002729 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002730 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2731 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002732 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002733 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002734 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002735 * Caller: library/constant_time.c
2736 * library/ecdsa.c
2737 * library/ecjpake.c
2738 * library/hkdf.c
2739 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002740 * library/pk.c
2741 * library/pkcs5.c
2742 * library/pkcs12.c
2743 * library/psa_crypto_ecp.c
2744 * library/psa_crypto_rsa.c
2745 * library/rsa.c
2746 * library/ssl_cookie.c
2747 * library/ssl_msg.c
2748 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002749 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002750 * library/x509_crt.c
2751 * library/x509write_crt.c
2752 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002753 *
2754 * Uncomment to enable generic message digest wrappers.
2755 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002756#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002757
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002758/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002759 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002760 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002761 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002762 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002763 * Module: library/md5.c
2764 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002765 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002766 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002767 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002768 * This module is required for TLS 1.2 depending on the handshake parameters.
2769 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2770 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002771 *
2772 * \warning MD5 is considered a weak message digest and its use constitutes a
2773 * security risk. If possible, we recommend avoiding dependencies on
2774 * it, and considering stronger message digests instead.
2775 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002778
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002779/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002781 *
2782 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002783 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002784 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002785 *
2786 * Module: library/memory_buffer_alloc.c
2787 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002788 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002789 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002790 *
2791 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002792 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002793//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002794
2795/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002797 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002798 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2799 *
Simon Butcherd567a232016-03-09 20:19:21 +00002800 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2801 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002802 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002803 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002804 * \note See also our Knowledge Base article about porting to a new
2805 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002806 * 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 +00002807 *
Andres AG788aa4a2016-09-14 14:32:09 +01002808 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002809 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002810 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002813
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002814/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002816 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002817 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002818 *
2819 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002820 * Caller: library/asn1write.c
2821 * library/pkcs5.c
2822 * library/pkparse.c
2823 * library/pkwrite.c
2824 * library/rsa.c
2825 * library/x509.c
2826 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002827 * library/x509_crl.c
2828 * library/x509_crt.c
2829 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002830 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002831 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002832 *
2833 * This modules translates between OIDs and internal values.
2834 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002836
2837/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002838 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002839 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002840 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002841 *
2842 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002843 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002844 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002845 * library/x509_crl.c
2846 * library/x509_crt.c
2847 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002848 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002850 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2851 *
2852 * \warning When parsing password-protected files, if MD5 is provided only by
2853 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002854 *
Paul Bakkercff68422013-09-15 20:43:33 +02002855 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002858
2859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002861 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002862 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002863 *
2864 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002865 * Caller: library/pkwrite.c
2866 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002867 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002868 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002870 *
2871 * This modules adds support for encoding / writing PEM files.
2872 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002874
2875/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002877 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002878 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002879 *
2880 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002881 * Caller: library/psa_crypto_rsa.c
2882 * library/ssl_tls.c
2883 * library/ssl*_client.c
2884 * library/ssl*_server.c
2885 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002886 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002887 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002888 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002889 * Uncomment to enable generic public key wrappers.
2890 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002892
2893/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002894 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002895 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002896 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002897 *
2898 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002899 * Caller: library/x509_crt.c
2900 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002901 *
Yanray Wang072a0682023-12-05 10:53:04 +08002902 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002903 *
2904 * Uncomment to enable generic public key parse functions.
2905 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002907
2908/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002909 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002910 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002911 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002912 *
2913 * Module: library/pkwrite.c
2914 * Caller: library/x509write.c
2915 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002916 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002917 *
2918 * Uncomment to enable generic public key write functions.
2919 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002920#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002921
2922/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002923 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002924 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002925 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002926 *
2927 * Module: library/pkcs5.c
2928 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002929 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002930 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002931 * \warning If using a hash that is only provided by PSA drivers, you must
2932 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002933 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002934 * This module adds support for the PKCS#5 functions.
2935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002936#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002937
2938/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002939 * \def MBEDTLS_PKCS7_C
2940 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002941 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002942 * RFC Link - https://tools.ietf.org/html/rfc2315
2943 *
2944 * Module: library/pkcs7.c
2945 *
2946 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002947 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2948 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002949 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002950 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002951 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002952#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002953
2954/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002956 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002957 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002958 * Adds algorithms for parsing PKCS#8 encrypted private keys
2959 *
2960 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002961 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002962 *
Valerio Settie98ad592023-12-28 10:42:12 +01002963 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2964 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002965 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002966 * \warning If using a hash that is only provided by PSA drivers, you must
2967 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002968 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002969 * This module enables PKCS#12 functions.
2970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002972
2973/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002975 *
2976 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002977 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002978 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2980 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002981 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002982 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002983 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002984 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002985 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002986 * Module: library/platform.c
2987 * Caller: Most other .c files
2988 *
2989 * This module enables abstraction of common (libc) functions.
2990 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002991#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002992
2993/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002994 * \def MBEDTLS_POLY1305_C
2995 *
2996 * Enable the Poly1305 MAC algorithm.
2997 *
2998 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002999 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003000 */
3001#define MBEDTLS_POLY1305_C
3002
3003/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003004 * \def MBEDTLS_PSA_CRYPTO_C
3005 *
3006 * Enable the Platform Security Architecture cryptography API.
3007 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003008 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003009 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003010 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003011 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003012 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3013 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3014 * is enabled in PSA (unless it's fully accelerated, see
3015 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003016 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003017#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003018
3019/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003020 * \def MBEDTLS_PSA_CRYPTO_SE_C
3021 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003022 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003023 * cryptography API.
3024 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003025 * \deprecated This feature is deprecated. Please switch to the PSA driver
3026 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003027 *
Ryan Everett32a64582024-03-05 18:16:18 +00003028 * \warning This feature is not thread-safe, and should not be used in a
3029 * multi-threaded environment.
3030 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003031 * Module: library/psa_crypto_se.c
3032 *
3033 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3034 *
3035 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003036//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003037
3038/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003039 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3040 *
3041 * Enable the Platform Security Architecture persistent key storage.
3042 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003043 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003044 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003045 * Requires: MBEDTLS_PSA_CRYPTO_C,
3046 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3047 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003048 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003049#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003050
3051/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003052 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003053 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003054 * Enable the emulation of the Platform Security Architecture
3055 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003056 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003057 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003058 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003059 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003060 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003061#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003062
3063/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003065 *
3066 * Enable the RIPEMD-160 hash algorithm.
3067 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003068 * Module: library/ripemd160.c
3069 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003070 *
3071 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003073
3074/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003075 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003076 *
3077 * Enable the RSA public-key cryptosystem.
3078 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003079 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003080 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003081 * Caller: library/pk.c
3082 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003083 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003084 * library/ssl*_client.c
3085 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003086 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003087 * This module is used by the following key exchanges:
3088 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003089 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003091 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003093
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003094/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003095 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003096 *
3097 * Enable the SHA1 cryptographic hash algorithm.
3098 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003099 * Module: library/sha1.c
3100 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003101 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003102 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003103 * This module is required for TLS 1.2 depending on the handshake parameters,
3104 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003105 *
3106 * \warning SHA-1 is considered a weak message digest and its use constitutes
3107 * a security risk. If possible, we recommend avoiding dependencies
3108 * on it, and considering stronger message digests instead.
3109 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003110 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003111#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003112
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003113/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003114 * \def MBEDTLS_SHA224_C
3115 *
3116 * Enable the SHA-224 cryptographic hash algorithm.
3117 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003118 * Module: library/sha256.c
3119 * Caller: library/md.c
3120 * library/ssl_cookie.c
3121 *
3122 * This module adds support for SHA-224.
3123 */
3124#define MBEDTLS_SHA224_C
3125
3126/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003128 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003129 * Enable the SHA-256 cryptographic hash algorithm.
3130 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003131 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003132 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003133 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003134 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003135 * library/ssl*_client.c
3136 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003137 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003138 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003139 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003140 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003141#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003142
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003143/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003144 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003145 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003146 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3147 * with the ARMv8 cryptographic extensions if they are available at runtime.
3148 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003149 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003150 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003151 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003152 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003153 * \note Minimum compiler versions for this feature are Clang 4.0,
3154 * armclang 6.6 or GCC 6.0.
3155 *
3156 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3157 * armclang <= 6.9
3158 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003159 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3160 * That name is deprecated, but may still be used as an alternative form for this
3161 * option.
3162 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003163 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3164 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003165 *
3166 * Requires: MBEDTLS_SHA256_C.
3167 *
3168 * Module: library/sha256.c
3169 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003170 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003171 * and use them if available.
3172 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003173//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003174
Dave Rodgmand85277c2023-10-13 09:22:54 +01003175/**
3176 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3177 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003178 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003179 * This name is now deprecated, but may still be used as an alternative form for
3180 * this option.
3181 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003182//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3183
3184/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003185 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003186 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003187 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3188 * with the ARMv8 cryptographic extensions, which must be available at runtime
3189 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003190 *
3191 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003192 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003193 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003194 * \note Minimum compiler versions for this feature are Clang 4.0,
3195 * armclang 6.6 or GCC 6.0.
3196 *
3197 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3198 * armclang <= 6.9
3199 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003200 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003201 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003202 * option.
3203 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003204 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3205 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003206 *
3207 * Requires: MBEDTLS_SHA256_C.
3208 *
3209 * Module: library/sha256.c
3210 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003211 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003212 * unconditionally.
3213 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003214//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003215
Dave Rodgmand85277c2023-10-13 09:22:54 +01003216/**
3217 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3218 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003219 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003220 * This name is now deprecated, but may still be used as an alternative form for
3221 * this option.
3222 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003223//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3224
3225/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003226 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003227 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003228 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003229 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003230 * Module: library/sha512.c
3231 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003232 * library/psa_crypto_hash.c
3233 * library/ssl_tls.c
3234 * library/ssl*_client.c
3235 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003236 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003237 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003238 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003239#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003240
3241/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003242 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003243 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003244 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003245 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003246 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003247 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003248 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003249 * library/ssl_tls.c
3250 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003251 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003252 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003253 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003254#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003255
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003256/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003257 * \def MBEDTLS_SHA3_C
3258 *
3259 * Enable the SHA3 cryptographic hash algorithm.
3260 *
3261 * Module: library/sha3.c
3262 *
3263 * This module adds support for SHA3.
3264 */
3265#define MBEDTLS_SHA3_C
3266
3267/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003268 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3269 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003270 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3271 * with the ARMv8 cryptographic extensions if they are available at runtime.
3272 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003273 *
3274 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3275 * for a non-Aarch64 build it will be silently ignored.
3276 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003277 * \note Minimum compiler versions for this feature are Clang 7.0,
3278 * armclang 6.9 or GCC 8.0.
3279 *
3280 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3281 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003282 *
3283 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3284 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3285 *
3286 * Requires: MBEDTLS_SHA512_C.
3287 *
3288 * Module: library/sha512.c
3289 *
3290 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3291 * and use them if available.
3292 */
3293//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3294
3295/**
3296 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3297 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003298 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3299 * with the ARMv8 cryptographic extensions, which must be available at runtime
3300 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003301 *
3302 * \note This allows builds with a smaller code size than with
3303 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3304 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003305 * \note Minimum compiler versions for this feature are Clang 7.0,
3306 * armclang 6.9 or GCC 8.0.
3307 *
3308 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3309 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003310 *
3311 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3312 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3313 *
3314 * Requires: MBEDTLS_SHA512_C.
3315 *
3316 * Module: library/sha512.c
3317 *
3318 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3319 * unconditionally.
3320 */
3321//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3322
3323/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003325 *
3326 * Enable simple SSL cache implementation.
3327 *
3328 * Module: library/ssl_cache.c
3329 * Caller:
3330 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003331 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003332 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003333#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003334
3335/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003336 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003337 *
3338 * Enable basic implementation of DTLS cookies for hello verification.
3339 *
3340 * Module: library/ssl_cookie.c
3341 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003342 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003344
3345/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003346 * \def MBEDTLS_SSL_TICKET_C
3347 *
3348 * Enable an implementation of TLS server-side callbacks for session tickets.
3349 *
3350 * Module: library/ssl_ticket.c
3351 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003352 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003353 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3354 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003355 */
3356#define MBEDTLS_SSL_TICKET_C
3357
3358/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003360 *
3361 * Enable the SSL/TLS client code.
3362 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003363 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003364 * Caller:
3365 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003367 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003368 * This module is required for SSL/TLS client support.
3369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003371
Paul Bakker9a736322012-11-14 12:39:52 +00003372/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003374 *
3375 * Enable the SSL/TLS server code.
3376 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003377 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003378 * Caller:
3379 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003381 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003382 * This module is required for SSL/TLS server support.
3383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003385
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003386/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003388 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003389 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003390 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003391 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003392 * Caller: library/ssl*_client.c
3393 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003394 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3396 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003397 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003398 * This module is required for SSL/TLS.
3399 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003401
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003402/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003403 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003404 *
3405 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003406 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003407 * contexts are not shared between threads. If you do intend to use contexts
3408 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003409 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003410 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003411 *
3412 * Module: library/threading.c
3413 *
3414 * This allows different threading implementations (self-implemented or
3415 * provided).
3416 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417 * You will have to enable either MBEDTLS_THREADING_ALT or
3418 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003419 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003420 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003421 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003423
3424/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003426 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003427 * Enable the semi-portable timing interface.
3428 *
Simon Butcherd567a232016-03-09 20:19:21 +00003429 * \note The provided implementation only works on POSIX/Unix (including Linux,
3430 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003431 * module and provide your own implementations of the callbacks needed by
3432 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3433 * your own implementation of the whole module by setting
3434 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003435 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003436 * \note The timing module will include time.h on suitable platforms
3437 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3438 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3439 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003440 * \note See also our Knowledge Base article about porting to a new
3441 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003442 * 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 +00003443 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003444 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003447
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003448/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003449 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003450 *
3451 * Enable run-time version information.
3452 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003453 * Module: library/version.c
3454 *
3455 * This module provides run-time version information.
3456 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003457#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003458
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003459/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003461 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003462 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003463 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003464 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003465 * Caller: library/x509_crl.c
3466 * library/x509_crt.c
3467 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003468 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003469 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003470 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3471 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003472 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3473 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003474 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003475 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003477#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003478
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003479/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003481 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003482 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003483 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003484 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003485 * Caller: library/ssl_tls.c
3486 * library/ssl*_client.c
3487 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003488 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003489 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003490 *
3491 * This module is required for X.509 certificate parsing.
3492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003493#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003494
3495/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003496 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003497 *
3498 * Enable X.509 CRL parsing.
3499 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003500 * Module: library/x509_crl.c
3501 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003502 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003503 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003504 *
3505 * This module is required for X.509 CRL parsing.
3506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003508
3509/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003510 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003511 *
3512 * Enable X.509 Certificate Signing Request (CSR) parsing.
3513 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003514 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003515 * Caller: library/x509_crt_write.c
3516 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003518 *
3519 * This module is used for reading X.509 certificate request.
3520 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003521#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003522
3523/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003524 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003525 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003526 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003527 *
3528 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003529 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003530 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003531 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3532 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003533 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3534 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003535 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003536 * This module is the basis for creating X.509 certificates and CSRs.
3537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003538#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003539
3540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003542 *
3543 * Enable creating X.509 certificates.
3544 *
3545 * Module: library/x509_crt_write.c
3546 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003547 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003548 *
3549 * This module is required for X.509 certificate creation.
3550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003551#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003552
3553/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003554 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003555 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003556 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003557 *
3558 * Module: library/x509_csr_write.c
3559 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003560 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003561 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003562 * This module is required for X.509 certificate request writing.
3563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003564#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003565
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003566/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003567
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003568/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003569 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003570 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003571 * This section contains Mbed TLS build settings that are not associated
3572 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003573 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003574 * \{
3575 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003576
Gilles Peskinea02c1242022-03-16 17:03:19 +01003577/**
3578 * \def MBEDTLS_CONFIG_FILE
3579 *
3580 * If defined, this is a header which will be included instead of
3581 * `"mbedtls/mbedtls_config.h"`.
3582 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003583 * Unlike other configuration options, this one must be defined on the
3584 * compiler command line: a definition in `mbedtls_config.h` would have
3585 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003586 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003587 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003588 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003589 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003590 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003591 * The value of this symbol is typically a path in double quotes, either
3592 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003593 */
3594//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3595
3596/**
3597 * \def MBEDTLS_USER_CONFIG_FILE
3598 *
3599 * If defined, this is a header which will be included after
3600 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003601 * This allows you to modify the default configuration, including the ability
3602 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003603 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003604 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003605 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003606 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003607 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003608 * The value of this symbol is typically a path in double quotes, either
3609 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003610 */
3611//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3612
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003613/**
3614 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3615 *
3616 * If defined, this is a header which will be included instead of
3617 * `"psa/crypto_config.h"`.
3618 * This header file specifies which cryptographic mechanisms are available
3619 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3620 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3621 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003622 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003623 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003624 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003625 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003626 * The value of this symbol is typically a path in double quotes, either
3627 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003628 */
3629//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3630
3631/**
3632 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3633 *
3634 * If defined, this is a header which will be included after
3635 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003636 * This allows you to modify the default configuration, including the ability
3637 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003638 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003639 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003640 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003641 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003642 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003643 * The value of this symbol is typically a path in double quotes, either
3644 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003645 */
3646//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3647
Gilles Peskineb1176f22023-02-22 22:07:28 +01003648/**
3649 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3650 *
3651 * If defined, this is a header which will be included instead of
3652 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3653 * as the one in Mbed TLS, but with definitions adapted to the platform on
3654 * which the library code will run.
3655 *
3656 * \note The required content of this header can vary from one version of
3657 * Mbed TLS to the next. Integrators who provide an alternative file
3658 * should review the changes in the original file whenever they
3659 * upgrade Mbed TLS.
3660 *
3661 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3662 * non-standard feature of the C language, so this feature is only available
3663 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3664 *
3665 * The value of this symbol is typically a path in double quotes, either
3666 * absolute or relative to a directory on the include search path.
3667 */
3668//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3669
3670/**
3671 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3672 *
3673 * If defined, this is a header which will be included instead of
3674 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3675 * as the one in Mbed TLS, but with definitions adapted to the environment
3676 * in which the library code will run. The typical use for this feature
3677 * is to provide alternative type definitions on the client side in
3678 * client-server integrations of PSA crypto, where operation structures
3679 * contain handles instead of cryptographic data.
3680 *
3681 * \note The required content of this header can vary from one version of
3682 * Mbed TLS to the next. Integrators who provide an alternative file
3683 * should review the changes in the original file whenever they
3684 * upgrade Mbed TLS.
3685 *
3686 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3687 * non-standard feature of the C language, so this feature is only available
3688 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3689 *
3690 * The value of this symbol is typically a path in double quotes, either
3691 * absolute or relative to a directory on the include search path.
3692 */
3693//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3694
Gilles Peskineba4162a2022-04-11 17:04:38 +02003695/** \} name SECTION: General configuration options */
3696
3697/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003698 * \name SECTION: Module configuration options
3699 *
3700 * This section allows for the setting of module specific sizes and
3701 * configuration options. The default values are already present in the
3702 * relevant header files and should suffice for the regular use cases.
3703 *
3704 * Our advice is to enable options and change their values here
3705 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003706 * \{
3707 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003708/* The Doxygen documentation here is used when a user comments out a
3709 * setting and runs doxygen themselves. On the other hand, when we typeset
3710 * the full documentation including disabled settings, the documentation
3711 * in specific modules' header files is used if present. When editing this
3712 * file, make sure that each option is documented in exactly one place,
3713 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3714 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003715
Paul Bakker088c5c52014-04-25 11:11:10 +02003716/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003717//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003718//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003719
Paul Bakker088c5c52014-04-25 11:11:10 +02003720/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003721//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3722//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3723//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3724//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3725//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003726
Paul Bakker088c5c52014-04-25 11:11:10 +02003727/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003728//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3729//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3730//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3731//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003732
Paul Bakker088c5c52014-04-25 11:11:10 +02003733/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003734//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003735//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003736
Paul Bakker088c5c52014-04-25 11:11:10 +02003737/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003738//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3739//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003740//#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 +01003741
Paul Bakker088c5c52014-04-25 11:11:10 +02003742/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003743//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003744
Paul Bakker088c5c52014-04-25 11:11:10 +02003745/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003746//#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 -04003747
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003748/** \def MBEDTLS_PLATFORM_STD_CALLOC
3749 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003750 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003751 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003752 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003753 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003754 * 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 -04003755 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3756 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003757 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003758 */
3759//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003760
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003761/** \def MBEDTLS_PLATFORM_STD_FREE
3762 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003763 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003764 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003765 * 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 -04003766 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3767 * 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 -04003768 */
3769//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003770//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003771//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003772//#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 +02003773//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3774//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003775/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003776//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003777//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3778//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003779//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3780//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3781//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003782
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003783/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003784/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003785//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3786//#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 +02003787//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003788//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003789//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3790//#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 +02003791//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3792//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003793/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003794//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003795//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003796//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3797//#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 +08003798//#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 +08003799//#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 +02003800
Gilles Peskine3f106f72021-09-23 17:42:39 +02003801/** \def MBEDTLS_CHECK_RETURN
3802 *
3803 * This macro is used at the beginning of the declaration of a function
3804 * to indicate that its return value should be checked. It should
3805 * instruct the compiler to emit a warning or an error if the function
3806 * is called without checking its return value.
3807 *
3808 * There is a default implementation for popular compilers in platform_util.h.
3809 * You can override the default implementation by defining your own here.
3810 *
3811 * If the implementation here is empty, this will effectively disable the
3812 * checking of functions' return values.
3813 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003814//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003815
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003816/** \def MBEDTLS_IGNORE_RETURN
3817 *
3818 * This macro requires one argument, which should be a C function call.
3819 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3820 * warning is suppressed.
3821 */
3822//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3823
Gilles Peskineed038902020-11-13 21:33:21 +01003824/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003825/**
Gilles Peskineed038902020-11-13 21:33:21 +01003826 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3827 * PSA crypto subsystem.
3828 *
3829 * If this option is unset:
3830 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003831 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003832 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3833 * on unspecified heuristics.
3834 */
3835//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3836
Steven Cooreman863470a2021-02-15 14:03:19 +01003837/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003838 * Restrict the PSA library to supporting a maximum amount of simultaneously
3839 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3840 * volatile key, or a persistent key which is loaded temporarily by the
3841 * library as part of a crypto operation in flight.
3842 *
3843 * If this option is unset, the library will fall back to a default value of
3844 * 32 keys.
3845 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003846//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003847
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003848/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003849//#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 +00003850
Paul Bakker088c5c52014-04-25 11:11:10 +02003851/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003852//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3853//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003854
Paul Bakker088c5c52014-04-25 11:11:10 +02003855/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003856
Angus Grattond8213d02016-05-25 20:56:48 +10003857/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3858 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003859 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003860 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003861 * This determines the size of the incoming TLS I/O buffer in such a way
3862 * that it is capable of holding the specified amount of plaintext data,
3863 * regardless of the protection mechanism used.
3864 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003865 * \note When using a value less than the default of 16KB on the client, it is
3866 * recommended to use the Maximum Fragment Length (MFL) extension to
3867 * inform the server about this limitation. On the server, there
3868 * is no supported, standardized way of informing the client about
3869 * restriction on the maximum size of incoming messages, and unless
3870 * the limitation has been communicated by other means, it is recommended
3871 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3872 * while keeping the default value of 16KB for the incoming buffer.
3873 *
David Horstmann95d516f2021-05-04 18:36:56 +01003874 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003875 */
3876//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3877
Gilles Peskined3d02902020-03-04 21:35:27 +01003878/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3879 *
3880 * The maximum length of CIDs used for incoming DTLS messages.
3881 *
3882 */
3883//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3884
3885/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3886 *
3887 * The maximum length of CIDs used for outgoing DTLS messages.
3888 *
3889 */
3890//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3891
TRodziewicze8dd7092021-05-12 14:19:11 +02003892/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003893 *
3894 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003895 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003896 *
3897 * The padding will always be chosen so that the length of the
3898 * padded plaintext is a multiple of the value of this option.
3899 *
3900 * Note: A value of \c 1 means that no padding will be used
3901 * for outgoing records.
3902 *
3903 * Note: On systems lacking division instructions,
3904 * a power of two should be preferred.
3905 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003906//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003907
Angus Grattond8213d02016-05-25 20:56:48 +10003908/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3909 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003910 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003911 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003912 * This determines the size of the outgoing TLS I/O buffer in such a way
3913 * that it is capable of holding the specified amount of plaintext data,
3914 * regardless of the protection mechanism used.
3915 *
Angus Grattond8213d02016-05-25 20:56:48 +10003916 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3917 * the default inward 16384 byte buffer to conform to the TLS specification.
3918 *
3919 * The minimum required outward buffer size is determined by the handshake
3920 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3921 * The specific size requirement depends on the configured ciphers and any
3922 * certificate data which is sent during the handshake.
3923 *
David Horstmann95d516f2021-05-04 18:36:56 +01003924 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003925 */
3926//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3927
Hanno Beckere0b150f2018-08-21 15:51:03 +01003928/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3929 *
3930 * Maximum number of heap-allocated bytes for the purpose of
3931 * DTLS handshake message reassembly and future message buffering.
3932 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003933 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003934 * to account for a reassembled handshake message of maximum size,
3935 * together with its reassembly bitmap.
3936 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003937 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003938 * should be sufficient for all practical situations as it allows
3939 * to reassembly a large handshake message (such as a certificate)
3940 * while buffering multiple smaller handshake messages.
3941 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003942 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003943//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003944
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003945//#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 +02003946//#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 +02003947
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003948/**
3949 * Complete list of ciphersuites to use, in order of preference.
3950 *
3951 * \warning No dependency checking is done on that field! This option can only
3952 * be used to restrict the set of available ciphersuites. It is your
3953 * responsibility to make sure the needed modules are active.
3954 *
3955 * Use this to save a few hundred bytes of ROM (default ordering of all
3956 * available ciphersuites) and a few to a few hundred bytes of RAM.
3957 *
3958 * The value below is only an example, not the default.
3959 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003960//#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 +02003961
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003962/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003963 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3964 *
3965 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003966 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003967 *
3968 * It must be positive and smaller than UINT32_MAX.
3969 *
3970 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3971 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003972 */
3973//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3974
3975/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003976 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3977 *
Jerry Yucf913512023-11-14 11:06:52 +08003978 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003979 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003980 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003981 * - The client ticket age is the time difference between the time when the
3982 * client proposes to the server to use the ticket and the time the client
3983 * received the ticket from the server.
3984 * - The server ticket age is the time difference between the time when the
3985 * server receives a proposition from the client to use the ticket and the
3986 * time when the ticket was created by the server.
3987 *
Jerry Yucf913512023-11-14 11:06:52 +08003988 * The ages might be different due to the client and server clocks not running
3989 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3990 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3991 * 6s, thus in the worst case clients and servers must sync up their system time
3992 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003993 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003994 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003995 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003996//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003997
3998/**
3999 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4000 *
4001 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4002 *
4003 * This must be less than 256.
4004 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004005//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004006
4007/**
4008 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4009 *
4010 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4011 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4012 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4013 *
4014 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004015//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004016
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004017/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004018//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004019//#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 +01004020
Gilles Peskine611179c2022-04-13 23:04:48 +02004021/** \} name SECTION: Module configuration options */