blob: a3185238c83f987edcf43a45795c7acd6c684ff0 [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
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000353//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200355//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200356//#define MBEDTLS_DES_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300357//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200358//#define MBEDTLS_MD5_ALT
359//#define MBEDTLS_RIPEMD160_ALT
360//#define MBEDTLS_SHA1_ALT
361//#define MBEDTLS_SHA256_ALT
362//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000363
Paul Bakker90995b52013-06-24 19:20:35 +0200364/**
TRodziewicz75628d52021-06-18 12:56:27 +0200365 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200366 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200367 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100368 * alternate core implementation of symmetric crypto or hash function. Keep in
369 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200370 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200371 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200372 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200373 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200374 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375 * no longer provide the mbedtls_sha1_process() function, but it will still provide
376 * the other function (using your mbedtls_sha1_process() function) and the definition
377 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200378 * with this definition.
379 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200380 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100381 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
382 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200383 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200384 * Uncomment a macro to enable alternate implementation of the corresponding
385 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100386 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200387 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100388 * constitutes a security risk. If possible, we recommend avoiding
389 * dependencies on them, and considering stronger message digests
390 * and ciphers instead.
391 *
Janos Follath1231d212019-01-07 15:01:32 +0000392 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
393 * enabled, then the deterministic ECDH signature functions pass the
394 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
395 * alternative implementations should use the RNG only for generating
396 * the ephemeral key and nothing else. If this is not possible, then
397 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200398 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000399 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401//#define MBEDTLS_MD5_PROCESS_ALT
402//#define MBEDTLS_RIPEMD160_PROCESS_ALT
403//#define MBEDTLS_SHA1_PROCESS_ALT
404//#define MBEDTLS_SHA256_PROCESS_ALT
405//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200406//#define MBEDTLS_DES_SETKEY_ALT
407//#define MBEDTLS_DES_CRYPT_ECB_ALT
408//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200409//#define MBEDTLS_AES_SETKEY_ENC_ALT
410//#define MBEDTLS_AES_SETKEY_DEC_ALT
411//#define MBEDTLS_AES_ENCRYPT_ALT
412//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300413//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300414//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300415//#define MBEDTLS_ECDSA_VERIFY_ALT
416//#define MBEDTLS_ECDSA_SIGN_ALT
417//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200418
419/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200420 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200421 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200422 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200423 * hardware entropy collector.
424 *
425 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000426 * prototype as declared in library/entropy_poll.h, and accept NULL as first
427 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200428 *
429 * Uncomment to use your own hardware entropy collector.
430 */
431//#define MBEDTLS_ENTROPY_HARDWARE_ALT
432
433/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200434 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000435 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100436 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000437 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100438 * Uncomment this macro to use precomputed AES tables stored in ROM.
439 * Comment this macro to generate AES tables in RAM at runtime.
440 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100441 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
442 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100443 * initialization time before the first AES operation can be performed.
444 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
445 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
446 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100447 *
448 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200450//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000451
452/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100453 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200454 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100455 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200456 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100457 * Uncommenting this macro omits 75% of the AES tables from
458 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
459 * by computing their values on the fly during operations
460 * (the tables are entry-wise rotations of one another).
461 *
462 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100463 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100464 * runtime. Specifically, one has to compare 4 accesses within
465 * different tables to 4 accesses with additional arithmetic
466 * operations within the same table. The performance gain/loss
467 * depends on the system and memory details.
468 *
469 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200470 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100471//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200472
473/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800474 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
475 *
476 * Use only 128-bit keys in AES operations to save ROM.
477 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800478 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800479 * or 256-bit keys.
480 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800481 * Uncommenting this macro reduces the size of AES code by ~300 bytes
482 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800483 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800484 * Module: library/aes.c
485 *
486 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800487 */
488//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
489
Gilles Peskinea8861e02023-09-05 20:20:51 +0200490/*
491 * Disable plain C implementation for AES.
492 *
493 * When the plain C implementation is enabled, and an implementation using a
494 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
495 * detection will be used to select between them.
496 *
497 * If only one implementation is present, runtime detection will not be used.
498 * This configuration will crash at runtime if running on a CPU without the
499 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
500 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
501 */
502//#define MBEDTLS_AES_USE_HARDWARE_ONLY
503
Arto Kinnunen732ca322023-04-14 14:26:10 +0800504/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200505 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200506 *
507 * Use less ROM for the Camellia implementation (saves about 768 bytes).
508 *
509 * Uncomment this macro to use less memory for Camellia.
510 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200511//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200512
513/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200514 * \def MBEDTLS_CHECK_RETURN_WARNING
515 *
516 * If this macro is defined, emit a compile-time warning if application code
517 * calls a function without checking its return value, but the return value
518 * should generally be checked in portable applications.
519 *
520 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
521 * implemented. Otherwise this option has no effect.
522 *
523 * Uncomment to get warnings on using fallible functions without checking
524 * their return value.
525 *
526 * \note This feature is a work in progress.
527 * Warnings will be added to more functions in the future.
528 *
529 * \note A few functions are considered critical, and ignoring the return
530 * value of these functions will trigger a warning even if this
531 * macro is not defined. To completely disable return value check
532 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
533 */
534//#define MBEDTLS_CHECK_RETURN_WARNING
535
536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200537 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200538 *
539 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200541#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200542
543/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000545 *
546 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000549
550/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000552 *
553 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200555#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000556
557/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100558 * \def MBEDTLS_CIPHER_MODE_OFB
559 *
560 * Enable Output Feedback mode (OFB) for symmetric ciphers.
561 */
562#define MBEDTLS_CIPHER_MODE_OFB
563
564/**
565 * \def MBEDTLS_CIPHER_MODE_XTS
566 *
567 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
568 */
569#define MBEDTLS_CIPHER_MODE_XTS
570
571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000573 *
574 * Enable NULL cipher.
575 * Warning: Only do so when you know what you are doing. This allows for
576 * encryption or channels without any security!
577 *
Ronald Croncee42702021-04-26 11:34:44 +0200578 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200579 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
580 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
581 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
582 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
583 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
584 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
585 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
586 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
587 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
588 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
589 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
590 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
591 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
592 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
593 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
594 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
595 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
596 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
597 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000598 *
599 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200601//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000602
603/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100604 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200605 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100606 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
607 * specific padding modes in the cipher layer with cipher modes that support
608 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200609 *
610 * If you disable all padding modes, only full blocks can be used with CBC.
611 *
612 * Enable padding modes in the cipher layer.
613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614#define MBEDTLS_CIPHER_PADDING_PKCS7
615#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
616#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
617#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200618
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200619/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
620 *
621 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800622 * Without this, CTR_DRBG uses a 256-bit key
623 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200624 */
625//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
626
Paul Bakker48e93c82013-08-14 12:21:18 +0200627/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200628 * Enable the verified implementations of ECDH primitives from Project Everest
629 * (currently only Curve25519). This feature changes the layout of ECDH
630 * contexts and therefore is a compatibility break for applications that access
631 * fields of a mbedtls_ecdh_context structure directly. See also
632 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000633 *
634 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
635 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200636 */
637//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
638
639/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100640 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200641 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100642 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
643 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200644 *
645 * Comment macros to disable the curve and functions for it
646 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200647/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
649#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
650#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
651#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
652#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
653#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
654#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
655#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
656#define MBEDTLS_ECP_DP_BP256R1_ENABLED
657#define MBEDTLS_ECP_DP_BP384R1_ENABLED
658#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200659/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200660#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000661#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200662
663/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200664 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200665 *
666 * Enable specific 'modulo p' routines for each NIST prime.
667 * Depending on the prime and architecture, makes operations 4 to 8 times
668 * faster on the corresponding curve.
669 *
670 * Comment this macro to disable NIST curves optimisation.
671 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200673
674/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200675 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100676 *
677 * Enable "non-blocking" ECC operations that can return early and be resumed.
678 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200679 * This allows various functions to pause by returning
680 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
681 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
682 * order to further progress and eventually complete their operation. This is
683 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
684 * number of ECC operations a function may perform before pausing; see
685 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100686 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200687 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200688 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100689 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100690 * This option:
691 * - Adds xxx_restartable() variants of existing operations in the
692 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100693 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
694 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100695 * - ECDSA: signature generation & verification;
696 * - PK: signature generation & verification;
697 * - X509: certificate chain verification.
698 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
699 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
700 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
701 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000702 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100703 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100704 * - verification of the server's key exchange signature;
705 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100706 * - generation of the client's signature if client authentication is used,
707 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100708 *
709 * \note In the cases above, the usual SSL/TLS functions, such as
710 * mbedtls_ssl_handshake(), can now return
711 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200712 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100713 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
714 * restartable operations in PK, X.509 and TLS (see above) are not
715 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100716 * PSA, and are not restartable. These are temporary limitations that
717 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200718 *
Ron Eldor19779c42018-11-05 16:58:13 +0200719 * \note This option only works with the default software implementation of
720 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100721 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100722 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100723 * Requires: MBEDTLS_ECP_C
724 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100725 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100726 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200727//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100728
729/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200730 * Uncomment to enable using new bignum code in the ECC modules.
731 *
732 * \warning This is currently experimental, incomplete and therefore should not
733 * be used in production.
734 */
735//#define MBEDTLS_ECP_WITH_MPI_UINT
736
737/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100739 *
740 * Enable deterministic ECDSA (RFC 6979).
741 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
742 * may result in a compromise of the long-term signing key. This is avoided by
743 * the deterministic variant.
744 *
John Durkop36a82e52020-10-26 09:39:05 -0700745 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100746 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100747 * Comment this macro to disable deterministic ECDSA.
748 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200749#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100750
751/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200752 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200753 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200754 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200755 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200756 * This enables the following ciphersuites (if other requisites are
757 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
759 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
760 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
761 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
762 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
763 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
764 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
765 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
766 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
767 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200768 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200770
771/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200772 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200773 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200774 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200775 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200776 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200777 *
778 * This enables the following ciphersuites (if other requisites are
779 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
781 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
782 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
783 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
784 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
785 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
786 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
787 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
788 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
789 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100790 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100791 * \warning Using DHE constitutes a security risk as it
792 * is not possible to validate custom DH parameters.
793 * If possible, it is recommended users should consider
794 * preferring other methods of key exchange.
795 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100796 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200799
800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200801 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200802 *
803 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
804 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200805 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200806 *
807 * This enables the following ciphersuites (if other requisites are
808 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
810 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
811 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
812 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
813 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
814 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200815 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200816#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200817
818/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200819 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200820 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200821 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200822 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200823 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
824 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200825 *
826 * This enables the following ciphersuites (if other requisites are
827 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
829 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
830 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
831 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
832 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
833 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
834 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
835 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
836 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
837 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200840
841/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200843 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200844 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200845 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
847 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200848 *
849 * This enables the following ciphersuites (if other requisites are
850 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200851 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
852 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
853 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
854 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
855 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
856 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
857 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
858 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
859 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
860 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
861 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
862 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200864#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200865
866/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200868 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200869 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200870 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
872 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +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_DHE_RSA_WITH_AES_256_GCM_SHA384
877 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
878 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
879 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
880 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
881 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
882 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
883 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
884 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
885 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
886 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
887 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100888 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100889 * \warning Using DHE constitutes a security risk as it
890 * is not possible to validate custom DH parameters.
891 * If possible, it is recommended users should consider
892 * preferring other methods of key exchange.
893 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100894 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200895 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200897
898/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200899 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200900 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200901 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200902 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200903 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
904 * MBEDTLS_RSA_C
905 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200907 *
908 * This enables the following ciphersuites (if other requisites are
909 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
913 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
914 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
915 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
916 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
917 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
918 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
919 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200920 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200922
923/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200924 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200925 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200926 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200927 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200928 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
929 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
930 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200931 *
932 * This enables the following ciphersuites (if other requisites are
933 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
938 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
939 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
940 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
941 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
942 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
943 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200944 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200946
947/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100949 *
950 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
951 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200952 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
953 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
954 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100955 *
956 * This enables the following ciphersuites (if other requisites are
957 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
960 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
961 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
962 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
963 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
964 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
965 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
966 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
967 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100968 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100970
971/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100973 *
974 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
975 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200976 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
977 * MBEDTLS_RSA_C
978 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100979 *
980 * This enables the following ciphersuites (if other requisites are
981 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
983 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
984 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
985 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
986 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
987 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
988 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
989 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
990 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
991 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100992 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100994
995/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200996 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
997 *
998 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
999 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001000 * \warning This is currently experimental. EC J-PAKE support is based on the
1001 * Thread v1.0.0 specification; incompatible changes to the specification
1002 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001003 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001004 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001005 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001006 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1007 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001008 * \warning If SHA-256 is provided only by a PSA driver, you must call
1009 * psa_crypto_init() before the first hanshake (even if
1010 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1011 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001012 * This enables the following ciphersuites (if other requisites are
1013 * enabled as well):
1014 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1015 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001016//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001017
1018/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001020 *
1021 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1022 * RFC 5915 and RFC 5480.
1023 *
1024 * Currently this means parsing the SpecifiedECDomain choice of EC
1025 * parameters (only known groups are supported, not arbitrary domains, to
1026 * avoid validation issues).
1027 *
1028 * Disable if you only need to support RFC 5915 + 5480 key formats.
1029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001031
1032/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001033 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1034 *
1035 * Enable the support for parsing public keys of type Short Weierstrass
1036 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001037 * compressed point format. This parsing is done through ECP module's functions.
1038 *
1039 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1040 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1041 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001042 */
1043#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1044
1045/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001046 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001047 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048 * Enable a dummy error function to make use of mbedtls_strerror() in
1049 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1050 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001051 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1053 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001054 *
1055 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001057 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001059
1060/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001062 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001063 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001064 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001065 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001066 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001068
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001069/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001071 *
1072 * Enable functions that use the filesystem.
1073 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001075
1076/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001078 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001079 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001080 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001081 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001082 * application.
1083 *
1084 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001087
1088/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001090 *
1091 * Do not use built-in platform entropy functions.
1092 * This is useful if your platform does not support
1093 * standards like the /dev/urandom or Windows CryptoAPI.
1094 *
1095 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001098
1099/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001101 *
1102 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1103 * default SHA-512 based one (if both are available).
1104 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001106 *
1107 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1108 * if you have performance concerns.
1109 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001110 * This option is only useful if both MBEDTLS_SHA256_C and
1111 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001112 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001113//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001114
1115/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001116 * \def MBEDTLS_ENTROPY_NV_SEED
1117 *
1118 * Enable the non-volatile (NV) seed file-based entropy source.
1119 * (Also enables the NV seed read/write functions in the platform layer)
1120 *
1121 * This is crucial (if not required) on systems that do not have a
1122 * cryptographic entropy source (in hardware or kernel) available.
1123 *
1124 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1125 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001126 * \note The read/write functions that are used by the entropy source are
1127 * determined in the platform layer, and can be modified at runtime and/or
1128 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1129 *
1130 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001131 * with regular fopen(), please make sure you make a seedfile with the
1132 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1133 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001134 * and written to or you will get an entropy source error! The default
1135 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1136 * bytes from the file.
1137 *
1138 * \note The entropy collector will write to the seed file before entropy is
1139 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001140 */
1141//#define MBEDTLS_ENTROPY_NV_SEED
1142
Ronald Cron71016a92020-08-28 19:01:50 +02001143/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001144 *
Ronald Cron71016a92020-08-28 19:01:50 +02001145 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001146 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001147 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1148 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001149 *
1150 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001151 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001152 */
Ronald Cron71016a92020-08-28 19:01:50 +02001153//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001154
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001157 *
1158 * Enable debugging of buffer allocator memory issues. Automatically prints
1159 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1160 * function for 'debug output' of allocated memory.
1161 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001163 *
1164 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001165 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001167
1168/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001170 *
1171 * Include backtrace information with each allocated block.
1172 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001174 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001175 *
1176 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001179
1180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001182 *
1183 * Support external private RSA keys (eg from a HSM) in the PK layer.
1184 *
1185 * Comment this macro to disable support for external private RSA keys.
1186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001188
1189/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001190 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001191 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001192 * Enable support for PKCS#1 v1.5 encoding.
1193 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001194 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001195 *
Paul Bakker48377d92013-08-30 12:06:24 +02001196 * This enables support for PKCS#1 v1.5 operations.
1197 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001199
1200/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001202 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001203 * Enable support for PKCS#1 v2.1 encoding.
1204 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001205 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001206 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001207 * \warning If using a hash that is only provided by PSA drivers, you must
1208 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001209 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001210 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1211 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001212#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001213
Steven Cooreman6801f082021-02-19 17:21:22 +01001214/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1215 *
1216 * Enable support for platform built-in keys. If you enable this feature,
1217 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1218 * See the documentation of that function for more information.
1219 *
1220 * Built-in keys are typically derived from a hardware unique key or
1221 * stored in a secure element.
1222 *
1223 * Requires: MBEDTLS_PSA_CRYPTO_C.
1224 *
1225 * \warning This interface is experimental and may change or be removed
1226 * without notice.
1227 */
1228//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1229
Ronald Cron3768ac12021-01-26 16:58:00 +01001230/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1231 *
1232 * Enable support for PSA crypto client.
1233 *
1234 * \note This option allows to include the code necessary for a PSA
1235 * crypto client when the PSA crypto implementation is not included in
1236 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1237 * code to set and get PSA key attributes.
1238 * The development of PSA drivers partially relying on the library to
1239 * fulfill the hardware gaps is another possible usage of this option.
1240 *
1241 * \warning This interface is experimental and may change or be removed
1242 * without notice.
1243 */
1244//#define MBEDTLS_PSA_CRYPTO_CLIENT
1245
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001246/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1247 *
1248 * Make the PSA Crypto module use an external random generator provided
1249 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1250 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001251 * \note This random generator must deliver random numbers with cryptographic
1252 * quality and high performance. It must supply unpredictable numbers
1253 * with a uniform distribution. The implementation of this function
1254 * is responsible for ensuring that the random generator is seeded
1255 * with sufficient entropy. If you have a hardware TRNG which is slow
1256 * or delivers non-uniform output, declare it as an entropy source
1257 * with mbedtls_entropy_add_source() instead of enabling this option.
1258 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001259 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001260 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1261 * and define a function called mbedtls_psa_external_get_random()
1262 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001263 * ```
1264 * psa_status_t mbedtls_psa_external_get_random(
1265 * mbedtls_psa_external_random_context_t *context,
1266 * uint8_t *output, size_t output_size, size_t *output_length);
1267 * );
1268 * ```
1269 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001270 * The function must fill the \c output buffer with \c output_size bytes
1271 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001272 *
1273 * Requires: MBEDTLS_PSA_CRYPTO_C
1274 *
1275 * \warning If you enable this option, code that uses the PSA cryptography
1276 * interface will not use any of the entropy sources set up for
1277 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1278 * enables.
1279 *
1280 * \note This option is experimental and may be removed without notice.
1281 */
1282//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1283
Paul Bakker9dcc3222011-03-08 14:16:06 +00001284/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001285 * \def MBEDTLS_PSA_CRYPTO_SPM
1286 *
1287 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1288 * Partition Manager) integration which separates the code into two parts: a
1289 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1290 * Environment).
1291 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001292 * If you enable this option, your build environment must include a header
1293 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1294 * header files, or in another directory on the compiler's include search
1295 * path). Alternatively, your platform may customize the header
1296 * `psa/crypto_platform.h`, in which case it can skip or replace the
1297 * inclusion of `"crypto_spe.h"`.
1298 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001299 * Module: library/psa_crypto.c
1300 * Requires: MBEDTLS_PSA_CRYPTO_C
1301 *
1302 */
1303//#define MBEDTLS_PSA_CRYPTO_SPM
1304
1305/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001306 * Uncomment to enable p256-m. This is an alternative implementation of
1307 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1308 * Compared to the default implementation:
1309 *
1310 * - p256-m has a much smaller code size and RAM footprint.
1311 * - p256-m is only available via the PSA API. This includes the pk module
1312 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1313 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1314 * over the core arithmetic, or deterministic derivation of keys.
1315 *
1316 * We recommend enabling this option if your application uses the PSA API
1317 * and the only elliptic curve support it needs is ECDH and ECDSA over
1318 * SECP256R1.
1319 *
1320 * If you enable this option, you do not need to enable any ECC-related
1321 * MBEDTLS_xxx option. You do need to separately request support for the
1322 * cryptographic mechanisms through the PSA API:
1323 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1324 * configuration;
1325 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1326 * - #PSA_WANT_ECC_SECP_R1_256;
1327 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1328 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1329 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1330 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1331 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001332 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001333 * \note To benefit from the smaller code size of p256-m, make sure that you
1334 * do not enable any ECC-related option not supported by p256-m: this
1335 * would cause the built-in ECC implementation to be built as well, in
1336 * order to provide the required option.
1337 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001338 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1339 * SECP256R1 are disabled as they are not supported by this driver.
1340 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1341 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001342 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001343 */
1344//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1345
1346/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001347 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001348 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001349 * Enable support for entropy injection at first boot. This feature is
1350 * required on systems that do not have a built-in entropy source (TRNG).
1351 * This feature is currently not supported on systems that have a built-in
1352 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001353 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001354 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001355 *
1356 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001357//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001358
1359/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001360 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001361 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001362 * Assume all buffers passed to PSA functions are owned exclusively by the
1363 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001364 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001365 * This option may be enabled if all buffers passed to any PSA function reside
1366 * in memory that is accessible only to the PSA function during its execution.
1367 *
1368 * This option MUST be disabled whenever buffer arguments are in memory shared
1369 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001370 * across a trust boundary.
1371 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001372 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001373 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001374 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001375 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001376 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001377//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001378
1379/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001380 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001381 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001382 * Do not use the Chinese Remainder Theorem
1383 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001384 *
1385 * Uncomment this macro to disable the use of CRT in RSA.
1386 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001389
1390/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001392 *
1393 * Enable the checkup functions (*_self_test).
1394 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001395#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001396
1397/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001398 * \def MBEDTLS_SHA256_SMALLER
1399 *
1400 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1401 * lower performance.
1402 *
Adam Wolf039080f2019-09-10 09:53:08 -05001403 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001404 * performance and size. This version optimizes more aggressively for size at
1405 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1406 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1407 * 30%.
1408 *
1409 * Uncomment to enable the smaller implementation of SHA256.
1410 */
1411//#define MBEDTLS_SHA256_SMALLER
1412
1413/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001414 * \def MBEDTLS_SHA512_SMALLER
1415 *
1416 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1417 * lower performance.
1418 *
1419 * Uncomment to enable the smaller implementation of SHA512.
1420 */
1421//#define MBEDTLS_SHA512_SMALLER
1422
1423/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001424 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001425 *
1426 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001427 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001428 * with other servers, only debugging of failures is harder.
1429 *
1430 * The advantage of not sending alert messages, is that no information is given
1431 * about reasons for failures thus preventing adversaries of gaining intel.
1432 *
1433 * Enable sending of all alert messages
1434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001435#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001436
1437/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001438 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1439 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001440 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001441 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001442 * in the underlying transport. The CID functionality is described
1443 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001444 *
1445 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001446 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1447 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1448 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001449 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001450 * The maximum lengths of outgoing and incoming CIDs can be configured
1451 * through the options
1452 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1453 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1454 *
1455 * Requires: MBEDTLS_SSL_PROTO_DTLS
1456 *
1457 * Uncomment to enable the Connection ID extension.
1458 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001459#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1460
1461
1462/**
1463 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1464 *
1465 * Defines whether RFC 9146 (default) or the legacy version
1466 * (version draft-ietf-tls-dtls-connection-id-05,
1467 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1468 * is used.
1469 *
1470 * Set the value to 0 for the standard version, and
1471 * 1 for the legacy draft version.
1472 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001473 * \deprecated Support for the legacy version of the DTLS
1474 * Connection ID feature is deprecated. Please
1475 * switch to the standardized version defined
1476 * in RFC 9146 enabled by utilizing
1477 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1478 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1479 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001480 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1481 */
1482#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001483
1484/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001485 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1486 *
1487 * Enable asynchronous external private key operations in SSL. This allows
1488 * you to configure an SSL connection to call an external cryptographic
1489 * module to perform private key operations instead of performing the
1490 * operation inside the library.
1491 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001492 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001493 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001494//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001495
1496/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001497 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1498 *
1499 * Enable serialization of the TLS context structures, through use of the
1500 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1501 *
1502 * This pair of functions allows one side of a connection to serialize the
1503 * context associated with the connection, then free or re-use that context
1504 * while the serialized state is persisted elsewhere, and finally deserialize
1505 * that state to a live context for resuming read/write operations on the
1506 * connection. From a protocol perspective, the state of the connection is
1507 * unaffected, in particular this is entirely transparent to the peer.
1508 *
1509 * Note: this is distinct from TLS session resumption, which is part of the
1510 * protocol and fully visible by the peer. TLS session resumption enables
1511 * establishing new connections associated to a saved session with shorter,
1512 * lighter handshakes, while context serialization is a local optimization in
1513 * handling a single, potentially long-lived connection.
1514 *
1515 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1516 * saved after the handshake to allow for more efficient serialization, so if
1517 * you don't need this feature you'll save RAM by disabling it.
1518 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001519 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1520 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001521 * Comment to disable the context serialization APIs.
1522 */
1523#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1524
1525/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001526 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001527 *
1528 * Enable the debug messages in SSL module for all issues.
1529 * Debug messages have been disabled in some places to prevent timing
1530 * attacks due to (unbalanced) debugging function calls.
1531 *
1532 * If you need all error reporting you should enable this during debugging,
1533 * but remove this for production servers that should log as well.
1534 *
1535 * Uncomment this macro to report all debug messages on errors introducing
1536 * a timing side-channel.
1537 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001539//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001540
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001541/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001542 *
1543 * Enable support for Encrypt-then-MAC, RFC 7366.
1544 *
1545 * This allows peers that both support it to use a more robust protection for
1546 * ciphersuites using CBC, providing deep resistance against timing attacks
1547 * on the padding or underlying cipher.
1548 *
1549 * This only affects CBC ciphersuites, and is useless if none is defined.
1550 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001551 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001552 *
1553 * Comment this macro to disable support for Encrypt-then-MAC
1554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001556
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001558 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001559 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1560 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001561 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001562 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001563 * attacks, but it is recommended to always use it (even if you disable
1564 * renegotiation), since it actually fixes a more fundamental issue in the
1565 * original SSL/TLS design, and has implications beyond Triple Handshake.
1566 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001567 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001568 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001569 * Comment this macro to disable support for Extended Master Secret.
1570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001572
Paul Bakkerd66f0702013-01-31 16:57:45 +01001573/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001574 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1575 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001576 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001577 * giving access to the peer's certificate after completion of the handshake.
1578 *
1579 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1580 * recommended to disable this option for reduced RAM usage.
1581 *
1582 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1583 * defined, but always returns \c NULL.
1584 *
1585 * \note This option has no influence on the protection against the
1586 * triple handshake attack. Even if it is disabled, Mbed TLS will
1587 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001588 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001589 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001590 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001591 *
1592 * Comment this macro to disable storing the peer's certificate
1593 * after the handshake.
1594 */
1595#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1596
1597/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001598 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001599 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001600 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001601 *
1602 * The two main uses of renegotiation are (1) refresh keys on long-lived
1603 * connections and (2) client authentication after the initial handshake.
1604 * If you don't need renegotiation, it's probably better to disable it, since
1605 * it has been associated with security issues in the past and is easy to
1606 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001607 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001608 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1609 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001610 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001611 *
1612 * \note Even if this option is disabled, both client and server are aware
1613 * of the Renegotiation Indication Extension (RFC 5746) used to
1614 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1615 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1616 * configuration of this extension).
1617 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001618 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001619#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001620
1621/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001622 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001623 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001624 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001625 *
1626 * Comment this macro to disable support for the max_fragment_length extension
1627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001628#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001629
1630/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001631 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1632 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001633 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001634 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001635 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1636 *
1637 * Uncomment this macro to enable support for the record_size_limit extension
1638 */
1639//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1640
1641/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001643 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001644 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001645 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001646 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001647 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1648 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001649 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001650 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001651 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001652 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1653 * are only provided by PSA drivers, you must call psa_crypto_init() before
1654 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001655 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001656 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001658#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001659
1660/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001661 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001662 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001663 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001664 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001665 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001666 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001667 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001668 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001669 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001670 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001671 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1672 * directly performed by TLS 1.3 code. As a consequence, you must
1673 * call psa_crypto_init() before the first TLS 1.3 handshake.
1674 *
1675 * \note Cryptographic operations performed indirectly via another module
1676 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1677 * running handshake hash) only use PSA crypto if
1678 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001679 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001680 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001681 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001682#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001683
1684/**
Ronald Cronab65c522021-11-24 10:47:20 +01001685 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1686 *
1687 * Enable TLS 1.3 middlebox compatibility mode.
1688 *
1689 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1690 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1691 * expecting TLS 1.2 traffic.
1692 *
1693 * Turning on the compatibility mode comes at the cost of a few added bytes
1694 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1695 * that don't use it. Therefore, unless transmission bandwidth is critical and
1696 * you know that middlebox compatibility issues won't occur, it is therefore
1697 * recommended to set this option.
1698 *
1699 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001700 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1701 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001702 *
1703 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001704#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001705
1706/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001707 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1708 *
1709 * Enable TLS 1.3 PSK key exchange mode.
1710 *
1711 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1712 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1713 * effect on the build.
1714 *
1715 */
1716#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1717
1718/**
1719 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1720 *
1721 * Enable TLS 1.3 ephemeral key exchange mode.
1722 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001723 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001724 * MBEDTLS_X509_CRT_PARSE_C
1725 * and at least one of:
1726 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1727 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001728 *
1729 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1730 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1731 * effect on the build.
1732 *
1733 */
1734#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1735
1736/**
1737 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1738 *
1739 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1740 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001741 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001742 *
1743 * Comment to disable support for the PSK ephemeral key exchange mode in
1744 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1745 * have any effect on the build.
1746 *
1747 */
1748#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1749
1750/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 * \def MBEDTLS_SSL_EARLY_DATA
1752 *
1753 * Enable support for RFC 8446 TLS 1.3 early data.
1754 *
1755 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1756 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1757 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1758 *
1759 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1760 * is not enabled, this option does not have any effect on the build.
1761 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001762 * \note The maximum amount of early data can be set with
1763 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1764 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001766//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001767
1768/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001770 *
1771 * Enable support for DTLS (all available versions).
1772 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001773 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001774 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001775 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001776 *
1777 * Comment this macro to disable support for DTLS
1778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001779#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001780
1781/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001783 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001784 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001785 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001786 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001787 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001789
1790/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001792 *
1793 * Enable support for the anti-replay mechanism in DTLS.
1794 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795 * Requires: MBEDTLS_SSL_TLS_C
1796 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001797 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001798 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001799 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001800 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001801 * Comment this to disable anti-replay in DTLS.
1802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001804
1805/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001807 *
1808 * Enable support for HelloVerifyRequest on DTLS servers.
1809 *
1810 * This feature is highly recommended to prevent DTLS servers being used as
1811 * amplifiers in DoS attacks against other hosts. It should always be enabled
1812 * unless you know for sure amplification cannot be a problem in the
1813 * environment in which your server operates.
1814 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001815 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001816 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001817 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001818 *
1819 * Comment this to disable support for HelloVerifyRequest.
1820 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001822
1823/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001824 * \def MBEDTLS_SSL_DTLS_SRTP
1825 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001826 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001827 * through the use_srtp extension.
1828 *
1829 * \note This feature provides the minimum functionality required
1830 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1831 * the associated SRTP packet protection key material.
1832 * In particular, the SRTP packet protection itself, as well as the
1833 * demultiplexing of RTP and DTLS packets at the datagram layer
1834 * (see Section 5 of RFC 5764), are not handled by this feature.
1835 * Instead, after successful completion of a handshake negotiating
1836 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001837 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001838 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1839 * (this is implemented in the SSL example programs).
1840 * The resulting key should then be passed to an SRTP stack.
1841 *
1842 * Setting this option enables the runtime API
1843 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1844 * through which the supported DTLS-SRTP protection
1845 * profiles can be configured. You must call this API at
1846 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001847 *
1848 * Requires: MBEDTLS_SSL_PROTO_DTLS
1849 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001850 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001851 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001852//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001853
1854/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001855 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1856 *
1857 * Enable server-side support for clients that reconnect from the same port.
1858 *
1859 * Some clients unexpectedly close the connection and try to reconnect using the
1860 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001861 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001862 * flag enables that support.
1863 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001864 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001865 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001866 * Comment this to disable support for clients reusing the source port.
1867 */
1868#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1869
1870/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001872 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001873 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001874 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001875 * session store remains the responsibility of the application, though).
1876 * Server-side, you also need to provide callbacks for writing and parsing
1877 * tickets, including authenticated encryption and key management. Example
1878 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001879 *
1880 * Comment this macro to disable support for SSL session tickets
1881 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001883
1884/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001886 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001887 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001888 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001889 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001890 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001891 * Comment this macro to disable support for server name indication in SSL
1892 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001893#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001894
1895/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001896 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1897 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001898 * When this option is enabled, the SSL buffer will be resized automatically
1899 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001900 *
1901 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001902 */
1903//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1904
1905/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001906 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1907 *
1908 * Enable testing of the constant-flow nature of some sensitive functions with
1909 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001910 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001911 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001912 * This setting requires compiling with clang -fsanitize=memory. The test
1913 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001914 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001915 * \warning This macro is only used for extended testing; it is not considered
1916 * part of the library's API, so it may change or disappear at any time.
1917 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001918 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001919 */
1920//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1921
1922/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001923 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1924 *
1925 * Enable testing of the constant-flow nature of some sensitive functions with
1926 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001927 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001928 *
1929 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001930 * testing if the tests suites are run with valgrind's memcheck. This can be
1931 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1932 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001933 *
1934 * \warning This macro is only used for extended testing; it is not considered
1935 * part of the library's API, so it may change or disappear at any time.
1936 *
1937 * Uncomment to enable testing of the constant-flow nature of selected code.
1938 */
1939//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1940
1941/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001942 * \def MBEDTLS_TEST_HOOKS
1943 *
1944 * Enable features for invasive testing such as introspection functions and
1945 * hooks for fault injection. This enables additional unit tests.
1946 *
1947 * Merely enabling this feature should not change the behavior of the product.
1948 * It only adds new code, and new branching points where the default behavior
1949 * is the same as when this feature is disabled.
1950 * However, this feature increases the attack surface: there is an added
1951 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1952 * Therefore this feature must never be enabled in production.
1953 *
1954 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1955 * information.
1956 *
1957 * Uncomment to enable invasive tests.
1958 */
1959//#define MBEDTLS_TEST_HOOKS
1960
1961/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001963 *
1964 * Provide your own alternate threading implementation.
1965 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001967 *
1968 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001971
1972/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001974 *
1975 * Enable the pthread wrapper layer for the threading layer.
1976 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001978 *
1979 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001982
1983/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001984 * \def MBEDTLS_USE_PSA_CRYPTO
1985 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001986 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1987 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001988 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001989 * \note Development of this option is currently in progress, and parts of Mbed
1990 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001991 * will still continue to work as usual, so enabling this option should not
1992 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001993 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001994 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001995 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1996 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001997 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001998 * \note An important and desirable effect of this option is that it allows
1999 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2000 * 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 +02002001 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002002 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2003 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002004 *
2005 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002006 *
2007 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002008 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002009 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002010 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002011//#define MBEDTLS_USE_PSA_CRYPTO
2012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002013/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002014 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2015 *
John Durkop185764f2020-10-12 21:32:12 -07002016 * This setting allows support for cryptographic mechanisms through the PSA
2017 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002018 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002019 * When this option is disabled, the PSA API exposes the cryptographic
2020 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2021 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002022 *
2023 * When this option is enabled, the PSA API exposes the cryptographic
2024 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2025 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2026 * automatically enabled if required (i.e. if no PSA driver provides the
2027 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2028 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002029 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002030 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002031 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002032 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002033 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2034 * symbols is not completely finalized yet, and the configuration
2035 * tooling is not ideally adapted to having two separate configuration
2036 * files.
2037 * Future minor releases of Mbed TLS may make minor changes to those
2038 * symbols, but we will endeavor to provide a transition path.
2039 * Nonetheless, this option is considered mature enough to use in
2040 * production, as long as you accept that you may need to make
2041 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002042 */
2043//#define MBEDTLS_PSA_CRYPTO_CONFIG
2044
2045/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002046 * \def MBEDTLS_VERSION_FEATURES
2047 *
2048 * Allow run-time checking of compile-time enabled features. Thus allowing users
2049 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002050 * support via mbedtls_version_check_feature().
2051 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002052 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002053 *
2054 * Comment this to disable run-time checking and save ROM space
2055 */
2056#define MBEDTLS_VERSION_FEATURES
2057
2058/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002059 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2060 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002061 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002062 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2063 * the set of trusted certificates through a callback instead of a linked
2064 * list.
2065 *
2066 * This is useful for example in environments where a large number of trusted
2067 * certificates is present and storing them in a linked list isn't efficient
2068 * enough, or when the set of trusted certificates changes frequently.
2069 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002070 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002071 * `mbedtls_ssl_conf_ca_cb()` for more information.
2072 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002073 * Requires: MBEDTLS_X509_CRT_PARSE_C
2074 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002075 * Uncomment to enable trusted certificate callbacks.
2076 */
2077//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2078
2079/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002080 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002081 *
Chris Jones2c745862020-12-16 11:41:06 +00002082 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002083 *
Chris Jones2c745862020-12-16 11:41:06 +00002084 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002085 * and other functions/constants only used by these functions, thus reducing
2086 * the code footprint by several KB.
2087 */
Chris Jones2c745862020-12-16 11:41:06 +00002088//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002089
2090/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002092 *
2093 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2094 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2095 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002096 * Requires: MBEDTLS_PKCS1_V21
2097 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002098 * Comment this macro to disallow using RSASSA-PSS in certificates.
2099 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002100#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002101/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002102
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002103/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002104 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002105 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002106 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002107 * \{
2108 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002109
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002110/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002112 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002113 * Enable AES-NI support on x86-64 or x86-32.
2114 *
2115 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002116 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002117 * - GCC, x86-64, target not explicitly supporting AESNI:
2118 * requires MBEDTLS_HAVE_ASM.
2119 * - GCC, x86-32, target not explicitly supporting AESNI:
2120 * not supported.
2121 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2122 * For this assembly-less implementation, you must currently compile
2123 * `library/aesni.c` and `library/aes.c` with machine options to enable
2124 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2125 * `clang -maes -mpclmul`.
2126 * - Non-x86 targets: this option is silently ignored.
2127 * - Other compilers: this option is silently ignored.
2128 *
2129 * \note
2130 * Above, "GCC" includes compatible compilers such as Clang.
2131 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002132 *
2133 * Module: library/aesni.c
2134 * Caller: library/aes.c
2135 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002136 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002137 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002138 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002139 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002141
2142/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002143 * \def MBEDTLS_AESCE_C
2144 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002145 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002146 *
2147 * Module: library/aesce.c
2148 * Caller: library/aes.c
2149 *
Jerry Yuf015a932023-04-25 10:38:03 +08002150 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002151 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002152 * \warning Runtime detection only works on Linux. For non-Linux operating
2153 * system, Armv8-A Cryptographic Extensions must be supported by
2154 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002155 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002156 * \note Minimum compiler versions for this feature when targeting aarch64
2157 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2158 * Minimum compiler versions for this feature when targeting 32-bit
2159 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002160 *
2161 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2162 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002163 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002164 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002165 */
2166#define MBEDTLS_AESCE_C
2167
2168/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002169 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002170 *
2171 * Enable the AES block cipher.
2172 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002173 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002174 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002175 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002176 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002177 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002178 * This module enables the following ciphersuites (if other requisites are
2179 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002180 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2181 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2182 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2183 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2184 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2185 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2186 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2187 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2188 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2189 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2190 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2191 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2192 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2193 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2194 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2195 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2196 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2197 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2198 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2199 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2200 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2201 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2202 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2203 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2204 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2205 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2206 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2207 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2208 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2209 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2210 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2211 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2212 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2213 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2214 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2215 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2216 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2217 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2218 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2219 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2220 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2221 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2222 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2223 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2224 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2225 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2226 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2227 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2228 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2229 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2230 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2231 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2232 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2233 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2234 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2235 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2236 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2237 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002238 *
Paul Bakkercff68422013-09-15 20:43:33 +02002239 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002240 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002242
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002243/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002244 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002245 *
2246 * Enable the generic ASN1 parser.
2247 *
2248 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002249 * Caller: library/x509.c
2250 * library/dhm.c
2251 * library/pkcs12.c
2252 * library/pkcs5.c
2253 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002254 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002256
2257/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002258 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002259 *
2260 * Enable the generic ASN1 writer.
2261 *
2262 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002263 * Caller: library/ecdsa.c
2264 * library/pkwrite.c
2265 * library/x509_create.c
2266 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002267 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002270
2271/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002273 *
2274 * Enable the Base64 module.
2275 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002276 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002277 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002278 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002279 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002280 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002281#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002282
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002283/**
Yanray Wange367e472023-10-31 17:23:04 +08002284 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2285 *
2286 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2287 *
2288 * \note This feature is incompatible with insecure block cipher,
2289 * MBEDTLS_DES_C, and cipher modes which always require decryption
2290 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002291 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2292 * this feature is incompatible with following supported PSA equivalence,
2293 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2294 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002295 *
2296 * Module: library/aes.c
2297 * library/aesce.c
2298 * library/aesni.c
2299 * library/aria.c
2300 * library/camellia.c
2301 * library/cipher.c
2302 */
2303//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2304
2305/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002306 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002307 *
Paul Bakker9a736322012-11-14 12:39:52 +00002308 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002309 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002310 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002311 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002312 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002313 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002314 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002315 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002316 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002317 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002318 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002319 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002320 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002321 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002324
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002327 *
2328 * Enable the Camellia block cipher.
2329 *
Paul Bakker38119b12009-01-10 23:31:23 +00002330 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002331 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002332 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002333 * This module enables the following ciphersuites (if other requisites are
2334 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2336 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2337 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2338 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2339 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2340 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2341 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2342 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2343 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2344 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2345 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2346 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2347 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2348 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2349 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2350 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2351 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2352 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2353 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2354 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2355 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2356 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2357 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2358 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2359 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2360 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2361 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2362 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2363 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2364 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2365 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2366 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2367 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2368 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2369 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2370 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2371 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2372 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2373 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2374 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2375 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2376 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002378#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002379
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002380/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002381 * \def MBEDTLS_ARIA_C
2382 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002383 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002384 *
2385 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002386 * Caller: library/cipher.c
2387 *
2388 * This module enables the following ciphersuites (if other requisites are
2389 * enabled as well):
2390 *
2391 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2392 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2393 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2394 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2395 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2396 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2397 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2398 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2399 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2400 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2401 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2402 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2403 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2404 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2405 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2406 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2407 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2408 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2409 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2410 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2411 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2412 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2413 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2414 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2415 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2416 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2417 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2418 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2419 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2420 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2421 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2422 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2423 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2424 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2425 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2426 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2427 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2428 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002429 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002430#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002431
2432/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002434 *
2435 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2436 *
2437 * Module: library/ccm.c
2438 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002439 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2440 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002441 *
2442 * This module enables the AES-CCM ciphersuites, if other requisites are
2443 * enabled as well.
2444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002445#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002446
2447/**
Daniel King34b822c2016-05-15 17:28:08 -03002448 * \def MBEDTLS_CHACHA20_C
2449 *
2450 * Enable the ChaCha20 stream cipher.
2451 *
2452 * Module: library/chacha20.c
2453 */
2454#define MBEDTLS_CHACHA20_C
2455
2456/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002457 * \def MBEDTLS_CHACHAPOLY_C
2458 *
2459 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2460 *
2461 * Module: library/chachapoly.c
2462 *
2463 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2464 */
2465#define MBEDTLS_CHACHAPOLY_C
2466
2467/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002468 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002469 *
2470 * Enable the generic cipher layer.
2471 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002472 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002473 * Caller: library/ccm.c
2474 * library/cmac.c
2475 * library/gcm.c
2476 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002477 * library/pkcs12.c
2478 * library/pkcs5.c
2479 * library/psa_crypto_aead.c
2480 * library/psa_crypto_mac.c
2481 * library/ssl_ciphersuites.c
2482 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002483 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002484 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2485 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002486 *
2487 * Uncomment to enable generic cipher wrappers.
2488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002489#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002490
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002491/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002492 * \def MBEDTLS_CMAC_C
2493 *
Simon Butcher327398a2016-10-05 14:09:11 +01002494 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2495 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002496 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002497 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2498 * implementation of the CMAC algorithm is provided by an alternate
2499 * implementation, that alternate implementation may opt to not support
2500 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2501 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002502 * Module: library/cmac.c
2503 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002504 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002505 *
2506 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002507#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002508
2509/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002510 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002511 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002512 * Enable the CTR_DRBG AES-based random generator.
2513 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002514 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002515 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002516 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2517 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2518 * is used.
2519 *
2520 * \warning When using PSA, the user should call `psa_crypto_init()` before
2521 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2522 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002523 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2524 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002525 * \note To achieve a 256-bit security strength with CTR_DRBG,
2526 * you must use AES-256 *and* use sufficient entropy.
2527 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002528 *
2529 * Module: library/ctr_drbg.c
2530 * Caller:
2531 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002532 * Requires: MBEDTLS_AES_C or
2533 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2534 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002535 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002536 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002539
2540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002542 *
2543 * Enable the debug functions.
2544 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002545 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002546 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002547 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002548 * library/ssl_tls12_*.c
2549 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002550 *
2551 * This module provides debugging functions.
2552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002554
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002557 *
2558 * Enable the DES block cipher.
2559 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002560 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002561 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002562 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002563 *
Paul Bakkercff68422013-09-15 20:43:33 +02002564 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002565 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002566 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002567 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002570
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002572 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002573 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002574 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002575 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002576 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002577 * Caller: library/ssl_tls.c
2578 * library/ssl*_client.c
2579 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002580 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002581 * This module is used by the following key exchanges:
2582 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002583 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002584 * \warning Using DHE constitutes a security risk as it
2585 * is not possible to validate custom DH parameters.
2586 * If possible, it is recommended users should consider
2587 * preferring other methods of key exchange.
2588 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002589 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002590 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002591#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002592
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002593/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002594 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002595 *
2596 * Enable the elliptic curve Diffie-Hellman library.
2597 *
2598 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002599 * Caller: library/psa_crypto.c
2600 * library/ssl_tls.c
2601 * library/ssl*_client.c
2602 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002603 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002604 * This module is used by the following key exchanges:
2605 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002606 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002610
2611/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002613 *
2614 * Enable the elliptic curve DSA library.
2615 *
2616 * Module: library/ecdsa.c
2617 * Caller:
2618 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002619 * This module is used by the following key exchanges:
2620 * ECDHE-ECDSA
2621 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002622 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2623 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2624 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002625 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002627
2628/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002629 * \def MBEDTLS_ECJPAKE_C
2630 *
2631 * Enable the elliptic curve J-PAKE library.
2632 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002633 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2634 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002635 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002636 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002637 * Module: library/ecjpake.c
2638 * Caller:
2639 *
2640 * This module is used by the following key exchanges:
2641 * ECJPAKE
2642 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002643 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002644 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002645 * \warning If using a hash that is only provided by PSA drivers, you must
2646 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002647 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002648#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002649
2650/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002651 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002652 *
2653 * Enable the elliptic curve over GF(p) library.
2654 *
2655 * Module: library/ecp.c
2656 * Caller: library/ecdh.c
2657 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002658 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002659 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002661 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002662#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002663
2664/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002665 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002666 *
2667 * Enable the platform-specific entropy code.
2668 *
2669 * Module: library/entropy.c
2670 * Caller:
2671 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002672 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002673 *
2674 * This module provides a generic entropy pool
2675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002677
2678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002680 *
2681 * Enable error code to error string conversion.
2682 *
2683 * Module: library/error.c
2684 * Caller:
2685 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002687 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002688#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002689
2690/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002692 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002693 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002694 *
2695 * Module: library/gcm.c
2696 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002697 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2698 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002699 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002700 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2701 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002702 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002703#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002704
2705/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002706 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002707 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002708 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002709 * Can significantly increase throughput on systems without GCM hardware
2710 * acceleration (e.g., AESNI, AESCE).
2711 *
Matthias Schulz78266782024-02-08 13:54:48 +01002712 * The mbedtls_gcm_context size will increase by 3840 bytes.
2713 * The code size will increase by roughly 344 bytes.
2714 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002715 * Module: library/gcm.c
2716 *
2717 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002718 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002719//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002720
2721/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002722 * \def MBEDTLS_HKDF_C
2723 *
2724 * Enable the HKDF algorithm (RFC 5869).
2725 *
2726 * Module: library/hkdf.c
2727 * Caller:
2728 *
2729 * Requires: MBEDTLS_MD_C
2730 *
2731 * This module adds support for the Hashed Message Authentication Code
2732 * (HMAC)-based key derivation function (HKDF).
2733 */
2734#define MBEDTLS_HKDF_C
2735
2736/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002738 *
2739 * Enable the HMAC_DRBG random generator.
2740 *
2741 * Module: library/hmac_drbg.c
2742 * Caller:
2743 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002745 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002746 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002747 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002748#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002749
2750/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002751 * \def MBEDTLS_LMS_C
2752 *
2753 * Enable the LMS stateful-hash asymmetric signature algorithm.
2754 *
2755 * Module: library/lms.c
2756 * Caller:
2757 *
Raef Colesab4f8742022-09-01 12:24:31 +01002758 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002759 *
Raef Colesab4f8742022-09-01 12:24:31 +01002760 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002761 */
2762#define MBEDTLS_LMS_C
2763
2764/**
Raef Colesab4f8742022-09-01 12:24:31 +01002765 * \def MBEDTLS_LMS_PRIVATE
2766 *
2767 * Enable LMS private-key operations and signing code. Functions enabled by this
2768 * option are experimental, and should not be used in production.
2769 *
2770 * Requires: MBEDTLS_LMS_C
2771 *
2772 * Uncomment to enable the LMS signature algorithm and private key operations.
2773 */
Raef Coles5127e852022-10-07 10:35:56 +01002774//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002775
2776/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002777 * \def MBEDTLS_NIST_KW_C
2778 *
2779 * Enable the Key Wrapping mode for 128-bit block ciphers,
2780 * as defined in NIST SP 800-38F. Only KW and KWP modes
2781 * are supported. At the moment, only AES is approved by NIST.
2782 *
2783 * Module: library/nist_kw.c
2784 *
2785 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2786 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002787#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002788
2789/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002790 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002791 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002792 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002793 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002794 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2795 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002796 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002797 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002798 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002799 * Caller: library/constant_time.c
2800 * library/ecdsa.c
2801 * library/ecjpake.c
2802 * library/hkdf.c
2803 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002804 * library/pk.c
2805 * library/pkcs5.c
2806 * library/pkcs12.c
2807 * library/psa_crypto_ecp.c
2808 * library/psa_crypto_rsa.c
2809 * library/rsa.c
2810 * library/ssl_cookie.c
2811 * library/ssl_msg.c
2812 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002813 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002814 * library/x509_crt.c
2815 * library/x509write_crt.c
2816 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002817 *
2818 * Uncomment to enable generic message digest wrappers.
2819 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002821
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002822/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002823 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002824 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002825 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002826 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002827 * Module: library/md5.c
2828 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002829 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002830 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002831 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002832 * This module is required for TLS 1.2 depending on the handshake parameters.
2833 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2834 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002835 *
2836 * \warning MD5 is considered a weak message digest and its use constitutes a
2837 * security risk. If possible, we recommend avoiding dependencies on
2838 * it, and considering stronger message digests instead.
2839 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002840 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002841#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002842
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002843/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002845 *
2846 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002847 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002848 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002849 *
2850 * Module: library/memory_buffer_alloc.c
2851 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002853 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002854 *
2855 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002858
2859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002861 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002862 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2863 *
Simon Butcherd567a232016-03-09 20:19:21 +00002864 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2865 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002866 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002867 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002868 * \note See also our Knowledge Base article about porting to a new
2869 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002870 * 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 +00002871 *
Andres AG788aa4a2016-09-14 14:32:09 +01002872 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002873 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002874 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002875 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002877
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002878/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002879 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002880 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002881 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002882 *
2883 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002884 * Caller: library/asn1write.c
2885 * library/pkcs5.c
2886 * library/pkparse.c
2887 * library/pkwrite.c
2888 * library/rsa.c
2889 * library/x509.c
2890 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002891 * library/x509_crl.c
2892 * library/x509_crt.c
2893 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002894 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002895 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002896 *
2897 * This modules translates between OIDs and internal values.
2898 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002899#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002900
2901/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002903 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002904 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002905 *
2906 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002907 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002908 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002909 * library/x509_crl.c
2910 * library/x509_crt.c
2911 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002912 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002913 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002914 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2915 *
2916 * \warning When parsing password-protected files, if MD5 is provided only by
2917 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002918 *
Paul Bakkercff68422013-09-15 20:43:33 +02002919 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002920 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002921#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002922
2923/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002924 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002925 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002926 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002927 *
2928 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002929 * Caller: library/pkwrite.c
2930 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002931 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002932 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002934 *
2935 * This modules adds support for encoding / writing PEM files.
2936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002937#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002938
2939/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002940 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002941 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002942 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002943 *
2944 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002945 * Caller: library/psa_crypto_rsa.c
2946 * library/ssl_tls.c
2947 * library/ssl*_client.c
2948 * library/ssl*_server.c
2949 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002950 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002951 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002952 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002953 * Uncomment to enable generic public key wrappers.
2954 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002956
2957/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002959 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002960 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002961 *
2962 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002963 * Caller: library/x509_crt.c
2964 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002965 *
Yanray Wang072a0682023-12-05 10:53:04 +08002966 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002967 *
2968 * Uncomment to enable generic public key parse functions.
2969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002971
2972/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002974 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002975 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002976 *
2977 * Module: library/pkwrite.c
2978 * Caller: library/x509write.c
2979 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002980 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002981 *
2982 * Uncomment to enable generic public key write functions.
2983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002985
2986/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002988 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002989 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002990 *
2991 * Module: library/pkcs5.c
2992 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002993 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002994 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002995 * \warning If using a hash that is only provided by PSA drivers, you must
2996 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002997 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002998 * This module adds support for the PKCS#5 functions.
2999 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003001
3002/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003003 * \def MBEDTLS_PKCS7_C
3004 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003005 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003006 * RFC Link - https://tools.ietf.org/html/rfc2315
3007 *
3008 * Module: library/pkcs7.c
3009 *
3010 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003011 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3012 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003013 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003014 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003015 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003016#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003017
3018/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003020 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003021 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003022 * Adds algorithms for parsing PKCS#8 encrypted private keys
3023 *
3024 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003025 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003026 *
Valerio Settie98ad592023-12-28 10:42:12 +01003027 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3028 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003029 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003030 * \warning If using a hash that is only provided by PSA drivers, you must
3031 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003032 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003033 * This module enables PKCS#12 functions.
3034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003036
3037/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003038 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003039 *
3040 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003041 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003042 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3044 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003045 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003046 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003047 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003048 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003049 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003050 * Module: library/platform.c
3051 * Caller: Most other .c files
3052 *
3053 * This module enables abstraction of common (libc) functions.
3054 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003055#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003056
3057/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003058 * \def MBEDTLS_POLY1305_C
3059 *
3060 * Enable the Poly1305 MAC algorithm.
3061 *
3062 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003063 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003064 */
3065#define MBEDTLS_POLY1305_C
3066
3067/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003068 * \def MBEDTLS_PSA_CRYPTO_C
3069 *
3070 * Enable the Platform Security Architecture cryptography API.
3071 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003072 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003073 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003074 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003075 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003076 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3077 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3078 * is enabled in PSA (unless it's fully accelerated, see
3079 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003080 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003081#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003082
3083/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003084 * \def MBEDTLS_PSA_CRYPTO_SE_C
3085 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003086 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003087 * cryptography API.
3088 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003089 * \deprecated This feature is deprecated. Please switch to the PSA driver
3090 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003091 *
Ryan Everett32a64582024-03-05 18:16:18 +00003092 * \warning This feature is not thread-safe, and should not be used in a
3093 * multi-threaded environment.
3094 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003095 * Module: library/psa_crypto_se.c
3096 *
3097 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3098 *
3099 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003100//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003101
3102/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003103 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3104 *
3105 * Enable the Platform Security Architecture persistent key storage.
3106 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003107 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003108 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003109 * Requires: MBEDTLS_PSA_CRYPTO_C,
3110 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3111 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003112 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003113#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003114
3115/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003116 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003117 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003118 * Enable the emulation of the Platform Security Architecture
3119 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003120 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003121 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003122 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003123 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003124 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003125#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003126
3127/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003128 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003129 *
3130 * Enable the RIPEMD-160 hash algorithm.
3131 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003132 * Module: library/ripemd160.c
3133 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003134 *
3135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003137
3138/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003140 *
3141 * Enable the RSA public-key cryptosystem.
3142 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003143 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003144 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003145 * Caller: library/pk.c
3146 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003147 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003148 * library/ssl*_client.c
3149 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003150 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003151 * This module is used by the following key exchanges:
3152 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003153 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003155 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003156#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003157
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003158/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003160 *
3161 * Enable the SHA1 cryptographic hash algorithm.
3162 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003163 * Module: library/sha1.c
3164 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003165 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003166 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003167 * This module is required for TLS 1.2 depending on the handshake parameters,
3168 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003169 *
3170 * \warning SHA-1 is considered a weak message digest and its use constitutes
3171 * a security risk. If possible, we recommend avoiding dependencies
3172 * on it, and considering stronger message digests instead.
3173 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003175#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003176
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003177/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003178 * \def MBEDTLS_SHA224_C
3179 *
3180 * Enable the SHA-224 cryptographic hash algorithm.
3181 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003182 * Module: library/sha256.c
3183 * Caller: library/md.c
3184 * library/ssl_cookie.c
3185 *
3186 * This module adds support for SHA-224.
3187 */
3188#define MBEDTLS_SHA224_C
3189
3190/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003191 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003192 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003193 * Enable the SHA-256 cryptographic hash algorithm.
3194 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003195 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003196 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003197 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003198 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003199 * library/ssl*_client.c
3200 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003201 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003202 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003203 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003206
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003207/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003208 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003209 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003210 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3211 * with the ARMv8 cryptographic extensions if they are available at runtime.
3212 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003213 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003214 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003215 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003216 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003217 * \note Minimum compiler versions for this feature are Clang 4.0,
3218 * armclang 6.6 or GCC 6.0.
3219 *
3220 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3221 * armclang <= 6.9
3222 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003223 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3224 * That name is deprecated, but may still be used as an alternative form for this
3225 * option.
3226 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003227 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3228 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003229 *
3230 * Requires: MBEDTLS_SHA256_C.
3231 *
3232 * Module: library/sha256.c
3233 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003234 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003235 * and use them if available.
3236 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003237//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003238
Dave Rodgmand85277c2023-10-13 09:22:54 +01003239/**
3240 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3241 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003242 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003243 * This name is now deprecated, but may still be used as an alternative form for
3244 * this option.
3245 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003246//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3247
3248/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003249 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003250 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003251 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3252 * with the ARMv8 cryptographic extensions, which must be available at runtime
3253 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003254 *
3255 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003256 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003257 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003258 * \note Minimum compiler versions for this feature are Clang 4.0,
3259 * armclang 6.6 or GCC 6.0.
3260 *
3261 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3262 * armclang <= 6.9
3263 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003264 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003265 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003266 * option.
3267 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003268 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3269 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003270 *
3271 * Requires: MBEDTLS_SHA256_C.
3272 *
3273 * Module: library/sha256.c
3274 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003275 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003276 * unconditionally.
3277 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003278//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003279
Dave Rodgmand85277c2023-10-13 09:22:54 +01003280/**
3281 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3282 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003283 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003284 * This name is now deprecated, but may still be used as an alternative form for
3285 * this option.
3286 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003287//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3288
3289/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003290 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003291 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003292 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003293 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003294 * Module: library/sha512.c
3295 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003296 * library/psa_crypto_hash.c
3297 * library/ssl_tls.c
3298 * library/ssl*_client.c
3299 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003300 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003301 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003302 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003303#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003304
3305/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003306 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003307 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003308 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003309 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003310 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003311 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003312 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003313 * library/ssl_tls.c
3314 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003315 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003316 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003318#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003319
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003320/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003321 * \def MBEDTLS_SHA3_C
3322 *
3323 * Enable the SHA3 cryptographic hash algorithm.
3324 *
3325 * Module: library/sha3.c
3326 *
3327 * This module adds support for SHA3.
3328 */
3329#define MBEDTLS_SHA3_C
3330
3331/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003332 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3333 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003334 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3335 * with the ARMv8 cryptographic extensions if they are available at runtime.
3336 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003337 *
3338 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3339 * for a non-Aarch64 build it will be silently ignored.
3340 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003341 * \note Minimum compiler versions for this feature are Clang 7.0,
3342 * armclang 6.9 or GCC 8.0.
3343 *
3344 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3345 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003346 *
3347 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3348 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3349 *
3350 * Requires: MBEDTLS_SHA512_C.
3351 *
3352 * Module: library/sha512.c
3353 *
3354 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3355 * and use them if available.
3356 */
3357//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3358
3359/**
3360 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3361 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003362 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3363 * with the ARMv8 cryptographic extensions, which must be available at runtime
3364 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003365 *
3366 * \note This allows builds with a smaller code size than with
3367 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3368 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003369 * \note Minimum compiler versions for this feature are Clang 7.0,
3370 * armclang 6.9 or GCC 8.0.
3371 *
3372 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3373 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003374 *
3375 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3376 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3377 *
3378 * Requires: MBEDTLS_SHA512_C.
3379 *
3380 * Module: library/sha512.c
3381 *
3382 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3383 * unconditionally.
3384 */
3385//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3386
3387/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003388 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003389 *
3390 * Enable simple SSL cache implementation.
3391 *
3392 * Module: library/ssl_cache.c
3393 * Caller:
3394 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003398
3399/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003401 *
3402 * Enable basic implementation of DTLS cookies for hello verification.
3403 *
3404 * Module: library/ssl_cookie.c
3405 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003407#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003408
3409/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003410 * \def MBEDTLS_SSL_TICKET_C
3411 *
3412 * Enable an implementation of TLS server-side callbacks for session tickets.
3413 *
3414 * Module: library/ssl_ticket.c
3415 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003416 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003417 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3418 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003419 */
3420#define MBEDTLS_SSL_TICKET_C
3421
3422/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003424 *
3425 * Enable the SSL/TLS client code.
3426 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003427 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003428 * Caller:
3429 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003431 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003432 * This module is required for SSL/TLS client support.
3433 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003434#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003435
Paul Bakker9a736322012-11-14 12:39:52 +00003436/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003437 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003438 *
3439 * Enable the SSL/TLS server code.
3440 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003441 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003442 * Caller:
3443 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003445 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003446 * This module is required for SSL/TLS server support.
3447 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003449
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003450/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003451 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003452 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003453 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003454 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003455 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003456 * Caller: library/ssl*_client.c
3457 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003458 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3460 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003461 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003462 * This module is required for SSL/TLS.
3463 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003464#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003465
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003466/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003467 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003468 *
3469 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003470 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003471 * contexts are not shared between threads. If you do intend to use contexts
3472 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003473 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003474 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003475 *
3476 * Module: library/threading.c
3477 *
3478 * This allows different threading implementations (self-implemented or
3479 * provided).
3480 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003481 * You will have to enable either MBEDTLS_THREADING_ALT or
3482 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003483 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003484 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003486//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003487
3488/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003489 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003490 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003491 * Enable the semi-portable timing interface.
3492 *
Simon Butcherd567a232016-03-09 20:19:21 +00003493 * \note The provided implementation only works on POSIX/Unix (including Linux,
3494 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003495 * module and provide your own implementations of the callbacks needed by
3496 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3497 * your own implementation of the whole module by setting
3498 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003499 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003500 * \note The timing module will include time.h on suitable platforms
3501 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3502 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3503 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003504 * \note See also our Knowledge Base article about porting to a new
3505 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003506 * 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 +00003507 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003508 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003510#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003511
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003512/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003513 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003514 *
3515 * Enable run-time version information.
3516 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003517 * Module: library/version.c
3518 *
3519 * This module provides run-time version information.
3520 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003521#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003522
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003523/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003524 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003525 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003526 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003527 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003528 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003529 * Caller: library/x509_crl.c
3530 * library/x509_crt.c
3531 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003532 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003533 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003534 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3535 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003536 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3537 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003538 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003539 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003542
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003543/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003545 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003546 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003547 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003548 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003549 * Caller: library/ssl_tls.c
3550 * library/ssl*_client.c
3551 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003552 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003553 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003554 *
3555 * This module is required for X.509 certificate parsing.
3556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003557#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003558
3559/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003560 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003561 *
3562 * Enable X.509 CRL parsing.
3563 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003564 * Module: library/x509_crl.c
3565 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003566 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003567 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003568 *
3569 * This module is required for X.509 CRL parsing.
3570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003571#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003572
3573/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003574 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003575 *
3576 * Enable X.509 Certificate Signing Request (CSR) parsing.
3577 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003578 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003579 * Caller: library/x509_crt_write.c
3580 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003581 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003582 *
3583 * This module is used for reading X.509 certificate request.
3584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003585#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003586
3587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003589 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003590 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003591 *
3592 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003593 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003594 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003595 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3596 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003597 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3598 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003599 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003600 * This module is the basis for creating X.509 certificates and CSRs.
3601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003603
3604/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003605 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003606 *
3607 * Enable creating X.509 certificates.
3608 *
3609 * Module: library/x509_crt_write.c
3610 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003611 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003612 *
3613 * This module is required for X.509 certificate creation.
3614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003615#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003616
3617/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003618 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003619 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003620 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003621 *
3622 * Module: library/x509_csr_write.c
3623 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003624 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003625 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003626 * This module is required for X.509 certificate request writing.
3627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003628#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003629
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003630/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003631
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003632/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003633 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003634 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003635 * This section contains Mbed TLS build settings that are not associated
3636 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003637 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003638 * \{
3639 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003640
Gilles Peskinea02c1242022-03-16 17:03:19 +01003641/**
3642 * \def MBEDTLS_CONFIG_FILE
3643 *
3644 * If defined, this is a header which will be included instead of
3645 * `"mbedtls/mbedtls_config.h"`.
3646 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003647 * Unlike other configuration options, this one must be defined on the
3648 * compiler command line: a definition in `mbedtls_config.h` would have
3649 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003650 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003651 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003652 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003653 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003654 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003655 * The value of this symbol is typically a path in double quotes, either
3656 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003657 */
3658//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3659
3660/**
3661 * \def MBEDTLS_USER_CONFIG_FILE
3662 *
3663 * If defined, this is a header which will be included after
3664 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003665 * This allows you to modify the default configuration, including the ability
3666 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003667 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003668 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003669 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003670 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003671 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003672 * The value of this symbol is typically a path in double quotes, either
3673 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003674 */
3675//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3676
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003677/**
3678 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3679 *
3680 * If defined, this is a header which will be included instead of
3681 * `"psa/crypto_config.h"`.
3682 * This header file specifies which cryptographic mechanisms are available
3683 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3684 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3685 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003686 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003687 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003688 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003689 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003690 * The value of this symbol is typically a path in double quotes, either
3691 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003692 */
3693//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3694
3695/**
3696 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3697 *
3698 * If defined, this is a header which will be included after
3699 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003700 * This allows you to modify the default configuration, including the ability
3701 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003702 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003703 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003704 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003705 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003706 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003707 * The value of this symbol is typically a path in double quotes, either
3708 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003709 */
3710//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3711
Gilles Peskineb1176f22023-02-22 22:07:28 +01003712/**
3713 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3714 *
3715 * If defined, this is a header which will be included instead of
3716 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3717 * as the one in Mbed TLS, but with definitions adapted to the platform on
3718 * which the library code will run.
3719 *
3720 * \note The required content of this header can vary from one version of
3721 * Mbed TLS to the next. Integrators who provide an alternative file
3722 * should review the changes in the original file whenever they
3723 * upgrade Mbed TLS.
3724 *
3725 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3726 * non-standard feature of the C language, so this feature is only available
3727 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3728 *
3729 * The value of this symbol is typically a path in double quotes, either
3730 * absolute or relative to a directory on the include search path.
3731 */
3732//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3733
3734/**
3735 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3736 *
3737 * If defined, this is a header which will be included instead of
3738 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3739 * as the one in Mbed TLS, but with definitions adapted to the environment
3740 * in which the library code will run. The typical use for this feature
3741 * is to provide alternative type definitions on the client side in
3742 * client-server integrations of PSA crypto, where operation structures
3743 * contain handles instead of cryptographic data.
3744 *
3745 * \note The required content of this header can vary from one version of
3746 * Mbed TLS to the next. Integrators who provide an alternative file
3747 * should review the changes in the original file whenever they
3748 * upgrade Mbed TLS.
3749 *
3750 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3751 * non-standard feature of the C language, so this feature is only available
3752 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3753 *
3754 * The value of this symbol is typically a path in double quotes, either
3755 * absolute or relative to a directory on the include search path.
3756 */
3757//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3758
Gilles Peskineba4162a2022-04-11 17:04:38 +02003759/** \} name SECTION: General configuration options */
3760
3761/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003762 * \name SECTION: Module configuration options
3763 *
3764 * This section allows for the setting of module specific sizes and
3765 * configuration options. The default values are already present in the
3766 * relevant header files and should suffice for the regular use cases.
3767 *
3768 * Our advice is to enable options and change their values here
3769 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003770 * \{
3771 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003772/* The Doxygen documentation here is used when a user comments out a
3773 * setting and runs doxygen themselves. On the other hand, when we typeset
3774 * the full documentation including disabled settings, the documentation
3775 * in specific modules' header files is used if present. When editing this
3776 * file, make sure that each option is documented in exactly one place,
3777 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3778 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003779
Paul Bakker088c5c52014-04-25 11:11:10 +02003780/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003781//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003782//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003783
Paul Bakker088c5c52014-04-25 11:11:10 +02003784/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003785//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3786//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3787//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3788//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3789//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003790
Paul Bakker088c5c52014-04-25 11:11:10 +02003791/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003792//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3793//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3794//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3795//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003796
Paul Bakker088c5c52014-04-25 11:11:10 +02003797/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003798//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003799//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003800
Paul Bakker088c5c52014-04-25 11:11:10 +02003801/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003802//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3803//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003804//#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 +01003805
Paul Bakker088c5c52014-04-25 11:11:10 +02003806/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003807//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003808
Paul Bakker088c5c52014-04-25 11:11:10 +02003809/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003810//#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 -04003811
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003812/** \def MBEDTLS_PLATFORM_STD_CALLOC
3813 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003814 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003815 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003816 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003817 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003818 * 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 -04003819 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3820 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003821 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003822 */
3823//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003824
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003825/** \def MBEDTLS_PLATFORM_STD_FREE
3826 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003827 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003828 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003829 * 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 -04003830 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3831 * 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 -04003832 */
3833//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003834//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003835//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003836//#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 +02003837//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3838//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003839/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003840//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003841//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3842//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003843//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3844//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3845//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003846
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003847/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003848/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003849//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3850//#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 +02003851//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003852//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003853//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3854//#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 +02003855//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3856//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003857/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003858//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003859//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003860//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3861//#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 +08003862//#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 +08003863//#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 +02003864
Gilles Peskine3f106f72021-09-23 17:42:39 +02003865/** \def MBEDTLS_CHECK_RETURN
3866 *
3867 * This macro is used at the beginning of the declaration of a function
3868 * to indicate that its return value should be checked. It should
3869 * instruct the compiler to emit a warning or an error if the function
3870 * is called without checking its return value.
3871 *
3872 * There is a default implementation for popular compilers in platform_util.h.
3873 * You can override the default implementation by defining your own here.
3874 *
3875 * If the implementation here is empty, this will effectively disable the
3876 * checking of functions' return values.
3877 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003878//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003879
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003880/** \def MBEDTLS_IGNORE_RETURN
3881 *
3882 * This macro requires one argument, which should be a C function call.
3883 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3884 * warning is suppressed.
3885 */
3886//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3887
Gilles Peskineed038902020-11-13 21:33:21 +01003888/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003889/**
Gilles Peskineed038902020-11-13 21:33:21 +01003890 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3891 * PSA crypto subsystem.
3892 *
3893 * If this option is unset:
3894 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003895 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003896 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3897 * on unspecified heuristics.
3898 */
3899//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3900
Steven Cooreman863470a2021-02-15 14:03:19 +01003901/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003902 * Restrict the PSA library to supporting a maximum amount of simultaneously
3903 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3904 * volatile key, or a persistent key which is loaded temporarily by the
3905 * library as part of a crypto operation in flight.
3906 *
3907 * If this option is unset, the library will fall back to a default value of
3908 * 32 keys.
3909 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003910//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003911
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003912/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003913//#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 +00003914
Paul Bakker088c5c52014-04-25 11:11:10 +02003915/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003916//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3917//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003918
Paul Bakker088c5c52014-04-25 11:11:10 +02003919/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003920
Angus Grattond8213d02016-05-25 20:56:48 +10003921/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3922 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003923 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003924 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003925 * This determines the size of the incoming TLS I/O buffer in such a way
3926 * that it is capable of holding the specified amount of plaintext data,
3927 * regardless of the protection mechanism used.
3928 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003929 * \note When using a value less than the default of 16KB on the client, it is
3930 * recommended to use the Maximum Fragment Length (MFL) extension to
3931 * inform the server about this limitation. On the server, there
3932 * is no supported, standardized way of informing the client about
3933 * restriction on the maximum size of incoming messages, and unless
3934 * the limitation has been communicated by other means, it is recommended
3935 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3936 * while keeping the default value of 16KB for the incoming buffer.
3937 *
David Horstmann95d516f2021-05-04 18:36:56 +01003938 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003939 */
3940//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3941
Gilles Peskined3d02902020-03-04 21:35:27 +01003942/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3943 *
3944 * The maximum length of CIDs used for incoming DTLS messages.
3945 *
3946 */
3947//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3948
3949/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3950 *
3951 * The maximum length of CIDs used for outgoing DTLS messages.
3952 *
3953 */
3954//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3955
TRodziewicze8dd7092021-05-12 14:19:11 +02003956/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003957 *
3958 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003959 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003960 *
3961 * The padding will always be chosen so that the length of the
3962 * padded plaintext is a multiple of the value of this option.
3963 *
3964 * Note: A value of \c 1 means that no padding will be used
3965 * for outgoing records.
3966 *
3967 * Note: On systems lacking division instructions,
3968 * a power of two should be preferred.
3969 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003970//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003971
Angus Grattond8213d02016-05-25 20:56:48 +10003972/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3973 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003974 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003975 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003976 * This determines the size of the outgoing TLS I/O buffer in such a way
3977 * that it is capable of holding the specified amount of plaintext data,
3978 * regardless of the protection mechanism used.
3979 *
Angus Grattond8213d02016-05-25 20:56:48 +10003980 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3981 * the default inward 16384 byte buffer to conform to the TLS specification.
3982 *
3983 * The minimum required outward buffer size is determined by the handshake
3984 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3985 * The specific size requirement depends on the configured ciphers and any
3986 * certificate data which is sent during the handshake.
3987 *
David Horstmann95d516f2021-05-04 18:36:56 +01003988 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003989 */
3990//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3991
Hanno Beckere0b150f2018-08-21 15:51:03 +01003992/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3993 *
3994 * Maximum number of heap-allocated bytes for the purpose of
3995 * DTLS handshake message reassembly and future message buffering.
3996 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003997 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003998 * to account for a reassembled handshake message of maximum size,
3999 * together with its reassembly bitmap.
4000 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004001 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004002 * should be sufficient for all practical situations as it allows
4003 * to reassembly a large handshake message (such as a certificate)
4004 * while buffering multiple smaller handshake messages.
4005 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004006 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004007//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004008
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004009//#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 +02004010//#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 +02004011
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004012/**
4013 * Complete list of ciphersuites to use, in order of preference.
4014 *
4015 * \warning No dependency checking is done on that field! This option can only
4016 * be used to restrict the set of available ciphersuites. It is your
4017 * responsibility to make sure the needed modules are active.
4018 *
4019 * Use this to save a few hundred bytes of ROM (default ordering of all
4020 * available ciphersuites) and a few to a few hundred bytes of RAM.
4021 *
4022 * The value below is only an example, not the default.
4023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004024//#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 +02004025
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004026/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004027 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4028 *
4029 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004030 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004031 *
4032 * It must be positive and smaller than UINT32_MAX.
4033 *
4034 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4035 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004036 */
4037//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4038
4039/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004040 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4041 *
Jerry Yucf913512023-11-14 11:06:52 +08004042 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004043 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004044 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004045 * - The client ticket age is the time difference between the time when the
4046 * client proposes to the server to use the ticket and the time the client
4047 * received the ticket from the server.
4048 * - The server ticket age is the time difference between the time when the
4049 * server receives a proposition from the client to use the ticket and the
4050 * time when the ticket was created by the server.
4051 *
Jerry Yucf913512023-11-14 11:06:52 +08004052 * The ages might be different due to the client and server clocks not running
4053 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4054 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4055 * 6s, thus in the worst case clients and servers must sync up their system time
4056 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004057 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004058 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004059 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004060//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004061
4062/**
4063 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4064 *
4065 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4066 *
4067 * This must be less than 256.
4068 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004069//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004070
4071/**
4072 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4073 *
4074 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4075 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4076 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4077 *
4078 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004079//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004080
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004081/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004082//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004083//#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 +01004084
Gilles Peskine611179c2022-04-13 23:04:48 +02004085/** \} name SECTION: Module configuration options */