blob: 452889955fa292f2e214259f31571c6463b38380 [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
Jaeden Amero15263302017-09-21 12:53:48 +0100357//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300358//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200359//#define MBEDTLS_MD5_ALT
360//#define MBEDTLS_RIPEMD160_ALT
361//#define MBEDTLS_SHA1_ALT
362//#define MBEDTLS_SHA256_ALT
363//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000364
Paul Bakker90995b52013-06-24 19:20:35 +0200365/**
TRodziewicz75628d52021-06-18 12:56:27 +0200366 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200367 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200368 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100369 * alternate core implementation of symmetric crypto or hash function. Keep in
370 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200371 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200372 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200374 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200375 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376 * no longer provide the mbedtls_sha1_process() function, but it will still provide
377 * the other function (using your mbedtls_sha1_process() function) and the definition
378 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200379 * with this definition.
380 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200381 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100382 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
383 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200384 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200385 * Uncomment a macro to enable alternate implementation of the corresponding
386 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100387 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200388 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100389 * constitutes a security risk. If possible, we recommend avoiding
390 * dependencies on them, and considering stronger message digests
391 * and ciphers instead.
392 *
Janos Follath1231d212019-01-07 15:01:32 +0000393 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
394 * enabled, then the deterministic ECDH signature functions pass the
395 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
396 * alternative implementations should use the RNG only for generating
397 * the ephemeral key and nothing else. If this is not possible, then
398 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200399 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000400 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200402//#define MBEDTLS_MD5_PROCESS_ALT
403//#define MBEDTLS_RIPEMD160_PROCESS_ALT
404//#define MBEDTLS_SHA1_PROCESS_ALT
405//#define MBEDTLS_SHA256_PROCESS_ALT
406//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200407//#define MBEDTLS_DES_SETKEY_ALT
408//#define MBEDTLS_DES_CRYPT_ECB_ALT
409//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200410//#define MBEDTLS_AES_SETKEY_ENC_ALT
411//#define MBEDTLS_AES_SETKEY_DEC_ALT
412//#define MBEDTLS_AES_ENCRYPT_ALT
413//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300414//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300415//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300416//#define MBEDTLS_ECDSA_VERIFY_ALT
417//#define MBEDTLS_ECDSA_SIGN_ALT
418//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200419
420/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200421 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200422 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200423 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200424 * hardware entropy collector.
425 *
426 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000427 * prototype as declared in library/entropy_poll.h, and accept NULL as first
428 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200429 *
430 * Uncomment to use your own hardware entropy collector.
431 */
432//#define MBEDTLS_ENTROPY_HARDWARE_ALT
433
434/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200435 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000436 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100437 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000438 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100439 * Uncomment this macro to use precomputed AES tables stored in ROM.
440 * Comment this macro to generate AES tables in RAM at runtime.
441 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100442 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
443 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100444 * initialization time before the first AES operation can be performed.
445 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
446 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
447 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100448 *
449 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200451//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000452
453/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100454 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200455 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100456 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200457 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100458 * Uncommenting this macro omits 75% of the AES tables from
459 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
460 * by computing their values on the fly during operations
461 * (the tables are entry-wise rotations of one another).
462 *
463 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100464 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100465 * runtime. Specifically, one has to compare 4 accesses within
466 * different tables to 4 accesses with additional arithmetic
467 * operations within the same table. The performance gain/loss
468 * depends on the system and memory details.
469 *
470 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200471 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100472//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200473
474/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800475 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
476 *
477 * Use only 128-bit keys in AES operations to save ROM.
478 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800479 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800480 * or 256-bit keys.
481 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800482 * Uncommenting this macro reduces the size of AES code by ~300 bytes
483 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800484 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800485 * Module: library/aes.c
486 *
487 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800488 */
489//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
490
Gilles Peskinea8861e02023-09-05 20:20:51 +0200491/*
492 * Disable plain C implementation for AES.
493 *
494 * When the plain C implementation is enabled, and an implementation using a
495 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
496 * detection will be used to select between them.
497 *
498 * If only one implementation is present, runtime detection will not be used.
499 * This configuration will crash at runtime if running on a CPU without the
500 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
501 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
502 */
503//#define MBEDTLS_AES_USE_HARDWARE_ONLY
504
Arto Kinnunen732ca322023-04-14 14:26:10 +0800505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200506 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200507 *
508 * Use less ROM for the Camellia implementation (saves about 768 bytes).
509 *
510 * Uncomment this macro to use less memory for Camellia.
511 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200512//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200513
514/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200515 * \def MBEDTLS_CHECK_RETURN_WARNING
516 *
517 * If this macro is defined, emit a compile-time warning if application code
518 * calls a function without checking its return value, but the return value
519 * should generally be checked in portable applications.
520 *
521 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
522 * implemented. Otherwise this option has no effect.
523 *
524 * Uncomment to get warnings on using fallible functions without checking
525 * their return value.
526 *
527 * \note This feature is a work in progress.
528 * Warnings will be added to more functions in the future.
529 *
530 * \note A few functions are considered critical, and ignoring the return
531 * value of these functions will trigger a warning even if this
532 * macro is not defined. To completely disable return value check
533 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
534 */
535//#define MBEDTLS_CHECK_RETURN_WARNING
536
537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200538 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200539 *
540 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200543
544/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000546 *
547 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200549#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000550
551/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200552 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000553 *
554 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000557
558/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100559 * \def MBEDTLS_CIPHER_MODE_OFB
560 *
561 * Enable Output Feedback mode (OFB) for symmetric ciphers.
562 */
563#define MBEDTLS_CIPHER_MODE_OFB
564
565/**
566 * \def MBEDTLS_CIPHER_MODE_XTS
567 *
568 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
569 */
570#define MBEDTLS_CIPHER_MODE_XTS
571
572/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200573 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000574 *
575 * Enable NULL cipher.
576 * Warning: Only do so when you know what you are doing. This allows for
577 * encryption or channels without any security!
578 *
Ronald Croncee42702021-04-26 11:34:44 +0200579 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200580 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
581 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
582 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
583 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
584 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
585 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
586 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
587 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
588 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
589 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
590 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
591 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
592 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
593 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
594 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
595 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
596 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
597 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
598 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000599 *
600 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000603
604/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100605 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200606 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100607 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
608 * specific padding modes in the cipher layer with cipher modes that support
609 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200610 *
611 * If you disable all padding modes, only full blocks can be used with CBC.
612 *
613 * Enable padding modes in the cipher layer.
614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200615#define MBEDTLS_CIPHER_PADDING_PKCS7
616#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
617#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
618#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200619
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200620/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
621 *
622 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800623 * Without this, CTR_DRBG uses a 256-bit key
624 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200625 */
626//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
627
Paul Bakker48e93c82013-08-14 12:21:18 +0200628/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200629 * Enable the verified implementations of ECDH primitives from Project Everest
630 * (currently only Curve25519). This feature changes the layout of ECDH
631 * contexts and therefore is a compatibility break for applications that access
632 * fields of a mbedtls_ecdh_context structure directly. See also
633 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000634 *
635 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
636 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200637 */
638//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
639
640/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100641 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200642 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100643 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
644 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200645 *
646 * Comment macros to disable the curve and functions for it
647 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200648/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
650#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
651#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
652#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
653#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
654#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
655#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
656#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
657#define MBEDTLS_ECP_DP_BP256R1_ENABLED
658#define MBEDTLS_ECP_DP_BP384R1_ENABLED
659#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200660/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200661#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000662#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200663
664/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200666 *
667 * Enable specific 'modulo p' routines for each NIST prime.
668 * Depending on the prime and architecture, makes operations 4 to 8 times
669 * faster on the corresponding curve.
670 *
671 * Comment this macro to disable NIST curves optimisation.
672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200673#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200674
675/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200676 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100677 *
678 * Enable "non-blocking" ECC operations that can return early and be resumed.
679 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200680 * This allows various functions to pause by returning
681 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
682 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
683 * order to further progress and eventually complete their operation. This is
684 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
685 * number of ECC operations a function may perform before pausing; see
686 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100687 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200688 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200689 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100690 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100691 * This option:
692 * - Adds xxx_restartable() variants of existing operations in the
693 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100694 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
695 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100696 * - ECDSA: signature generation & verification;
697 * - PK: signature generation & verification;
698 * - X509: certificate chain verification.
699 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
700 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
701 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
702 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000703 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100704 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100705 * - verification of the server's key exchange signature;
706 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100707 * - generation of the client's signature if client authentication is used,
708 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100709 *
710 * \note In the cases above, the usual SSL/TLS functions, such as
711 * mbedtls_ssl_handshake(), can now return
712 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200713 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100714 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
715 * restartable operations in PK, X.509 and TLS (see above) are not
716 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100717 * PSA, and are not restartable. These are temporary limitations that
718 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200719 *
Ron Eldor19779c42018-11-05 16:58:13 +0200720 * \note This option only works with the default software implementation of
721 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100722 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100723 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100724 * Requires: MBEDTLS_ECP_C
725 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100726 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100727 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200728//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100729
730/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200731 * Uncomment to enable using new bignum code in the ECC modules.
732 *
733 * \warning This is currently experimental, incomplete and therefore should not
734 * be used in production.
735 */
736//#define MBEDTLS_ECP_WITH_MPI_UINT
737
738/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200739 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100740 *
741 * Enable deterministic ECDSA (RFC 6979).
742 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
743 * may result in a compromise of the long-term signing key. This is avoided by
744 * the deterministic variant.
745 *
John Durkop36a82e52020-10-26 09:39:05 -0700746 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100747 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100748 * Comment this macro to disable deterministic ECDSA.
749 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200750#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100751
752/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200753 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200754 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200755 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200756 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200757 * This enables the following ciphersuites (if other requisites are
758 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200759 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
760 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
761 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
762 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
763 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
764 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
765 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
766 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
767 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
768 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200769 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200770#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200771
772/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200773 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200774 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200775 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200776 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200777 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200778 *
779 * This enables the following ciphersuites (if other requisites are
780 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
782 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
783 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
784 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
785 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
786 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
787 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
788 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
789 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
790 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100791 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100792 * \warning Using DHE constitutes a security risk as it
793 * is not possible to validate custom DH parameters.
794 * If possible, it is recommended users should consider
795 * preferring other methods of key exchange.
796 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100797 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200798 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200799#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200800
801/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200803 *
804 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
805 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200806 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200807 *
808 * This enables the following ciphersuites (if other requisites are
809 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
811 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
812 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
813 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
814 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
815 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200816 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200817#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200818
819/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200820 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200821 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200822 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200823 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200824 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
825 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200826 *
827 * This enables the following ciphersuites (if other requisites are
828 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200829 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
830 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
831 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
832 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
833 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
834 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
835 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
836 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
837 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
838 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200839 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200841
842/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200843 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200844 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200845 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200846 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200847 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
848 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200849 *
850 * This enables the following ciphersuites (if other requisites are
851 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200852 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
853 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
854 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
855 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
856 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
857 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
858 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
859 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
860 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
861 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
862 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
863 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866
867/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200869 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200870 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200871 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
873 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200874 *
875 * This enables the following ciphersuites (if other requisites are
876 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200877 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
878 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
879 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
880 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
881 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
882 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
883 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
884 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
885 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
886 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
887 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
888 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100889 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100890 * \warning Using DHE constitutes a security risk as it
891 * is not possible to validate custom DH parameters.
892 * If possible, it is recommended users should consider
893 * preferring other methods of key exchange.
894 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100895 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200896 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200898
899/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200900 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200901 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200902 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200903 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200904 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
905 * MBEDTLS_RSA_C
906 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200908 *
909 * This enables the following ciphersuites (if other requisites are
910 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200911 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
913 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
914 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
915 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
916 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
917 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
918 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
919 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
920 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200921 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200922#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200923
924/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200926 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200927 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200928 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200929 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
930 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
931 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200932 *
933 * This enables the following ciphersuites (if other requisites are
934 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
938 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
939 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
940 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
941 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
942 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
943 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
944 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200945 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200946#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200947
948/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100950 *
951 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
952 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200953 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
954 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
955 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100956 *
957 * This enables the following ciphersuites (if other requisites are
958 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
960 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
961 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
962 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
963 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
964 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
965 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
966 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
967 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
968 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100971
972/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200973 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100974 *
975 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
976 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200977 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
978 * MBEDTLS_RSA_C
979 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100980 *
981 * This enables the following ciphersuites (if other requisites are
982 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200983 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
984 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
985 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
986 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
987 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
988 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
989 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
990 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
991 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
992 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100993 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100995
996/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200997 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
998 *
999 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1000 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001001 * \warning This is currently experimental. EC J-PAKE support is based on the
1002 * Thread v1.0.0 specification; incompatible changes to the specification
1003 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001004 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001005 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001006 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001007 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1008 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001009 * \warning If SHA-256 is provided only by a PSA driver, you must call
1010 * psa_crypto_init() before the first hanshake (even if
1011 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1012 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001013 * This enables the following ciphersuites (if other requisites are
1014 * enabled as well):
1015 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1016 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001017//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001018
1019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001021 *
1022 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1023 * RFC 5915 and RFC 5480.
1024 *
1025 * Currently this means parsing the SpecifiedECDomain choice of EC
1026 * parameters (only known groups are supported, not arbitrary domains, to
1027 * avoid validation issues).
1028 *
1029 * Disable if you only need to support RFC 5915 + 5480 key formats.
1030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001032
1033/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001034 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1035 *
1036 * Enable the support for parsing public keys of type Short Weierstrass
1037 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001038 * compressed point format. This parsing is done through ECP module's functions.
1039 *
1040 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1041 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1042 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001043 */
1044#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1045
1046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001048 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049 * Enable a dummy error function to make use of mbedtls_strerror() in
1050 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1051 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001052 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1054 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001055 *
1056 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001057 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001060
1061/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001063 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001064 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001065 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001067 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001069
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001070/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001071 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001072 *
1073 * Enable functions that use the filesystem.
1074 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001076
1077/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001079 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001080 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001081 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001082 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001083 * application.
1084 *
1085 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001086 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001087//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001088
1089/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001091 *
1092 * Do not use built-in platform entropy functions.
1093 * This is useful if your platform does not support
1094 * standards like the /dev/urandom or Windows CryptoAPI.
1095 *
1096 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001097 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001099
1100/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001102 *
1103 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1104 * default SHA-512 based one (if both are available).
1105 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001107 *
1108 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1109 * if you have performance concerns.
1110 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001111 * This option is only useful if both MBEDTLS_SHA256_C and
1112 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001113 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001115
1116/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001117 * \def MBEDTLS_ENTROPY_NV_SEED
1118 *
1119 * Enable the non-volatile (NV) seed file-based entropy source.
1120 * (Also enables the NV seed read/write functions in the platform layer)
1121 *
1122 * This is crucial (if not required) on systems that do not have a
1123 * cryptographic entropy source (in hardware or kernel) available.
1124 *
1125 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1126 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001127 * \note The read/write functions that are used by the entropy source are
1128 * determined in the platform layer, and can be modified at runtime and/or
1129 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1130 *
1131 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001132 * with regular fopen(), please make sure you make a seedfile with the
1133 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1134 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001135 * and written to or you will get an entropy source error! The default
1136 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1137 * bytes from the file.
1138 *
1139 * \note The entropy collector will write to the seed file before entropy is
1140 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001141 */
1142//#define MBEDTLS_ENTROPY_NV_SEED
1143
Ronald Cron71016a92020-08-28 19:01:50 +02001144/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001145 *
Ronald Cron71016a92020-08-28 19:01:50 +02001146 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001147 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001148 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1149 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001150 *
1151 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001152 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001153 */
Ronald Cron71016a92020-08-28 19:01:50 +02001154//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001155
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001158 *
1159 * Enable debugging of buffer allocator memory issues. Automatically prints
1160 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1161 * function for 'debug output' of allocated memory.
1162 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001163 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001164 *
1165 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001168
1169/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001171 *
1172 * Include backtrace information with each allocated block.
1173 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001175 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001176 *
1177 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001178 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001180
1181/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001182 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001183 *
1184 * Support external private RSA keys (eg from a HSM) in the PK layer.
1185 *
1186 * Comment this macro to disable support for external private RSA keys.
1187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001189
1190/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001192 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001193 * Enable support for PKCS#1 v1.5 encoding.
1194 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001195 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001196 *
Paul Bakker48377d92013-08-30 12:06:24 +02001197 * This enables support for PKCS#1 v1.5 operations.
1198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001200
1201/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001203 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001204 * Enable support for PKCS#1 v2.1 encoding.
1205 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001206 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001207 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001208 * \warning If using a hash that is only provided by PSA drivers, you must
1209 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001210 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001211 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001213#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001214
Steven Cooreman6801f082021-02-19 17:21:22 +01001215/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1216 *
1217 * Enable support for platform built-in keys. If you enable this feature,
1218 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1219 * See the documentation of that function for more information.
1220 *
1221 * Built-in keys are typically derived from a hardware unique key or
1222 * stored in a secure element.
1223 *
1224 * Requires: MBEDTLS_PSA_CRYPTO_C.
1225 *
1226 * \warning This interface is experimental and may change or be removed
1227 * without notice.
1228 */
1229//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1230
Ronald Cron3768ac12021-01-26 16:58:00 +01001231/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1232 *
1233 * Enable support for PSA crypto client.
1234 *
1235 * \note This option allows to include the code necessary for a PSA
1236 * crypto client when the PSA crypto implementation is not included in
1237 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1238 * code to set and get PSA key attributes.
1239 * The development of PSA drivers partially relying on the library to
1240 * fulfill the hardware gaps is another possible usage of this option.
1241 *
1242 * \warning This interface is experimental and may change or be removed
1243 * without notice.
1244 */
1245//#define MBEDTLS_PSA_CRYPTO_CLIENT
1246
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001247/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1248 *
1249 * Make the PSA Crypto module use an external random generator provided
1250 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1251 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001252 * \note This random generator must deliver random numbers with cryptographic
1253 * quality and high performance. It must supply unpredictable numbers
1254 * with a uniform distribution. The implementation of this function
1255 * is responsible for ensuring that the random generator is seeded
1256 * with sufficient entropy. If you have a hardware TRNG which is slow
1257 * or delivers non-uniform output, declare it as an entropy source
1258 * with mbedtls_entropy_add_source() instead of enabling this option.
1259 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001260 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001261 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1262 * and define a function called mbedtls_psa_external_get_random()
1263 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001264 * ```
1265 * psa_status_t mbedtls_psa_external_get_random(
1266 * mbedtls_psa_external_random_context_t *context,
1267 * uint8_t *output, size_t output_size, size_t *output_length);
1268 * );
1269 * ```
1270 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001271 * The function must fill the \c output buffer with \c output_size bytes
1272 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001273 *
1274 * Requires: MBEDTLS_PSA_CRYPTO_C
1275 *
1276 * \warning If you enable this option, code that uses the PSA cryptography
1277 * interface will not use any of the entropy sources set up for
1278 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1279 * enables.
1280 *
1281 * \note This option is experimental and may be removed without notice.
1282 */
1283//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1284
Paul Bakker9dcc3222011-03-08 14:16:06 +00001285/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001286 * \def MBEDTLS_PSA_CRYPTO_SPM
1287 *
1288 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1289 * Partition Manager) integration which separates the code into two parts: a
1290 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1291 * Environment).
1292 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001293 * If you enable this option, your build environment must include a header
1294 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1295 * header files, or in another directory on the compiler's include search
1296 * path). Alternatively, your platform may customize the header
1297 * `psa/crypto_platform.h`, in which case it can skip or replace the
1298 * inclusion of `"crypto_spe.h"`.
1299 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001300 * Module: library/psa_crypto.c
1301 * Requires: MBEDTLS_PSA_CRYPTO_C
1302 *
1303 */
1304//#define MBEDTLS_PSA_CRYPTO_SPM
1305
1306/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001307 * Uncomment to enable p256-m. This is an alternative implementation of
1308 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1309 * Compared to the default implementation:
1310 *
1311 * - p256-m has a much smaller code size and RAM footprint.
1312 * - p256-m is only available via the PSA API. This includes the pk module
1313 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1314 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1315 * over the core arithmetic, or deterministic derivation of keys.
1316 *
1317 * We recommend enabling this option if your application uses the PSA API
1318 * and the only elliptic curve support it needs is ECDH and ECDSA over
1319 * SECP256R1.
1320 *
1321 * If you enable this option, you do not need to enable any ECC-related
1322 * MBEDTLS_xxx option. You do need to separately request support for the
1323 * cryptographic mechanisms through the PSA API:
1324 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1325 * configuration;
1326 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1327 * - #PSA_WANT_ECC_SECP_R1_256;
1328 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1329 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1330 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1331 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1332 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001333 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001334 * \note To benefit from the smaller code size of p256-m, make sure that you
1335 * do not enable any ECC-related option not supported by p256-m: this
1336 * would cause the built-in ECC implementation to be built as well, in
1337 * order to provide the required option.
1338 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001339 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1340 * SECP256R1 are disabled as they are not supported by this driver.
1341 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1342 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001343 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001344 */
1345//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1346
1347/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001348 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001349 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001350 * Enable support for entropy injection at first boot. This feature is
1351 * required on systems that do not have a built-in entropy source (TRNG).
1352 * This feature is currently not supported on systems that have a built-in
1353 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001354 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001355 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001356 *
1357 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001358//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001359
1360/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001361 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001362 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001363 * Assume all buffers passed to PSA functions are owned exclusively by the
1364 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001365 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001366 * This option may be enabled if all buffers passed to any PSA function reside
1367 * in memory that is accessible only to the PSA function during its execution.
1368 *
1369 * This option MUST be disabled whenever buffer arguments are in memory shared
1370 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001371 * across a trust boundary.
1372 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001373 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001374 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001375 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001376 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001377 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001378//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001379
1380/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001381 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001382 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001383 * Do not use the Chinese Remainder Theorem
1384 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001385 *
1386 * Uncomment this macro to disable the use of CRT in RSA.
1387 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001390
1391/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001393 *
1394 * Enable the checkup functions (*_self_test).
1395 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001396#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001397
1398/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001399 * \def MBEDTLS_SHA256_SMALLER
1400 *
1401 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1402 * lower performance.
1403 *
Adam Wolf039080f2019-09-10 09:53:08 -05001404 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001405 * performance and size. This version optimizes more aggressively for size at
1406 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1407 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1408 * 30%.
1409 *
1410 * Uncomment to enable the smaller implementation of SHA256.
1411 */
1412//#define MBEDTLS_SHA256_SMALLER
1413
1414/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001415 * \def MBEDTLS_SHA512_SMALLER
1416 *
1417 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1418 * lower performance.
1419 *
1420 * Uncomment to enable the smaller implementation of SHA512.
1421 */
1422//#define MBEDTLS_SHA512_SMALLER
1423
1424/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001425 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001426 *
1427 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001428 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001429 * with other servers, only debugging of failures is harder.
1430 *
1431 * The advantage of not sending alert messages, is that no information is given
1432 * about reasons for failures thus preventing adversaries of gaining intel.
1433 *
1434 * Enable sending of all alert messages
1435 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001436#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001437
1438/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001439 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1440 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001441 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001442 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001443 * in the underlying transport. The CID functionality is described
1444 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001445 *
1446 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001447 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1448 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1449 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001450 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001451 * The maximum lengths of outgoing and incoming CIDs can be configured
1452 * through the options
1453 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1454 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1455 *
1456 * Requires: MBEDTLS_SSL_PROTO_DTLS
1457 *
1458 * Uncomment to enable the Connection ID extension.
1459 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001460#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1461
1462
1463/**
1464 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1465 *
1466 * Defines whether RFC 9146 (default) or the legacy version
1467 * (version draft-ietf-tls-dtls-connection-id-05,
1468 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1469 * is used.
1470 *
1471 * Set the value to 0 for the standard version, and
1472 * 1 for the legacy draft version.
1473 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001474 * \deprecated Support for the legacy version of the DTLS
1475 * Connection ID feature is deprecated. Please
1476 * switch to the standardized version defined
1477 * in RFC 9146 enabled by utilizing
1478 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1479 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1480 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001481 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1482 */
1483#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001484
1485/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001486 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1487 *
1488 * Enable asynchronous external private key operations in SSL. This allows
1489 * you to configure an SSL connection to call an external cryptographic
1490 * module to perform private key operations instead of performing the
1491 * operation inside the library.
1492 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001493 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001494 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001495//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001496
1497/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001498 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1499 *
1500 * Enable serialization of the TLS context structures, through use of the
1501 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1502 *
1503 * This pair of functions allows one side of a connection to serialize the
1504 * context associated with the connection, then free or re-use that context
1505 * while the serialized state is persisted elsewhere, and finally deserialize
1506 * that state to a live context for resuming read/write operations on the
1507 * connection. From a protocol perspective, the state of the connection is
1508 * unaffected, in particular this is entirely transparent to the peer.
1509 *
1510 * Note: this is distinct from TLS session resumption, which is part of the
1511 * protocol and fully visible by the peer. TLS session resumption enables
1512 * establishing new connections associated to a saved session with shorter,
1513 * lighter handshakes, while context serialization is a local optimization in
1514 * handling a single, potentially long-lived connection.
1515 *
1516 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1517 * saved after the handshake to allow for more efficient serialization, so if
1518 * you don't need this feature you'll save RAM by disabling it.
1519 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001520 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1521 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001522 * Comment to disable the context serialization APIs.
1523 */
1524#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1525
1526/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001527 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001528 *
1529 * Enable the debug messages in SSL module for all issues.
1530 * Debug messages have been disabled in some places to prevent timing
1531 * attacks due to (unbalanced) debugging function calls.
1532 *
1533 * If you need all error reporting you should enable this during debugging,
1534 * but remove this for production servers that should log as well.
1535 *
1536 * Uncomment this macro to report all debug messages on errors introducing
1537 * a timing side-channel.
1538 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001541
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001542/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001543 *
1544 * Enable support for Encrypt-then-MAC, RFC 7366.
1545 *
1546 * This allows peers that both support it to use a more robust protection for
1547 * ciphersuites using CBC, providing deep resistance against timing attacks
1548 * on the padding or underlying cipher.
1549 *
1550 * This only affects CBC ciphersuites, and is useless if none is defined.
1551 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001552 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001553 *
1554 * Comment this macro to disable support for Encrypt-then-MAC
1555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001557
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001559 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001560 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1561 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001562 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001563 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001564 * attacks, but it is recommended to always use it (even if you disable
1565 * renegotiation), since it actually fixes a more fundamental issue in the
1566 * original SSL/TLS design, and has implications beyond Triple Handshake.
1567 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001568 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001569 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001570 * Comment this macro to disable support for Extended Master Secret.
1571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001572#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001573
Paul Bakkerd66f0702013-01-31 16:57:45 +01001574/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001575 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1576 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001577 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001578 * giving access to the peer's certificate after completion of the handshake.
1579 *
1580 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1581 * recommended to disable this option for reduced RAM usage.
1582 *
1583 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1584 * defined, but always returns \c NULL.
1585 *
1586 * \note This option has no influence on the protection against the
1587 * triple handshake attack. Even if it is disabled, Mbed TLS will
1588 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001589 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001590 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001591 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001592 *
1593 * Comment this macro to disable storing the peer's certificate
1594 * after the handshake.
1595 */
1596#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1597
1598/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001599 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001600 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001601 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001602 *
1603 * The two main uses of renegotiation are (1) refresh keys on long-lived
1604 * connections and (2) client authentication after the initial handshake.
1605 * If you don't need renegotiation, it's probably better to disable it, since
1606 * it has been associated with security issues in the past and is easy to
1607 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001608 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001609 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1610 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001611 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001612 *
1613 * \note Even if this option is disabled, both client and server are aware
1614 * of the Renegotiation Indication Extension (RFC 5746) used to
1615 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1616 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1617 * configuration of this extension).
1618 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001620#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001621
1622/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001623 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001624 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001625 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001626 *
1627 * Comment this macro to disable support for the max_fragment_length extension
1628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001630
1631/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001632 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1633 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001634 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001635 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001636 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1637 *
1638 * Uncomment this macro to enable support for the record_size_limit extension
1639 */
1640//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1641
1642/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001644 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001645 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001646 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001647 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001648 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1649 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001650 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001651 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001652 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001653 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1654 * are only provided by PSA drivers, you must call psa_crypto_init() before
1655 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001656 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001657 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001659#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001660
1661/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001662 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001663 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001664 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001665 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001666 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001667 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001668 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001669 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001670 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001671 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001672 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1673 * directly performed by TLS 1.3 code. As a consequence, you must
1674 * call psa_crypto_init() before the first TLS 1.3 handshake.
1675 *
1676 * \note Cryptographic operations performed indirectly via another module
1677 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1678 * running handshake hash) only use PSA crypto if
1679 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001680 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001681 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001682 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001683#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001684
1685/**
Ronald Cronab65c522021-11-24 10:47:20 +01001686 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1687 *
1688 * Enable TLS 1.3 middlebox compatibility mode.
1689 *
1690 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1691 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1692 * expecting TLS 1.2 traffic.
1693 *
1694 * Turning on the compatibility mode comes at the cost of a few added bytes
1695 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1696 * that don't use it. Therefore, unless transmission bandwidth is critical and
1697 * you know that middlebox compatibility issues won't occur, it is therefore
1698 * recommended to set this option.
1699 *
1700 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001701 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1702 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001703 *
1704 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001705#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001706
1707/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001708 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1709 *
1710 * Enable TLS 1.3 PSK key exchange mode.
1711 *
1712 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1713 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1714 * effect on the build.
1715 *
1716 */
1717#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1718
1719/**
1720 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1721 *
1722 * Enable TLS 1.3 ephemeral key exchange mode.
1723 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001724 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001725 * MBEDTLS_X509_CRT_PARSE_C
1726 * and at least one of:
1727 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1728 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001729 *
1730 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1731 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1732 * effect on the build.
1733 *
1734 */
1735#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1736
1737/**
1738 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1739 *
1740 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1741 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001742 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001743 *
1744 * Comment to disable support for the PSK ephemeral key exchange mode in
1745 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1746 * have any effect on the build.
1747 *
1748 */
1749#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1750
1751/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 * \def MBEDTLS_SSL_EARLY_DATA
1753 *
1754 * Enable support for RFC 8446 TLS 1.3 early data.
1755 *
1756 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1757 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1758 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1759 *
1760 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1761 * is not enabled, this option does not have any effect on the build.
1762 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001763 * \note The maximum amount of early data can be set with
1764 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1765 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001767//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001768
1769/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001770 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001771 *
1772 * Enable support for DTLS (all available versions).
1773 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001774 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001775 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001776 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001777 *
1778 * Comment this macro to disable support for DTLS
1779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001780#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001781
1782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001784 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001785 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001786 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001787 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001788 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001789#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001790
1791/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001792 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001793 *
1794 * Enable support for the anti-replay mechanism in DTLS.
1795 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796 * Requires: MBEDTLS_SSL_TLS_C
1797 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001798 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001799 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001800 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001801 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001802 * Comment this to disable anti-replay in DTLS.
1803 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001805
1806/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001808 *
1809 * Enable support for HelloVerifyRequest on DTLS servers.
1810 *
1811 * This feature is highly recommended to prevent DTLS servers being used as
1812 * amplifiers in DoS attacks against other hosts. It should always be enabled
1813 * unless you know for sure amplification cannot be a problem in the
1814 * environment in which your server operates.
1815 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001816 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001817 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001818 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001819 *
1820 * Comment this to disable support for HelloVerifyRequest.
1821 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001823
1824/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001825 * \def MBEDTLS_SSL_DTLS_SRTP
1826 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001827 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001828 * through the use_srtp extension.
1829 *
1830 * \note This feature provides the minimum functionality required
1831 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1832 * the associated SRTP packet protection key material.
1833 * In particular, the SRTP packet protection itself, as well as the
1834 * demultiplexing of RTP and DTLS packets at the datagram layer
1835 * (see Section 5 of RFC 5764), are not handled by this feature.
1836 * Instead, after successful completion of a handshake negotiating
1837 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001838 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001839 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1840 * (this is implemented in the SSL example programs).
1841 * The resulting key should then be passed to an SRTP stack.
1842 *
1843 * Setting this option enables the runtime API
1844 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1845 * through which the supported DTLS-SRTP protection
1846 * profiles can be configured. You must call this API at
1847 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001848 *
1849 * Requires: MBEDTLS_SSL_PROTO_DTLS
1850 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001851 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001852 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001853//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001854
1855/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001856 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1857 *
1858 * Enable server-side support for clients that reconnect from the same port.
1859 *
1860 * Some clients unexpectedly close the connection and try to reconnect using the
1861 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001862 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001863 * flag enables that support.
1864 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001865 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001866 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001867 * Comment this to disable support for clients reusing the source port.
1868 */
1869#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1870
1871/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001873 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001874 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001875 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001876 * session store remains the responsibility of the application, though).
1877 * Server-side, you also need to provide callbacks for writing and parsing
1878 * tickets, including authenticated encryption and key management. Example
1879 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001880 *
1881 * Comment this macro to disable support for SSL session tickets
1882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001884
1885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001887 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001888 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001889 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001891 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001892 * Comment this macro to disable support for server name indication in SSL
1893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001895
1896/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001897 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1898 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001899 * When this option is enabled, the SSL buffer will be resized automatically
1900 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001901 *
1902 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001903 */
1904//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1905
1906/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001907 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1908 *
1909 * Enable testing of the constant-flow nature of some sensitive functions with
1910 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001911 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001912 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001913 * This setting requires compiling with clang -fsanitize=memory. The test
1914 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001915 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001916 * \warning This macro is only used for extended testing; it is not considered
1917 * part of the library's API, so it may change or disappear at any time.
1918 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001919 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001920 */
1921//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1922
1923/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001924 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1925 *
1926 * Enable testing of the constant-flow nature of some sensitive functions with
1927 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001928 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001929 *
1930 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001931 * testing if the tests suites are run with valgrind's memcheck. This can be
1932 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1933 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001934 *
1935 * \warning This macro is only used for extended testing; it is not considered
1936 * part of the library's API, so it may change or disappear at any time.
1937 *
1938 * Uncomment to enable testing of the constant-flow nature of selected code.
1939 */
1940//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1941
1942/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001943 * \def MBEDTLS_TEST_HOOKS
1944 *
1945 * Enable features for invasive testing such as introspection functions and
1946 * hooks for fault injection. This enables additional unit tests.
1947 *
1948 * Merely enabling this feature should not change the behavior of the product.
1949 * It only adds new code, and new branching points where the default behavior
1950 * is the same as when this feature is disabled.
1951 * However, this feature increases the attack surface: there is an added
1952 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1953 * Therefore this feature must never be enabled in production.
1954 *
1955 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1956 * information.
1957 *
1958 * Uncomment to enable invasive tests.
1959 */
1960//#define MBEDTLS_TEST_HOOKS
1961
1962/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001963 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001964 *
1965 * Provide your own alternate threading implementation.
1966 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001968 *
1969 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001971//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001972
1973/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001975 *
1976 * Enable the pthread wrapper layer for the threading layer.
1977 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001979 *
1980 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001982//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001983
1984/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001985 * \def MBEDTLS_USE_PSA_CRYPTO
1986 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001987 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1988 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001989 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001990 * \note Development of this option is currently in progress, and parts of Mbed
1991 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001992 * will still continue to work as usual, so enabling this option should not
1993 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001994 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001995 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001996 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1997 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001998 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001999 * \note An important and desirable effect of this option is that it allows
2000 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2001 * 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 +02002002 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002003 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2004 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002005 *
2006 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002007 *
2008 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002009 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002010 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002011 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002012//#define MBEDTLS_USE_PSA_CRYPTO
2013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002014/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002015 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2016 *
John Durkop185764f2020-10-12 21:32:12 -07002017 * This setting allows support for cryptographic mechanisms through the PSA
2018 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002019 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002020 * When this option is disabled, the PSA API exposes the cryptographic
2021 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2022 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002023 *
2024 * When this option is enabled, the PSA API exposes the cryptographic
2025 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2026 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2027 * automatically enabled if required (i.e. if no PSA driver provides the
2028 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2029 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002030 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002031 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002032 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002033 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002034 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2035 * symbols is not completely finalized yet, and the configuration
2036 * tooling is not ideally adapted to having two separate configuration
2037 * files.
2038 * Future minor releases of Mbed TLS may make minor changes to those
2039 * symbols, but we will endeavor to provide a transition path.
2040 * Nonetheless, this option is considered mature enough to use in
2041 * production, as long as you accept that you may need to make
2042 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002043 */
2044//#define MBEDTLS_PSA_CRYPTO_CONFIG
2045
2046/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002047 * \def MBEDTLS_VERSION_FEATURES
2048 *
2049 * Allow run-time checking of compile-time enabled features. Thus allowing users
2050 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002051 * support via mbedtls_version_check_feature().
2052 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002053 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002054 *
2055 * Comment this to disable run-time checking and save ROM space
2056 */
2057#define MBEDTLS_VERSION_FEATURES
2058
2059/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002060 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2061 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002062 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002063 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2064 * the set of trusted certificates through a callback instead of a linked
2065 * list.
2066 *
2067 * This is useful for example in environments where a large number of trusted
2068 * certificates is present and storing them in a linked list isn't efficient
2069 * enough, or when the set of trusted certificates changes frequently.
2070 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002071 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002072 * `mbedtls_ssl_conf_ca_cb()` for more information.
2073 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002074 * Requires: MBEDTLS_X509_CRT_PARSE_C
2075 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002076 * Uncomment to enable trusted certificate callbacks.
2077 */
2078//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2079
2080/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002081 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002082 *
Chris Jones2c745862020-12-16 11:41:06 +00002083 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002084 *
Chris Jones2c745862020-12-16 11:41:06 +00002085 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002086 * and other functions/constants only used by these functions, thus reducing
2087 * the code footprint by several KB.
2088 */
Chris Jones2c745862020-12-16 11:41:06 +00002089//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002090
2091/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002092 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002093 *
2094 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2095 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2096 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002097 * Requires: MBEDTLS_PKCS1_V21
2098 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002099 * Comment this macro to disallow using RSASSA-PSS in certificates.
2100 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002101#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002102/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002103
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002104/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002105 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002106 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002107 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002108 * \{
2109 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002110
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002112 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002113 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002114 * Enable AES-NI support on x86-64 or x86-32.
2115 *
2116 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002117 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002118 * - GCC, x86-64, target not explicitly supporting AESNI:
2119 * requires MBEDTLS_HAVE_ASM.
2120 * - GCC, x86-32, target not explicitly supporting AESNI:
2121 * not supported.
2122 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2123 * For this assembly-less implementation, you must currently compile
2124 * `library/aesni.c` and `library/aes.c` with machine options to enable
2125 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2126 * `clang -maes -mpclmul`.
2127 * - Non-x86 targets: this option is silently ignored.
2128 * - Other compilers: this option is silently ignored.
2129 *
2130 * \note
2131 * Above, "GCC" includes compatible compilers such as Clang.
2132 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002133 *
2134 * Module: library/aesni.c
2135 * Caller: library/aes.c
2136 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002137 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002138 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002139 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002140 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002141#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002142
2143/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002144 * \def MBEDTLS_AESCE_C
2145 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002146 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002147 *
2148 * Module: library/aesce.c
2149 * Caller: library/aes.c
2150 *
Jerry Yuf015a932023-04-25 10:38:03 +08002151 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002152 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002153 * \warning Runtime detection only works on Linux. For non-Linux operating
2154 * system, Armv8-A Cryptographic Extensions must be supported by
2155 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002156 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002157 * \note Minimum compiler versions for this feature when targeting aarch64
2158 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2159 * Minimum compiler versions for this feature when targeting 32-bit
2160 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002161 *
2162 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2163 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002164 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002165 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002166 */
2167#define MBEDTLS_AESCE_C
2168
2169/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002171 *
2172 * Enable the AES block cipher.
2173 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002174 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002175 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002176 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002177 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002178 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002179 * This module enables the following ciphersuites (if other requisites are
2180 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2182 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2183 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2184 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2185 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2186 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2187 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2188 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2189 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2190 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2191 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2192 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2193 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2194 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2195 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2196 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2197 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2198 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2199 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2200 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2201 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2202 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2203 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2204 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2205 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2206 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2207 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2208 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2209 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2210 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2211 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2212 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2213 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2214 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2215 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2216 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2217 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2218 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2219 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2220 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2221 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2222 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2223 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2224 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2225 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2226 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2227 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2228 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2229 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2230 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2231 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2232 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2233 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2234 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2235 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2236 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2237 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2238 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002239 *
Paul Bakkercff68422013-09-15 20:43:33 +02002240 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002241 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002242#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002243
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002244/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002246 *
2247 * Enable the generic ASN1 parser.
2248 *
2249 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002250 * Caller: library/x509.c
2251 * library/dhm.c
2252 * library/pkcs12.c
2253 * library/pkcs5.c
2254 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002256#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002257
2258/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002259 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002260 *
2261 * Enable the generic ASN1 writer.
2262 *
2263 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002264 * Caller: library/ecdsa.c
2265 * library/pkwrite.c
2266 * library/x509_create.c
2267 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002268 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002269 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002271
2272/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002274 *
2275 * Enable the Base64 module.
2276 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002277 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002278 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002279 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002280 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002281 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002282#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002283
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002284/**
Yanray Wange367e472023-10-31 17:23:04 +08002285 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2286 *
2287 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2288 *
2289 * \note This feature is incompatible with insecure block cipher,
2290 * MBEDTLS_DES_C, and cipher modes which always require decryption
2291 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002292 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2293 * this feature is incompatible with following supported PSA equivalence,
2294 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2295 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002296 *
2297 * Module: library/aes.c
2298 * library/aesce.c
2299 * library/aesni.c
2300 * library/aria.c
2301 * library/camellia.c
2302 * library/cipher.c
2303 */
2304//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2305
2306/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002307 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002308 *
Paul Bakker9a736322012-11-14 12:39:52 +00002309 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002310 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002311 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002312 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002313 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002314 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002315 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002316 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002317 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002318 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002319 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002320 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002321 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002322 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002323 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002325
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002326/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002328 *
2329 * Enable the Camellia block cipher.
2330 *
Paul Bakker38119b12009-01-10 23:31:23 +00002331 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002332 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002333 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002334 * This module enables the following ciphersuites (if other requisites are
2335 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002336 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2337 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2338 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2339 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2340 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2341 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2342 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2343 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2344 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2345 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2346 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2347 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2348 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2349 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2350 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2351 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2352 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2353 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2354 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2355 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2356 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2357 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2358 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2359 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2360 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2361 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2362 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2363 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2364 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2365 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2366 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2367 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2368 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2369 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2370 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2371 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2372 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2373 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2374 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2375 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2376 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2377 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002380
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002381/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002382 * \def MBEDTLS_ARIA_C
2383 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002384 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002385 *
2386 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002387 * Caller: library/cipher.c
2388 *
2389 * This module enables the following ciphersuites (if other requisites are
2390 * enabled as well):
2391 *
2392 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2393 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2394 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2395 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2396 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2397 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2398 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2399 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2400 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2401 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2402 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2403 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2404 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2405 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2406 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2407 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2408 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2409 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2410 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2411 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2412 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2413 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2414 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2415 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2416 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2417 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2418 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2419 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2420 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2421 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2422 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2423 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2424 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2425 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2426 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2427 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2428 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2429 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002430 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002431#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002432
2433/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002434 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002435 *
2436 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2437 *
2438 * Module: library/ccm.c
2439 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002440 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2441 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002442 *
2443 * This module enables the AES-CCM ciphersuites, if other requisites are
2444 * enabled as well.
2445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002447
2448/**
Daniel King34b822c2016-05-15 17:28:08 -03002449 * \def MBEDTLS_CHACHA20_C
2450 *
2451 * Enable the ChaCha20 stream cipher.
2452 *
2453 * Module: library/chacha20.c
2454 */
2455#define MBEDTLS_CHACHA20_C
2456
2457/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002458 * \def MBEDTLS_CHACHAPOLY_C
2459 *
2460 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2461 *
2462 * Module: library/chachapoly.c
2463 *
2464 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2465 */
2466#define MBEDTLS_CHACHAPOLY_C
2467
2468/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002469 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002470 *
2471 * Enable the generic cipher layer.
2472 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002473 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002474 * Caller: library/ccm.c
2475 * library/cmac.c
2476 * library/gcm.c
2477 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002478 * library/pkcs12.c
2479 * library/pkcs5.c
2480 * library/psa_crypto_aead.c
2481 * library/psa_crypto_mac.c
2482 * library/ssl_ciphersuites.c
2483 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002484 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002485 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2486 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002487 *
2488 * Uncomment to enable generic cipher wrappers.
2489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002490#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002491
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002492/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002493 * \def MBEDTLS_CMAC_C
2494 *
Simon Butcher327398a2016-10-05 14:09:11 +01002495 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2496 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002497 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002498 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2499 * implementation of the CMAC algorithm is provided by an alternate
2500 * implementation, that alternate implementation may opt to not support
2501 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2502 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002503 * Module: library/cmac.c
2504 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002505 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002506 *
2507 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002508#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002509
2510/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002512 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002513 * Enable the CTR_DRBG AES-based random generator.
2514 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002515 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002516 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002517 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2518 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2519 * is used.
2520 *
2521 * \warning When using PSA, the user should call `psa_crypto_init()` before
2522 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2523 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002524 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2525 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002526 * \note To achieve a 256-bit security strength with CTR_DRBG,
2527 * you must use AES-256 *and* use sufficient entropy.
2528 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002529 *
2530 * Module: library/ctr_drbg.c
2531 * Caller:
2532 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002533 * Requires: MBEDTLS_AES_C or
2534 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2535 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002536 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002537 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002540
2541/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002543 *
2544 * Enable the debug functions.
2545 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002546 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002547 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002548 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002549 * library/ssl_tls12_*.c
2550 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002551 *
2552 * This module provides debugging functions.
2553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002555
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002556/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002557 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002558 *
2559 * Enable the DES block cipher.
2560 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002561 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002562 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002563 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002564 *
Paul Bakkercff68422013-09-15 20:43:33 +02002565 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002566 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002567 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002568 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002571
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002572/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002574 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002575 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002576 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002577 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002578 * Caller: library/ssl_tls.c
2579 * library/ssl*_client.c
2580 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002581 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002582 * This module is used by the following key exchanges:
2583 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002584 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002585 * \warning Using DHE constitutes a security risk as it
2586 * is not possible to validate custom DH parameters.
2587 * If possible, it is recommended users should consider
2588 * preferring other methods of key exchange.
2589 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002590 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002591 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002593
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002594/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002596 *
2597 * Enable the elliptic curve Diffie-Hellman library.
2598 *
2599 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002600 * Caller: library/psa_crypto.c
2601 * library/ssl_tls.c
2602 * library/ssl*_client.c
2603 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002604 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002605 * This module is used by the following key exchanges:
2606 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002607 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002610#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002611
2612/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002614 *
2615 * Enable the elliptic curve DSA library.
2616 *
2617 * Module: library/ecdsa.c
2618 * Caller:
2619 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002620 * This module is used by the following key exchanges:
2621 * ECDHE-ECDSA
2622 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002623 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2624 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2625 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002626 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002627#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002628
2629/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002630 * \def MBEDTLS_ECJPAKE_C
2631 *
2632 * Enable the elliptic curve J-PAKE library.
2633 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002634 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2635 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002636 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002637 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002638 * Module: library/ecjpake.c
2639 * Caller:
2640 *
2641 * This module is used by the following key exchanges:
2642 * ECJPAKE
2643 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002644 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002645 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002646 * \warning If using a hash that is only provided by PSA drivers, you must
2647 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002648 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002649#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002650
2651/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002652 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002653 *
2654 * Enable the elliptic curve over GF(p) library.
2655 *
2656 * Module: library/ecp.c
2657 * Caller: library/ecdh.c
2658 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002659 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002660 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002662 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002664
2665/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002667 *
2668 * Enable the platform-specific entropy code.
2669 *
2670 * Module: library/entropy.c
2671 * Caller:
2672 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002674 *
2675 * This module provides a generic entropy pool
2676 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002678
2679/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002681 *
2682 * Enable error code to error string conversion.
2683 *
2684 * Module: library/error.c
2685 * Caller:
2686 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002688 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002690
2691/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002693 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002694 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002695 *
2696 * Module: library/gcm.c
2697 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002698 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2699 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002700 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002701 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2702 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002703 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002704#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002705
2706/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002707 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002708 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002709 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002710 * Can significantly increase throughput on systems without GCM hardware
2711 * acceleration (e.g., AESNI, AESCE).
2712 *
Matthias Schulz78266782024-02-08 13:54:48 +01002713 * The mbedtls_gcm_context size will increase by 3840 bytes.
2714 * The code size will increase by roughly 344 bytes.
2715 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002716 * Module: library/gcm.c
2717 *
2718 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002719 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002720//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002721
2722/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002723 * \def MBEDTLS_HKDF_C
2724 *
2725 * Enable the HKDF algorithm (RFC 5869).
2726 *
2727 * Module: library/hkdf.c
2728 * Caller:
2729 *
2730 * Requires: MBEDTLS_MD_C
2731 *
2732 * This module adds support for the Hashed Message Authentication Code
2733 * (HMAC)-based key derivation function (HKDF).
2734 */
2735#define MBEDTLS_HKDF_C
2736
2737/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002739 *
2740 * Enable the HMAC_DRBG random generator.
2741 *
2742 * Module: library/hmac_drbg.c
2743 * Caller:
2744 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002745 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002746 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002747 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002748 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002750
2751/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002752 * \def MBEDTLS_LMS_C
2753 *
2754 * Enable the LMS stateful-hash asymmetric signature algorithm.
2755 *
2756 * Module: library/lms.c
2757 * Caller:
2758 *
Raef Colesab4f8742022-09-01 12:24:31 +01002759 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002760 *
Raef Colesab4f8742022-09-01 12:24:31 +01002761 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002762 */
2763#define MBEDTLS_LMS_C
2764
2765/**
Raef Colesab4f8742022-09-01 12:24:31 +01002766 * \def MBEDTLS_LMS_PRIVATE
2767 *
2768 * Enable LMS private-key operations and signing code. Functions enabled by this
2769 * option are experimental, and should not be used in production.
2770 *
2771 * Requires: MBEDTLS_LMS_C
2772 *
2773 * Uncomment to enable the LMS signature algorithm and private key operations.
2774 */
Raef Coles5127e852022-10-07 10:35:56 +01002775//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002776
2777/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002778 * \def MBEDTLS_NIST_KW_C
2779 *
2780 * Enable the Key Wrapping mode for 128-bit block ciphers,
2781 * as defined in NIST SP 800-38F. Only KW and KWP modes
2782 * are supported. At the moment, only AES is approved by NIST.
2783 *
2784 * Module: library/nist_kw.c
2785 *
2786 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2787 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002788#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002789
2790/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002792 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002793 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002794 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002795 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2796 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002797 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002798 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002799 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002800 * Caller: library/constant_time.c
2801 * library/ecdsa.c
2802 * library/ecjpake.c
2803 * library/hkdf.c
2804 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002805 * library/pk.c
2806 * library/pkcs5.c
2807 * library/pkcs12.c
2808 * library/psa_crypto_ecp.c
2809 * library/psa_crypto_rsa.c
2810 * library/rsa.c
2811 * library/ssl_cookie.c
2812 * library/ssl_msg.c
2813 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002814 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002815 * library/x509_crt.c
2816 * library/x509write_crt.c
2817 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002818 *
2819 * Uncomment to enable generic message digest wrappers.
2820 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002822
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002823/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002825 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002826 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002827 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002828 * Module: library/md5.c
2829 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002830 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002831 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002832 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002833 * This module is required for TLS 1.2 depending on the handshake parameters.
2834 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2835 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002836 *
2837 * \warning MD5 is considered a weak message digest and its use constitutes a
2838 * security risk. If possible, we recommend avoiding dependencies on
2839 * it, and considering stronger message digests instead.
2840 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002841 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002843
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002844/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002846 *
2847 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002848 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002849 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002850 *
2851 * Module: library/memory_buffer_alloc.c
2852 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002854 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002855 *
2856 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002857 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002859
2860/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002862 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002863 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2864 *
Simon Butcherd567a232016-03-09 20:19:21 +00002865 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2866 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002867 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002868 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002869 * \note See also our Knowledge Base article about porting to a new
2870 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002871 * 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 +00002872 *
Andres AG788aa4a2016-09-14 14:32:09 +01002873 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002874 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002875 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002876 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002878
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002879/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002881 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002882 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002883 *
2884 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002885 * Caller: library/asn1write.c
2886 * library/pkcs5.c
2887 * library/pkparse.c
2888 * library/pkwrite.c
2889 * library/rsa.c
2890 * library/x509.c
2891 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002892 * library/x509_crl.c
2893 * library/x509_crt.c
2894 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002895 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002896 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002897 *
2898 * This modules translates between OIDs and internal values.
2899 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002900#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002901
2902/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002903 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002904 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002905 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002906 *
2907 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002908 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002909 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002910 * library/x509_crl.c
2911 * library/x509_crt.c
2912 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002913 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002915 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2916 *
2917 * \warning When parsing password-protected files, if MD5 is provided only by
2918 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002919 *
Paul Bakkercff68422013-09-15 20:43:33 +02002920 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002921 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002923
2924/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002926 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002927 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002928 *
2929 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002930 * Caller: library/pkwrite.c
2931 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002932 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002933 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002935 *
2936 * This modules adds support for encoding / writing PEM files.
2937 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002939
2940/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002942 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002943 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002944 *
2945 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002946 * Caller: library/psa_crypto_rsa.c
2947 * library/ssl_tls.c
2948 * library/ssl*_client.c
2949 * library/ssl*_server.c
2950 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002951 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002952 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002953 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002954 * Uncomment to enable generic public key wrappers.
2955 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002957
2958/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002960 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002961 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002962 *
2963 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002964 * Caller: library/x509_crt.c
2965 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002966 *
Yanray Wang072a0682023-12-05 10:53:04 +08002967 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002968 *
2969 * Uncomment to enable generic public key parse functions.
2970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002972
2973/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002975 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002976 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002977 *
2978 * Module: library/pkwrite.c
2979 * Caller: library/x509write.c
2980 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002981 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002982 *
2983 * Uncomment to enable generic public key write functions.
2984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002986
2987/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002989 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002990 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002991 *
2992 * Module: library/pkcs5.c
2993 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002994 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002995 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002996 * \warning If using a hash that is only provided by PSA drivers, you must
2997 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002998 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002999 * This module adds support for the PKCS#5 functions.
3000 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003002
3003/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003004 * \def MBEDTLS_PKCS7_C
3005 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003006 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003007 * RFC Link - https://tools.ietf.org/html/rfc2315
3008 *
3009 * Module: library/pkcs7.c
3010 *
3011 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003012 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3013 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003014 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003015 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003016 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003017#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003018
3019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003021 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003022 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003023 * Adds algorithms for parsing PKCS#8 encrypted private keys
3024 *
3025 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003026 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003027 *
Valerio Settie98ad592023-12-28 10:42:12 +01003028 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3029 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003030 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003031 * \warning If using a hash that is only provided by PSA drivers, you must
3032 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003033 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003034 * This module enables PKCS#12 functions.
3035 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003037
3038/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003040 *
3041 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003042 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003043 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3045 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003046 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003047 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003048 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003049 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003050 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003051 * Module: library/platform.c
3052 * Caller: Most other .c files
3053 *
3054 * This module enables abstraction of common (libc) functions.
3055 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003056#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003057
3058/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003059 * \def MBEDTLS_POLY1305_C
3060 *
3061 * Enable the Poly1305 MAC algorithm.
3062 *
3063 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003064 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003065 */
3066#define MBEDTLS_POLY1305_C
3067
3068/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003069 * \def MBEDTLS_PSA_CRYPTO_C
3070 *
3071 * Enable the Platform Security Architecture cryptography API.
3072 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003073 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003074 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003075 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003076 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003077 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3078 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3079 * is enabled in PSA (unless it's fully accelerated, see
3080 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003081 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003082#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003083
3084/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003085 * \def MBEDTLS_PSA_CRYPTO_SE_C
3086 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003087 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003088 * cryptography API.
3089 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003090 * \deprecated This feature is deprecated. Please switch to the PSA driver
3091 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003092 *
Ryan Everett32a64582024-03-05 18:16:18 +00003093 * \warning This feature is not thread-safe, and should not be used in a
3094 * multi-threaded environment.
3095 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003096 * Module: library/psa_crypto_se.c
3097 *
3098 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3099 *
3100 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003101//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003102
3103/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003104 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3105 *
3106 * Enable the Platform Security Architecture persistent key storage.
3107 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003108 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003109 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003110 * Requires: MBEDTLS_PSA_CRYPTO_C,
3111 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3112 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003113 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003114#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003115
3116/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003117 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003118 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003119 * Enable the emulation of the Platform Security Architecture
3120 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003121 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003122 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003123 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003124 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003125 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003126#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003127
3128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003130 *
3131 * Enable the RIPEMD-160 hash algorithm.
3132 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003133 * Module: library/ripemd160.c
3134 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003135 *
3136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003138
3139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003141 *
3142 * Enable the RSA public-key cryptosystem.
3143 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003144 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003145 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003146 * Caller: library/pk.c
3147 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003148 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003149 * library/ssl*_client.c
3150 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003151 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003152 * This module is used by the following key exchanges:
3153 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003154 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003156 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003158
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003159/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003161 *
3162 * Enable the SHA1 cryptographic hash algorithm.
3163 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003164 * Module: library/sha1.c
3165 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003166 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003167 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003168 * This module is required for TLS 1.2 depending on the handshake parameters,
3169 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003170 *
3171 * \warning SHA-1 is considered a weak message digest and its use constitutes
3172 * a security risk. If possible, we recommend avoiding dependencies
3173 * on it, and considering stronger message digests instead.
3174 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003176#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003177
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003178/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003179 * \def MBEDTLS_SHA224_C
3180 *
3181 * Enable the SHA-224 cryptographic hash algorithm.
3182 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003183 * Module: library/sha256.c
3184 * Caller: library/md.c
3185 * library/ssl_cookie.c
3186 *
3187 * This module adds support for SHA-224.
3188 */
3189#define MBEDTLS_SHA224_C
3190
3191/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003192 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003193 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003194 * Enable the SHA-256 cryptographic hash algorithm.
3195 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003196 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003197 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003198 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003199 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003200 * library/ssl*_client.c
3201 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003202 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003203 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003204 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003207
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003208/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003209 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003210 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003211 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3212 * with the ARMv8 cryptographic extensions if they are available at runtime.
3213 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003214 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003215 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003216 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003217 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003218 * \note Minimum compiler versions for this feature are Clang 4.0,
3219 * armclang 6.6 or GCC 6.0.
3220 *
3221 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3222 * armclang <= 6.9
3223 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003224 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3225 * That name is deprecated, but may still be used as an alternative form for this
3226 * option.
3227 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003228 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3229 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003230 *
3231 * Requires: MBEDTLS_SHA256_C.
3232 *
3233 * Module: library/sha256.c
3234 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003235 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003236 * and use them if available.
3237 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003238//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003239
Dave Rodgmand85277c2023-10-13 09:22:54 +01003240/**
3241 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3242 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003243 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003244 * This name is now deprecated, but may still be used as an alternative form for
3245 * this option.
3246 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003247//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3248
3249/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003250 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003251 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003252 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3253 * with the ARMv8 cryptographic extensions, which must be available at runtime
3254 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003255 *
3256 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003257 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003258 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003259 * \note Minimum compiler versions for this feature are Clang 4.0,
3260 * armclang 6.6 or GCC 6.0.
3261 *
3262 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3263 * armclang <= 6.9
3264 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003265 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003266 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003267 * option.
3268 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003269 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3270 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003271 *
3272 * Requires: MBEDTLS_SHA256_C.
3273 *
3274 * Module: library/sha256.c
3275 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003276 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003277 * unconditionally.
3278 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003279//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003280
Dave Rodgmand85277c2023-10-13 09:22:54 +01003281/**
3282 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3283 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003284 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003285 * This name is now deprecated, but may still be used as an alternative form for
3286 * this option.
3287 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003288//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3289
3290/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003291 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003292 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003293 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003294 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003295 * Module: library/sha512.c
3296 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003297 * library/psa_crypto_hash.c
3298 * library/ssl_tls.c
3299 * library/ssl*_client.c
3300 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003301 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003302 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003303 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003304#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003305
3306/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003307 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003308 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003309 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003310 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003311 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003312 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003313 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003314 * library/ssl_tls.c
3315 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003316 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003317 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003319#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003320
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003321/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003322 * \def MBEDTLS_SHA3_C
3323 *
3324 * Enable the SHA3 cryptographic hash algorithm.
3325 *
3326 * Module: library/sha3.c
3327 *
3328 * This module adds support for SHA3.
3329 */
3330#define MBEDTLS_SHA3_C
3331
3332/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003333 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3334 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003335 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3336 * with the ARMv8 cryptographic extensions if they are available at runtime.
3337 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003338 *
3339 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3340 * for a non-Aarch64 build it will be silently ignored.
3341 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003342 * \note Minimum compiler versions for this feature are Clang 7.0,
3343 * armclang 6.9 or GCC 8.0.
3344 *
3345 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3346 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003347 *
3348 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3349 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3350 *
3351 * Requires: MBEDTLS_SHA512_C.
3352 *
3353 * Module: library/sha512.c
3354 *
3355 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3356 * and use them if available.
3357 */
3358//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3359
3360/**
3361 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3362 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003363 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3364 * with the ARMv8 cryptographic extensions, which must be available at runtime
3365 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003366 *
3367 * \note This allows builds with a smaller code size than with
3368 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3369 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003370 * \note Minimum compiler versions for this feature are Clang 7.0,
3371 * armclang 6.9 or GCC 8.0.
3372 *
3373 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3374 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003375 *
3376 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3377 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3378 *
3379 * Requires: MBEDTLS_SHA512_C.
3380 *
3381 * Module: library/sha512.c
3382 *
3383 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3384 * unconditionally.
3385 */
3386//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3387
3388/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003390 *
3391 * Enable simple SSL cache implementation.
3392 *
3393 * Module: library/ssl_cache.c
3394 * Caller:
3395 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003397 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003399
3400/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003401 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003402 *
3403 * Enable basic implementation of DTLS cookies for hello verification.
3404 *
3405 * Module: library/ssl_cookie.c
3406 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003407 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003408#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003409
3410/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003411 * \def MBEDTLS_SSL_TICKET_C
3412 *
3413 * Enable an implementation of TLS server-side callbacks for session tickets.
3414 *
3415 * Module: library/ssl_ticket.c
3416 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003417 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003418 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3419 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003420 */
3421#define MBEDTLS_SSL_TICKET_C
3422
3423/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003425 *
3426 * Enable the SSL/TLS client code.
3427 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003428 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003429 * Caller:
3430 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003432 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003433 * This module is required for SSL/TLS client support.
3434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003436
Paul Bakker9a736322012-11-14 12:39:52 +00003437/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003438 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003439 *
3440 * Enable the SSL/TLS server code.
3441 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003442 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003443 * Caller:
3444 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003445 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003446 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003447 * This module is required for SSL/TLS server support.
3448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003449#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003450
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003451/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003452 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003453 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003454 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003455 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003456 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003457 * Caller: library/ssl*_client.c
3458 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003459 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3461 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003462 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003463 * This module is required for SSL/TLS.
3464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003466
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003467/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003468 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003469 *
3470 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003471 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003472 * contexts are not shared between threads. If you do intend to use contexts
3473 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003474 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003475 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003476 *
3477 * Module: library/threading.c
3478 *
3479 * This allows different threading implementations (self-implemented or
3480 * provided).
3481 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482 * You will have to enable either MBEDTLS_THREADING_ALT or
3483 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003484 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003485 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003488
3489/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003491 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003492 * Enable the semi-portable timing interface.
3493 *
Simon Butcherd567a232016-03-09 20:19:21 +00003494 * \note The provided implementation only works on POSIX/Unix (including Linux,
3495 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003496 * module and provide your own implementations of the callbacks needed by
3497 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3498 * your own implementation of the whole module by setting
3499 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003500 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003501 * \note The timing module will include time.h on suitable platforms
3502 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3503 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3504 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003505 * \note See also our Knowledge Base article about porting to a new
3506 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003507 * 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 +00003508 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003509 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003510 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003511#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003512
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003513/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003514 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003515 *
3516 * Enable run-time version information.
3517 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003518 * Module: library/version.c
3519 *
3520 * This module provides run-time version information.
3521 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003523
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003525 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003526 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003527 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003528 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003529 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003530 * Caller: library/x509_crl.c
3531 * library/x509_crt.c
3532 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003533 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003534 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003535 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3536 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003537 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3538 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003539 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003540 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003543
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003544/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003545 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003546 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003547 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003548 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003549 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003550 * Caller: library/ssl_tls.c
3551 * library/ssl*_client.c
3552 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003553 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003554 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003555 *
3556 * This module is required for X.509 certificate parsing.
3557 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003559
3560/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003561 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003562 *
3563 * Enable X.509 CRL parsing.
3564 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003565 * Module: library/x509_crl.c
3566 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003567 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003568 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003569 *
3570 * This module is required for X.509 CRL parsing.
3571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003573
3574/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003576 *
3577 * Enable X.509 Certificate Signing Request (CSR) parsing.
3578 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003579 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003580 * Caller: library/x509_crt_write.c
3581 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003582 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003583 *
3584 * This module is used for reading X.509 certificate request.
3585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003586#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003587
3588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003589 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003590 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003591 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003592 *
3593 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003594 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003595 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003596 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3597 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003598 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3599 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003600 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003601 * This module is the basis for creating X.509 certificates and CSRs.
3602 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003604
3605/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003606 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003607 *
3608 * Enable creating X.509 certificates.
3609 *
3610 * Module: library/x509_crt_write.c
3611 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003612 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003613 *
3614 * This module is required for X.509 certificate creation.
3615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003617
3618/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003619 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003620 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003621 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003622 *
3623 * Module: library/x509_csr_write.c
3624 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003625 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003626 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003627 * This module is required for X.509 certificate request writing.
3628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003629#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003630
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003631/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003632
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003633/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003634 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003635 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003636 * This section contains Mbed TLS build settings that are not associated
3637 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003638 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003639 * \{
3640 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003641
Gilles Peskinea02c1242022-03-16 17:03:19 +01003642/**
3643 * \def MBEDTLS_CONFIG_FILE
3644 *
3645 * If defined, this is a header which will be included instead of
3646 * `"mbedtls/mbedtls_config.h"`.
3647 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003648 * Unlike other configuration options, this one must be defined on the
3649 * compiler command line: a definition in `mbedtls_config.h` would have
3650 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003651 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003652 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003653 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003654 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003655 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003656 * The value of this symbol is typically a path in double quotes, either
3657 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003658 */
3659//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3660
3661/**
3662 * \def MBEDTLS_USER_CONFIG_FILE
3663 *
3664 * If defined, this is a header which will be included after
3665 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003666 * This allows you to modify the default configuration, including the ability
3667 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003668 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003669 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003670 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003671 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003672 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003673 * The value of this symbol is typically a path in double quotes, either
3674 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003675 */
3676//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3677
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003678/**
3679 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3680 *
3681 * If defined, this is a header which will be included instead of
3682 * `"psa/crypto_config.h"`.
3683 * This header file specifies which cryptographic mechanisms are available
3684 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3685 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3686 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003687 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003688 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003689 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003690 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003691 * The value of this symbol is typically a path in double quotes, either
3692 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003693 */
3694//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3695
3696/**
3697 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3698 *
3699 * If defined, this is a header which will be included after
3700 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003701 * This allows you to modify the default configuration, including the ability
3702 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003703 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003704 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003705 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003706 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003707 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003708 * The value of this symbol is typically a path in double quotes, either
3709 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003710 */
3711//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3712
Gilles Peskineb1176f22023-02-22 22:07:28 +01003713/**
3714 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3715 *
3716 * If defined, this is a header which will be included instead of
3717 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3718 * as the one in Mbed TLS, but with definitions adapted to the platform on
3719 * which the library code will run.
3720 *
3721 * \note The required content of this header can vary from one version of
3722 * Mbed TLS to the next. Integrators who provide an alternative file
3723 * should review the changes in the original file whenever they
3724 * upgrade Mbed TLS.
3725 *
3726 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3727 * non-standard feature of the C language, so this feature is only available
3728 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3729 *
3730 * The value of this symbol is typically a path in double quotes, either
3731 * absolute or relative to a directory on the include search path.
3732 */
3733//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3734
3735/**
3736 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3737 *
3738 * If defined, this is a header which will be included instead of
3739 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3740 * as the one in Mbed TLS, but with definitions adapted to the environment
3741 * in which the library code will run. The typical use for this feature
3742 * is to provide alternative type definitions on the client side in
3743 * client-server integrations of PSA crypto, where operation structures
3744 * contain handles instead of cryptographic data.
3745 *
3746 * \note The required content of this header can vary from one version of
3747 * Mbed TLS to the next. Integrators who provide an alternative file
3748 * should review the changes in the original file whenever they
3749 * upgrade Mbed TLS.
3750 *
3751 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3752 * non-standard feature of the C language, so this feature is only available
3753 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3754 *
3755 * The value of this symbol is typically a path in double quotes, either
3756 * absolute or relative to a directory on the include search path.
3757 */
3758//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3759
Gilles Peskineba4162a2022-04-11 17:04:38 +02003760/** \} name SECTION: General configuration options */
3761
3762/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003763 * \name SECTION: Module configuration options
3764 *
3765 * This section allows for the setting of module specific sizes and
3766 * configuration options. The default values are already present in the
3767 * relevant header files and should suffice for the regular use cases.
3768 *
3769 * Our advice is to enable options and change their values here
3770 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003771 * \{
3772 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003773/* The Doxygen documentation here is used when a user comments out a
3774 * setting and runs doxygen themselves. On the other hand, when we typeset
3775 * the full documentation including disabled settings, the documentation
3776 * in specific modules' header files is used if present. When editing this
3777 * file, make sure that each option is documented in exactly one place,
3778 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3779 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003780
Paul Bakker088c5c52014-04-25 11:11:10 +02003781/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003782//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003783//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003784
Paul Bakker088c5c52014-04-25 11:11:10 +02003785/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003786//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3787//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3788//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3789//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3790//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003791
Paul Bakker088c5c52014-04-25 11:11:10 +02003792/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003793//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3794//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3795//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3796//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003797
Paul Bakker088c5c52014-04-25 11:11:10 +02003798/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003799//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003800//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003801
Paul Bakker088c5c52014-04-25 11:11:10 +02003802/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003803//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3804//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003805//#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 +01003806
Paul Bakker088c5c52014-04-25 11:11:10 +02003807/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003808//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003809
Paul Bakker088c5c52014-04-25 11:11:10 +02003810/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003811//#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 -04003812
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003813/** \def MBEDTLS_PLATFORM_STD_CALLOC
3814 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003815 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003816 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003817 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003818 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003819 * 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 -04003820 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3821 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003822 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003823 */
3824//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003825
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003826/** \def MBEDTLS_PLATFORM_STD_FREE
3827 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003828 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003829 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003830 * 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 -04003831 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3832 * 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 -04003833 */
3834//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003835//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003836//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003837//#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 +02003838//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3839//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003840/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003841//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003842//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3843//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003844//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3845//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3846//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003847
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003848/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003849/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003850//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3851//#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 +02003852//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003853//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003854//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3855//#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 +02003856//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3857//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003858/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003859//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003860//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003861//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3862//#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 +08003863//#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 +08003864//#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 +02003865
Gilles Peskine3f106f72021-09-23 17:42:39 +02003866/** \def MBEDTLS_CHECK_RETURN
3867 *
3868 * This macro is used at the beginning of the declaration of a function
3869 * to indicate that its return value should be checked. It should
3870 * instruct the compiler to emit a warning or an error if the function
3871 * is called without checking its return value.
3872 *
3873 * There is a default implementation for popular compilers in platform_util.h.
3874 * You can override the default implementation by defining your own here.
3875 *
3876 * If the implementation here is empty, this will effectively disable the
3877 * checking of functions' return values.
3878 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003879//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003880
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003881/** \def MBEDTLS_IGNORE_RETURN
3882 *
3883 * This macro requires one argument, which should be a C function call.
3884 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3885 * warning is suppressed.
3886 */
3887//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3888
Gilles Peskineed038902020-11-13 21:33:21 +01003889/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003890/**
Gilles Peskineed038902020-11-13 21:33:21 +01003891 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3892 * PSA crypto subsystem.
3893 *
3894 * If this option is unset:
3895 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003896 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003897 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3898 * on unspecified heuristics.
3899 */
3900//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3901
Steven Cooreman863470a2021-02-15 14:03:19 +01003902/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003903 * Restrict the PSA library to supporting a maximum amount of simultaneously
3904 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3905 * volatile key, or a persistent key which is loaded temporarily by the
3906 * library as part of a crypto operation in flight.
3907 *
3908 * If this option is unset, the library will fall back to a default value of
3909 * 32 keys.
3910 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003911//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003912
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003913/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003914//#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 +00003915
Paul Bakker088c5c52014-04-25 11:11:10 +02003916/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003917//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3918//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003919
Paul Bakker088c5c52014-04-25 11:11:10 +02003920/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003921
Angus Grattond8213d02016-05-25 20:56:48 +10003922/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3923 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003924 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003925 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003926 * This determines the size of the incoming TLS I/O buffer in such a way
3927 * that it is capable of holding the specified amount of plaintext data,
3928 * regardless of the protection mechanism used.
3929 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003930 * \note When using a value less than the default of 16KB on the client, it is
3931 * recommended to use the Maximum Fragment Length (MFL) extension to
3932 * inform the server about this limitation. On the server, there
3933 * is no supported, standardized way of informing the client about
3934 * restriction on the maximum size of incoming messages, and unless
3935 * the limitation has been communicated by other means, it is recommended
3936 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3937 * while keeping the default value of 16KB for the incoming buffer.
3938 *
David Horstmann95d516f2021-05-04 18:36:56 +01003939 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003940 */
3941//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3942
Gilles Peskined3d02902020-03-04 21:35:27 +01003943/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3944 *
3945 * The maximum length of CIDs used for incoming DTLS messages.
3946 *
3947 */
3948//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3949
3950/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3951 *
3952 * The maximum length of CIDs used for outgoing DTLS messages.
3953 *
3954 */
3955//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3956
TRodziewicze8dd7092021-05-12 14:19:11 +02003957/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003958 *
3959 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003960 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003961 *
3962 * The padding will always be chosen so that the length of the
3963 * padded plaintext is a multiple of the value of this option.
3964 *
3965 * Note: A value of \c 1 means that no padding will be used
3966 * for outgoing records.
3967 *
3968 * Note: On systems lacking division instructions,
3969 * a power of two should be preferred.
3970 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003971//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003972
Angus Grattond8213d02016-05-25 20:56:48 +10003973/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3974 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003975 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003976 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003977 * This determines the size of the outgoing TLS I/O buffer in such a way
3978 * that it is capable of holding the specified amount of plaintext data,
3979 * regardless of the protection mechanism used.
3980 *
Angus Grattond8213d02016-05-25 20:56:48 +10003981 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3982 * the default inward 16384 byte buffer to conform to the TLS specification.
3983 *
3984 * The minimum required outward buffer size is determined by the handshake
3985 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3986 * The specific size requirement depends on the configured ciphers and any
3987 * certificate data which is sent during the handshake.
3988 *
David Horstmann95d516f2021-05-04 18:36:56 +01003989 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003990 */
3991//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3992
Hanno Beckere0b150f2018-08-21 15:51:03 +01003993/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3994 *
3995 * Maximum number of heap-allocated bytes for the purpose of
3996 * DTLS handshake message reassembly and future message buffering.
3997 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003998 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003999 * to account for a reassembled handshake message of maximum size,
4000 * together with its reassembly bitmap.
4001 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004002 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004003 * should be sufficient for all practical situations as it allows
4004 * to reassembly a large handshake message (such as a certificate)
4005 * while buffering multiple smaller handshake messages.
4006 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004007 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004008//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004009
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004010//#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 +02004011//#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 +02004012
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004013/**
4014 * Complete list of ciphersuites to use, in order of preference.
4015 *
4016 * \warning No dependency checking is done on that field! This option can only
4017 * be used to restrict the set of available ciphersuites. It is your
4018 * responsibility to make sure the needed modules are active.
4019 *
4020 * Use this to save a few hundred bytes of ROM (default ordering of all
4021 * available ciphersuites) and a few to a few hundred bytes of RAM.
4022 *
4023 * The value below is only an example, not the default.
4024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004025//#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 +02004026
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004027/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004028 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4029 *
4030 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004031 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004032 *
4033 * It must be positive and smaller than UINT32_MAX.
4034 *
4035 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4036 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004037 */
4038//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4039
4040/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004041 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4042 *
Jerry Yucf913512023-11-14 11:06:52 +08004043 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004044 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004045 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004046 * - The client ticket age is the time difference between the time when the
4047 * client proposes to the server to use the ticket and the time the client
4048 * received the ticket from the server.
4049 * - The server ticket age is the time difference between the time when the
4050 * server receives a proposition from the client to use the ticket and the
4051 * time when the ticket was created by the server.
4052 *
Jerry Yucf913512023-11-14 11:06:52 +08004053 * The ages might be different due to the client and server clocks not running
4054 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4055 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4056 * 6s, thus in the worst case clients and servers must sync up their system time
4057 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004058 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004059 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004060 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004061//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004062
4063/**
4064 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4065 *
4066 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4067 *
4068 * This must be less than 256.
4069 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004070//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004071
4072/**
4073 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4074 *
4075 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4076 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4077 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4078 *
4079 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004080//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004081
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004082/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004083//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004084//#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 +01004085
Gilles Peskine611179c2022-04-13 23:04:48 +02004086/** \} name SECTION: Module configuration options */