blob: 1642d8dc697f9c3eea3a3a09ab4467b386020c0e [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_ENCRYPT_ALT
354//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300355//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300356//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300357//#define MBEDTLS_ECDSA_VERIFY_ALT
358//#define MBEDTLS_ECDSA_SIGN_ALT
359//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200360
361/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200362 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200363 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200364 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200365 * hardware entropy collector.
366 *
367 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000368 * prototype as declared in library/entropy_poll.h, and accept NULL as first
369 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200370 *
371 * Uncomment to use your own hardware entropy collector.
372 */
373//#define MBEDTLS_ENTROPY_HARDWARE_ALT
374
375/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000377 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100378 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000379 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100380 * Uncomment this macro to use precomputed AES tables stored in ROM.
381 * Comment this macro to generate AES tables in RAM at runtime.
382 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100383 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
384 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100385 * initialization time before the first AES operation can be performed.
386 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
387 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
388 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100389 *
390 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000393
394/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100395 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200396 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100397 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200398 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100399 * Uncommenting this macro omits 75% of the AES tables from
400 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
401 * by computing their values on the fly during operations
402 * (the tables are entry-wise rotations of one another).
403 *
404 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100405 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100406 * runtime. Specifically, one has to compare 4 accesses within
407 * different tables to 4 accesses with additional arithmetic
408 * operations within the same table. The performance gain/loss
409 * depends on the system and memory details.
410 *
411 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200412 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100413//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200414
415/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800416 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
417 *
418 * Use only 128-bit keys in AES operations to save ROM.
419 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800420 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800421 * or 256-bit keys.
422 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800423 * Uncommenting this macro reduces the size of AES code by ~300 bytes
424 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800425 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800426 * Module: library/aes.c
427 *
428 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800429 */
430//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
431
Gilles Peskinea8861e02023-09-05 20:20:51 +0200432/*
433 * Disable plain C implementation for AES.
434 *
435 * When the plain C implementation is enabled, and an implementation using a
436 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
437 * detection will be used to select between them.
438 *
439 * If only one implementation is present, runtime detection will not be used.
440 * This configuration will crash at runtime if running on a CPU without the
441 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
442 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
443 */
444//#define MBEDTLS_AES_USE_HARDWARE_ONLY
445
Arto Kinnunen732ca322023-04-14 14:26:10 +0800446/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200447 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200448 *
449 * Use less ROM for the Camellia implementation (saves about 768 bytes).
450 *
451 * Uncomment this macro to use less memory for Camellia.
452 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200453//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200454
455/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200456 * \def MBEDTLS_CHECK_RETURN_WARNING
457 *
458 * If this macro is defined, emit a compile-time warning if application code
459 * calls a function without checking its return value, but the return value
460 * should generally be checked in portable applications.
461 *
462 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
463 * implemented. Otherwise this option has no effect.
464 *
465 * Uncomment to get warnings on using fallible functions without checking
466 * their return value.
467 *
468 * \note This feature is a work in progress.
469 * Warnings will be added to more functions in the future.
470 *
471 * \note A few functions are considered critical, and ignoring the return
472 * value of these functions will trigger a warning even if this
473 * macro is not defined. To completely disable return value check
474 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
475 */
476//#define MBEDTLS_CHECK_RETURN_WARNING
477
478/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200479 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200480 *
481 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
482 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200483#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200484
485/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200486 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000487 *
488 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200490#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000491
492/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200493 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000494 *
495 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
496 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200497#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000498
499/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100500 * \def MBEDTLS_CIPHER_MODE_OFB
501 *
502 * Enable Output Feedback mode (OFB) for symmetric ciphers.
503 */
504#define MBEDTLS_CIPHER_MODE_OFB
505
506/**
507 * \def MBEDTLS_CIPHER_MODE_XTS
508 *
509 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
510 */
511#define MBEDTLS_CIPHER_MODE_XTS
512
513/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200514 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000515 *
516 * Enable NULL cipher.
517 * Warning: Only do so when you know what you are doing. This allows for
518 * encryption or channels without any security!
519 *
Ronald Croncee42702021-04-26 11:34:44 +0200520 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200521 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
522 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
523 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
524 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
525 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
526 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
527 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
528 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
529 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
530 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
531 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
532 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
533 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
534 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
535 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
536 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
537 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
538 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
539 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000540 *
541 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000542 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200543//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000544
545/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100546 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200547 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100548 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
549 * specific padding modes in the cipher layer with cipher modes that support
550 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200551 *
552 * If you disable all padding modes, only full blocks can be used with CBC.
553 *
554 * Enable padding modes in the cipher layer.
555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556#define MBEDTLS_CIPHER_PADDING_PKCS7
557#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
558#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
559#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200560
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200561/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
562 *
563 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800564 * Without this, CTR_DRBG uses a 256-bit key
565 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200566 */
567//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
568
Paul Bakker48e93c82013-08-14 12:21:18 +0200569/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200570 * Enable the verified implementations of ECDH primitives from Project Everest
571 * (currently only Curve25519). This feature changes the layout of ECDH
572 * contexts and therefore is a compatibility break for applications that access
573 * fields of a mbedtls_ecdh_context structure directly. See also
574 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000575 *
576 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
577 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200578 */
579//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
580
581/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100582 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200583 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100584 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
585 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200586 *
587 * Comment macros to disable the curve and functions for it
588 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200589/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200590#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
591#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
592#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
593#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
594#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
595#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
596#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
597#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
598#define MBEDTLS_ECP_DP_BP256R1_ENABLED
599#define MBEDTLS_ECP_DP_BP384R1_ENABLED
600#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200601/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200602#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000603#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200604
605/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200607 *
608 * Enable specific 'modulo p' routines for each NIST prime.
609 * Depending on the prime and architecture, makes operations 4 to 8 times
610 * faster on the corresponding curve.
611 *
612 * Comment this macro to disable NIST curves optimisation.
613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200615
616/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200617 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100618 *
619 * Enable "non-blocking" ECC operations that can return early and be resumed.
620 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200621 * This allows various functions to pause by returning
622 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
623 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
624 * order to further progress and eventually complete their operation. This is
625 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
626 * number of ECC operations a function may perform before pausing; see
627 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100628 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200629 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200630 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100631 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100632 * This option:
633 * - Adds xxx_restartable() variants of existing operations in the
634 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100635 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
636 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100637 * - ECDSA: signature generation & verification;
638 * - PK: signature generation & verification;
639 * - X509: certificate chain verification.
640 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
641 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
642 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
643 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000644 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100645 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100646 * - verification of the server's key exchange signature;
647 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100648 * - generation of the client's signature if client authentication is used,
649 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100650 *
651 * \note In the cases above, the usual SSL/TLS functions, such as
652 * mbedtls_ssl_handshake(), can now return
653 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200654 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100655 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
656 * restartable operations in PK, X.509 and TLS (see above) are not
657 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100658 * PSA, and are not restartable. These are temporary limitations that
659 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200660 *
Ron Eldor19779c42018-11-05 16:58:13 +0200661 * \note This option only works with the default software implementation of
662 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100663 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100664 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100665 * Requires: MBEDTLS_ECP_C
666 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100667 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100668 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200669//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100670
671/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200672 * Uncomment to enable using new bignum code in the ECC modules.
673 *
674 * \warning This is currently experimental, incomplete and therefore should not
675 * be used in production.
676 */
677//#define MBEDTLS_ECP_WITH_MPI_UINT
678
679/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100681 *
682 * Enable deterministic ECDSA (RFC 6979).
683 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
684 * may result in a compromise of the long-term signing key. This is avoided by
685 * the deterministic variant.
686 *
John Durkop36a82e52020-10-26 09:39:05 -0700687 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100688 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100689 * Comment this macro to disable deterministic ECDSA.
690 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200691#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100692
693/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200694 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200695 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200696 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200697 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200698 * This enables the following ciphersuites (if other requisites are
699 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
701 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
702 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
703 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
704 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
705 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
706 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
707 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
708 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
709 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200710 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200711#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200712
713/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200715 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200716 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200717 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200718 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200719 *
720 * This enables the following ciphersuites (if other requisites are
721 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
723 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
724 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
725 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
726 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
727 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
728 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
729 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
730 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
731 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100732 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100733 * \warning Using DHE constitutes a security risk as it
734 * is not possible to validate custom DH parameters.
735 * If possible, it is recommended users should consider
736 * preferring other methods of key exchange.
737 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100738 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200739 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200741
742/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200743 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200744 *
745 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
746 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200747 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200748 *
749 * This enables the following ciphersuites (if other requisites are
750 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200751 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
752 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
753 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
754 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
755 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
756 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200757 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200759
760/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200762 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200763 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200764 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
766 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200767 *
768 * This enables the following ciphersuites (if other requisites are
769 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200770 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
771 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
772 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
773 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
774 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
775 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
776 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
777 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
778 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
779 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200780 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200782
783/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200784 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200785 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200786 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200787 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200788 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
789 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200790 *
791 * This enables the following ciphersuites (if other requisites are
792 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200793 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
794 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
795 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
796 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
797 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
798 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
799 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
800 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
801 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
802 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
803 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
804 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200805 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200807
808/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200810 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200811 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200812 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
814 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200815 *
816 * This enables the following ciphersuites (if other requisites are
817 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200818 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
819 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
820 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
821 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
822 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
823 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
824 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
825 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
826 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
827 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
828 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
829 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100830 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100831 * \warning Using DHE constitutes a security risk as it
832 * is not possible to validate custom DH parameters.
833 * If possible, it is recommended users should consider
834 * preferring other methods of key exchange.
835 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100836 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200837 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200839
840/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200841 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200842 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200843 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200844 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200845 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
846 * MBEDTLS_RSA_C
847 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200848 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200849 *
850 * This enables the following ciphersuites (if other requisites are
851 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200852 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
853 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
854 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
855 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
856 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
857 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
858 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
859 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
860 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
861 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200862 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200863#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864
865/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200867 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200868 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200869 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200870 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
871 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
872 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200873 *
874 * This enables the following ciphersuites (if other requisites are
875 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
877 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
878 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
879 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
880 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
881 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
882 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
883 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
884 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
885 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200888
889/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100891 *
892 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
893 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200894 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
895 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
896 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100897 *
898 * This enables the following ciphersuites (if other requisites are
899 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200900 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
901 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
902 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
903 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
904 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
905 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
906 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
907 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
908 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
909 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200911#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100912
913/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200914 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100915 *
916 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
917 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200918 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
919 * MBEDTLS_RSA_C
920 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100921 *
922 * This enables the following ciphersuites (if other requisites are
923 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200924 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
925 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
926 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
927 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
928 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
929 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
930 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
931 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
932 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
933 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100934 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100936
937/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200938 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
939 *
940 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
941 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200942 * \warning This is currently experimental. EC J-PAKE support is based on the
943 * Thread v1.0.0 specification; incompatible changes to the specification
944 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200945 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200946 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100947 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200948 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
949 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100950 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800951 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100952 * MBEDTLS_USE_PSA_CRYPTO is disabled).
953 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200954 * This enables the following ciphersuites (if other requisites are
955 * enabled as well):
956 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
957 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200958//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200959
960/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100962 *
963 * Enhance support for reading EC keys using variants of SEC1 not allowed by
964 * RFC 5915 and RFC 5480.
965 *
966 * Currently this means parsing the SpecifiedECDomain choice of EC
967 * parameters (only known groups are supported, not arbitrary domains, to
968 * avoid validation issues).
969 *
970 * Disable if you only need to support RFC 5915 + 5480 key formats.
971 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100973
974/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200975 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
976 *
977 * Enable the support for parsing public keys of type Short Weierstrass
978 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200979 * compressed point format. This parsing is done through ECP module's functions.
980 *
981 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
982 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
983 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200984 */
985#define MBEDTLS_PK_PARSE_EC_COMPRESSED
986
987/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100989 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990 * Enable a dummy error function to make use of mbedtls_strerror() in
991 * third party libraries easier when MBEDTLS_ERROR_C is disabled
992 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200993 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
995 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100996 *
997 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100999 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001001
1002/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001004 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001005 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001006 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001010
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001013 *
1014 * Enable functions that use the filesystem.
1015 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001017
1018/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001020 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001021 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001022 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001023 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001024 * application.
1025 *
1026 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001029
1030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001032 *
1033 * Do not use built-in platform entropy functions.
1034 * This is useful if your platform does not support
1035 * standards like the /dev/urandom or Windows CryptoAPI.
1036 *
1037 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001040
1041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001043 *
1044 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1045 * default SHA-512 based one (if both are available).
1046 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001048 *
1049 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1050 * if you have performance concerns.
1051 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052 * This option is only useful if both MBEDTLS_SHA256_C and
1053 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001056
1057/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001058 * \def MBEDTLS_ENTROPY_NV_SEED
1059 *
1060 * Enable the non-volatile (NV) seed file-based entropy source.
1061 * (Also enables the NV seed read/write functions in the platform layer)
1062 *
1063 * This is crucial (if not required) on systems that do not have a
1064 * cryptographic entropy source (in hardware or kernel) available.
1065 *
1066 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1067 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001068 * \note The read/write functions that are used by the entropy source are
1069 * determined in the platform layer, and can be modified at runtime and/or
1070 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1071 *
1072 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001073 * with regular fopen(), please make sure you make a seedfile with the
1074 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1075 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001076 * and written to or you will get an entropy source error! The default
1077 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1078 * bytes from the file.
1079 *
1080 * \note The entropy collector will write to the seed file before entropy is
1081 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001082 */
1083//#define MBEDTLS_ENTROPY_NV_SEED
1084
Ronald Cron71016a92020-08-28 19:01:50 +02001085/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001086 *
Ronald Cron71016a92020-08-28 19:01:50 +02001087 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001088 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001089 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1090 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001091 *
1092 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001093 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001094 */
Ronald Cron71016a92020-08-28 19:01:50 +02001095//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001096
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001097/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001099 *
1100 * Enable debugging of buffer allocator memory issues. Automatically prints
1101 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1102 * function for 'debug output' of allocated memory.
1103 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001105 *
1106 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001109
1110/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001111 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001112 *
1113 * Include backtrace information with each allocated block.
1114 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001116 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001117 *
1118 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001119 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001121
1122/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001123 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001124 *
1125 * Support external private RSA keys (eg from a HSM) in the PK layer.
1126 *
1127 * Comment this macro to disable support for external private RSA keys.
1128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001130
1131/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001133 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001134 * Enable support for PKCS#1 v1.5 encoding.
1135 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001136 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001137 *
Paul Bakker48377d92013-08-30 12:06:24 +02001138 * This enables support for PKCS#1 v1.5 operations.
1139 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001141
1142/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001144 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001145 * Enable support for PKCS#1 v2.1 encoding.
1146 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001147 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001148 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001149 * \warning If using a hash that is only provided by PSA drivers, you must
1150 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001151 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001152 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1153 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001154#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001155
Steven Cooreman6801f082021-02-19 17:21:22 +01001156/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1157 *
1158 * Enable support for platform built-in keys. If you enable this feature,
1159 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1160 * See the documentation of that function for more information.
1161 *
1162 * Built-in keys are typically derived from a hardware unique key or
1163 * stored in a secure element.
1164 *
1165 * Requires: MBEDTLS_PSA_CRYPTO_C.
1166 *
1167 * \warning This interface is experimental and may change or be removed
1168 * without notice.
1169 */
1170//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1171
Ronald Cron3768ac12021-01-26 16:58:00 +01001172/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1173 *
1174 * Enable support for PSA crypto client.
1175 *
1176 * \note This option allows to include the code necessary for a PSA
1177 * crypto client when the PSA crypto implementation is not included in
1178 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1179 * code to set and get PSA key attributes.
1180 * The development of PSA drivers partially relying on the library to
1181 * fulfill the hardware gaps is another possible usage of this option.
1182 *
1183 * \warning This interface is experimental and may change or be removed
1184 * without notice.
1185 */
1186//#define MBEDTLS_PSA_CRYPTO_CLIENT
1187
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001188/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1189 *
1190 * Make the PSA Crypto module use an external random generator provided
1191 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1192 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001193 * \note This random generator must deliver random numbers with cryptographic
1194 * quality and high performance. It must supply unpredictable numbers
1195 * with a uniform distribution. The implementation of this function
1196 * is responsible for ensuring that the random generator is seeded
1197 * with sufficient entropy. If you have a hardware TRNG which is slow
1198 * or delivers non-uniform output, declare it as an entropy source
1199 * with mbedtls_entropy_add_source() instead of enabling this option.
1200 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001201 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001202 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1203 * and define a function called mbedtls_psa_external_get_random()
1204 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001205 * ```
1206 * psa_status_t mbedtls_psa_external_get_random(
1207 * mbedtls_psa_external_random_context_t *context,
1208 * uint8_t *output, size_t output_size, size_t *output_length);
1209 * );
1210 * ```
1211 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001212 * The function must fill the \c output buffer with \c output_size bytes
1213 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001214 *
1215 * Requires: MBEDTLS_PSA_CRYPTO_C
1216 *
1217 * \warning If you enable this option, code that uses the PSA cryptography
1218 * interface will not use any of the entropy sources set up for
1219 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1220 * enables.
1221 *
1222 * \note This option is experimental and may be removed without notice.
1223 */
1224//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1225
Paul Bakker9dcc3222011-03-08 14:16:06 +00001226/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001227 * \def MBEDTLS_PSA_CRYPTO_SPM
1228 *
1229 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1230 * Partition Manager) integration which separates the code into two parts: a
1231 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1232 * Environment).
1233 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001234 * If you enable this option, your build environment must include a header
1235 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1236 * header files, or in another directory on the compiler's include search
1237 * path). Alternatively, your platform may customize the header
1238 * `psa/crypto_platform.h`, in which case it can skip or replace the
1239 * inclusion of `"crypto_spe.h"`.
1240 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001241 * Module: library/psa_crypto.c
1242 * Requires: MBEDTLS_PSA_CRYPTO_C
1243 *
1244 */
1245//#define MBEDTLS_PSA_CRYPTO_SPM
1246
1247/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001248 * Uncomment to enable p256-m. This is an alternative implementation of
1249 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1250 * Compared to the default implementation:
1251 *
1252 * - p256-m has a much smaller code size and RAM footprint.
1253 * - p256-m is only available via the PSA API. This includes the pk module
1254 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1255 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1256 * over the core arithmetic, or deterministic derivation of keys.
1257 *
1258 * We recommend enabling this option if your application uses the PSA API
1259 * and the only elliptic curve support it needs is ECDH and ECDSA over
1260 * SECP256R1.
1261 *
1262 * If you enable this option, you do not need to enable any ECC-related
1263 * MBEDTLS_xxx option. You do need to separately request support for the
1264 * cryptographic mechanisms through the PSA API:
1265 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1266 * configuration;
1267 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1268 * - #PSA_WANT_ECC_SECP_R1_256;
1269 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1270 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1271 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1272 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1273 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001274 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001275 * \note To benefit from the smaller code size of p256-m, make sure that you
1276 * do not enable any ECC-related option not supported by p256-m: this
1277 * would cause the built-in ECC implementation to be built as well, in
1278 * order to provide the required option.
1279 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001280 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1281 * SECP256R1 are disabled as they are not supported by this driver.
1282 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1283 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001284 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001285 */
1286//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1287
1288/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001289 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001290 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001291 * Enable support for entropy injection at first boot. This feature is
1292 * required on systems that do not have a built-in entropy source (TRNG).
1293 * This feature is currently not supported on systems that have a built-in
1294 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001295 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001296 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001297 *
1298 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001299//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001300
1301/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001302 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001303 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001304 * Assume all buffers passed to PSA functions are owned exclusively by the
1305 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001306 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001307 * This option may be enabled if all buffers passed to any PSA function reside
1308 * in memory that is accessible only to the PSA function during its execution.
1309 *
1310 * This option MUST be disabled whenever buffer arguments are in memory shared
1311 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001312 * across a trust boundary.
1313 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001314 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001315 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001316 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001317 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001318 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001319//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001320
1321/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001323 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001324 * Do not use the Chinese Remainder Theorem
1325 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001326 *
1327 * Uncomment this macro to disable the use of CRT in RSA.
1328 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001329 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001331
1332/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001334 *
1335 * Enable the checkup functions (*_self_test).
1336 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001337#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001338
1339/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001340 * \def MBEDTLS_SHA256_SMALLER
1341 *
1342 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1343 * lower performance.
1344 *
Adam Wolf039080f2019-09-10 09:53:08 -05001345 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001346 * performance and size. This version optimizes more aggressively for size at
1347 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1348 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1349 * 30%.
1350 *
1351 * Uncomment to enable the smaller implementation of SHA256.
1352 */
1353//#define MBEDTLS_SHA256_SMALLER
1354
1355/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001356 * \def MBEDTLS_SHA512_SMALLER
1357 *
1358 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1359 * lower performance.
1360 *
1361 * Uncomment to enable the smaller implementation of SHA512.
1362 */
1363//#define MBEDTLS_SHA512_SMALLER
1364
1365/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001366 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001367 *
1368 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001369 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001370 * with other servers, only debugging of failures is harder.
1371 *
1372 * The advantage of not sending alert messages, is that no information is given
1373 * about reasons for failures thus preventing adversaries of gaining intel.
1374 *
1375 * Enable sending of all alert messages
1376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001378
1379/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001380 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1381 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001382 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001383 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001384 * in the underlying transport. The CID functionality is described
1385 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001386 *
1387 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001388 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1389 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1390 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001391 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001392 * The maximum lengths of outgoing and incoming CIDs can be configured
1393 * through the options
1394 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1395 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1396 *
1397 * Requires: MBEDTLS_SSL_PROTO_DTLS
1398 *
1399 * Uncomment to enable the Connection ID extension.
1400 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001401#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1402
1403
1404/**
1405 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1406 *
1407 * Defines whether RFC 9146 (default) or the legacy version
1408 * (version draft-ietf-tls-dtls-connection-id-05,
1409 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1410 * is used.
1411 *
1412 * Set the value to 0 for the standard version, and
1413 * 1 for the legacy draft version.
1414 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001415 * \deprecated Support for the legacy version of the DTLS
1416 * Connection ID feature is deprecated. Please
1417 * switch to the standardized version defined
1418 * in RFC 9146 enabled by utilizing
1419 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1420 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1421 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001422 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1423 */
1424#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001425
1426/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001427 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1428 *
1429 * Enable asynchronous external private key operations in SSL. This allows
1430 * you to configure an SSL connection to call an external cryptographic
1431 * module to perform private key operations instead of performing the
1432 * operation inside the library.
1433 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001434 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001435 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001436//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001437
1438/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001439 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1440 *
1441 * Enable serialization of the TLS context structures, through use of the
1442 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1443 *
1444 * This pair of functions allows one side of a connection to serialize the
1445 * context associated with the connection, then free or re-use that context
1446 * while the serialized state is persisted elsewhere, and finally deserialize
1447 * that state to a live context for resuming read/write operations on the
1448 * connection. From a protocol perspective, the state of the connection is
1449 * unaffected, in particular this is entirely transparent to the peer.
1450 *
1451 * Note: this is distinct from TLS session resumption, which is part of the
1452 * protocol and fully visible by the peer. TLS session resumption enables
1453 * establishing new connections associated to a saved session with shorter,
1454 * lighter handshakes, while context serialization is a local optimization in
1455 * handling a single, potentially long-lived connection.
1456 *
1457 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1458 * saved after the handshake to allow for more efficient serialization, so if
1459 * you don't need this feature you'll save RAM by disabling it.
1460 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001461 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1462 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001463 * Comment to disable the context serialization APIs.
1464 */
1465#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1466
1467/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001468 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001469 *
1470 * Enable the debug messages in SSL module for all issues.
1471 * Debug messages have been disabled in some places to prevent timing
1472 * attacks due to (unbalanced) debugging function calls.
1473 *
1474 * If you need all error reporting you should enable this during debugging,
1475 * but remove this for production servers that should log as well.
1476 *
1477 * Uncomment this macro to report all debug messages on errors introducing
1478 * a timing side-channel.
1479 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001480 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001481//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001484 *
1485 * Enable support for Encrypt-then-MAC, RFC 7366.
1486 *
1487 * This allows peers that both support it to use a more robust protection for
1488 * ciphersuites using CBC, providing deep resistance against timing attacks
1489 * on the padding or underlying cipher.
1490 *
1491 * This only affects CBC ciphersuites, and is useless if none is defined.
1492 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001493 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001494 *
1495 * Comment this macro to disable support for Encrypt-then-MAC
1496 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001497#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001498
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001500 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001501 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1502 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001503 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001504 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001505 * attacks, but it is recommended to always use it (even if you disable
1506 * renegotiation), since it actually fixes a more fundamental issue in the
1507 * original SSL/TLS design, and has implications beyond Triple Handshake.
1508 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001509 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001510 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001511 * Comment this macro to disable support for Extended Master Secret.
1512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001514
Paul Bakkerd66f0702013-01-31 16:57:45 +01001515/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001516 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1517 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001518 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001519 * giving access to the peer's certificate after completion of the handshake.
1520 *
1521 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1522 * recommended to disable this option for reduced RAM usage.
1523 *
1524 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1525 * defined, but always returns \c NULL.
1526 *
1527 * \note This option has no influence on the protection against the
1528 * triple handshake attack. Even if it is disabled, Mbed TLS will
1529 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001530 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001531 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001532 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001533 *
1534 * Comment this macro to disable storing the peer's certificate
1535 * after the handshake.
1536 */
1537#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1538
1539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001541 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001542 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001543 *
1544 * The two main uses of renegotiation are (1) refresh keys on long-lived
1545 * connections and (2) client authentication after the initial handshake.
1546 * If you don't need renegotiation, it's probably better to disable it, since
1547 * it has been associated with security issues in the past and is easy to
1548 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001549 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001550 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1551 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001552 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001553 *
1554 * \note Even if this option is disabled, both client and server are aware
1555 * of the Renegotiation Indication Extension (RFC 5746) used to
1556 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1557 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1558 * configuration of this extension).
1559 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001560 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001561#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001562
1563/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001565 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001566 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001567 *
1568 * Comment this macro to disable support for the max_fragment_length extension
1569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001571
1572/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001573 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1574 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001575 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001576 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001577 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1578 *
1579 * Uncomment this macro to enable support for the record_size_limit extension
1580 */
1581//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1582
1583/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001584 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001585 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001586 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001587 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001588 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001589 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1590 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001591 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001592 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001593 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001594 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1595 * are only provided by PSA drivers, you must call psa_crypto_init() before
1596 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001597 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001598 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001601
1602/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001603 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001604 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001605 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001606 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001607 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001608 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001609 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001610 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001611 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001612 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001613 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1614 * directly performed by TLS 1.3 code. As a consequence, you must
1615 * call psa_crypto_init() before the first TLS 1.3 handshake.
1616 *
1617 * \note Cryptographic operations performed indirectly via another module
1618 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1619 * running handshake hash) only use PSA crypto if
1620 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001621 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001622 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001623 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001624#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001625
1626/**
Ronald Cronab65c522021-11-24 10:47:20 +01001627 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1628 *
1629 * Enable TLS 1.3 middlebox compatibility mode.
1630 *
1631 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1632 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1633 * expecting TLS 1.2 traffic.
1634 *
1635 * Turning on the compatibility mode comes at the cost of a few added bytes
1636 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1637 * that don't use it. Therefore, unless transmission bandwidth is critical and
1638 * you know that middlebox compatibility issues won't occur, it is therefore
1639 * recommended to set this option.
1640 *
1641 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001642 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1643 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001644 *
1645 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001646#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001647
1648/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001649 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1650 *
1651 * Enable TLS 1.3 PSK key exchange mode.
1652 *
1653 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1654 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1655 * effect on the build.
1656 *
1657 */
1658#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1659
1660/**
1661 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1662 *
1663 * Enable TLS 1.3 ephemeral key exchange mode.
1664 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001665 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001666 * MBEDTLS_X509_CRT_PARSE_C
1667 * and at least one of:
1668 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1669 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001670 *
1671 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1672 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1673 * effect on the build.
1674 *
1675 */
1676#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1677
1678/**
1679 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1680 *
1681 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1682 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001683 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001684 *
1685 * Comment to disable support for the PSK ephemeral key exchange mode in
1686 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1687 * have any effect on the build.
1688 *
1689 */
1690#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1691
1692/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 * \def MBEDTLS_SSL_EARLY_DATA
1694 *
1695 * Enable support for RFC 8446 TLS 1.3 early data.
1696 *
1697 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1698 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1699 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1700 *
1701 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1702 * is not enabled, this option does not have any effect on the build.
1703 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001704 * \note The maximum amount of early data can be set with
1705 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1706 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001708//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001709
1710/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001712 *
1713 * Enable support for DTLS (all available versions).
1714 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001715 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001716 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001717 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001718 *
1719 * Comment this macro to disable support for DTLS
1720 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001722
1723/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001724 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001725 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001726 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001727 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001728 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001729 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001731
1732/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001734 *
1735 * Enable support for the anti-replay mechanism in DTLS.
1736 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001737 * Requires: MBEDTLS_SSL_TLS_C
1738 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001739 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001740 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001741 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001742 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001743 * Comment this to disable anti-replay in DTLS.
1744 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001746
1747/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001748 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001749 *
1750 * Enable support for HelloVerifyRequest on DTLS servers.
1751 *
1752 * This feature is highly recommended to prevent DTLS servers being used as
1753 * amplifiers in DoS attacks against other hosts. It should always be enabled
1754 * unless you know for sure amplification cannot be a problem in the
1755 * environment in which your server operates.
1756 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001757 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001758 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001759 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001760 *
1761 * Comment this to disable support for HelloVerifyRequest.
1762 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001763#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001764
1765/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001766 * \def MBEDTLS_SSL_DTLS_SRTP
1767 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001768 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001769 * through the use_srtp extension.
1770 *
1771 * \note This feature provides the minimum functionality required
1772 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1773 * the associated SRTP packet protection key material.
1774 * In particular, the SRTP packet protection itself, as well as the
1775 * demultiplexing of RTP and DTLS packets at the datagram layer
1776 * (see Section 5 of RFC 5764), are not handled by this feature.
1777 * Instead, after successful completion of a handshake negotiating
1778 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001779 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001780 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1781 * (this is implemented in the SSL example programs).
1782 * The resulting key should then be passed to an SRTP stack.
1783 *
1784 * Setting this option enables the runtime API
1785 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1786 * through which the supported DTLS-SRTP protection
1787 * profiles can be configured. You must call this API at
1788 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001789 *
1790 * Requires: MBEDTLS_SSL_PROTO_DTLS
1791 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001792 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001793 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001794//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001795
1796/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001797 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1798 *
1799 * Enable server-side support for clients that reconnect from the same port.
1800 *
1801 * Some clients unexpectedly close the connection and try to reconnect using the
1802 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001803 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001804 * flag enables that support.
1805 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001806 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001807 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001808 * Comment this to disable support for clients reusing the source port.
1809 */
1810#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1811
1812/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001814 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001815 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001816 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001817 * session store remains the responsibility of the application, though).
1818 * Server-side, you also need to provide callbacks for writing and parsing
1819 * tickets, including authenticated encryption and key management. Example
1820 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001821 *
1822 * Comment this macro to disable support for SSL session tickets
1823 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001825
1826/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001828 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001829 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001830 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001831 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001832 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001833 * Comment this macro to disable support for server name indication in SSL
1834 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001835#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001836
1837/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001838 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1839 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001840 * When this option is enabled, the SSL buffer will be resized automatically
1841 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001842 *
1843 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001844 */
1845//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1846
1847/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001848 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1849 *
1850 * Enable testing of the constant-flow nature of some sensitive functions with
1851 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001852 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001853 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001854 * This setting requires compiling with clang -fsanitize=memory. The test
1855 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001856 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001857 * \warning This macro is only used for extended testing; it is not considered
1858 * part of the library's API, so it may change or disappear at any time.
1859 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001860 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001861 */
1862//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1863
1864/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001865 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1866 *
1867 * Enable testing of the constant-flow nature of some sensitive functions with
1868 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001869 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001870 *
1871 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001872 * testing if the tests suites are run with valgrind's memcheck. This can be
1873 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1874 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001875 *
1876 * \warning This macro is only used for extended testing; it is not considered
1877 * part of the library's API, so it may change or disappear at any time.
1878 *
1879 * Uncomment to enable testing of the constant-flow nature of selected code.
1880 */
1881//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1882
1883/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001884 * \def MBEDTLS_TEST_HOOKS
1885 *
1886 * Enable features for invasive testing such as introspection functions and
1887 * hooks for fault injection. This enables additional unit tests.
1888 *
1889 * Merely enabling this feature should not change the behavior of the product.
1890 * It only adds new code, and new branching points where the default behavior
1891 * is the same as when this feature is disabled.
1892 * However, this feature increases the attack surface: there is an added
1893 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1894 * Therefore this feature must never be enabled in production.
1895 *
1896 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1897 * information.
1898 *
1899 * Uncomment to enable invasive tests.
1900 */
1901//#define MBEDTLS_TEST_HOOKS
1902
1903/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001904 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001905 *
1906 * Provide your own alternate threading implementation.
1907 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001909 *
1910 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001913
1914/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001915 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001916 *
1917 * Enable the pthread wrapper layer for the threading layer.
1918 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001920 *
1921 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001922 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001924
1925/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001926 * \def MBEDTLS_USE_PSA_CRYPTO
1927 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001928 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1929 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001930 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001931 * \note Development of this option is currently in progress, and parts of Mbed
1932 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001933 * will still continue to work as usual, so enabling this option should not
1934 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001935 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001936 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001937 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1938 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001939 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001940 * \note An important and desirable effect of this option is that it allows
1941 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1942 * 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 +02001943 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001944 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1945 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001946 *
1947 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001948 *
1949 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001950 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001951 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001952 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001953//#define MBEDTLS_USE_PSA_CRYPTO
1954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001955/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001956 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1957 *
John Durkop185764f2020-10-12 21:32:12 -07001958 * This setting allows support for cryptographic mechanisms through the PSA
1959 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001960 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001961 * When this option is disabled, the PSA API exposes the cryptographic
1962 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1963 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001964 *
1965 * When this option is enabled, the PSA API exposes the cryptographic
1966 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1967 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1968 * automatically enabled if required (i.e. if no PSA driver provides the
1969 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1970 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001971 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001972 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001973 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001974 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001975 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1976 * symbols is not completely finalized yet, and the configuration
1977 * tooling is not ideally adapted to having two separate configuration
1978 * files.
1979 * Future minor releases of Mbed TLS may make minor changes to those
1980 * symbols, but we will endeavor to provide a transition path.
1981 * Nonetheless, this option is considered mature enough to use in
1982 * production, as long as you accept that you may need to make
1983 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001984 */
1985//#define MBEDTLS_PSA_CRYPTO_CONFIG
1986
1987/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001988 * \def MBEDTLS_VERSION_FEATURES
1989 *
1990 * Allow run-time checking of compile-time enabled features. Thus allowing users
1991 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001992 * support via mbedtls_version_check_feature().
1993 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001994 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00001995 *
1996 * Comment this to disable run-time checking and save ROM space
1997 */
1998#define MBEDTLS_VERSION_FEATURES
1999
2000/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002001 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2002 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002003 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002004 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2005 * the set of trusted certificates through a callback instead of a linked
2006 * list.
2007 *
2008 * This is useful for example in environments where a large number of trusted
2009 * certificates is present and storing them in a linked list isn't efficient
2010 * enough, or when the set of trusted certificates changes frequently.
2011 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002012 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002013 * `mbedtls_ssl_conf_ca_cb()` for more information.
2014 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002015 * Requires: MBEDTLS_X509_CRT_PARSE_C
2016 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002017 * Uncomment to enable trusted certificate callbacks.
2018 */
2019//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2020
2021/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002022 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002023 *
Chris Jones2c745862020-12-16 11:41:06 +00002024 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002025 *
Chris Jones2c745862020-12-16 11:41:06 +00002026 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002027 * and other functions/constants only used by these functions, thus reducing
2028 * the code footprint by several KB.
2029 */
Chris Jones2c745862020-12-16 11:41:06 +00002030//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002031
2032/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002033 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002034 *
2035 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2036 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2037 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002038 * Requires: MBEDTLS_PKCS1_V21
2039 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002040 * Comment this macro to disallow using RSASSA-PSS in certificates.
2041 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002042#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002043/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002044
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002045/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002046 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002047 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002048 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002049 * \{
2050 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002051
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002052/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002053 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002054 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002055 * Enable AES-NI support on x86-64 or x86-32.
2056 *
2057 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002058 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002059 * - GCC, x86-64, target not explicitly supporting AESNI:
2060 * requires MBEDTLS_HAVE_ASM.
2061 * - GCC, x86-32, target not explicitly supporting AESNI:
2062 * not supported.
2063 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2064 * For this assembly-less implementation, you must currently compile
2065 * `library/aesni.c` and `library/aes.c` with machine options to enable
2066 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2067 * `clang -maes -mpclmul`.
2068 * - Non-x86 targets: this option is silently ignored.
2069 * - Other compilers: this option is silently ignored.
2070 *
2071 * \note
2072 * Above, "GCC" includes compatible compilers such as Clang.
2073 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002074 *
2075 * Module: library/aesni.c
2076 * Caller: library/aes.c
2077 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002078 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002079 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002080 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002081 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002083
2084/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002085 * \def MBEDTLS_AESCE_C
2086 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002087 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002088 *
2089 * Module: library/aesce.c
2090 * Caller: library/aes.c
2091 *
Jerry Yuf015a932023-04-25 10:38:03 +08002092 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002093 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002094 * \warning Runtime detection only works on Linux. For non-Linux operating
2095 * system, Armv8-A Cryptographic Extensions must be supported by
2096 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002097 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002098 * \note Minimum compiler versions for this feature when targeting aarch64
2099 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2100 * Minimum compiler versions for this feature when targeting 32-bit
2101 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002102 *
2103 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2104 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002105 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002106 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002107 */
2108#define MBEDTLS_AESCE_C
2109
2110/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002112 *
2113 * Enable the AES block cipher.
2114 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002115 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002116 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002117 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002118 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002119 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002120 * This module enables the following ciphersuites (if other requisites are
2121 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2123 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2124 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2125 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2126 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2127 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2128 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2129 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2130 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2131 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2132 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2133 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2134 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2135 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2136 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2137 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2138 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2139 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2140 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2141 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2142 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2143 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2144 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2145 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2146 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2147 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2148 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2149 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2150 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2151 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2152 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2153 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2154 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2155 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2156 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2157 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2158 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2159 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2160 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2161 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2162 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2163 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2164 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2165 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2166 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2167 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2168 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2169 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2170 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2171 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2172 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2173 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2174 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2175 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2176 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2177 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2178 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2179 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002180 *
Paul Bakkercff68422013-09-15 20:43:33 +02002181 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002182 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002184
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002185/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002187 *
2188 * Enable the generic ASN1 parser.
2189 *
2190 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002191 * Caller: library/x509.c
2192 * library/dhm.c
2193 * library/pkcs12.c
2194 * library/pkcs5.c
2195 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002198
2199/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002200 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002201 *
2202 * Enable the generic ASN1 writer.
2203 *
2204 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002205 * Caller: library/ecdsa.c
2206 * library/pkwrite.c
2207 * library/x509_create.c
2208 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002209 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002210 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002212
2213/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002214 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002215 *
2216 * Enable the Base64 module.
2217 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002218 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002219 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002220 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002221 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002222 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002223#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002224
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002225/**
Yanray Wange367e472023-10-31 17:23:04 +08002226 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2227 *
2228 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2229 *
2230 * \note This feature is incompatible with insecure block cipher,
2231 * MBEDTLS_DES_C, and cipher modes which always require decryption
2232 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002233 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2234 * this feature is incompatible with following supported PSA equivalence,
2235 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2236 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002237 *
2238 * Module: library/aes.c
2239 * library/aesce.c
2240 * library/aesni.c
2241 * library/aria.c
2242 * library/camellia.c
2243 * library/cipher.c
2244 */
2245//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2246
2247/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002249 *
Paul Bakker9a736322012-11-14 12:39:52 +00002250 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002251 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002252 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002253 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002254 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002255 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002256 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002257 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002258 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002259 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002260 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002261 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002262 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002263 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002264 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002265#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002266
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002267/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002269 *
2270 * Enable the Camellia block cipher.
2271 *
Paul Bakker38119b12009-01-10 23:31:23 +00002272 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002273 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002274 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002275 * This module enables the following ciphersuites (if other requisites are
2276 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002277 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2278 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2279 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2280 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2281 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2282 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2283 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2284 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2285 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2286 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2287 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2288 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2289 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2290 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2291 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2292 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2293 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2294 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2295 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2296 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2297 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2298 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2299 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2300 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2301 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2302 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2303 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2304 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2305 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2306 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2307 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2308 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2309 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2310 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2311 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2312 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2313 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2314 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2315 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2316 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2317 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2318 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002319 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002320#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002321
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002322/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002323 * \def MBEDTLS_ARIA_C
2324 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002325 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002326 *
2327 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002328 * Caller: library/cipher.c
2329 *
2330 * This module enables the following ciphersuites (if other requisites are
2331 * enabled as well):
2332 *
2333 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2334 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2335 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2336 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2337 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2338 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2339 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2340 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2341 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2342 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2343 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2344 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2345 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2346 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2347 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2348 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2349 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2350 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2351 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2352 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2353 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2354 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2355 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2356 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2357 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2358 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2359 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2360 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2361 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2362 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2363 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2364 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2365 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2366 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2367 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2368 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2369 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2370 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002371 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002372#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002373
2374/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002376 *
2377 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2378 *
2379 * Module: library/ccm.c
2380 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002381 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2382 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002383 *
2384 * This module enables the AES-CCM ciphersuites, if other requisites are
2385 * enabled as well.
2386 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002387#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002388
2389/**
Daniel King34b822c2016-05-15 17:28:08 -03002390 * \def MBEDTLS_CHACHA20_C
2391 *
2392 * Enable the ChaCha20 stream cipher.
2393 *
2394 * Module: library/chacha20.c
2395 */
2396#define MBEDTLS_CHACHA20_C
2397
2398/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002399 * \def MBEDTLS_CHACHAPOLY_C
2400 *
2401 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2402 *
2403 * Module: library/chachapoly.c
2404 *
2405 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2406 */
2407#define MBEDTLS_CHACHAPOLY_C
2408
2409/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002411 *
2412 * Enable the generic cipher layer.
2413 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002414 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002415 * Caller: library/ccm.c
2416 * library/cmac.c
2417 * library/gcm.c
2418 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002419 * library/pkcs12.c
2420 * library/pkcs5.c
2421 * library/psa_crypto_aead.c
2422 * library/psa_crypto_mac.c
2423 * library/ssl_ciphersuites.c
2424 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002425 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002426 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2427 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002428 *
2429 * Uncomment to enable generic cipher wrappers.
2430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002432
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002433/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002434 * \def MBEDTLS_CMAC_C
2435 *
Simon Butcher327398a2016-10-05 14:09:11 +01002436 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2437 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002438 *
2439 * Module: library/cmac.c
2440 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002441 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002442 *
2443 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002444#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002445
2446/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002447 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002448 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002449 * Enable the CTR_DRBG AES-based random generator.
2450 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002451 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002452 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002453 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002454 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2455 * is used.
2456 *
2457 * \warning When using PSA, the user should call `psa_crypto_init()` before
2458 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2459 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002460 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2461 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002462 * \note To achieve a 256-bit security strength with CTR_DRBG,
2463 * you must use AES-256 *and* use sufficient entropy.
2464 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002465 *
2466 * Module: library/ctr_drbg.c
2467 * Caller:
2468 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002469 * Requires: MBEDTLS_AES_C or
2470 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2471 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002472 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002473 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002475#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002476
2477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002479 *
2480 * Enable the debug functions.
2481 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002482 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002483 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002484 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002485 * library/ssl_tls12_*.c
2486 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002487 *
2488 * This module provides debugging functions.
2489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002490#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002491
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002492/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002493 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002494 *
2495 * Enable the DES block cipher.
2496 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002497 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002498 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002499 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002500 *
Paul Bakkercff68422013-09-15 20:43:33 +02002501 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002502 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002503 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002504 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002507
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002508/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002510 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002511 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002512 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002513 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002514 * Caller: library/ssl_tls.c
2515 * library/ssl*_client.c
2516 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002517 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002518 * This module is used by the following key exchanges:
2519 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002520 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002521 * \warning Using DHE constitutes a security risk as it
2522 * is not possible to validate custom DH parameters.
2523 * If possible, it is recommended users should consider
2524 * preferring other methods of key exchange.
2525 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002526 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002528#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002529
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002530/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002532 *
2533 * Enable the elliptic curve Diffie-Hellman library.
2534 *
2535 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002536 * Caller: library/psa_crypto.c
2537 * library/ssl_tls.c
2538 * library/ssl*_client.c
2539 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002540 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002541 * This module is used by the following key exchanges:
2542 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002543 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002544 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002545 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002547
2548/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002550 *
2551 * Enable the elliptic curve DSA library.
2552 *
2553 * Module: library/ecdsa.c
2554 * Caller:
2555 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002556 * This module is used by the following key exchanges:
2557 * ECDHE-ECDSA
2558 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002559 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2560 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2561 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002562 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002564
2565/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002566 * \def MBEDTLS_ECJPAKE_C
2567 *
2568 * Enable the elliptic curve J-PAKE library.
2569 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002570 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2571 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002572 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002573 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002574 * Module: library/ecjpake.c
2575 * Caller:
2576 *
2577 * This module is used by the following key exchanges:
2578 * ECJPAKE
2579 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002580 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002581 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002582 * \warning If using a hash that is only provided by PSA drivers, you must
2583 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002584 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002585#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002586
2587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002588 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002589 *
2590 * Enable the elliptic curve over GF(p) library.
2591 *
2592 * Module: library/ecp.c
2593 * Caller: library/ecdh.c
2594 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002595 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002596 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002597 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002600
2601/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002603 *
2604 * Enable the platform-specific entropy code.
2605 *
2606 * Module: library/entropy.c
2607 * Caller:
2608 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002610 *
2611 * This module provides a generic entropy pool
2612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002614
2615/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002616 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002617 *
2618 * Enable error code to error string conversion.
2619 *
2620 * Module: library/error.c
2621 * Caller:
2622 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002624 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002625#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002626
2627/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002628 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002629 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002630 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002631 *
2632 * Module: library/gcm.c
2633 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002634 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2635 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002636 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002637 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2638 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002639 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002640#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002641
2642/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002643 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002644 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002645 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002646 * Can significantly increase throughput on systems without GCM hardware
2647 * acceleration (e.g., AESNI, AESCE).
2648 *
Matthias Schulz78266782024-02-08 13:54:48 +01002649 * The mbedtls_gcm_context size will increase by 3840 bytes.
2650 * The code size will increase by roughly 344 bytes.
2651 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002652 * Module: library/gcm.c
2653 *
2654 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002655 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002656//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002657
2658/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002659 * \def MBEDTLS_HKDF_C
2660 *
2661 * Enable the HKDF algorithm (RFC 5869).
2662 *
2663 * Module: library/hkdf.c
2664 * Caller:
2665 *
2666 * Requires: MBEDTLS_MD_C
2667 *
2668 * This module adds support for the Hashed Message Authentication Code
2669 * (HMAC)-based key derivation function (HKDF).
2670 */
2671#define MBEDTLS_HKDF_C
2672
2673/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002675 *
2676 * Enable the HMAC_DRBG random generator.
2677 *
2678 * Module: library/hmac_drbg.c
2679 * Caller:
2680 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002682 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002683 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002684 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002686
2687/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002688 * \def MBEDTLS_LMS_C
2689 *
2690 * Enable the LMS stateful-hash asymmetric signature algorithm.
2691 *
2692 * Module: library/lms.c
2693 * Caller:
2694 *
Raef Colesab4f8742022-09-01 12:24:31 +01002695 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002696 *
Raef Colesab4f8742022-09-01 12:24:31 +01002697 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002698 */
2699#define MBEDTLS_LMS_C
2700
2701/**
Raef Colesab4f8742022-09-01 12:24:31 +01002702 * \def MBEDTLS_LMS_PRIVATE
2703 *
2704 * Enable LMS private-key operations and signing code. Functions enabled by this
2705 * option are experimental, and should not be used in production.
2706 *
2707 * Requires: MBEDTLS_LMS_C
2708 *
2709 * Uncomment to enable the LMS signature algorithm and private key operations.
2710 */
Raef Coles5127e852022-10-07 10:35:56 +01002711//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002712
2713/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002714 * \def MBEDTLS_NIST_KW_C
2715 *
2716 * Enable the Key Wrapping mode for 128-bit block ciphers,
2717 * as defined in NIST SP 800-38F. Only KW and KWP modes
2718 * are supported. At the moment, only AES is approved by NIST.
2719 *
2720 * Module: library/nist_kw.c
2721 *
2722 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2723 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002724#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002725
2726/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002728 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002729 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002730 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002731 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2732 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002733 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002734 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002735 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002736 * Caller: library/constant_time.c
2737 * library/ecdsa.c
2738 * library/ecjpake.c
2739 * library/hkdf.c
2740 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002741 * library/pk.c
2742 * library/pkcs5.c
2743 * library/pkcs12.c
2744 * library/psa_crypto_ecp.c
2745 * library/psa_crypto_rsa.c
2746 * library/rsa.c
2747 * library/ssl_cookie.c
2748 * library/ssl_msg.c
2749 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002750 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002751 * library/x509_crt.c
2752 * library/x509write_crt.c
2753 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002754 *
2755 * Uncomment to enable generic message digest wrappers.
2756 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002758
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002759/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002760 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002761 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002762 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002763 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002764 * Module: library/md5.c
2765 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002766 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002767 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002768 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002769 * This module is required for TLS 1.2 depending on the handshake parameters.
2770 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2771 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002772 *
2773 * \warning MD5 is considered a weak message digest and its use constitutes a
2774 * security risk. If possible, we recommend avoiding dependencies on
2775 * it, and considering stronger message digests instead.
2776 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002777 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002778#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002779
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002780/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002782 *
2783 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002784 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002785 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002786 *
2787 * Module: library/memory_buffer_alloc.c
2788 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002789 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002790 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002791 *
2792 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002795
2796/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002797 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002798 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002799 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2800 *
Simon Butcherd567a232016-03-09 20:19:21 +00002801 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2802 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002803 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002804 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002805 * \note See also our Knowledge Base article about porting to a new
2806 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002807 * 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 +00002808 *
Andres AG788aa4a2016-09-14 14:32:09 +01002809 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002810 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002811 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002814
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002815/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002816 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002817 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002818 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002819 *
2820 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002821 * Caller: library/asn1write.c
2822 * library/pkcs5.c
2823 * library/pkparse.c
2824 * library/pkwrite.c
2825 * library/rsa.c
2826 * library/x509.c
2827 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002828 * library/x509_crl.c
2829 * library/x509_crt.c
2830 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002831 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002832 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002833 *
2834 * This modules translates between OIDs and internal values.
2835 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002836#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002837
2838/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002840 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002841 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002842 *
2843 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002844 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002845 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002846 * library/x509_crl.c
2847 * library/x509_crt.c
2848 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002849 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002851 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2852 *
2853 * \warning When parsing password-protected files, if MD5 is provided only by
2854 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002855 *
Paul Bakkercff68422013-09-15 20:43:33 +02002856 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002857 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002859
2860/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002862 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002863 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002864 *
2865 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002866 * Caller: library/pkwrite.c
2867 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002868 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002869 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002870 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002871 *
2872 * This modules adds support for encoding / writing PEM files.
2873 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002875
2876/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002878 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002879 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002880 *
2881 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002882 * Caller: library/psa_crypto_rsa.c
2883 * library/ssl_tls.c
2884 * library/ssl*_client.c
2885 * library/ssl*_server.c
2886 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002887 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002888 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002889 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002890 * Uncomment to enable generic public key wrappers.
2891 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002892#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002893
2894/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002896 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002897 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002898 *
2899 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002900 * Caller: library/x509_crt.c
2901 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002902 *
Yanray Wang072a0682023-12-05 10:53:04 +08002903 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002904 *
2905 * Uncomment to enable generic public key parse functions.
2906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002908
2909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002910 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002911 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002912 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002913 *
2914 * Module: library/pkwrite.c
2915 * Caller: library/x509write.c
2916 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002917 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002918 *
2919 * Uncomment to enable generic public key write functions.
2920 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002921#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002922
2923/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002924 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002925 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002926 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002927 *
2928 * Module: library/pkcs5.c
2929 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002930 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002931 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002932 * \warning If using a hash that is only provided by PSA drivers, you must
2933 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002934 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002935 * This module adds support for the PKCS#5 functions.
2936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002937#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002938
2939/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002940 * \def MBEDTLS_PKCS7_C
2941 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002942 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002943 * RFC Link - https://tools.ietf.org/html/rfc2315
2944 *
2945 * Module: library/pkcs7.c
2946 *
2947 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002948 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2949 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002950 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002951 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002952 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002953#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002954
2955/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002957 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002958 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002959 * Adds algorithms for parsing PKCS#8 encrypted private keys
2960 *
2961 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002962 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002963 *
Valerio Settie98ad592023-12-28 10:42:12 +01002964 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2965 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002966 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002967 * \warning If using a hash that is only provided by PSA drivers, you must
2968 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002969 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002970 * This module enables PKCS#12 functions.
2971 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002972#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002973
2974/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002976 *
2977 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002978 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002979 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2981 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002982 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002983 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002984 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002985 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002986 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002987 * Module: library/platform.c
2988 * Caller: Most other .c files
2989 *
2990 * This module enables abstraction of common (libc) functions.
2991 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002992#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002993
2994/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002995 * \def MBEDTLS_POLY1305_C
2996 *
2997 * Enable the Poly1305 MAC algorithm.
2998 *
2999 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003000 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003001 */
3002#define MBEDTLS_POLY1305_C
3003
3004/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003005 * \def MBEDTLS_PSA_CRYPTO_C
3006 *
3007 * Enable the Platform Security Architecture cryptography API.
3008 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003009 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003010 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003011 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003012 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003013 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3014 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3015 * is enabled in PSA (unless it's fully accelerated, see
3016 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003017 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003018#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003019
3020/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003021 * \def MBEDTLS_PSA_CRYPTO_SE_C
3022 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003023 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003024 * cryptography API.
3025 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003026 * \deprecated This feature is deprecated. Please switch to the PSA driver
3027 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003028 *
Ryan Everett32a64582024-03-05 18:16:18 +00003029 * \warning This feature is not thread-safe, and should not be used in a
3030 * multi-threaded environment.
3031 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003032 * Module: library/psa_crypto_se.c
3033 *
3034 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3035 *
3036 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003037//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003038
3039/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003040 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3041 *
3042 * Enable the Platform Security Architecture persistent key storage.
3043 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003044 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003045 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003046 * Requires: MBEDTLS_PSA_CRYPTO_C,
3047 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3048 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003049 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003050#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003051
3052/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003053 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003054 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003055 * Enable the emulation of the Platform Security Architecture
3056 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003057 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003058 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003059 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003060 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003061 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003062#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003063
3064/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003066 *
3067 * Enable the RIPEMD-160 hash algorithm.
3068 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003069 * Module: library/ripemd160.c
3070 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003071 *
3072 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003074
3075/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003077 *
3078 * Enable the RSA public-key cryptosystem.
3079 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003080 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003081 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003082 * Caller: library/pk.c
3083 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003084 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003085 * library/ssl*_client.c
3086 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003087 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003088 * This module is used by the following key exchanges:
3089 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003090 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003092 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003094
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003095/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003097 *
3098 * Enable the SHA1 cryptographic hash algorithm.
3099 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003100 * Module: library/sha1.c
3101 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003102 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003103 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003104 * This module is required for TLS 1.2 depending on the handshake parameters,
3105 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003106 *
3107 * \warning SHA-1 is considered a weak message digest and its use constitutes
3108 * a security risk. If possible, we recommend avoiding dependencies
3109 * on it, and considering stronger message digests instead.
3110 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003111 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003113
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003114/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003115 * \def MBEDTLS_SHA224_C
3116 *
3117 * Enable the SHA-224 cryptographic hash algorithm.
3118 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003119 * Module: library/sha256.c
3120 * Caller: library/md.c
3121 * library/ssl_cookie.c
3122 *
3123 * This module adds support for SHA-224.
3124 */
3125#define MBEDTLS_SHA224_C
3126
3127/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003128 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003129 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003130 * Enable the SHA-256 cryptographic hash algorithm.
3131 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003132 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003133 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003134 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003135 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003136 * library/ssl*_client.c
3137 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003138 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003139 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003140 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003143
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003144/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003145 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003146 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003147 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3148 * with the ARMv8 cryptographic extensions if they are available at runtime.
3149 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003150 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003151 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003152 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003153 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003154 * \note Minimum compiler versions for this feature are Clang 4.0,
3155 * armclang 6.6 or GCC 6.0.
3156 *
3157 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3158 * armclang <= 6.9
3159 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003160 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3161 * That name is deprecated, but may still be used as an alternative form for this
3162 * option.
3163 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003164 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3165 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003166 *
3167 * Requires: MBEDTLS_SHA256_C.
3168 *
3169 * Module: library/sha256.c
3170 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003171 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003172 * and use them if available.
3173 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003174//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003175
Dave Rodgmand85277c2023-10-13 09:22:54 +01003176/**
3177 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3178 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003179 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003180 * This name is now deprecated, but may still be used as an alternative form for
3181 * this option.
3182 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003183//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3184
3185/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003186 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003187 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003188 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3189 * with the ARMv8 cryptographic extensions, which must be available at runtime
3190 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003191 *
3192 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003193 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003194 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003195 * \note Minimum compiler versions for this feature are Clang 4.0,
3196 * armclang 6.6 or GCC 6.0.
3197 *
3198 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3199 * armclang <= 6.9
3200 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003201 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003202 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003203 * option.
3204 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003205 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3206 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003207 *
3208 * Requires: MBEDTLS_SHA256_C.
3209 *
3210 * Module: library/sha256.c
3211 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003212 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003213 * unconditionally.
3214 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003215//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003216
Dave Rodgmand85277c2023-10-13 09:22:54 +01003217/**
3218 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3219 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003220 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003221 * This name is now deprecated, but may still be used as an alternative form for
3222 * this option.
3223 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003224//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3225
3226/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003227 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003228 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003229 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003230 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003231 * Module: library/sha512.c
3232 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003233 * library/psa_crypto_hash.c
3234 * library/ssl_tls.c
3235 * library/ssl*_client.c
3236 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003237 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003238 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003239 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003240#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003241
3242/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003244 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003245 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003246 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003247 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003248 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003249 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003250 * library/ssl_tls.c
3251 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003252 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003253 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003254 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003256
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003257/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003258 * \def MBEDTLS_SHA3_C
3259 *
3260 * Enable the SHA3 cryptographic hash algorithm.
3261 *
3262 * Module: library/sha3.c
3263 *
3264 * This module adds support for SHA3.
3265 */
3266#define MBEDTLS_SHA3_C
3267
3268/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003269 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3270 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003271 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3272 * with the ARMv8 cryptographic extensions if they are available at runtime.
3273 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003274 *
3275 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3276 * for a non-Aarch64 build it will be silently ignored.
3277 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003278 * \note Minimum compiler versions for this feature are Clang 7.0,
3279 * armclang 6.9 or GCC 8.0.
3280 *
3281 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3282 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003283 *
3284 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3285 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3286 *
3287 * Requires: MBEDTLS_SHA512_C.
3288 *
3289 * Module: library/sha512.c
3290 *
3291 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3292 * and use them if available.
3293 */
3294//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3295
3296/**
3297 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3298 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003299 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3300 * with the ARMv8 cryptographic extensions, which must be available at runtime
3301 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003302 *
3303 * \note This allows builds with a smaller code size than with
3304 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3305 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003306 * \note Minimum compiler versions for this feature are Clang 7.0,
3307 * armclang 6.9 or GCC 8.0.
3308 *
3309 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3310 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003311 *
3312 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3313 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3314 *
3315 * Requires: MBEDTLS_SHA512_C.
3316 *
3317 * Module: library/sha512.c
3318 *
3319 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3320 * unconditionally.
3321 */
3322//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3323
3324/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003326 *
3327 * Enable simple SSL cache implementation.
3328 *
3329 * Module: library/ssl_cache.c
3330 * Caller:
3331 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003333 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003334#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003335
3336/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003337 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003338 *
3339 * Enable basic implementation of DTLS cookies for hello verification.
3340 *
3341 * Module: library/ssl_cookie.c
3342 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003343 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003344#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003345
3346/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003347 * \def MBEDTLS_SSL_TICKET_C
3348 *
3349 * Enable an implementation of TLS server-side callbacks for session tickets.
3350 *
3351 * Module: library/ssl_ticket.c
3352 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003353 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003354 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3355 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003356 */
3357#define MBEDTLS_SSL_TICKET_C
3358
3359/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003360 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003361 *
3362 * Enable the SSL/TLS client code.
3363 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003364 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003365 * Caller:
3366 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003368 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003369 * This module is required for SSL/TLS client support.
3370 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003372
Paul Bakker9a736322012-11-14 12:39:52 +00003373/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003374 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003375 *
3376 * Enable the SSL/TLS server code.
3377 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003378 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003379 * Caller:
3380 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003382 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003383 * This module is required for SSL/TLS server support.
3384 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003385#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003386
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003387/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003388 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003389 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003390 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003391 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003392 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003393 * Caller: library/ssl*_client.c
3394 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003395 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3397 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003398 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003399 * This module is required for SSL/TLS.
3400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003401#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003402
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003403/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003405 *
3406 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003407 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003408 * contexts are not shared between threads. If you do intend to use contexts
3409 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003410 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003411 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003412 *
3413 * Module: library/threading.c
3414 *
3415 * This allows different threading implementations (self-implemented or
3416 * provided).
3417 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418 * You will have to enable either MBEDTLS_THREADING_ALT or
3419 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003420 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003421 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003424
3425/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003427 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003428 * Enable the semi-portable timing interface.
3429 *
Simon Butcherd567a232016-03-09 20:19:21 +00003430 * \note The provided implementation only works on POSIX/Unix (including Linux,
3431 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003432 * module and provide your own implementations of the callbacks needed by
3433 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3434 * your own implementation of the whole module by setting
3435 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003436 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003437 * \note The timing module will include time.h on suitable platforms
3438 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3439 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3440 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003441 * \note See also our Knowledge Base article about porting to a new
3442 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003443 * 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 +00003444 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003445 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003447#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003448
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003449/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003451 *
3452 * Enable run-time version information.
3453 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003454 * Module: library/version.c
3455 *
3456 * This module provides run-time version information.
3457 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003458#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003459
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003460/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003462 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003463 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003464 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003465 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003466 * Caller: library/x509_crl.c
3467 * library/x509_crt.c
3468 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003469 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003470 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003471 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3472 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003473 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3474 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003475 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003476 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003479
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003480/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003481 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003482 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003483 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003484 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003485 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003486 * Caller: library/ssl_tls.c
3487 * library/ssl*_client.c
3488 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003489 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003491 *
3492 * This module is required for X.509 certificate parsing.
3493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003495
3496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003498 *
3499 * Enable X.509 CRL parsing.
3500 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003501 * Module: library/x509_crl.c
3502 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003503 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003505 *
3506 * This module is required for X.509 CRL parsing.
3507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003509
3510/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003511 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003512 *
3513 * Enable X.509 Certificate Signing Request (CSR) parsing.
3514 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003515 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003516 * Caller: library/x509_crt_write.c
3517 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003518 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003519 *
3520 * This module is used for reading X.509 certificate request.
3521 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003523
3524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003525 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003526 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003527 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003528 *
3529 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003530 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003531 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003532 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3533 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003534 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3535 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003536 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003537 * This module is the basis for creating X.509 certificates and CSRs.
3538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003539#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003540
3541/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003543 *
3544 * Enable creating X.509 certificates.
3545 *
3546 * Module: library/x509_crt_write.c
3547 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003548 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003549 *
3550 * This module is required for X.509 certificate creation.
3551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003553
3554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003556 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003557 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003558 *
3559 * Module: library/x509_csr_write.c
3560 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003561 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003562 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003563 * This module is required for X.509 certificate request writing.
3564 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003565#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003566
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003567/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003568
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003569/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003570 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003571 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003572 * This section contains Mbed TLS build settings that are not associated
3573 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003574 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003575 * \{
3576 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003577
Gilles Peskinea02c1242022-03-16 17:03:19 +01003578/**
3579 * \def MBEDTLS_CONFIG_FILE
3580 *
3581 * If defined, this is a header which will be included instead of
3582 * `"mbedtls/mbedtls_config.h"`.
3583 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003584 * Unlike other configuration options, this one must be defined on the
3585 * compiler command line: a definition in `mbedtls_config.h` would have
3586 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003587 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003588 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003589 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003590 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003591 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003592 * The value of this symbol is typically a path in double quotes, either
3593 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003594 */
3595//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3596
3597/**
3598 * \def MBEDTLS_USER_CONFIG_FILE
3599 *
3600 * If defined, this is a header which will be included after
3601 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003602 * This allows you to modify the default configuration, including the ability
3603 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003604 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003605 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003606 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003607 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003608 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003609 * The value of this symbol is typically a path in double quotes, either
3610 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003611 */
3612//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3613
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003614/**
3615 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3616 *
3617 * If defined, this is a header which will be included instead of
3618 * `"psa/crypto_config.h"`.
3619 * This header file specifies which cryptographic mechanisms are available
3620 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3621 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3622 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003623 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003624 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003625 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003626 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003627 * The value of this symbol is typically a path in double quotes, either
3628 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003629 */
3630//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3631
3632/**
3633 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3634 *
3635 * If defined, this is a header which will be included after
3636 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003637 * This allows you to modify the default configuration, including the ability
3638 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003639 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003640 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003641 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003642 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003643 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003644 * The value of this symbol is typically a path in double quotes, either
3645 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003646 */
3647//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3648
Gilles Peskineb1176f22023-02-22 22:07:28 +01003649/**
3650 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3651 *
3652 * If defined, this is a header which will be included instead of
3653 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3654 * as the one in Mbed TLS, but with definitions adapted to the platform on
3655 * which the library code will run.
3656 *
3657 * \note The required content of this header can vary from one version of
3658 * Mbed TLS to the next. Integrators who provide an alternative file
3659 * should review the changes in the original file whenever they
3660 * upgrade Mbed TLS.
3661 *
3662 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3663 * non-standard feature of the C language, so this feature is only available
3664 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3665 *
3666 * The value of this symbol is typically a path in double quotes, either
3667 * absolute or relative to a directory on the include search path.
3668 */
3669//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3670
3671/**
3672 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3673 *
3674 * If defined, this is a header which will be included instead of
3675 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3676 * as the one in Mbed TLS, but with definitions adapted to the environment
3677 * in which the library code will run. The typical use for this feature
3678 * is to provide alternative type definitions on the client side in
3679 * client-server integrations of PSA crypto, where operation structures
3680 * contain handles instead of cryptographic data.
3681 *
3682 * \note The required content of this header can vary from one version of
3683 * Mbed TLS to the next. Integrators who provide an alternative file
3684 * should review the changes in the original file whenever they
3685 * upgrade Mbed TLS.
3686 *
3687 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3688 * non-standard feature of the C language, so this feature is only available
3689 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3690 *
3691 * The value of this symbol is typically a path in double quotes, either
3692 * absolute or relative to a directory on the include search path.
3693 */
3694//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3695
Gilles Peskineba4162a2022-04-11 17:04:38 +02003696/** \} name SECTION: General configuration options */
3697
3698/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003699 * \name SECTION: Module configuration options
3700 *
3701 * This section allows for the setting of module specific sizes and
3702 * configuration options. The default values are already present in the
3703 * relevant header files and should suffice for the regular use cases.
3704 *
3705 * Our advice is to enable options and change their values here
3706 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003707 * \{
3708 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003709/* The Doxygen documentation here is used when a user comments out a
3710 * setting and runs doxygen themselves. On the other hand, when we typeset
3711 * the full documentation including disabled settings, the documentation
3712 * in specific modules' header files is used if present. When editing this
3713 * file, make sure that each option is documented in exactly one place,
3714 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3715 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003716
Paul Bakker088c5c52014-04-25 11:11:10 +02003717/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003718//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003719//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003720
Paul Bakker088c5c52014-04-25 11:11:10 +02003721/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003722//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3723//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3724//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3725//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3726//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003727
Paul Bakker088c5c52014-04-25 11:11:10 +02003728/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003729//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3730//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3731//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3732//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003733
Paul Bakker088c5c52014-04-25 11:11:10 +02003734/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003735//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003736//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003737
Paul Bakker088c5c52014-04-25 11:11:10 +02003738/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003739//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3740//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003741//#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 +01003742
Paul Bakker088c5c52014-04-25 11:11:10 +02003743/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003744//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003745
Paul Bakker088c5c52014-04-25 11:11:10 +02003746/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003747//#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 -04003748
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003749/** \def MBEDTLS_PLATFORM_STD_CALLOC
3750 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003751 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003752 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003753 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003754 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003755 * 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 -04003756 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3757 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003758 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003759 */
3760//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003761
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003762/** \def MBEDTLS_PLATFORM_STD_FREE
3763 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003764 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003765 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003766 * 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 -04003767 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3768 * 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 -04003769 */
3770//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003771//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003772//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003773//#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 +02003774//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3775//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003776/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003777//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003778//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3779//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003780//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3781//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3782//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003783
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003784/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003785/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003786//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3787//#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 +02003788//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003789//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003790//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3791//#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 +02003792//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3793//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003794/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003795//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003796//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003797//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3798//#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 +08003799//#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 +08003800//#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 +02003801
Gilles Peskine3f106f72021-09-23 17:42:39 +02003802/** \def MBEDTLS_CHECK_RETURN
3803 *
3804 * This macro is used at the beginning of the declaration of a function
3805 * to indicate that its return value should be checked. It should
3806 * instruct the compiler to emit a warning or an error if the function
3807 * is called without checking its return value.
3808 *
3809 * There is a default implementation for popular compilers in platform_util.h.
3810 * You can override the default implementation by defining your own here.
3811 *
3812 * If the implementation here is empty, this will effectively disable the
3813 * checking of functions' return values.
3814 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003815//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003816
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003817/** \def MBEDTLS_IGNORE_RETURN
3818 *
3819 * This macro requires one argument, which should be a C function call.
3820 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3821 * warning is suppressed.
3822 */
3823//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3824
Gilles Peskineed038902020-11-13 21:33:21 +01003825/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003826/**
Gilles Peskineed038902020-11-13 21:33:21 +01003827 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3828 * PSA crypto subsystem.
3829 *
3830 * If this option is unset:
3831 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003832 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003833 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3834 * on unspecified heuristics.
3835 */
3836//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3837
Steven Cooreman863470a2021-02-15 14:03:19 +01003838/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003839 * Restrict the PSA library to supporting a maximum amount of simultaneously
3840 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3841 * volatile key, or a persistent key which is loaded temporarily by the
3842 * library as part of a crypto operation in flight.
3843 *
3844 * If this option is unset, the library will fall back to a default value of
3845 * 32 keys.
3846 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003847//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003848
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003849/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003850//#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 +00003851
Paul Bakker088c5c52014-04-25 11:11:10 +02003852/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003853//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3854//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003855
Paul Bakker088c5c52014-04-25 11:11:10 +02003856/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003857
Angus Grattond8213d02016-05-25 20:56:48 +10003858/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3859 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003860 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003861 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003862 * This determines the size of the incoming TLS I/O buffer in such a way
3863 * that it is capable of holding the specified amount of plaintext data,
3864 * regardless of the protection mechanism used.
3865 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003866 * \note When using a value less than the default of 16KB on the client, it is
3867 * recommended to use the Maximum Fragment Length (MFL) extension to
3868 * inform the server about this limitation. On the server, there
3869 * is no supported, standardized way of informing the client about
3870 * restriction on the maximum size of incoming messages, and unless
3871 * the limitation has been communicated by other means, it is recommended
3872 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3873 * while keeping the default value of 16KB for the incoming buffer.
3874 *
David Horstmann95d516f2021-05-04 18:36:56 +01003875 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003876 */
3877//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3878
Gilles Peskined3d02902020-03-04 21:35:27 +01003879/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3880 *
3881 * The maximum length of CIDs used for incoming DTLS messages.
3882 *
3883 */
3884//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3885
3886/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3887 *
3888 * The maximum length of CIDs used for outgoing DTLS messages.
3889 *
3890 */
3891//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3892
TRodziewicze8dd7092021-05-12 14:19:11 +02003893/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003894 *
3895 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003896 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003897 *
3898 * The padding will always be chosen so that the length of the
3899 * padded plaintext is a multiple of the value of this option.
3900 *
3901 * Note: A value of \c 1 means that no padding will be used
3902 * for outgoing records.
3903 *
3904 * Note: On systems lacking division instructions,
3905 * a power of two should be preferred.
3906 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003907//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003908
Angus Grattond8213d02016-05-25 20:56:48 +10003909/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3910 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003911 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003912 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003913 * This determines the size of the outgoing TLS I/O buffer in such a way
3914 * that it is capable of holding the specified amount of plaintext data,
3915 * regardless of the protection mechanism used.
3916 *
Angus Grattond8213d02016-05-25 20:56:48 +10003917 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3918 * the default inward 16384 byte buffer to conform to the TLS specification.
3919 *
3920 * The minimum required outward buffer size is determined by the handshake
3921 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3922 * The specific size requirement depends on the configured ciphers and any
3923 * certificate data which is sent during the handshake.
3924 *
David Horstmann95d516f2021-05-04 18:36:56 +01003925 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003926 */
3927//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3928
Hanno Beckere0b150f2018-08-21 15:51:03 +01003929/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3930 *
3931 * Maximum number of heap-allocated bytes for the purpose of
3932 * DTLS handshake message reassembly and future message buffering.
3933 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003934 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003935 * to account for a reassembled handshake message of maximum size,
3936 * together with its reassembly bitmap.
3937 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003938 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003939 * should be sufficient for all practical situations as it allows
3940 * to reassembly a large handshake message (such as a certificate)
3941 * while buffering multiple smaller handshake messages.
3942 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003943 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003944//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003945
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003946//#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 +02003947//#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 +02003948
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003949/**
3950 * Complete list of ciphersuites to use, in order of preference.
3951 *
3952 * \warning No dependency checking is done on that field! This option can only
3953 * be used to restrict the set of available ciphersuites. It is your
3954 * responsibility to make sure the needed modules are active.
3955 *
3956 * Use this to save a few hundred bytes of ROM (default ordering of all
3957 * available ciphersuites) and a few to a few hundred bytes of RAM.
3958 *
3959 * The value below is only an example, not the default.
3960 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003961//#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 +02003962
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003963/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003964 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3965 *
3966 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003967 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003968 *
3969 * It must be positive and smaller than UINT32_MAX.
3970 *
3971 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3972 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003973 */
3974//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3975
3976/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003977 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3978 *
Jerry Yucf913512023-11-14 11:06:52 +08003979 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003980 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003981 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003982 * - The client ticket age is the time difference between the time when the
3983 * client proposes to the server to use the ticket and the time the client
3984 * received the ticket from the server.
3985 * - The server ticket age is the time difference between the time when the
3986 * server receives a proposition from the client to use the ticket and the
3987 * time when the ticket was created by the server.
3988 *
Jerry Yucf913512023-11-14 11:06:52 +08003989 * The ages might be different due to the client and server clocks not running
3990 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3991 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3992 * 6s, thus in the worst case clients and servers must sync up their system time
3993 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003994 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003995 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003996 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003997//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003998
3999/**
4000 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4001 *
4002 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4003 *
4004 * This must be less than 256.
4005 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004006//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004007
4008/**
4009 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4010 *
4011 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4012 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4013 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4014 *
4015 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004016//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004017
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004018/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004019//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004020//#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 +01004021
Gilles Peskine611179c2022-04-13 23:04:48 +02004022/** \} name SECTION: Module configuration options */