blob: 8748cdd6d04f8dd07311d410b7245802612c7dd4 [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
Steven Cooreman63342772017-04-04 11:47:16 +0200354//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200355//#define MBEDTLS_DES_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300356//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357//#define MBEDTLS_MD5_ALT
358//#define MBEDTLS_RIPEMD160_ALT
359//#define MBEDTLS_SHA1_ALT
360//#define MBEDTLS_SHA256_ALT
361//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000362
Paul Bakker90995b52013-06-24 19:20:35 +0200363/**
TRodziewicz75628d52021-06-18 12:56:27 +0200364 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200365 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200366 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100367 * alternate core implementation of symmetric crypto or hash function. Keep in
368 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200369 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200370 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200371 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200372 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200373 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200374 * no longer provide the mbedtls_sha1_process() function, but it will still provide
375 * the other function (using your mbedtls_sha1_process() function) and the definition
376 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200377 * with this definition.
378 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200379 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100380 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
381 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200382 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200383 * Uncomment a macro to enable alternate implementation of the corresponding
384 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100385 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200386 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100387 * constitutes a security risk. If possible, we recommend avoiding
388 * dependencies on them, and considering stronger message digests
389 * and ciphers instead.
390 *
Janos Follath1231d212019-01-07 15:01:32 +0000391 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
392 * enabled, then the deterministic ECDH signature functions pass the
393 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
394 * alternative implementations should use the RNG only for generating
395 * the ephemeral key and nothing else. If this is not possible, then
396 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200397 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000398 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200399 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200400//#define MBEDTLS_MD5_PROCESS_ALT
401//#define MBEDTLS_RIPEMD160_PROCESS_ALT
402//#define MBEDTLS_SHA1_PROCESS_ALT
403//#define MBEDTLS_SHA256_PROCESS_ALT
404//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200405//#define MBEDTLS_DES_SETKEY_ALT
406//#define MBEDTLS_DES_CRYPT_ECB_ALT
407//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200408//#define MBEDTLS_AES_SETKEY_ENC_ALT
409//#define MBEDTLS_AES_SETKEY_DEC_ALT
410//#define MBEDTLS_AES_ENCRYPT_ALT
411//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300412//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300413//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300414//#define MBEDTLS_ECDSA_VERIFY_ALT
415//#define MBEDTLS_ECDSA_SIGN_ALT
416//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200417
418/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200419 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200420 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200421 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200422 * hardware entropy collector.
423 *
424 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000425 * prototype as declared in library/entropy_poll.h, and accept NULL as first
426 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200427 *
428 * Uncomment to use your own hardware entropy collector.
429 */
430//#define MBEDTLS_ENTROPY_HARDWARE_ALT
431
432/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200433 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000434 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100435 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000436 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100437 * Uncomment this macro to use precomputed AES tables stored in ROM.
438 * Comment this macro to generate AES tables in RAM at runtime.
439 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100440 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
441 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100442 * initialization time before the first AES operation can be performed.
443 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
444 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
445 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100446 *
447 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200449//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000450
451/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100452 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200453 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100454 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200455 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100456 * Uncommenting this macro omits 75% of the AES tables from
457 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
458 * by computing their values on the fly during operations
459 * (the tables are entry-wise rotations of one another).
460 *
461 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100462 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100463 * runtime. Specifically, one has to compare 4 accesses within
464 * different tables to 4 accesses with additional arithmetic
465 * operations within the same table. The performance gain/loss
466 * depends on the system and memory details.
467 *
468 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200469 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100470//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200471
472/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800473 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
474 *
475 * Use only 128-bit keys in AES operations to save ROM.
476 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800477 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800478 * or 256-bit keys.
479 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800480 * Uncommenting this macro reduces the size of AES code by ~300 bytes
481 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800482 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800483 * Module: library/aes.c
484 *
485 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800486 */
487//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
488
Gilles Peskinea8861e02023-09-05 20:20:51 +0200489/*
490 * Disable plain C implementation for AES.
491 *
492 * When the plain C implementation is enabled, and an implementation using a
493 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
494 * detection will be used to select between them.
495 *
496 * If only one implementation is present, runtime detection will not be used.
497 * This configuration will crash at runtime if running on a CPU without the
498 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
499 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
500 */
501//#define MBEDTLS_AES_USE_HARDWARE_ONLY
502
Arto Kinnunen732ca322023-04-14 14:26:10 +0800503/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200504 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200505 *
506 * Use less ROM for the Camellia implementation (saves about 768 bytes).
507 *
508 * Uncomment this macro to use less memory for Camellia.
509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200510//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200511
512/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200513 * \def MBEDTLS_CHECK_RETURN_WARNING
514 *
515 * If this macro is defined, emit a compile-time warning if application code
516 * calls a function without checking its return value, but the return value
517 * should generally be checked in portable applications.
518 *
519 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
520 * implemented. Otherwise this option has no effect.
521 *
522 * Uncomment to get warnings on using fallible functions without checking
523 * their return value.
524 *
525 * \note This feature is a work in progress.
526 * Warnings will be added to more functions in the future.
527 *
528 * \note A few functions are considered critical, and ignoring the return
529 * value of these functions will trigger a warning even if this
530 * macro is not defined. To completely disable return value check
531 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
532 */
533//#define MBEDTLS_CHECK_RETURN_WARNING
534
535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200537 *
538 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200541
542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200543 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000544 *
545 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200547#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000548
549/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000551 *
552 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000555
556/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100557 * \def MBEDTLS_CIPHER_MODE_OFB
558 *
559 * Enable Output Feedback mode (OFB) for symmetric ciphers.
560 */
561#define MBEDTLS_CIPHER_MODE_OFB
562
563/**
564 * \def MBEDTLS_CIPHER_MODE_XTS
565 *
566 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
567 */
568#define MBEDTLS_CIPHER_MODE_XTS
569
570/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000572 *
573 * Enable NULL cipher.
574 * Warning: Only do so when you know what you are doing. This allows for
575 * encryption or channels without any security!
576 *
Ronald Croncee42702021-04-26 11:34:44 +0200577 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
579 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
580 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
581 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
582 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
583 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
584 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
585 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
586 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
587 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
588 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
589 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
590 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
591 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
592 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
593 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
594 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
595 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
596 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000597 *
598 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000601
602/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100603 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200604 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100605 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
606 * specific padding modes in the cipher layer with cipher modes that support
607 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200608 *
609 * If you disable all padding modes, only full blocks can be used with CBC.
610 *
611 * Enable padding modes in the cipher layer.
612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200613#define MBEDTLS_CIPHER_PADDING_PKCS7
614#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
615#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
616#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200617
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200618/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
619 *
620 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800621 * Without this, CTR_DRBG uses a 256-bit key
622 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200623 */
624//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
625
Paul Bakker48e93c82013-08-14 12:21:18 +0200626/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200627 * Enable the verified implementations of ECDH primitives from Project Everest
628 * (currently only Curve25519). This feature changes the layout of ECDH
629 * contexts and therefore is a compatibility break for applications that access
630 * fields of a mbedtls_ecdh_context structure directly. See also
631 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000632 *
633 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
634 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200635 */
636//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
637
638/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100639 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200640 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100641 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
642 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200643 *
644 * Comment macros to disable the curve and functions for it
645 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200646/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200647#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
648#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
649#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
650#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
651#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
652#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
653#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
654#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
655#define MBEDTLS_ECP_DP_BP256R1_ENABLED
656#define MBEDTLS_ECP_DP_BP384R1_ENABLED
657#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200658/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200659#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000660#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200661
662/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200664 *
665 * Enable specific 'modulo p' routines for each NIST prime.
666 * Depending on the prime and architecture, makes operations 4 to 8 times
667 * faster on the corresponding curve.
668 *
669 * Comment this macro to disable NIST curves optimisation.
670 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200671#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200672
673/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200674 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100675 *
676 * Enable "non-blocking" ECC operations that can return early and be resumed.
677 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200678 * This allows various functions to pause by returning
679 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
680 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
681 * order to further progress and eventually complete their operation. This is
682 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
683 * number of ECC operations a function may perform before pausing; see
684 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100685 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200686 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200687 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100688 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100689 * This option:
690 * - Adds xxx_restartable() variants of existing operations in the
691 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100692 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
693 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100694 * - ECDSA: signature generation & verification;
695 * - PK: signature generation & verification;
696 * - X509: certificate chain verification.
697 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
698 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
699 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
700 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000701 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100702 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100703 * - verification of the server's key exchange signature;
704 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100705 * - generation of the client's signature if client authentication is used,
706 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100707 *
708 * \note In the cases above, the usual SSL/TLS functions, such as
709 * mbedtls_ssl_handshake(), can now return
710 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200711 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100712 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
713 * restartable operations in PK, X.509 and TLS (see above) are not
714 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100715 * PSA, and are not restartable. These are temporary limitations that
716 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200717 *
Ron Eldor19779c42018-11-05 16:58:13 +0200718 * \note This option only works with the default software implementation of
719 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100720 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100721 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100722 * Requires: MBEDTLS_ECP_C
723 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100724 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100725 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200726//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100727
728/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200729 * Uncomment to enable using new bignum code in the ECC modules.
730 *
731 * \warning This is currently experimental, incomplete and therefore should not
732 * be used in production.
733 */
734//#define MBEDTLS_ECP_WITH_MPI_UINT
735
736/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200737 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100738 *
739 * Enable deterministic ECDSA (RFC 6979).
740 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
741 * may result in a compromise of the long-term signing key. This is avoided by
742 * the deterministic variant.
743 *
John Durkop36a82e52020-10-26 09:39:05 -0700744 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100745 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100746 * Comment this macro to disable deterministic ECDSA.
747 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100749
750/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200751 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200752 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200753 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200754 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200755 * This enables the following ciphersuites (if other requisites are
756 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
758 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
759 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
760 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
761 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
762 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
763 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
764 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
765 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
766 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200769
770/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200771 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200772 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200773 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200774 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200776 *
777 * This enables the following ciphersuites (if other requisites are
778 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200779 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
780 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
781 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
782 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
783 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
784 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
785 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
786 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
787 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
788 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100789 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100790 * \warning Using DHE constitutes a security risk as it
791 * is not possible to validate custom DH parameters.
792 * If possible, it is recommended users should consider
793 * preferring other methods of key exchange.
794 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100795 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200798
799/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200801 *
802 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
803 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200804 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200805 *
806 * This enables the following ciphersuites (if other requisites are
807 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200808 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
809 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
810 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
811 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
812 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
813 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200814 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200815#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200816
817/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200818 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200819 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200820 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200821 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200822 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
823 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200824 *
825 * This enables the following ciphersuites (if other requisites are
826 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200827 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
828 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
829 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
830 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
831 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
832 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
833 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
834 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
835 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
836 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200837 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200839
840/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200841 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200842 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200843 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200844 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
846 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200847 *
848 * This enables the following ciphersuites (if other requisites are
849 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200850 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
851 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
852 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
853 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
854 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
855 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
856 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
857 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
858 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
859 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
860 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
861 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200862 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200863#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864
865/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200867 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200868 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200869 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
871 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200872 *
873 * This enables the following ciphersuites (if other requisites are
874 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
876 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
877 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
878 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
879 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
880 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
881 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
882 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
883 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
884 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
885 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
886 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100887 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100888 * \warning Using DHE constitutes a security risk as it
889 * is not possible to validate custom DH parameters.
890 * If possible, it is recommended users should consider
891 * preferring other methods of key exchange.
892 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100893 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200896
897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200898 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200899 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200900 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200901 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200902 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
903 * MBEDTLS_RSA_C
904 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200906 *
907 * This enables the following ciphersuites (if other requisites are
908 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
913 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
914 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
915 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
916 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
917 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
918 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200919 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200920#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200921
922/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200923 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200924 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200925 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200926 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200927 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
928 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
929 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200930 *
931 * This enables the following ciphersuites (if other requisites are
932 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
938 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
939 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
940 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
941 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
942 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200943 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200944#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200945
946/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100948 *
949 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
950 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200951 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
952 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
953 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100954 *
955 * This enables the following ciphersuites (if other requisites are
956 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
960 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
961 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
962 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
963 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
964 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
965 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
966 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100969
970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100972 *
973 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
974 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200975 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
976 * MBEDTLS_RSA_C
977 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100978 *
979 * This enables the following ciphersuites (if other requisites are
980 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
982 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
983 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
984 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
985 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
986 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
987 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
988 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
989 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
990 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100991 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100993
994/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200995 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
996 *
997 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
998 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200999 * \warning This is currently experimental. EC J-PAKE support is based on the
1000 * Thread v1.0.0 specification; incompatible changes to the specification
1001 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001002 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001003 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001004 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001005 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1006 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001007 * \warning If SHA-256 is provided only by a PSA driver, you must call
1008 * psa_crypto_init() before the first hanshake (even if
1009 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1010 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001011 * This enables the following ciphersuites (if other requisites are
1012 * enabled as well):
1013 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1014 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001015//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001016
1017/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001018 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001019 *
1020 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1021 * RFC 5915 and RFC 5480.
1022 *
1023 * Currently this means parsing the SpecifiedECDomain choice of EC
1024 * parameters (only known groups are supported, not arbitrary domains, to
1025 * avoid validation issues).
1026 *
1027 * Disable if you only need to support RFC 5915 + 5480 key formats.
1028 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001029#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001030
1031/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001032 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1033 *
1034 * Enable the support for parsing public keys of type Short Weierstrass
1035 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001036 * compressed point format. This parsing is done through ECP module's functions.
1037 *
1038 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1039 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1040 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001041 */
1042#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1043
1044/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001046 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * Enable a dummy error function to make use of mbedtls_strerror() in
1048 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1049 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001050 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1052 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001053 *
1054 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001056 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001057#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001058
1059/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001061 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001062 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001063 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001064 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001067
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001070 *
1071 * Enable functions that use the filesystem.
1072 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001074
1075/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001076 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001077 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001078 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001079 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001080 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001081 * application.
1082 *
1083 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001084 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001086
1087/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001088 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001089 *
1090 * Do not use built-in platform entropy functions.
1091 * This is useful if your platform does not support
1092 * standards like the /dev/urandom or Windows CryptoAPI.
1093 *
1094 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001095 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001097
1098/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001099 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001100 *
1101 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1102 * default SHA-512 based one (if both are available).
1103 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001105 *
1106 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1107 * if you have performance concerns.
1108 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109 * This option is only useful if both MBEDTLS_SHA256_C and
1110 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001111 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001113
1114/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001115 * \def MBEDTLS_ENTROPY_NV_SEED
1116 *
1117 * Enable the non-volatile (NV) seed file-based entropy source.
1118 * (Also enables the NV seed read/write functions in the platform layer)
1119 *
1120 * This is crucial (if not required) on systems that do not have a
1121 * cryptographic entropy source (in hardware or kernel) available.
1122 *
1123 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1124 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001125 * \note The read/write functions that are used by the entropy source are
1126 * determined in the platform layer, and can be modified at runtime and/or
1127 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1128 *
1129 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001130 * with regular fopen(), please make sure you make a seedfile with the
1131 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1132 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001133 * and written to or you will get an entropy source error! The default
1134 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1135 * bytes from the file.
1136 *
1137 * \note The entropy collector will write to the seed file before entropy is
1138 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001139 */
1140//#define MBEDTLS_ENTROPY_NV_SEED
1141
Ronald Cron71016a92020-08-28 19:01:50 +02001142/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001143 *
Ronald Cron71016a92020-08-28 19:01:50 +02001144 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001145 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001146 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1147 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001148 *
1149 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001150 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001151 */
Ronald Cron71016a92020-08-28 19:01:50 +02001152//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001153
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001154/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001156 *
1157 * Enable debugging of buffer allocator memory issues. Automatically prints
1158 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1159 * function for 'debug output' of allocated memory.
1160 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001161 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001162 *
1163 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001164 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001166
1167/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001168 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001169 *
1170 * Include backtrace information with each allocated block.
1171 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001173 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001174 *
1175 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001176 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001178
1179/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001181 *
1182 * Support external private RSA keys (eg from a HSM) in the PK layer.
1183 *
1184 * Comment this macro to disable support for external private RSA keys.
1185 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001187
1188/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001190 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001191 * Enable support for PKCS#1 v1.5 encoding.
1192 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001193 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001194 *
Paul Bakker48377d92013-08-30 12:06:24 +02001195 * This enables support for PKCS#1 v1.5 operations.
1196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001197#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001198
1199/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001200 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001201 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001202 * Enable support for PKCS#1 v2.1 encoding.
1203 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001204 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001205 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001206 * \warning If using a hash that is only provided by PSA drivers, you must
1207 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001208 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001209 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1210 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001211#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001212
Steven Cooreman6801f082021-02-19 17:21:22 +01001213/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1214 *
1215 * Enable support for platform built-in keys. If you enable this feature,
1216 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1217 * See the documentation of that function for more information.
1218 *
1219 * Built-in keys are typically derived from a hardware unique key or
1220 * stored in a secure element.
1221 *
1222 * Requires: MBEDTLS_PSA_CRYPTO_C.
1223 *
1224 * \warning This interface is experimental and may change or be removed
1225 * without notice.
1226 */
1227//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1228
Ronald Cron3768ac12021-01-26 16:58:00 +01001229/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1230 *
1231 * Enable support for PSA crypto client.
1232 *
1233 * \note This option allows to include the code necessary for a PSA
1234 * crypto client when the PSA crypto implementation is not included in
1235 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1236 * code to set and get PSA key attributes.
1237 * The development of PSA drivers partially relying on the library to
1238 * fulfill the hardware gaps is another possible usage of this option.
1239 *
1240 * \warning This interface is experimental and may change or be removed
1241 * without notice.
1242 */
1243//#define MBEDTLS_PSA_CRYPTO_CLIENT
1244
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001245/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1246 *
1247 * Make the PSA Crypto module use an external random generator provided
1248 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1249 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001250 * \note This random generator must deliver random numbers with cryptographic
1251 * quality and high performance. It must supply unpredictable numbers
1252 * with a uniform distribution. The implementation of this function
1253 * is responsible for ensuring that the random generator is seeded
1254 * with sufficient entropy. If you have a hardware TRNG which is slow
1255 * or delivers non-uniform output, declare it as an entropy source
1256 * with mbedtls_entropy_add_source() instead of enabling this option.
1257 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001258 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001259 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1260 * and define a function called mbedtls_psa_external_get_random()
1261 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001262 * ```
1263 * psa_status_t mbedtls_psa_external_get_random(
1264 * mbedtls_psa_external_random_context_t *context,
1265 * uint8_t *output, size_t output_size, size_t *output_length);
1266 * );
1267 * ```
1268 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001269 * The function must fill the \c output buffer with \c output_size bytes
1270 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001271 *
1272 * Requires: MBEDTLS_PSA_CRYPTO_C
1273 *
1274 * \warning If you enable this option, code that uses the PSA cryptography
1275 * interface will not use any of the entropy sources set up for
1276 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1277 * enables.
1278 *
1279 * \note This option is experimental and may be removed without notice.
1280 */
1281//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1282
Paul Bakker9dcc3222011-03-08 14:16:06 +00001283/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001284 * \def MBEDTLS_PSA_CRYPTO_SPM
1285 *
1286 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1287 * Partition Manager) integration which separates the code into two parts: a
1288 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1289 * Environment).
1290 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001291 * If you enable this option, your build environment must include a header
1292 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1293 * header files, or in another directory on the compiler's include search
1294 * path). Alternatively, your platform may customize the header
1295 * `psa/crypto_platform.h`, in which case it can skip or replace the
1296 * inclusion of `"crypto_spe.h"`.
1297 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001298 * Module: library/psa_crypto.c
1299 * Requires: MBEDTLS_PSA_CRYPTO_C
1300 *
1301 */
1302//#define MBEDTLS_PSA_CRYPTO_SPM
1303
1304/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001305 * Uncomment to enable p256-m. This is an alternative implementation of
1306 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1307 * Compared to the default implementation:
1308 *
1309 * - p256-m has a much smaller code size and RAM footprint.
1310 * - p256-m is only available via the PSA API. This includes the pk module
1311 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1312 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1313 * over the core arithmetic, or deterministic derivation of keys.
1314 *
1315 * We recommend enabling this option if your application uses the PSA API
1316 * and the only elliptic curve support it needs is ECDH and ECDSA over
1317 * SECP256R1.
1318 *
1319 * If you enable this option, you do not need to enable any ECC-related
1320 * MBEDTLS_xxx option. You do need to separately request support for the
1321 * cryptographic mechanisms through the PSA API:
1322 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1323 * configuration;
1324 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1325 * - #PSA_WANT_ECC_SECP_R1_256;
1326 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1327 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1328 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1329 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1330 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001331 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001332 * \note To benefit from the smaller code size of p256-m, make sure that you
1333 * do not enable any ECC-related option not supported by p256-m: this
1334 * would cause the built-in ECC implementation to be built as well, in
1335 * order to provide the required option.
1336 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001337 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1338 * SECP256R1 are disabled as they are not supported by this driver.
1339 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1340 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001341 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001342 */
1343//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1344
1345/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001346 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001347 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001348 * Enable support for entropy injection at first boot. This feature is
1349 * required on systems that do not have a built-in entropy source (TRNG).
1350 * This feature is currently not supported on systems that have a built-in
1351 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001352 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001353 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001354 *
1355 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001356//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001357
1358/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001359 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001360 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001361 * Assume all buffers passed to PSA functions are owned exclusively by the
1362 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001363 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001364 * This option may be enabled if all buffers passed to any PSA function reside
1365 * in memory that is accessible only to the PSA function during its execution.
1366 *
1367 * This option MUST be disabled whenever buffer arguments are in memory shared
1368 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001369 * across a trust boundary.
1370 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001371 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001372 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001373 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001374 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001375 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001376//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001377
1378/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001379 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001380 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001381 * Do not use the Chinese Remainder Theorem
1382 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001383 *
1384 * Uncomment this macro to disable the use of CRT in RSA.
1385 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001386 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001387//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001388
1389/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001390 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001391 *
1392 * Enable the checkup functions (*_self_test).
1393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001394#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001395
1396/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001397 * \def MBEDTLS_SHA256_SMALLER
1398 *
1399 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1400 * lower performance.
1401 *
Adam Wolf039080f2019-09-10 09:53:08 -05001402 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001403 * performance and size. This version optimizes more aggressively for size at
1404 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1405 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1406 * 30%.
1407 *
1408 * Uncomment to enable the smaller implementation of SHA256.
1409 */
1410//#define MBEDTLS_SHA256_SMALLER
1411
1412/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001413 * \def MBEDTLS_SHA512_SMALLER
1414 *
1415 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1416 * lower performance.
1417 *
1418 * Uncomment to enable the smaller implementation of SHA512.
1419 */
1420//#define MBEDTLS_SHA512_SMALLER
1421
1422/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001424 *
1425 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001426 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001427 * with other servers, only debugging of failures is harder.
1428 *
1429 * The advantage of not sending alert messages, is that no information is given
1430 * about reasons for failures thus preventing adversaries of gaining intel.
1431 *
1432 * Enable sending of all alert messages
1433 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001434#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001435
1436/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001437 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1438 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001439 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001440 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001441 * in the underlying transport. The CID functionality is described
1442 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001443 *
1444 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001445 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1446 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1447 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001448 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001449 * The maximum lengths of outgoing and incoming CIDs can be configured
1450 * through the options
1451 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1452 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1453 *
1454 * Requires: MBEDTLS_SSL_PROTO_DTLS
1455 *
1456 * Uncomment to enable the Connection ID extension.
1457 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001458#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1459
1460
1461/**
1462 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1463 *
1464 * Defines whether RFC 9146 (default) or the legacy version
1465 * (version draft-ietf-tls-dtls-connection-id-05,
1466 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1467 * is used.
1468 *
1469 * Set the value to 0 for the standard version, and
1470 * 1 for the legacy draft version.
1471 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001472 * \deprecated Support for the legacy version of the DTLS
1473 * Connection ID feature is deprecated. Please
1474 * switch to the standardized version defined
1475 * in RFC 9146 enabled by utilizing
1476 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1477 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1478 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001479 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1480 */
1481#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001482
1483/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001484 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1485 *
1486 * Enable asynchronous external private key operations in SSL. This allows
1487 * you to configure an SSL connection to call an external cryptographic
1488 * module to perform private key operations instead of performing the
1489 * operation inside the library.
1490 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001491 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001492 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001493//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001494
1495/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001496 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1497 *
1498 * Enable serialization of the TLS context structures, through use of the
1499 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1500 *
1501 * This pair of functions allows one side of a connection to serialize the
1502 * context associated with the connection, then free or re-use that context
1503 * while the serialized state is persisted elsewhere, and finally deserialize
1504 * that state to a live context for resuming read/write operations on the
1505 * connection. From a protocol perspective, the state of the connection is
1506 * unaffected, in particular this is entirely transparent to the peer.
1507 *
1508 * Note: this is distinct from TLS session resumption, which is part of the
1509 * protocol and fully visible by the peer. TLS session resumption enables
1510 * establishing new connections associated to a saved session with shorter,
1511 * lighter handshakes, while context serialization is a local optimization in
1512 * handling a single, potentially long-lived connection.
1513 *
1514 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1515 * saved after the handshake to allow for more efficient serialization, so if
1516 * you don't need this feature you'll save RAM by disabling it.
1517 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001518 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1519 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001520 * Comment to disable the context serialization APIs.
1521 */
1522#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1523
1524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001525 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001526 *
1527 * Enable the debug messages in SSL module for all issues.
1528 * Debug messages have been disabled in some places to prevent timing
1529 * attacks due to (unbalanced) debugging function calls.
1530 *
1531 * If you need all error reporting you should enable this during debugging,
1532 * but remove this for production servers that should log as well.
1533 *
1534 * Uncomment this macro to report all debug messages on errors introducing
1535 * a timing side-channel.
1536 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001538//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001541 *
1542 * Enable support for Encrypt-then-MAC, RFC 7366.
1543 *
1544 * This allows peers that both support it to use a more robust protection for
1545 * ciphersuites using CBC, providing deep resistance against timing attacks
1546 * on the padding or underlying cipher.
1547 *
1548 * This only affects CBC ciphersuites, and is useless if none is defined.
1549 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001550 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001551 *
1552 * Comment this macro to disable support for Encrypt-then-MAC
1553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001557 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001558 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1559 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001560 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001561 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001562 * attacks, but it is recommended to always use it (even if you disable
1563 * renegotiation), since it actually fixes a more fundamental issue in the
1564 * original SSL/TLS design, and has implications beyond Triple Handshake.
1565 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001566 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001567 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001568 * Comment this macro to disable support for Extended Master Secret.
1569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001571
Paul Bakkerd66f0702013-01-31 16:57:45 +01001572/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001573 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1574 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001575 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001576 * giving access to the peer's certificate after completion of the handshake.
1577 *
1578 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1579 * recommended to disable this option for reduced RAM usage.
1580 *
1581 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1582 * defined, but always returns \c NULL.
1583 *
1584 * \note This option has no influence on the protection against the
1585 * triple handshake attack. Even if it is disabled, Mbed TLS will
1586 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001587 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001588 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001589 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001590 *
1591 * Comment this macro to disable storing the peer's certificate
1592 * after the handshake.
1593 */
1594#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1595
1596/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001597 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001598 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001599 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001600 *
1601 * The two main uses of renegotiation are (1) refresh keys on long-lived
1602 * connections and (2) client authentication after the initial handshake.
1603 * If you don't need renegotiation, it's probably better to disable it, since
1604 * it has been associated with security issues in the past and is easy to
1605 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001606 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001607 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1608 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001609 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001610 *
1611 * \note Even if this option is disabled, both client and server are aware
1612 * of the Renegotiation Indication Extension (RFC 5746) used to
1613 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1614 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1615 * configuration of this extension).
1616 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001618#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001619
1620/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001622 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001623 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001624 *
1625 * Comment this macro to disable support for the max_fragment_length extension
1626 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001627#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001628
1629/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001630 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1631 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001632 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001633 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001634 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1635 *
1636 * Uncomment this macro to enable support for the record_size_limit extension
1637 */
1638//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1639
1640/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001641 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001642 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001643 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001644 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001645 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001646 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1647 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001648 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001649 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001650 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001651 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1652 * are only provided by PSA drivers, you must call psa_crypto_init() before
1653 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001654 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001655 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001656 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001657#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001658
1659/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001660 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001661 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001662 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001663 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001664 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001665 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001666 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001667 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001668 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001669 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001670 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1671 * directly performed by TLS 1.3 code. As a consequence, you must
1672 * call psa_crypto_init() before the first TLS 1.3 handshake.
1673 *
1674 * \note Cryptographic operations performed indirectly via another module
1675 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1676 * running handshake hash) only use PSA crypto if
1677 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001678 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001679 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001680 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001681#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001682
1683/**
Ronald Cronab65c522021-11-24 10:47:20 +01001684 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1685 *
1686 * Enable TLS 1.3 middlebox compatibility mode.
1687 *
1688 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1689 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1690 * expecting TLS 1.2 traffic.
1691 *
1692 * Turning on the compatibility mode comes at the cost of a few added bytes
1693 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1694 * that don't use it. Therefore, unless transmission bandwidth is critical and
1695 * you know that middlebox compatibility issues won't occur, it is therefore
1696 * recommended to set this option.
1697 *
1698 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001699 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1700 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001701 *
1702 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001703#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001704
1705/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001706 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1707 *
1708 * Enable TLS 1.3 PSK key exchange mode.
1709 *
1710 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1711 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1712 * effect on the build.
1713 *
1714 */
1715#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1716
1717/**
1718 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1719 *
1720 * Enable TLS 1.3 ephemeral key exchange mode.
1721 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001722 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001723 * MBEDTLS_X509_CRT_PARSE_C
1724 * and at least one of:
1725 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1726 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001727 *
1728 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1729 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1730 * effect on the build.
1731 *
1732 */
1733#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1734
1735/**
1736 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1737 *
1738 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1739 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001740 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001741 *
1742 * Comment to disable support for the PSK ephemeral key exchange mode in
1743 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1744 * have any effect on the build.
1745 *
1746 */
1747#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1748
1749/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 * \def MBEDTLS_SSL_EARLY_DATA
1751 *
1752 * Enable support for RFC 8446 TLS 1.3 early data.
1753 *
1754 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1755 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1756 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1757 *
1758 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1759 * is not enabled, this option does not have any effect on the build.
1760 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001761 * \note The maximum amount of early data can be set with
1762 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1763 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001765//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001766
1767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001769 *
1770 * Enable support for DTLS (all available versions).
1771 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001772 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001773 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001774 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001775 *
1776 * Comment this macro to disable support for DTLS
1777 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001778#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001779
1780/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001781 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001782 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001783 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001784 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001785 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001786 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001788
1789/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001791 *
1792 * Enable support for the anti-replay mechanism in DTLS.
1793 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794 * Requires: MBEDTLS_SSL_TLS_C
1795 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001796 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001797 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001798 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001799 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001800 * Comment this to disable anti-replay in DTLS.
1801 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001803
1804/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001806 *
1807 * Enable support for HelloVerifyRequest on DTLS servers.
1808 *
1809 * This feature is highly recommended to prevent DTLS servers being used as
1810 * amplifiers in DoS attacks against other hosts. It should always be enabled
1811 * unless you know for sure amplification cannot be a problem in the
1812 * environment in which your server operates.
1813 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001814 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001815 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001816 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001817 *
1818 * Comment this to disable support for HelloVerifyRequest.
1819 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001820#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001821
1822/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001823 * \def MBEDTLS_SSL_DTLS_SRTP
1824 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001825 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001826 * through the use_srtp extension.
1827 *
1828 * \note This feature provides the minimum functionality required
1829 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1830 * the associated SRTP packet protection key material.
1831 * In particular, the SRTP packet protection itself, as well as the
1832 * demultiplexing of RTP and DTLS packets at the datagram layer
1833 * (see Section 5 of RFC 5764), are not handled by this feature.
1834 * Instead, after successful completion of a handshake negotiating
1835 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001836 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001837 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1838 * (this is implemented in the SSL example programs).
1839 * The resulting key should then be passed to an SRTP stack.
1840 *
1841 * Setting this option enables the runtime API
1842 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1843 * through which the supported DTLS-SRTP protection
1844 * profiles can be configured. You must call this API at
1845 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001846 *
1847 * Requires: MBEDTLS_SSL_PROTO_DTLS
1848 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001849 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001850 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001851//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001852
1853/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001854 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1855 *
1856 * Enable server-side support for clients that reconnect from the same port.
1857 *
1858 * Some clients unexpectedly close the connection and try to reconnect using the
1859 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001860 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001861 * flag enables that support.
1862 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001863 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001864 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001865 * Comment this to disable support for clients reusing the source port.
1866 */
1867#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1868
1869/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001871 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001872 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001873 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001874 * session store remains the responsibility of the application, though).
1875 * Server-side, you also need to provide callbacks for writing and parsing
1876 * tickets, including authenticated encryption and key management. Example
1877 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001878 *
1879 * Comment this macro to disable support for SSL session tickets
1880 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001882
1883/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001885 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001886 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001887 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001888 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001889 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001890 * Comment this macro to disable support for server name indication in SSL
1891 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001893
1894/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001895 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1896 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001897 * When this option is enabled, the SSL buffer will be resized automatically
1898 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001899 *
1900 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001901 */
1902//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1903
1904/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001905 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1906 *
1907 * Enable testing of the constant-flow nature of some sensitive functions with
1908 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001909 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001910 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001911 * This setting requires compiling with clang -fsanitize=memory. The test
1912 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001913 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001914 * \warning This macro is only used for extended testing; it is not considered
1915 * part of the library's API, so it may change or disappear at any time.
1916 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001917 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001918 */
1919//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1920
1921/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001922 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1923 *
1924 * Enable testing of the constant-flow nature of some sensitive functions with
1925 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001926 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001927 *
1928 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001929 * testing if the tests suites are run with valgrind's memcheck. This can be
1930 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1931 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001932 *
1933 * \warning This macro is only used for extended testing; it is not considered
1934 * part of the library's API, so it may change or disappear at any time.
1935 *
1936 * Uncomment to enable testing of the constant-flow nature of selected code.
1937 */
1938//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1939
1940/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001941 * \def MBEDTLS_TEST_HOOKS
1942 *
1943 * Enable features for invasive testing such as introspection functions and
1944 * hooks for fault injection. This enables additional unit tests.
1945 *
1946 * Merely enabling this feature should not change the behavior of the product.
1947 * It only adds new code, and new branching points where the default behavior
1948 * is the same as when this feature is disabled.
1949 * However, this feature increases the attack surface: there is an added
1950 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1951 * Therefore this feature must never be enabled in production.
1952 *
1953 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1954 * information.
1955 *
1956 * Uncomment to enable invasive tests.
1957 */
1958//#define MBEDTLS_TEST_HOOKS
1959
1960/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001961 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001962 *
1963 * Provide your own alternate threading implementation.
1964 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001965 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001966 *
1967 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001968 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001970
1971/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001972 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001973 *
1974 * Enable the pthread wrapper layer for the threading layer.
1975 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001976 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001977 *
1978 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001979 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001980//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001981
1982/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001983 * \def MBEDTLS_USE_PSA_CRYPTO
1984 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001985 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1986 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001987 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001988 * \note Development of this option is currently in progress, and parts of Mbed
1989 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001990 * will still continue to work as usual, so enabling this option should not
1991 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001992 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001993 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001994 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1995 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001996 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001997 * \note An important and desirable effect of this option is that it allows
1998 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1999 * 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 +02002000 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002001 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2002 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002003 *
2004 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002005 *
2006 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002007 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002008 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002010//#define MBEDTLS_USE_PSA_CRYPTO
2011
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002012/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002013 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2014 *
John Durkop185764f2020-10-12 21:32:12 -07002015 * This setting allows support for cryptographic mechanisms through the PSA
2016 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002017 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002018 * When this option is disabled, the PSA API exposes the cryptographic
2019 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2020 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002021 *
2022 * When this option is enabled, the PSA API exposes the cryptographic
2023 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2024 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2025 * automatically enabled if required (i.e. if no PSA driver provides the
2026 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2027 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002028 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002029 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002030 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002031 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002032 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2033 * symbols is not completely finalized yet, and the configuration
2034 * tooling is not ideally adapted to having two separate configuration
2035 * files.
2036 * Future minor releases of Mbed TLS may make minor changes to those
2037 * symbols, but we will endeavor to provide a transition path.
2038 * Nonetheless, this option is considered mature enough to use in
2039 * production, as long as you accept that you may need to make
2040 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002041 */
2042//#define MBEDTLS_PSA_CRYPTO_CONFIG
2043
2044/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002045 * \def MBEDTLS_VERSION_FEATURES
2046 *
2047 * Allow run-time checking of compile-time enabled features. Thus allowing users
2048 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002049 * support via mbedtls_version_check_feature().
2050 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002051 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002052 *
2053 * Comment this to disable run-time checking and save ROM space
2054 */
2055#define MBEDTLS_VERSION_FEATURES
2056
2057/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002058 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2059 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002060 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002061 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2062 * the set of trusted certificates through a callback instead of a linked
2063 * list.
2064 *
2065 * This is useful for example in environments where a large number of trusted
2066 * certificates is present and storing them in a linked list isn't efficient
2067 * enough, or when the set of trusted certificates changes frequently.
2068 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002069 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002070 * `mbedtls_ssl_conf_ca_cb()` for more information.
2071 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002072 * Requires: MBEDTLS_X509_CRT_PARSE_C
2073 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002074 * Uncomment to enable trusted certificate callbacks.
2075 */
2076//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2077
2078/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002079 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002080 *
Chris Jones2c745862020-12-16 11:41:06 +00002081 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002082 *
Chris Jones2c745862020-12-16 11:41:06 +00002083 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002084 * and other functions/constants only used by these functions, thus reducing
2085 * the code footprint by several KB.
2086 */
Chris Jones2c745862020-12-16 11:41:06 +00002087//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002088
2089/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002090 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002091 *
2092 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2093 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2094 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002095 * Requires: MBEDTLS_PKCS1_V21
2096 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002097 * Comment this macro to disallow using RSASSA-PSS in certificates.
2098 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002099#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002100/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002101
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002102/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002103 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002104 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002105 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002106 * \{
2107 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002108
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002109/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002111 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002112 * Enable AES-NI support on x86-64 or x86-32.
2113 *
2114 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002115 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002116 * - GCC, x86-64, target not explicitly supporting AESNI:
2117 * requires MBEDTLS_HAVE_ASM.
2118 * - GCC, x86-32, target not explicitly supporting AESNI:
2119 * not supported.
2120 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2121 * For this assembly-less implementation, you must currently compile
2122 * `library/aesni.c` and `library/aes.c` with machine options to enable
2123 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2124 * `clang -maes -mpclmul`.
2125 * - Non-x86 targets: this option is silently ignored.
2126 * - Other compilers: this option is silently ignored.
2127 *
2128 * \note
2129 * Above, "GCC" includes compatible compilers such as Clang.
2130 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002131 *
2132 * Module: library/aesni.c
2133 * Caller: library/aes.c
2134 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002135 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002136 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002137 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002139#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002140
2141/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002142 * \def MBEDTLS_AESCE_C
2143 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002144 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002145 *
2146 * Module: library/aesce.c
2147 * Caller: library/aes.c
2148 *
Jerry Yuf015a932023-04-25 10:38:03 +08002149 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002150 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002151 * \warning Runtime detection only works on Linux. For non-Linux operating
2152 * system, Armv8-A Cryptographic Extensions must be supported by
2153 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002154 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002155 * \note Minimum compiler versions for this feature when targeting aarch64
2156 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2157 * Minimum compiler versions for this feature when targeting 32-bit
2158 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002159 *
2160 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2161 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002162 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002163 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002164 */
2165#define MBEDTLS_AESCE_C
2166
2167/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002168 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002169 *
2170 * Enable the AES block cipher.
2171 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002172 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002173 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002174 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002175 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002176 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002177 * This module enables the following ciphersuites (if other requisites are
2178 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2180 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2181 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2182 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2183 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2184 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2185 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2186 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2187 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2188 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2189 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2190 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2191 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2192 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2193 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2194 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2195 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2196 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2197 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2198 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2199 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2200 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2201 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2202 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2203 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2204 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2205 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2206 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2207 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2208 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2209 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2210 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2211 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2212 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2213 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2214 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2215 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2216 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2217 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2218 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2219 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2220 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2221 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2222 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2223 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2224 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2225 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2226 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2227 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2228 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2229 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2230 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2231 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2232 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2233 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2234 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2235 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2236 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002237 *
Paul Bakkercff68422013-09-15 20:43:33 +02002238 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002239 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002240#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002241
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002242/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002243 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002244 *
2245 * Enable the generic ASN1 parser.
2246 *
2247 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002248 * Caller: library/x509.c
2249 * library/dhm.c
2250 * library/pkcs12.c
2251 * library/pkcs5.c
2252 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002253 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002254#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002255
2256/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002257 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002258 *
2259 * Enable the generic ASN1 writer.
2260 *
2261 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002262 * Caller: library/ecdsa.c
2263 * library/pkwrite.c
2264 * library/x509_create.c
2265 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002266 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002269
2270/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002271 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002272 *
2273 * Enable the Base64 module.
2274 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002275 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002276 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002277 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002278 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002279 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002280#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002281
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002282/**
Yanray Wange367e472023-10-31 17:23:04 +08002283 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2284 *
2285 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2286 *
2287 * \note This feature is incompatible with insecure block cipher,
2288 * MBEDTLS_DES_C, and cipher modes which always require decryption
2289 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002290 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2291 * this feature is incompatible with following supported PSA equivalence,
2292 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2293 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002294 *
2295 * Module: library/aes.c
2296 * library/aesce.c
2297 * library/aesni.c
2298 * library/aria.c
2299 * library/camellia.c
2300 * library/cipher.c
2301 */
2302//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2303
2304/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002305 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002306 *
Paul Bakker9a736322012-11-14 12:39:52 +00002307 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002308 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002309 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002310 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002311 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002312 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002313 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002314 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002315 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002316 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002317 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002318 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002319 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002320 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002321 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002323
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002324/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002325 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002326 *
2327 * Enable the Camellia block cipher.
2328 *
Paul Bakker38119b12009-01-10 23:31:23 +00002329 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002330 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002331 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002332 * This module enables the following ciphersuites (if other requisites are
2333 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2335 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2336 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2337 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2338 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2339 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2340 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2341 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2342 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2343 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2344 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2345 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2346 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2347 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2348 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2349 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2350 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2351 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2352 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2353 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2354 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2355 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2356 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2357 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2358 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2359 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2360 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2361 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2362 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2363 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2364 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2365 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2366 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2367 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2368 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2369 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2370 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2371 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2372 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2373 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2374 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2375 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002377#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002378
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002379/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002380 * \def MBEDTLS_ARIA_C
2381 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002382 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002383 *
2384 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002385 * Caller: library/cipher.c
2386 *
2387 * This module enables the following ciphersuites (if other requisites are
2388 * enabled as well):
2389 *
2390 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2391 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2392 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2393 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2394 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2395 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2396 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2397 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2398 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2399 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2400 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2401 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2402 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2403 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2404 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2405 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2406 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2407 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2408 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2409 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2410 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2411 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2412 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2413 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2414 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2415 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2416 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2417 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2418 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2419 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2420 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2421 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2422 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2423 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2424 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2425 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2426 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2427 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002428 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002429#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002430
2431/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002433 *
2434 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2435 *
2436 * Module: library/ccm.c
2437 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002438 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2439 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002440 *
2441 * This module enables the AES-CCM ciphersuites, if other requisites are
2442 * enabled as well.
2443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002445
2446/**
Daniel King34b822c2016-05-15 17:28:08 -03002447 * \def MBEDTLS_CHACHA20_C
2448 *
2449 * Enable the ChaCha20 stream cipher.
2450 *
2451 * Module: library/chacha20.c
2452 */
2453#define MBEDTLS_CHACHA20_C
2454
2455/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002456 * \def MBEDTLS_CHACHAPOLY_C
2457 *
2458 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2459 *
2460 * Module: library/chachapoly.c
2461 *
2462 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2463 */
2464#define MBEDTLS_CHACHAPOLY_C
2465
2466/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002467 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002468 *
2469 * Enable the generic cipher layer.
2470 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002471 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002472 * Caller: library/ccm.c
2473 * library/cmac.c
2474 * library/gcm.c
2475 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002476 * library/pkcs12.c
2477 * library/pkcs5.c
2478 * library/psa_crypto_aead.c
2479 * library/psa_crypto_mac.c
2480 * library/ssl_ciphersuites.c
2481 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002482 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002483 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2484 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002485 *
2486 * Uncomment to enable generic cipher wrappers.
2487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002489
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002490/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002491 * \def MBEDTLS_CMAC_C
2492 *
Simon Butcher327398a2016-10-05 14:09:11 +01002493 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2494 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002495 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002496 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2497 * implementation of the CMAC algorithm is provided by an alternate
2498 * implementation, that alternate implementation may opt to not support
2499 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2500 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002501 * Module: library/cmac.c
2502 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002503 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002504 *
2505 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002506#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002507
2508/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002510 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002511 * Enable the CTR_DRBG AES-based random generator.
2512 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002513 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002514 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002515 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2516 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2517 * is used.
2518 *
2519 * \warning When using PSA, the user should call `psa_crypto_init()` before
2520 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2521 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002522 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2523 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002524 * \note To achieve a 256-bit security strength with CTR_DRBG,
2525 * you must use AES-256 *and* use sufficient entropy.
2526 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002527 *
2528 * Module: library/ctr_drbg.c
2529 * Caller:
2530 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002531 * Requires: MBEDTLS_AES_C or
2532 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2533 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002534 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002535 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002538
2539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002541 *
2542 * Enable the debug functions.
2543 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002544 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002545 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002546 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002547 * library/ssl_tls12_*.c
2548 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002549 *
2550 * This module provides debugging functions.
2551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002553
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002556 *
2557 * Enable the DES block cipher.
2558 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002559 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002560 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002561 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002562 *
Paul Bakkercff68422013-09-15 20:43:33 +02002563 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002564 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002565 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002566 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002569
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002570/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002572 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002573 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002574 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002575 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002576 * Caller: library/ssl_tls.c
2577 * library/ssl*_client.c
2578 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002579 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002580 * This module is used by the following key exchanges:
2581 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002582 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002583 * \warning Using DHE constitutes a security risk as it
2584 * is not possible to validate custom DH parameters.
2585 * If possible, it is recommended users should consider
2586 * preferring other methods of key exchange.
2587 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002588 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002589 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002590#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002591
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002592/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002594 *
2595 * Enable the elliptic curve Diffie-Hellman library.
2596 *
2597 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002598 * Caller: library/psa_crypto.c
2599 * library/ssl_tls.c
2600 * library/ssl*_client.c
2601 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002602 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002603 * This module is used by the following key exchanges:
2604 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002605 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002606 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002609
2610/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002612 *
2613 * Enable the elliptic curve DSA library.
2614 *
2615 * Module: library/ecdsa.c
2616 * Caller:
2617 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002618 * This module is used by the following key exchanges:
2619 * ECDHE-ECDSA
2620 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002621 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2622 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2623 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002624 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002625#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002626
2627/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002628 * \def MBEDTLS_ECJPAKE_C
2629 *
2630 * Enable the elliptic curve J-PAKE library.
2631 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002632 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2633 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002634 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002635 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002636 * Module: library/ecjpake.c
2637 * Caller:
2638 *
2639 * This module is used by the following key exchanges:
2640 * ECJPAKE
2641 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002642 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002643 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002644 * \warning If using a hash that is only provided by PSA drivers, you must
2645 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002646 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002647#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002648
2649/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002650 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002651 *
2652 * Enable the elliptic curve over GF(p) library.
2653 *
2654 * Module: library/ecp.c
2655 * Caller: library/ecdh.c
2656 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002657 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002658 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002660 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002662
2663/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002665 *
2666 * Enable the platform-specific entropy code.
2667 *
2668 * Module: library/entropy.c
2669 * Caller:
2670 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002672 *
2673 * This module provides a generic entropy pool
2674 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002676
2677/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002678 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002679 *
2680 * Enable error code to error string conversion.
2681 *
2682 * Module: library/error.c
2683 * Caller:
2684 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002688
2689/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002691 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002692 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002693 *
2694 * Module: library/gcm.c
2695 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002696 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2697 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002698 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002699 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2700 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002701 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002703
2704/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002705 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002706 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002707 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002708 * Can significantly increase throughput on systems without GCM hardware
2709 * acceleration (e.g., AESNI, AESCE).
2710 *
Matthias Schulz78266782024-02-08 13:54:48 +01002711 * The mbedtls_gcm_context size will increase by 3840 bytes.
2712 * The code size will increase by roughly 344 bytes.
2713 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002714 * Module: library/gcm.c
2715 *
2716 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002717 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002718//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002719
2720/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002721 * \def MBEDTLS_HKDF_C
2722 *
2723 * Enable the HKDF algorithm (RFC 5869).
2724 *
2725 * Module: library/hkdf.c
2726 * Caller:
2727 *
2728 * Requires: MBEDTLS_MD_C
2729 *
2730 * This module adds support for the Hashed Message Authentication Code
2731 * (HMAC)-based key derivation function (HKDF).
2732 */
2733#define MBEDTLS_HKDF_C
2734
2735/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002737 *
2738 * Enable the HMAC_DRBG random generator.
2739 *
2740 * Module: library/hmac_drbg.c
2741 * Caller:
2742 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002744 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002745 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002746 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002747#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002748
2749/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002750 * \def MBEDTLS_LMS_C
2751 *
2752 * Enable the LMS stateful-hash asymmetric signature algorithm.
2753 *
2754 * Module: library/lms.c
2755 * Caller:
2756 *
Raef Colesab4f8742022-09-01 12:24:31 +01002757 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002758 *
Raef Colesab4f8742022-09-01 12:24:31 +01002759 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002760 */
2761#define MBEDTLS_LMS_C
2762
2763/**
Raef Colesab4f8742022-09-01 12:24:31 +01002764 * \def MBEDTLS_LMS_PRIVATE
2765 *
2766 * Enable LMS private-key operations and signing code. Functions enabled by this
2767 * option are experimental, and should not be used in production.
2768 *
2769 * Requires: MBEDTLS_LMS_C
2770 *
2771 * Uncomment to enable the LMS signature algorithm and private key operations.
2772 */
Raef Coles5127e852022-10-07 10:35:56 +01002773//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002774
2775/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002776 * \def MBEDTLS_NIST_KW_C
2777 *
2778 * Enable the Key Wrapping mode for 128-bit block ciphers,
2779 * as defined in NIST SP 800-38F. Only KW and KWP modes
2780 * are supported. At the moment, only AES is approved by NIST.
2781 *
2782 * Module: library/nist_kw.c
2783 *
2784 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2785 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002786#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002787
2788/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002789 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002790 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002791 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002792 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002793 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2794 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002795 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002796 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002797 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002798 * Caller: library/constant_time.c
2799 * library/ecdsa.c
2800 * library/ecjpake.c
2801 * library/hkdf.c
2802 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002803 * library/pk.c
2804 * library/pkcs5.c
2805 * library/pkcs12.c
2806 * library/psa_crypto_ecp.c
2807 * library/psa_crypto_rsa.c
2808 * library/rsa.c
2809 * library/ssl_cookie.c
2810 * library/ssl_msg.c
2811 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002812 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002813 * library/x509_crt.c
2814 * library/x509write_crt.c
2815 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002816 *
2817 * Uncomment to enable generic message digest wrappers.
2818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002820
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002821/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002823 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002824 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002825 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002826 * Module: library/md5.c
2827 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002828 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002829 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002830 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002831 * This module is required for TLS 1.2 depending on the handshake parameters.
2832 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2833 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002834 *
2835 * \warning MD5 is considered a weak message digest and its use constitutes a
2836 * security risk. If possible, we recommend avoiding dependencies on
2837 * it, and considering stronger message digests instead.
2838 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002839 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002840#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002841
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002842/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002844 *
2845 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002846 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002847 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002848 *
2849 * Module: library/memory_buffer_alloc.c
2850 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002852 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002853 *
2854 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002857
2858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002860 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002861 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2862 *
Simon Butcherd567a232016-03-09 20:19:21 +00002863 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2864 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002865 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002866 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002867 * \note See also our Knowledge Base article about porting to a new
2868 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002869 * 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 +00002870 *
Andres AG788aa4a2016-09-14 14:32:09 +01002871 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002872 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002873 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002874 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002876
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002877/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002879 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002880 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002881 *
2882 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002883 * Caller: library/asn1write.c
2884 * library/pkcs5.c
2885 * library/pkparse.c
2886 * library/pkwrite.c
2887 * library/rsa.c
2888 * library/x509.c
2889 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002890 * library/x509_crl.c
2891 * library/x509_crt.c
2892 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002893 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002894 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002895 *
2896 * This modules translates between OIDs and internal values.
2897 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002899
2900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002901 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002902 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002903 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002904 *
2905 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002906 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002907 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002908 * library/x509_crl.c
2909 * library/x509_crt.c
2910 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002911 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002913 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2914 *
2915 * \warning When parsing password-protected files, if MD5 is provided only by
2916 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002917 *
Paul Bakkercff68422013-09-15 20:43:33 +02002918 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002919 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002920#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002921
2922/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002923 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002924 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002925 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002926 *
2927 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002928 * Caller: library/pkwrite.c
2929 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002930 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002931 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002933 *
2934 * This modules adds support for encoding / writing PEM files.
2935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002936#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002937
2938/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002940 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002941 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002942 *
2943 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002944 * Caller: library/psa_crypto_rsa.c
2945 * library/ssl_tls.c
2946 * library/ssl*_client.c
2947 * library/ssl*_server.c
2948 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002949 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002950 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002951 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002952 * Uncomment to enable generic public key wrappers.
2953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002955
2956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002958 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002959 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002960 *
2961 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002962 * Caller: library/x509_crt.c
2963 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002964 *
Yanray Wang072a0682023-12-05 10:53:04 +08002965 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002966 *
2967 * Uncomment to enable generic public key parse functions.
2968 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002970
2971/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002972 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002973 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002974 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002975 *
2976 * Module: library/pkwrite.c
2977 * Caller: library/x509write.c
2978 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002979 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002980 *
2981 * Uncomment to enable generic public key write functions.
2982 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002984
2985/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002987 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002988 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002989 *
2990 * Module: library/pkcs5.c
2991 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002992 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002993 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002994 * \warning If using a hash that is only provided by PSA drivers, you must
2995 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002996 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002997 * This module adds support for the PKCS#5 functions.
2998 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002999#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003000
3001/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003002 * \def MBEDTLS_PKCS7_C
3003 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003004 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003005 * RFC Link - https://tools.ietf.org/html/rfc2315
3006 *
3007 * Module: library/pkcs7.c
3008 *
3009 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003010 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3011 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003012 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003013 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003014 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003015#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003016
3017/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003019 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003020 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003021 * Adds algorithms for parsing PKCS#8 encrypted private keys
3022 *
3023 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003024 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003025 *
Valerio Settie98ad592023-12-28 10:42:12 +01003026 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3027 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003028 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003029 * \warning If using a hash that is only provided by PSA drivers, you must
3030 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003031 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003032 * This module enables PKCS#12 functions.
3033 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003035
3036/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003038 *
3039 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003040 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003041 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3043 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003044 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003045 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003046 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003047 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003048 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003049 * Module: library/platform.c
3050 * Caller: Most other .c files
3051 *
3052 * This module enables abstraction of common (libc) functions.
3053 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003054#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003055
3056/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003057 * \def MBEDTLS_POLY1305_C
3058 *
3059 * Enable the Poly1305 MAC algorithm.
3060 *
3061 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003062 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003063 */
3064#define MBEDTLS_POLY1305_C
3065
3066/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003067 * \def MBEDTLS_PSA_CRYPTO_C
3068 *
3069 * Enable the Platform Security Architecture cryptography API.
3070 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003071 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003072 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003073 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003074 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003075 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3076 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3077 * is enabled in PSA (unless it's fully accelerated, see
3078 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003079 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003080#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003081
3082/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003083 * \def MBEDTLS_PSA_CRYPTO_SE_C
3084 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003085 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003086 * cryptography API.
3087 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003088 * \deprecated This feature is deprecated. Please switch to the PSA driver
3089 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003090 *
Ryan Everett32a64582024-03-05 18:16:18 +00003091 * \warning This feature is not thread-safe, and should not be used in a
3092 * multi-threaded environment.
3093 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003094 * Module: library/psa_crypto_se.c
3095 *
3096 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3097 *
3098 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003099//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003100
3101/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003102 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3103 *
3104 * Enable the Platform Security Architecture persistent key storage.
3105 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003106 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003107 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003108 * Requires: MBEDTLS_PSA_CRYPTO_C,
3109 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3110 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003111 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003112#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003113
3114/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003115 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003116 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003117 * Enable the emulation of the Platform Security Architecture
3118 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003119 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003120 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003121 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003122 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003123 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003124#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003125
3126/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003128 *
3129 * Enable the RIPEMD-160 hash algorithm.
3130 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003131 * Module: library/ripemd160.c
3132 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003133 *
3134 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003136
3137/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003138 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003139 *
3140 * Enable the RSA public-key cryptosystem.
3141 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003142 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003143 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003144 * Caller: library/pk.c
3145 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003146 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003147 * library/ssl*_client.c
3148 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003149 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003150 * This module is used by the following key exchanges:
3151 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003152 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003154 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003156
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003157/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003159 *
3160 * Enable the SHA1 cryptographic hash algorithm.
3161 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003162 * Module: library/sha1.c
3163 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003164 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003165 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003166 * This module is required for TLS 1.2 depending on the handshake parameters,
3167 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003168 *
3169 * \warning SHA-1 is considered a weak message digest and its use constitutes
3170 * a security risk. If possible, we recommend avoiding dependencies
3171 * on it, and considering stronger message digests instead.
3172 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003175
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003176/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003177 * \def MBEDTLS_SHA224_C
3178 *
3179 * Enable the SHA-224 cryptographic hash algorithm.
3180 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003181 * Module: library/sha256.c
3182 * Caller: library/md.c
3183 * library/ssl_cookie.c
3184 *
3185 * This module adds support for SHA-224.
3186 */
3187#define MBEDTLS_SHA224_C
3188
3189/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003190 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003191 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003192 * Enable the SHA-256 cryptographic hash algorithm.
3193 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003194 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003195 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003196 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003197 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003198 * library/ssl*_client.c
3199 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003200 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003201 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003202 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003203 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003204#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003205
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003206/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003207 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003208 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003209 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3210 * with the ARMv8 cryptographic extensions if they are available at runtime.
3211 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003212 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003213 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003214 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003215 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003216 * \note Minimum compiler versions for this feature are Clang 4.0,
3217 * armclang 6.6 or GCC 6.0.
3218 *
3219 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3220 * armclang <= 6.9
3221 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003222 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3223 * That name is deprecated, but may still be used as an alternative form for this
3224 * option.
3225 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003226 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3227 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003228 *
3229 * Requires: MBEDTLS_SHA256_C.
3230 *
3231 * Module: library/sha256.c
3232 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003233 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003234 * and use them if available.
3235 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003236//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003237
Dave Rodgmand85277c2023-10-13 09:22:54 +01003238/**
3239 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3240 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003241 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003242 * This name is now deprecated, but may still be used as an alternative form for
3243 * this option.
3244 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003245//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3246
3247/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003248 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003249 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003250 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3251 * with the ARMv8 cryptographic extensions, which must be available at runtime
3252 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003253 *
3254 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003255 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003256 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003257 * \note Minimum compiler versions for this feature are Clang 4.0,
3258 * armclang 6.6 or GCC 6.0.
3259 *
3260 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3261 * armclang <= 6.9
3262 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003263 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003264 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003265 * option.
3266 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003267 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3268 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003269 *
3270 * Requires: MBEDTLS_SHA256_C.
3271 *
3272 * Module: library/sha256.c
3273 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003274 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003275 * unconditionally.
3276 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003277//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003278
Dave Rodgmand85277c2023-10-13 09:22:54 +01003279/**
3280 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3281 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003282 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003283 * This name is now deprecated, but may still be used as an alternative form for
3284 * this option.
3285 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003286//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3287
3288/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003289 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003290 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003291 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003292 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003293 * Module: library/sha512.c
3294 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003295 * library/psa_crypto_hash.c
3296 * library/ssl_tls.c
3297 * library/ssl*_client.c
3298 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003299 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003300 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003301 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003302#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003303
3304/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003305 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003306 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003307 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003308 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003309 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003310 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003311 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003312 * library/ssl_tls.c
3313 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003314 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003315 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003316 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003318
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003319/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003320 * \def MBEDTLS_SHA3_C
3321 *
3322 * Enable the SHA3 cryptographic hash algorithm.
3323 *
3324 * Module: library/sha3.c
3325 *
3326 * This module adds support for SHA3.
3327 */
3328#define MBEDTLS_SHA3_C
3329
3330/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003331 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3332 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003333 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3334 * with the ARMv8 cryptographic extensions if they are available at runtime.
3335 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003336 *
3337 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3338 * for a non-Aarch64 build it will be silently ignored.
3339 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003340 * \note Minimum compiler versions for this feature are Clang 7.0,
3341 * armclang 6.9 or GCC 8.0.
3342 *
3343 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3344 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003345 *
3346 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3347 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3348 *
3349 * Requires: MBEDTLS_SHA512_C.
3350 *
3351 * Module: library/sha512.c
3352 *
3353 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3354 * and use them if available.
3355 */
3356//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3357
3358/**
3359 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3360 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003361 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3362 * with the ARMv8 cryptographic extensions, which must be available at runtime
3363 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003364 *
3365 * \note This allows builds with a smaller code size than with
3366 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3367 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003368 * \note Minimum compiler versions for this feature are Clang 7.0,
3369 * armclang 6.9 or GCC 8.0.
3370 *
3371 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3372 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003373 *
3374 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3375 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3376 *
3377 * Requires: MBEDTLS_SHA512_C.
3378 *
3379 * Module: library/sha512.c
3380 *
3381 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3382 * unconditionally.
3383 */
3384//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3385
3386/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003388 *
3389 * Enable simple SSL cache implementation.
3390 *
3391 * Module: library/ssl_cache.c
3392 * Caller:
3393 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003395 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003397
3398/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003399 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003400 *
3401 * Enable basic implementation of DTLS cookies for hello verification.
3402 *
3403 * Module: library/ssl_cookie.c
3404 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003405 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003406#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003407
3408/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003409 * \def MBEDTLS_SSL_TICKET_C
3410 *
3411 * Enable an implementation of TLS server-side callbacks for session tickets.
3412 *
3413 * Module: library/ssl_ticket.c
3414 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003415 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003416 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3417 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003418 */
3419#define MBEDTLS_SSL_TICKET_C
3420
3421/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003423 *
3424 * Enable the SSL/TLS client code.
3425 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003426 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003427 * Caller:
3428 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003429 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003430 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003431 * This module is required for SSL/TLS client support.
3432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003434
Paul Bakker9a736322012-11-14 12:39:52 +00003435/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003436 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003437 *
3438 * Enable the SSL/TLS server code.
3439 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003440 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003441 * Caller:
3442 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003443 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003444 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003445 * This module is required for SSL/TLS server support.
3446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003447#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003448
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003449/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003451 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003452 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003453 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003454 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003455 * Caller: library/ssl*_client.c
3456 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003457 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003458 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3459 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003460 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003461 * This module is required for SSL/TLS.
3462 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003463#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003464
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003465/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003466 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003467 *
3468 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003469 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003470 * contexts are not shared between threads. If you do intend to use contexts
3471 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003472 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003473 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003474 *
3475 * Module: library/threading.c
3476 *
3477 * This allows different threading implementations (self-implemented or
3478 * provided).
3479 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480 * You will have to enable either MBEDTLS_THREADING_ALT or
3481 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003482 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003483 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003485//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003486
3487/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003488 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003489 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003490 * Enable the semi-portable timing interface.
3491 *
Simon Butcherd567a232016-03-09 20:19:21 +00003492 * \note The provided implementation only works on POSIX/Unix (including Linux,
3493 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003494 * module and provide your own implementations of the callbacks needed by
3495 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3496 * your own implementation of the whole module by setting
3497 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003498 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003499 * \note The timing module will include time.h on suitable platforms
3500 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3501 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3502 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003503 * \note See also our Knowledge Base article about porting to a new
3504 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003505 * 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 +00003506 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003507 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003508 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003509#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003510
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003511/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003513 *
3514 * Enable run-time version information.
3515 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003516 * Module: library/version.c
3517 *
3518 * This module provides run-time version information.
3519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003521
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003522/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003523 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003524 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003525 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003526 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003527 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003528 * Caller: library/x509_crl.c
3529 * library/x509_crt.c
3530 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003531 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003532 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003533 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3534 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003535 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3536 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003537 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003538 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003541
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003544 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003545 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003546 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003547 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003548 * Caller: library/ssl_tls.c
3549 * library/ssl*_client.c
3550 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003551 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003553 *
3554 * This module is required for X.509 certificate parsing.
3555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003556#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003557
3558/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003559 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003560 *
3561 * Enable X.509 CRL parsing.
3562 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003563 * Module: library/x509_crl.c
3564 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003565 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003567 *
3568 * This module is required for X.509 CRL parsing.
3569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003570#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003571
3572/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003574 *
3575 * Enable X.509 Certificate Signing Request (CSR) parsing.
3576 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003577 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003578 * Caller: library/x509_crt_write.c
3579 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003580 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003581 *
3582 * This module is used for reading X.509 certificate request.
3583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003584#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003585
3586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003587 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003588 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003589 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003590 *
3591 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003592 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003593 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003594 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3595 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003596 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3597 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003598 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003599 * This module is the basis for creating X.509 certificates and CSRs.
3600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003602
3603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003604 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003605 *
3606 * Enable creating X.509 certificates.
3607 *
3608 * Module: library/x509_crt_write.c
3609 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003610 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003611 *
3612 * This module is required for X.509 certificate creation.
3613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003614#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003615
3616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003617 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003618 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003619 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003620 *
3621 * Module: library/x509_csr_write.c
3622 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003623 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003624 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003625 * This module is required for X.509 certificate request writing.
3626 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003627#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003628
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003629/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003630
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003631/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003632 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003633 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003634 * This section contains Mbed TLS build settings that are not associated
3635 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003636 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003637 * \{
3638 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003639
Gilles Peskinea02c1242022-03-16 17:03:19 +01003640/**
3641 * \def MBEDTLS_CONFIG_FILE
3642 *
3643 * If defined, this is a header which will be included instead of
3644 * `"mbedtls/mbedtls_config.h"`.
3645 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003646 * Unlike other configuration options, this one must be defined on the
3647 * compiler command line: a definition in `mbedtls_config.h` would have
3648 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003649 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003650 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003651 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003652 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003653 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003654 * The value of this symbol is typically a path in double quotes, either
3655 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003656 */
3657//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3658
3659/**
3660 * \def MBEDTLS_USER_CONFIG_FILE
3661 *
3662 * If defined, this is a header which will be included after
3663 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003664 * This allows you to modify the default configuration, including the ability
3665 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003666 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003667 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003668 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003669 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003670 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003671 * The value of this symbol is typically a path in double quotes, either
3672 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003673 */
3674//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3675
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003676/**
3677 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3678 *
3679 * If defined, this is a header which will be included instead of
3680 * `"psa/crypto_config.h"`.
3681 * This header file specifies which cryptographic mechanisms are available
3682 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3683 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3684 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003685 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003686 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003687 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003688 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003689 * The value of this symbol is typically a path in double quotes, either
3690 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003691 */
3692//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3693
3694/**
3695 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3696 *
3697 * If defined, this is a header which will be included after
3698 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003699 * This allows you to modify the default configuration, including the ability
3700 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003701 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003702 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003703 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003704 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003705 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003706 * The value of this symbol is typically a path in double quotes, either
3707 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003708 */
3709//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3710
Gilles Peskineb1176f22023-02-22 22:07:28 +01003711/**
3712 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3713 *
3714 * If defined, this is a header which will be included instead of
3715 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3716 * as the one in Mbed TLS, but with definitions adapted to the platform on
3717 * which the library code will run.
3718 *
3719 * \note The required content of this header can vary from one version of
3720 * Mbed TLS to the next. Integrators who provide an alternative file
3721 * should review the changes in the original file whenever they
3722 * upgrade Mbed TLS.
3723 *
3724 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3725 * non-standard feature of the C language, so this feature is only available
3726 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3727 *
3728 * The value of this symbol is typically a path in double quotes, either
3729 * absolute or relative to a directory on the include search path.
3730 */
3731//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3732
3733/**
3734 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3735 *
3736 * If defined, this is a header which will be included instead of
3737 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3738 * as the one in Mbed TLS, but with definitions adapted to the environment
3739 * in which the library code will run. The typical use for this feature
3740 * is to provide alternative type definitions on the client side in
3741 * client-server integrations of PSA crypto, where operation structures
3742 * contain handles instead of cryptographic data.
3743 *
3744 * \note The required content of this header can vary from one version of
3745 * Mbed TLS to the next. Integrators who provide an alternative file
3746 * should review the changes in the original file whenever they
3747 * upgrade Mbed TLS.
3748 *
3749 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3750 * non-standard feature of the C language, so this feature is only available
3751 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3752 *
3753 * The value of this symbol is typically a path in double quotes, either
3754 * absolute or relative to a directory on the include search path.
3755 */
3756//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3757
Gilles Peskineba4162a2022-04-11 17:04:38 +02003758/** \} name SECTION: General configuration options */
3759
3760/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003761 * \name SECTION: Module configuration options
3762 *
3763 * This section allows for the setting of module specific sizes and
3764 * configuration options. The default values are already present in the
3765 * relevant header files and should suffice for the regular use cases.
3766 *
3767 * Our advice is to enable options and change their values here
3768 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003769 * \{
3770 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003771/* The Doxygen documentation here is used when a user comments out a
3772 * setting and runs doxygen themselves. On the other hand, when we typeset
3773 * the full documentation including disabled settings, the documentation
3774 * in specific modules' header files is used if present. When editing this
3775 * file, make sure that each option is documented in exactly one place,
3776 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3777 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003778
Paul Bakker088c5c52014-04-25 11:11:10 +02003779/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003780//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003781//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003782
Paul Bakker088c5c52014-04-25 11:11:10 +02003783/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003784//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3785//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3786//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3787//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3788//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003789
Paul Bakker088c5c52014-04-25 11:11:10 +02003790/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003791//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3792//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3793//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3794//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003795
Paul Bakker088c5c52014-04-25 11:11:10 +02003796/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003797//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003798//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003799
Paul Bakker088c5c52014-04-25 11:11:10 +02003800/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003801//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3802//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003803//#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 +01003804
Paul Bakker088c5c52014-04-25 11:11:10 +02003805/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003806//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003807
Paul Bakker088c5c52014-04-25 11:11:10 +02003808/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003809//#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 -04003810
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003811/** \def MBEDTLS_PLATFORM_STD_CALLOC
3812 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003813 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003814 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003815 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003816 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003817 * 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 -04003818 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3819 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003820 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003821 */
3822//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003823
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003824/** \def MBEDTLS_PLATFORM_STD_FREE
3825 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003826 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003827 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003828 * 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 -04003829 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3830 * 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 -04003831 */
3832//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003833//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003834//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003835//#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 +02003836//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3837//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003838/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003839//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003840//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3841//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003842//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3843//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3844//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003845
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003846/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003847/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003848//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3849//#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 +02003850//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003851//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003852//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3853//#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 +02003854//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3855//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003856/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003857//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003858//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003859//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3860//#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 +08003861//#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 +08003862//#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 +02003863
Gilles Peskine3f106f72021-09-23 17:42:39 +02003864/** \def MBEDTLS_CHECK_RETURN
3865 *
3866 * This macro is used at the beginning of the declaration of a function
3867 * to indicate that its return value should be checked. It should
3868 * instruct the compiler to emit a warning or an error if the function
3869 * is called without checking its return value.
3870 *
3871 * There is a default implementation for popular compilers in platform_util.h.
3872 * You can override the default implementation by defining your own here.
3873 *
3874 * If the implementation here is empty, this will effectively disable the
3875 * checking of functions' return values.
3876 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003877//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003878
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003879/** \def MBEDTLS_IGNORE_RETURN
3880 *
3881 * This macro requires one argument, which should be a C function call.
3882 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3883 * warning is suppressed.
3884 */
3885//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3886
Gilles Peskineed038902020-11-13 21:33:21 +01003887/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003888/**
Gilles Peskineed038902020-11-13 21:33:21 +01003889 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3890 * PSA crypto subsystem.
3891 *
3892 * If this option is unset:
3893 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003894 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003895 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3896 * on unspecified heuristics.
3897 */
3898//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3899
Steven Cooreman863470a2021-02-15 14:03:19 +01003900/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003901 * Restrict the PSA library to supporting a maximum amount of simultaneously
3902 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3903 * volatile key, or a persistent key which is loaded temporarily by the
3904 * library as part of a crypto operation in flight.
3905 *
3906 * If this option is unset, the library will fall back to a default value of
3907 * 32 keys.
3908 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003909//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003910
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003911/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003912//#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 +00003913
Paul Bakker088c5c52014-04-25 11:11:10 +02003914/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003915//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3916//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003917
Paul Bakker088c5c52014-04-25 11:11:10 +02003918/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003919
Angus Grattond8213d02016-05-25 20:56:48 +10003920/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3921 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003922 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003923 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003924 * This determines the size of the incoming TLS I/O buffer in such a way
3925 * that it is capable of holding the specified amount of plaintext data,
3926 * regardless of the protection mechanism used.
3927 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003928 * \note When using a value less than the default of 16KB on the client, it is
3929 * recommended to use the Maximum Fragment Length (MFL) extension to
3930 * inform the server about this limitation. On the server, there
3931 * is no supported, standardized way of informing the client about
3932 * restriction on the maximum size of incoming messages, and unless
3933 * the limitation has been communicated by other means, it is recommended
3934 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3935 * while keeping the default value of 16KB for the incoming buffer.
3936 *
David Horstmann95d516f2021-05-04 18:36:56 +01003937 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003938 */
3939//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3940
Gilles Peskined3d02902020-03-04 21:35:27 +01003941/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3942 *
3943 * The maximum length of CIDs used for incoming DTLS messages.
3944 *
3945 */
3946//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3947
3948/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3949 *
3950 * The maximum length of CIDs used for outgoing DTLS messages.
3951 *
3952 */
3953//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3954
TRodziewicze8dd7092021-05-12 14:19:11 +02003955/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003956 *
3957 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003958 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003959 *
3960 * The padding will always be chosen so that the length of the
3961 * padded plaintext is a multiple of the value of this option.
3962 *
3963 * Note: A value of \c 1 means that no padding will be used
3964 * for outgoing records.
3965 *
3966 * Note: On systems lacking division instructions,
3967 * a power of two should be preferred.
3968 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003969//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003970
Angus Grattond8213d02016-05-25 20:56:48 +10003971/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3972 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003973 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003974 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003975 * This determines the size of the outgoing TLS I/O buffer in such a way
3976 * that it is capable of holding the specified amount of plaintext data,
3977 * regardless of the protection mechanism used.
3978 *
Angus Grattond8213d02016-05-25 20:56:48 +10003979 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3980 * the default inward 16384 byte buffer to conform to the TLS specification.
3981 *
3982 * The minimum required outward buffer size is determined by the handshake
3983 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3984 * The specific size requirement depends on the configured ciphers and any
3985 * certificate data which is sent during the handshake.
3986 *
David Horstmann95d516f2021-05-04 18:36:56 +01003987 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003988 */
3989//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3990
Hanno Beckere0b150f2018-08-21 15:51:03 +01003991/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3992 *
3993 * Maximum number of heap-allocated bytes for the purpose of
3994 * DTLS handshake message reassembly and future message buffering.
3995 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003996 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003997 * to account for a reassembled handshake message of maximum size,
3998 * together with its reassembly bitmap.
3999 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004000 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004001 * should be sufficient for all practical situations as it allows
4002 * to reassembly a large handshake message (such as a certificate)
4003 * while buffering multiple smaller handshake messages.
4004 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004005 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004006//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004007
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004008//#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 +02004009//#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 +02004010
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004011/**
4012 * Complete list of ciphersuites to use, in order of preference.
4013 *
4014 * \warning No dependency checking is done on that field! This option can only
4015 * be used to restrict the set of available ciphersuites. It is your
4016 * responsibility to make sure the needed modules are active.
4017 *
4018 * Use this to save a few hundred bytes of ROM (default ordering of all
4019 * available ciphersuites) and a few to a few hundred bytes of RAM.
4020 *
4021 * The value below is only an example, not the default.
4022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004023//#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 +02004024
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004025/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004026 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4027 *
4028 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004029 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004030 *
4031 * It must be positive and smaller than UINT32_MAX.
4032 *
4033 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4034 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004035 */
4036//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4037
4038/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004039 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4040 *
Jerry Yucf913512023-11-14 11:06:52 +08004041 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004042 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004043 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004044 * - The client ticket age is the time difference between the time when the
4045 * client proposes to the server to use the ticket and the time the client
4046 * received the ticket from the server.
4047 * - The server ticket age is the time difference between the time when the
4048 * server receives a proposition from the client to use the ticket and the
4049 * time when the ticket was created by the server.
4050 *
Jerry Yucf913512023-11-14 11:06:52 +08004051 * The ages might be different due to the client and server clocks not running
4052 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4053 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4054 * 6s, thus in the worst case clients and servers must sync up their system time
4055 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004056 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004057 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004058 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004059//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004060
4061/**
4062 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4063 *
4064 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4065 *
4066 * This must be less than 256.
4067 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004068//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004069
4070/**
4071 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4072 *
4073 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4074 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4075 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4076 *
4077 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004078//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004079
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004080/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004081//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004082//#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 +01004083
Gilles Peskine611179c2022-04-13 23:04:48 +02004084/** \} name SECTION: Module configuration options */