blob: e43c12d7e57d4c1ad8f14681dbfad057dc9349fe [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
Paul Bakker90995b52013-06-24 19:20:35 +0200353/**
TRodziewicz75628d52021-06-18 12:56:27 +0200354 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200355 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200356 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100357 * alternate core implementation of symmetric crypto or hash function. Keep in
358 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200359 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200360 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200361 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200362 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200363 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200364 * no longer provide the mbedtls_sha1_process() function, but it will still provide
365 * the other function (using your mbedtls_sha1_process() function) and the definition
366 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200367 * with this definition.
368 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200369 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100370 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
371 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200372 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200373 * Uncomment a macro to enable alternate implementation of the corresponding
374 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100375 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200376 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100377 * constitutes a security risk. If possible, we recommend avoiding
378 * dependencies on them, and considering stronger message digests
379 * and ciphers instead.
380 *
Janos Follath1231d212019-01-07 15:01:32 +0000381 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
382 * enabled, then the deterministic ECDH signature functions pass the
383 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
384 * alternative implementations should use the RNG only for generating
385 * the ephemeral key and nothing else. If this is not possible, then
386 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200387 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000388 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200389 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390//#define MBEDTLS_SHA256_PROCESS_ALT
391//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200392//#define MBEDTLS_DES_SETKEY_ALT
393//#define MBEDTLS_DES_CRYPT_ECB_ALT
394//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200395//#define MBEDTLS_AES_SETKEY_ENC_ALT
396//#define MBEDTLS_AES_SETKEY_DEC_ALT
397//#define MBEDTLS_AES_ENCRYPT_ALT
398//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300399//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300400//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300401//#define MBEDTLS_ECDSA_VERIFY_ALT
402//#define MBEDTLS_ECDSA_SIGN_ALT
403//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200404
405/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200406 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200407 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200408 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200409 * hardware entropy collector.
410 *
411 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000412 * prototype as declared in library/entropy_poll.h, and accept NULL as first
413 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200414 *
415 * Uncomment to use your own hardware entropy collector.
416 */
417//#define MBEDTLS_ENTROPY_HARDWARE_ALT
418
419/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000421 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100422 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000423 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100424 * Uncomment this macro to use precomputed AES tables stored in ROM.
425 * Comment this macro to generate AES tables in RAM at runtime.
426 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100427 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
428 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100429 * initialization time before the first AES operation can be performed.
430 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
431 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
432 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100433 *
434 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000435 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200436//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000437
438/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100439 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200440 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100441 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200442 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100443 * Uncommenting this macro omits 75% of the AES tables from
444 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
445 * by computing their values on the fly during operations
446 * (the tables are entry-wise rotations of one another).
447 *
448 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100449 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100450 * runtime. Specifically, one has to compare 4 accesses within
451 * different tables to 4 accesses with additional arithmetic
452 * operations within the same table. The performance gain/loss
453 * depends on the system and memory details.
454 *
455 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200456 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100457//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200458
459/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800460 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
461 *
462 * Use only 128-bit keys in AES operations to save ROM.
463 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800464 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800465 * or 256-bit keys.
466 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800467 * Uncommenting this macro reduces the size of AES code by ~300 bytes
468 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800469 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800470 * Module: library/aes.c
471 *
472 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800473 */
474//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
475
Gilles Peskinea8861e02023-09-05 20:20:51 +0200476/*
477 * Disable plain C implementation for AES.
478 *
479 * When the plain C implementation is enabled, and an implementation using a
480 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
481 * detection will be used to select between them.
482 *
483 * If only one implementation is present, runtime detection will not be used.
484 * This configuration will crash at runtime if running on a CPU without the
485 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
486 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
487 */
488//#define MBEDTLS_AES_USE_HARDWARE_ONLY
489
Arto Kinnunen732ca322023-04-14 14:26:10 +0800490/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200491 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200492 *
493 * Use less ROM for the Camellia implementation (saves about 768 bytes).
494 *
495 * Uncomment this macro to use less memory for Camellia.
496 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200497//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200498
499/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200500 * \def MBEDTLS_CHECK_RETURN_WARNING
501 *
502 * If this macro is defined, emit a compile-time warning if application code
503 * calls a function without checking its return value, but the return value
504 * should generally be checked in portable applications.
505 *
506 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
507 * implemented. Otherwise this option has no effect.
508 *
509 * Uncomment to get warnings on using fallible functions without checking
510 * their return value.
511 *
512 * \note This feature is a work in progress.
513 * Warnings will be added to more functions in the future.
514 *
515 * \note A few functions are considered critical, and ignoring the return
516 * value of these functions will trigger a warning even if this
517 * macro is not defined. To completely disable return value check
518 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
519 */
520//#define MBEDTLS_CHECK_RETURN_WARNING
521
522/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200523 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200524 *
525 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200528
529/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200530 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000531 *
532 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200534#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000535
536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200537 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000538 *
539 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200541#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000542
543/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100544 * \def MBEDTLS_CIPHER_MODE_OFB
545 *
546 * Enable Output Feedback mode (OFB) for symmetric ciphers.
547 */
548#define MBEDTLS_CIPHER_MODE_OFB
549
550/**
551 * \def MBEDTLS_CIPHER_MODE_XTS
552 *
553 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
554 */
555#define MBEDTLS_CIPHER_MODE_XTS
556
557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000559 *
560 * Enable NULL cipher.
561 * Warning: Only do so when you know what you are doing. This allows for
562 * encryption or channels without any security!
563 *
Ronald Croncee42702021-04-26 11:34:44 +0200564 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
566 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
567 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
568 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
569 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
570 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
571 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
572 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
573 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
574 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
575 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
576 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
577 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
578 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
579 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
580 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
581 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
582 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
583 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000584 *
585 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000586 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200587//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000588
589/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100590 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200591 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100592 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
593 * specific padding modes in the cipher layer with cipher modes that support
594 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200595 *
596 * If you disable all padding modes, only full blocks can be used with CBC.
597 *
598 * Enable padding modes in the cipher layer.
599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600#define MBEDTLS_CIPHER_PADDING_PKCS7
601#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
602#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
603#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200604
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200605/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
606 *
607 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800608 * Without this, CTR_DRBG uses a 256-bit key
609 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200610 */
611//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
612
Paul Bakker48e93c82013-08-14 12:21:18 +0200613/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200614 * Enable the verified implementations of ECDH primitives from Project Everest
615 * (currently only Curve25519). This feature changes the layout of ECDH
616 * contexts and therefore is a compatibility break for applications that access
617 * fields of a mbedtls_ecdh_context structure directly. See also
618 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000619 *
620 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
621 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200622 */
623//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
624
625/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100626 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200627 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100628 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
629 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200630 *
631 * Comment macros to disable the curve and functions for it
632 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200633/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200634#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
635#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
636#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
637#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
638#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
639#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
640#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
641#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
642#define MBEDTLS_ECP_DP_BP256R1_ENABLED
643#define MBEDTLS_ECP_DP_BP384R1_ENABLED
644#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200645/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200646#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000647#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200648
649/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200651 *
652 * Enable specific 'modulo p' routines for each NIST prime.
653 * Depending on the prime and architecture, makes operations 4 to 8 times
654 * faster on the corresponding curve.
655 *
656 * Comment this macro to disable NIST curves optimisation.
657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200658#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200659
660/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200661 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100662 *
663 * Enable "non-blocking" ECC operations that can return early and be resumed.
664 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200665 * This allows various functions to pause by returning
666 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
667 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
668 * order to further progress and eventually complete their operation. This is
669 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
670 * number of ECC operations a function may perform before pausing; see
671 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100672 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200673 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200674 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100675 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100676 * This option:
677 * - Adds xxx_restartable() variants of existing operations in the
678 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100679 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
680 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100681 * - ECDSA: signature generation & verification;
682 * - PK: signature generation & verification;
683 * - X509: certificate chain verification.
684 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
685 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
686 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
687 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000688 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100689 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100690 * - verification of the server's key exchange signature;
691 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100692 * - generation of the client's signature if client authentication is used,
693 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100694 *
695 * \note In the cases above, the usual SSL/TLS functions, such as
696 * mbedtls_ssl_handshake(), can now return
697 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200698 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100699 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
700 * restartable operations in PK, X.509 and TLS (see above) are not
701 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100702 * PSA, and are not restartable. These are temporary limitations that
703 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200704 *
Ron Eldor19779c42018-11-05 16:58:13 +0200705 * \note This option only works with the default software implementation of
706 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100707 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100708 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100709 * Requires: MBEDTLS_ECP_C
710 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100711 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100712 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200713//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100714
715/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200716 * Uncomment to enable using new bignum code in the ECC modules.
717 *
718 * \warning This is currently experimental, incomplete and therefore should not
719 * be used in production.
720 */
721//#define MBEDTLS_ECP_WITH_MPI_UINT
722
723/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100725 *
726 * Enable deterministic ECDSA (RFC 6979).
727 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
728 * may result in a compromise of the long-term signing key. This is avoided by
729 * the deterministic variant.
730 *
John Durkop36a82e52020-10-26 09:39:05 -0700731 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100732 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100733 * Comment this macro to disable deterministic ECDSA.
734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200735#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100736
737/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200739 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200740 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200741 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200742 * This enables the following ciphersuites (if other requisites are
743 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200744 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
745 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
746 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
747 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
748 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
749 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
750 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
751 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
752 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
753 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200754 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200755#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200756
757/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200759 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200760 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200761 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200763 *
764 * This enables the following ciphersuites (if other requisites are
765 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
767 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
768 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
769 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
770 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
771 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
772 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
773 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
774 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
775 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100776 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100777 * \warning Using DHE constitutes a security risk as it
778 * is not possible to validate custom DH parameters.
779 * If possible, it is recommended users should consider
780 * preferring other methods of key exchange.
781 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100782 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200783 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200784#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200785
786/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200788 *
789 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
790 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200791 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200792 *
793 * This enables the following ciphersuites (if other requisites are
794 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200795 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
796 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
797 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
798 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
799 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
800 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200801 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200803
804/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200806 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200807 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200808 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
810 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200811 *
812 * This enables the following ciphersuites (if other requisites are
813 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
815 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
816 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
817 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
818 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
819 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
820 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
821 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
822 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
823 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200824 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200825#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200826
827/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200829 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200830 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200831 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200832 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
833 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200834 *
835 * This enables the following ciphersuites (if other requisites are
836 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
838 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
839 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
840 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
841 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
842 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
843 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
844 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
845 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
846 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
847 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
848 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200850#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200851
852/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200853 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200854 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200855 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200857 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
858 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200859 *
860 * This enables the following ciphersuites (if other requisites are
861 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
863 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
864 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
865 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
866 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
867 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
868 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
869 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
870 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
871 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
872 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
873 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100874 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100875 * \warning Using DHE constitutes a security risk as it
876 * is not possible to validate custom DH parameters.
877 * If possible, it is recommended users should consider
878 * preferring other methods of key exchange.
879 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100880 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200881 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200883
884/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200886 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200887 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200888 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200889 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
890 * MBEDTLS_RSA_C
891 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200893 *
894 * This enables the following ciphersuites (if other requisites are
895 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
897 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
898 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
899 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
900 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
901 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
902 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
903 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
904 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
905 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200908
909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200911 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200912 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200913 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200914 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
915 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
916 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200917 *
918 * This enables the following ciphersuites (if other requisites are
919 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200920 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
921 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
922 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
923 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
924 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
925 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
926 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
927 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
928 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200930 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200931#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200932
933/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100935 *
936 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
937 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200938 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
939 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
940 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100941 *
942 * This enables the following ciphersuites (if other requisites are
943 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200944 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
945 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
946 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
947 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
948 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
949 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
950 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
951 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
952 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100954 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100956
957/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100959 *
960 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
961 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200962 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
963 * MBEDTLS_RSA_C
964 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100965 *
966 * This enables the following ciphersuites (if other requisites are
967 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
969 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
970 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
971 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
972 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
973 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
974 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
975 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
976 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
977 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100978 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200979#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100980
981/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200982 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
983 *
984 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
985 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200986 * \warning This is currently experimental. EC J-PAKE support is based on the
987 * Thread v1.0.0 specification; incompatible changes to the specification
988 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200989 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200990 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100991 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200992 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
993 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100994 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800995 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100996 * MBEDTLS_USE_PSA_CRYPTO is disabled).
997 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200998 * This enables the following ciphersuites (if other requisites are
999 * enabled as well):
1000 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1001 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001002//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001003
1004/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001005 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001006 *
1007 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1008 * RFC 5915 and RFC 5480.
1009 *
1010 * Currently this means parsing the SpecifiedECDomain choice of EC
1011 * parameters (only known groups are supported, not arbitrary domains, to
1012 * avoid validation issues).
1013 *
1014 * Disable if you only need to support RFC 5915 + 5480 key formats.
1015 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001017
1018/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001019 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1020 *
1021 * Enable the support for parsing public keys of type Short Weierstrass
1022 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001023 * compressed point format. This parsing is done through ECP module's functions.
1024 *
1025 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1026 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1027 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001028 */
1029#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1030
1031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001032 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001033 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034 * Enable a dummy error function to make use of mbedtls_strerror() in
1035 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1036 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001037 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1039 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001040 *
1041 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001043 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001045
1046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001048 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001049 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001050 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001054
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001055/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001057 *
1058 * Enable functions that use the filesystem.
1059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001061
1062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001064 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001065 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001066 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001067 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001068 * application.
1069 *
1070 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001071 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001072//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001073
1074/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001076 *
1077 * Do not use built-in platform entropy functions.
1078 * This is useful if your platform does not support
1079 * standards like the /dev/urandom or Windows CryptoAPI.
1080 *
1081 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001082 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001083//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001084
1085/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001087 *
1088 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1089 * default SHA-512 based one (if both are available).
1090 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001092 *
1093 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1094 * if you have performance concerns.
1095 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 * This option is only useful if both MBEDTLS_SHA256_C and
1097 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001098 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001099//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001100
1101/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001102 * \def MBEDTLS_ENTROPY_NV_SEED
1103 *
1104 * Enable the non-volatile (NV) seed file-based entropy source.
1105 * (Also enables the NV seed read/write functions in the platform layer)
1106 *
1107 * This is crucial (if not required) on systems that do not have a
1108 * cryptographic entropy source (in hardware or kernel) available.
1109 *
1110 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1111 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001112 * \note The read/write functions that are used by the entropy source are
1113 * determined in the platform layer, and can be modified at runtime and/or
1114 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1115 *
1116 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001117 * with regular fopen(), please make sure you make a seedfile with the
1118 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1119 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001120 * and written to or you will get an entropy source error! The default
1121 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1122 * bytes from the file.
1123 *
1124 * \note The entropy collector will write to the seed file before entropy is
1125 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001126 */
1127//#define MBEDTLS_ENTROPY_NV_SEED
1128
Ronald Cron71016a92020-08-28 19:01:50 +02001129/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001130 *
Ronald Cron71016a92020-08-28 19:01:50 +02001131 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001132 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001133 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1134 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001135 *
1136 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001137 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001138 */
Ronald Cron71016a92020-08-28 19:01:50 +02001139//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001140
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001142 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001143 *
1144 * Enable debugging of buffer allocator memory issues. Automatically prints
1145 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1146 * function for 'debug output' of allocated memory.
1147 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001148 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001149 *
1150 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001153
1154/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001156 *
1157 * Include backtrace information with each allocated block.
1158 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001160 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001161 *
1162 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001165
1166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001168 *
1169 * Support external private RSA keys (eg from a HSM) in the PK layer.
1170 *
1171 * Comment this macro to disable support for external private RSA keys.
1172 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001174
1175/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001177 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001178 * Enable support for PKCS#1 v1.5 encoding.
1179 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001180 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001181 *
Paul Bakker48377d92013-08-30 12:06:24 +02001182 * This enables support for PKCS#1 v1.5 operations.
1183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001185
1186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001188 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001189 * Enable support for PKCS#1 v2.1 encoding.
1190 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001191 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001192 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001193 * \warning If using a hash that is only provided by PSA drivers, you must
1194 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001195 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001196 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1197 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001199
Steven Cooreman6801f082021-02-19 17:21:22 +01001200/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1201 *
1202 * Enable support for platform built-in keys. If you enable this feature,
1203 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1204 * See the documentation of that function for more information.
1205 *
1206 * Built-in keys are typically derived from a hardware unique key or
1207 * stored in a secure element.
1208 *
1209 * Requires: MBEDTLS_PSA_CRYPTO_C.
1210 *
1211 * \warning This interface is experimental and may change or be removed
1212 * without notice.
1213 */
1214//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1215
Ronald Cron3768ac12021-01-26 16:58:00 +01001216/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1217 *
1218 * Enable support for PSA crypto client.
1219 *
1220 * \note This option allows to include the code necessary for a PSA
1221 * crypto client when the PSA crypto implementation is not included in
1222 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1223 * code to set and get PSA key attributes.
1224 * The development of PSA drivers partially relying on the library to
1225 * fulfill the hardware gaps is another possible usage of this option.
1226 *
1227 * \warning This interface is experimental and may change or be removed
1228 * without notice.
1229 */
1230//#define MBEDTLS_PSA_CRYPTO_CLIENT
1231
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001232/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1233 *
1234 * Make the PSA Crypto module use an external random generator provided
1235 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1236 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001237 * \note This random generator must deliver random numbers with cryptographic
1238 * quality and high performance. It must supply unpredictable numbers
1239 * with a uniform distribution. The implementation of this function
1240 * is responsible for ensuring that the random generator is seeded
1241 * with sufficient entropy. If you have a hardware TRNG which is slow
1242 * or delivers non-uniform output, declare it as an entropy source
1243 * with mbedtls_entropy_add_source() instead of enabling this option.
1244 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001245 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001246 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1247 * and define a function called mbedtls_psa_external_get_random()
1248 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001249 * ```
1250 * psa_status_t mbedtls_psa_external_get_random(
1251 * mbedtls_psa_external_random_context_t *context,
1252 * uint8_t *output, size_t output_size, size_t *output_length);
1253 * );
1254 * ```
1255 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001256 * The function must fill the \c output buffer with \c output_size bytes
1257 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001258 *
1259 * Requires: MBEDTLS_PSA_CRYPTO_C
1260 *
1261 * \warning If you enable this option, code that uses the PSA cryptography
1262 * interface will not use any of the entropy sources set up for
1263 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1264 * enables.
1265 *
1266 * \note This option is experimental and may be removed without notice.
1267 */
1268//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1269
Paul Bakker9dcc3222011-03-08 14:16:06 +00001270/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001271 * \def MBEDTLS_PSA_CRYPTO_SPM
1272 *
1273 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1274 * Partition Manager) integration which separates the code into two parts: a
1275 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1276 * Environment).
1277 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001278 * If you enable this option, your build environment must include a header
1279 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1280 * header files, or in another directory on the compiler's include search
1281 * path). Alternatively, your platform may customize the header
1282 * `psa/crypto_platform.h`, in which case it can skip or replace the
1283 * inclusion of `"crypto_spe.h"`.
1284 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001285 * Module: library/psa_crypto.c
1286 * Requires: MBEDTLS_PSA_CRYPTO_C
1287 *
1288 */
1289//#define MBEDTLS_PSA_CRYPTO_SPM
1290
1291/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001292 * Uncomment to enable p256-m. This is an alternative implementation of
1293 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1294 * Compared to the default implementation:
1295 *
1296 * - p256-m has a much smaller code size and RAM footprint.
1297 * - p256-m is only available via the PSA API. This includes the pk module
1298 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1299 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1300 * over the core arithmetic, or deterministic derivation of keys.
1301 *
1302 * We recommend enabling this option if your application uses the PSA API
1303 * and the only elliptic curve support it needs is ECDH and ECDSA over
1304 * SECP256R1.
1305 *
1306 * If you enable this option, you do not need to enable any ECC-related
1307 * MBEDTLS_xxx option. You do need to separately request support for the
1308 * cryptographic mechanisms through the PSA API:
1309 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1310 * configuration;
1311 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1312 * - #PSA_WANT_ECC_SECP_R1_256;
1313 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1314 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1315 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1316 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1317 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001318 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001319 * \note To benefit from the smaller code size of p256-m, make sure that you
1320 * do not enable any ECC-related option not supported by p256-m: this
1321 * would cause the built-in ECC implementation to be built as well, in
1322 * order to provide the required option.
1323 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001324 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1325 * SECP256R1 are disabled as they are not supported by this driver.
1326 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1327 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001328 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001329 */
1330//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1331
1332/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001333 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001334 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001335 * Enable support for entropy injection at first boot. This feature is
1336 * required on systems that do not have a built-in entropy source (TRNG).
1337 * This feature is currently not supported on systems that have a built-in
1338 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001339 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001340 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001341 *
1342 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001343//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001344
1345/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001346 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001347 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001348 * Assume all buffers passed to PSA functions are owned exclusively by the
1349 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001350 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001351 * This option may be enabled if all buffers passed to any PSA function reside
1352 * in memory that is accessible only to the PSA function during its execution.
1353 *
1354 * This option MUST be disabled whenever buffer arguments are in memory shared
1355 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001356 * across a trust boundary.
1357 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001358 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001359 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001360 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001361 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001362 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001363//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001364
1365/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001366 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001367 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001368 * Do not use the Chinese Remainder Theorem
1369 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001370 *
1371 * Uncomment this macro to disable the use of CRT in RSA.
1372 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001373 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001374//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001375
1376/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001378 *
1379 * Enable the checkup functions (*_self_test).
1380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001381#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001382
1383/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001384 * \def MBEDTLS_SHA256_SMALLER
1385 *
1386 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1387 * lower performance.
1388 *
Adam Wolf039080f2019-09-10 09:53:08 -05001389 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001390 * performance and size. This version optimizes more aggressively for size at
1391 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1392 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1393 * 30%.
1394 *
1395 * Uncomment to enable the smaller implementation of SHA256.
1396 */
1397//#define MBEDTLS_SHA256_SMALLER
1398
1399/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001400 * \def MBEDTLS_SHA512_SMALLER
1401 *
1402 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1403 * lower performance.
1404 *
1405 * Uncomment to enable the smaller implementation of SHA512.
1406 */
1407//#define MBEDTLS_SHA512_SMALLER
1408
1409/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001410 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001411 *
1412 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001413 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001414 * with other servers, only debugging of failures is harder.
1415 *
1416 * The advantage of not sending alert messages, is that no information is given
1417 * about reasons for failures thus preventing adversaries of gaining intel.
1418 *
1419 * Enable sending of all alert messages
1420 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001421#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001422
1423/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001424 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1425 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001426 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001427 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001428 * in the underlying transport. The CID functionality is described
1429 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001430 *
1431 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001432 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1433 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1434 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001435 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001436 * The maximum lengths of outgoing and incoming CIDs can be configured
1437 * through the options
1438 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1439 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1440 *
1441 * Requires: MBEDTLS_SSL_PROTO_DTLS
1442 *
1443 * Uncomment to enable the Connection ID extension.
1444 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001445#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1446
1447
1448/**
1449 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1450 *
1451 * Defines whether RFC 9146 (default) or the legacy version
1452 * (version draft-ietf-tls-dtls-connection-id-05,
1453 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1454 * is used.
1455 *
1456 * Set the value to 0 for the standard version, and
1457 * 1 for the legacy draft version.
1458 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001459 * \deprecated Support for the legacy version of the DTLS
1460 * Connection ID feature is deprecated. Please
1461 * switch to the standardized version defined
1462 * in RFC 9146 enabled by utilizing
1463 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1464 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1465 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001466 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1467 */
1468#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001469
1470/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001471 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1472 *
1473 * Enable asynchronous external private key operations in SSL. This allows
1474 * you to configure an SSL connection to call an external cryptographic
1475 * module to perform private key operations instead of performing the
1476 * operation inside the library.
1477 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001478 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001479 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001480//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001481
1482/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001483 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1484 *
1485 * Enable serialization of the TLS context structures, through use of the
1486 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1487 *
1488 * This pair of functions allows one side of a connection to serialize the
1489 * context associated with the connection, then free or re-use that context
1490 * while the serialized state is persisted elsewhere, and finally deserialize
1491 * that state to a live context for resuming read/write operations on the
1492 * connection. From a protocol perspective, the state of the connection is
1493 * unaffected, in particular this is entirely transparent to the peer.
1494 *
1495 * Note: this is distinct from TLS session resumption, which is part of the
1496 * protocol and fully visible by the peer. TLS session resumption enables
1497 * establishing new connections associated to a saved session with shorter,
1498 * lighter handshakes, while context serialization is a local optimization in
1499 * handling a single, potentially long-lived connection.
1500 *
1501 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1502 * saved after the handshake to allow for more efficient serialization, so if
1503 * you don't need this feature you'll save RAM by disabling it.
1504 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001505 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1506 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001507 * Comment to disable the context serialization APIs.
1508 */
1509#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1510
1511/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001512 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001513 *
1514 * Enable the debug messages in SSL module for all issues.
1515 * Debug messages have been disabled in some places to prevent timing
1516 * attacks due to (unbalanced) debugging function calls.
1517 *
1518 * If you need all error reporting you should enable this during debugging,
1519 * but remove this for production servers that should log as well.
1520 *
1521 * Uncomment this macro to report all debug messages on errors introducing
1522 * a timing side-channel.
1523 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001524 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001525//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001526
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001527/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001528 *
1529 * Enable support for Encrypt-then-MAC, RFC 7366.
1530 *
1531 * This allows peers that both support it to use a more robust protection for
1532 * ciphersuites using CBC, providing deep resistance against timing attacks
1533 * on the padding or underlying cipher.
1534 *
1535 * This only affects CBC ciphersuites, and is useless if none is defined.
1536 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001537 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001538 *
1539 * Comment this macro to disable support for Encrypt-then-MAC
1540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001541#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001543/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001544 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001545 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1546 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001547 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001548 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001549 * attacks, but it is recommended to always use it (even if you disable
1550 * renegotiation), since it actually fixes a more fundamental issue in the
1551 * original SSL/TLS design, and has implications beyond Triple Handshake.
1552 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001553 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001554 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001555 * Comment this macro to disable support for Extended Master Secret.
1556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001558
Paul Bakkerd66f0702013-01-31 16:57:45 +01001559/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001560 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1561 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001562 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001563 * giving access to the peer's certificate after completion of the handshake.
1564 *
1565 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1566 * recommended to disable this option for reduced RAM usage.
1567 *
1568 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1569 * defined, but always returns \c NULL.
1570 *
1571 * \note This option has no influence on the protection against the
1572 * triple handshake attack. Even if it is disabled, Mbed TLS will
1573 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001574 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001575 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001576 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001577 *
1578 * Comment this macro to disable storing the peer's certificate
1579 * after the handshake.
1580 */
1581#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1582
1583/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001584 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001585 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001586 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001587 *
1588 * The two main uses of renegotiation are (1) refresh keys on long-lived
1589 * connections and (2) client authentication after the initial handshake.
1590 * If you don't need renegotiation, it's probably better to disable it, since
1591 * it has been associated with security issues in the past and is easy to
1592 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001593 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001594 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1595 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001596 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001597 *
1598 * \note Even if this option is disabled, both client and server are aware
1599 * of the Renegotiation Indication Extension (RFC 5746) used to
1600 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1601 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1602 * configuration of this extension).
1603 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001605#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001606
1607/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001609 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001610 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001611 *
1612 * Comment this macro to disable support for the max_fragment_length extension
1613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001614#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001615
1616/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001617 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1618 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001619 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001620 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001621 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1622 *
1623 * Uncomment this macro to enable support for the record_size_limit extension
1624 */
1625//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1626
1627/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001628 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001629 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001630 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001631 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001632 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001633 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1634 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001635 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001636 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001637 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001638 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1639 * are only provided by PSA drivers, you must call psa_crypto_init() before
1640 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001641 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001642 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001643 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001644#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001645
1646/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001647 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001648 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001649 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001650 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001651 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001652 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001653 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001654 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001655 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001656 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001657 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1658 * directly performed by TLS 1.3 code. As a consequence, you must
1659 * call psa_crypto_init() before the first TLS 1.3 handshake.
1660 *
1661 * \note Cryptographic operations performed indirectly via another module
1662 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1663 * running handshake hash) only use PSA crypto if
1664 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001665 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001666 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001667 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001668#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001669
1670/**
Ronald Cronab65c522021-11-24 10:47:20 +01001671 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1672 *
1673 * Enable TLS 1.3 middlebox compatibility mode.
1674 *
1675 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1676 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1677 * expecting TLS 1.2 traffic.
1678 *
1679 * Turning on the compatibility mode comes at the cost of a few added bytes
1680 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1681 * that don't use it. Therefore, unless transmission bandwidth is critical and
1682 * you know that middlebox compatibility issues won't occur, it is therefore
1683 * recommended to set this option.
1684 *
1685 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001686 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1687 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001688 *
1689 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001690#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001691
1692/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001693 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1694 *
1695 * Enable TLS 1.3 PSK key exchange mode.
1696 *
1697 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1698 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1699 * effect on the build.
1700 *
1701 */
1702#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1703
1704/**
1705 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1706 *
1707 * Enable TLS 1.3 ephemeral key exchange mode.
1708 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001709 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001710 * MBEDTLS_X509_CRT_PARSE_C
1711 * and at least one of:
1712 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1713 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001714 *
1715 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1716 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1717 * effect on the build.
1718 *
1719 */
1720#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1721
1722/**
1723 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1724 *
1725 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1726 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001727 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001728 *
1729 * Comment to disable support for the PSK ephemeral key exchange mode in
1730 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1731 * have any effect on the build.
1732 *
1733 */
1734#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1735
1736/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 * \def MBEDTLS_SSL_EARLY_DATA
1738 *
1739 * Enable support for RFC 8446 TLS 1.3 early data.
1740 *
1741 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1742 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1743 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1744 *
1745 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1746 * is not enabled, this option does not have any effect on the build.
1747 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001748 * \note The maximum amount of early data can be set with
1749 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1750 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001752//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001753
1754/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001755 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001756 *
1757 * Enable support for DTLS (all available versions).
1758 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001759 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001760 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001761 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001762 *
1763 * Comment this macro to disable support for DTLS
1764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001766
1767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001769 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001770 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001771 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001772 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001773 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001774#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001775
1776/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001777 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001778 *
1779 * Enable support for the anti-replay mechanism in DTLS.
1780 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001781 * Requires: MBEDTLS_SSL_TLS_C
1782 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001783 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001784 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001785 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001786 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001787 * Comment this to disable anti-replay in DTLS.
1788 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001789#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001790
1791/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001792 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001793 *
1794 * Enable support for HelloVerifyRequest on DTLS servers.
1795 *
1796 * This feature is highly recommended to prevent DTLS servers being used as
1797 * amplifiers in DoS attacks against other hosts. It should always be enabled
1798 * unless you know for sure amplification cannot be a problem in the
1799 * environment in which your server operates.
1800 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001801 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001802 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001803 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001804 *
1805 * Comment this to disable support for HelloVerifyRequest.
1806 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001808
1809/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001810 * \def MBEDTLS_SSL_DTLS_SRTP
1811 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001812 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001813 * through the use_srtp extension.
1814 *
1815 * \note This feature provides the minimum functionality required
1816 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1817 * the associated SRTP packet protection key material.
1818 * In particular, the SRTP packet protection itself, as well as the
1819 * demultiplexing of RTP and DTLS packets at the datagram layer
1820 * (see Section 5 of RFC 5764), are not handled by this feature.
1821 * Instead, after successful completion of a handshake negotiating
1822 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001823 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001824 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1825 * (this is implemented in the SSL example programs).
1826 * The resulting key should then be passed to an SRTP stack.
1827 *
1828 * Setting this option enables the runtime API
1829 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1830 * through which the supported DTLS-SRTP protection
1831 * profiles can be configured. You must call this API at
1832 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001833 *
1834 * Requires: MBEDTLS_SSL_PROTO_DTLS
1835 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001836 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001837 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001838//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001839
1840/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001841 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1842 *
1843 * Enable server-side support for clients that reconnect from the same port.
1844 *
1845 * Some clients unexpectedly close the connection and try to reconnect using the
1846 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001847 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001848 * flag enables that support.
1849 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001850 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001851 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001852 * Comment this to disable support for clients reusing the source port.
1853 */
1854#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1855
1856/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001857 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001858 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001859 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001860 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001861 * session store remains the responsibility of the application, though).
1862 * Server-side, you also need to provide callbacks for writing and parsing
1863 * tickets, including authenticated encryption and key management. Example
1864 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001865 *
1866 * Comment this macro to disable support for SSL session tickets
1867 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001869
1870/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001872 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001873 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001874 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001875 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001876 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001877 * Comment this macro to disable support for server name indication in SSL
1878 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001880
1881/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001882 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1883 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001884 * When this option is enabled, the SSL buffer will be resized automatically
1885 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001886 *
1887 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001888 */
1889//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1890
1891/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001892 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1893 *
1894 * Enable testing of the constant-flow nature of some sensitive functions with
1895 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001896 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001897 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001898 * This setting requires compiling with clang -fsanitize=memory. The test
1899 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001900 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001901 * \warning This macro is only used for extended testing; it is not considered
1902 * part of the library's API, so it may change or disappear at any time.
1903 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001904 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001905 */
1906//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1907
1908/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001909 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1910 *
1911 * Enable testing of the constant-flow nature of some sensitive functions with
1912 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001913 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001914 *
1915 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001916 * testing if the tests suites are run with valgrind's memcheck. This can be
1917 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1918 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001919 *
1920 * \warning This macro is only used for extended testing; it is not considered
1921 * part of the library's API, so it may change or disappear at any time.
1922 *
1923 * Uncomment to enable testing of the constant-flow nature of selected code.
1924 */
1925//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1926
1927/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001928 * \def MBEDTLS_TEST_HOOKS
1929 *
1930 * Enable features for invasive testing such as introspection functions and
1931 * hooks for fault injection. This enables additional unit tests.
1932 *
1933 * Merely enabling this feature should not change the behavior of the product.
1934 * It only adds new code, and new branching points where the default behavior
1935 * is the same as when this feature is disabled.
1936 * However, this feature increases the attack surface: there is an added
1937 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1938 * Therefore this feature must never be enabled in production.
1939 *
1940 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1941 * information.
1942 *
1943 * Uncomment to enable invasive tests.
1944 */
1945//#define MBEDTLS_TEST_HOOKS
1946
1947/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001948 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001949 *
1950 * Provide your own alternate threading implementation.
1951 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001952 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001953 *
1954 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001955 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001957
1958/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001960 *
1961 * Enable the pthread wrapper layer for the threading layer.
1962 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001963 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001964 *
1965 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001968
1969/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001970 * \def MBEDTLS_USE_PSA_CRYPTO
1971 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001972 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1973 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001974 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001975 * \note Development of this option is currently in progress, and parts of Mbed
1976 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001977 * will still continue to work as usual, so enabling this option should not
1978 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001979 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001980 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001981 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1982 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001983 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001984 * \note An important and desirable effect of this option is that it allows
1985 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1986 * 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 +02001987 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001988 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1989 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001990 *
1991 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001992 *
1993 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001994 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001995 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001996 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001997//#define MBEDTLS_USE_PSA_CRYPTO
1998
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001999/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002000 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2001 *
John Durkop185764f2020-10-12 21:32:12 -07002002 * This setting allows support for cryptographic mechanisms through the PSA
2003 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002004 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002005 * When this option is disabled, the PSA API exposes the cryptographic
2006 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2007 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002008 *
2009 * When this option is enabled, the PSA API exposes the cryptographic
2010 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2011 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2012 * automatically enabled if required (i.e. if no PSA driver provides the
2013 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2014 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002015 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002016 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002017 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002018 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002019 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2020 * symbols is not completely finalized yet, and the configuration
2021 * tooling is not ideally adapted to having two separate configuration
2022 * files.
2023 * Future minor releases of Mbed TLS may make minor changes to those
2024 * symbols, but we will endeavor to provide a transition path.
2025 * Nonetheless, this option is considered mature enough to use in
2026 * production, as long as you accept that you may need to make
2027 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002028 */
2029//#define MBEDTLS_PSA_CRYPTO_CONFIG
2030
2031/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002032 * \def MBEDTLS_VERSION_FEATURES
2033 *
2034 * Allow run-time checking of compile-time enabled features. Thus allowing users
2035 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002036 * support via mbedtls_version_check_feature().
2037 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002038 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002039 *
2040 * Comment this to disable run-time checking and save ROM space
2041 */
2042#define MBEDTLS_VERSION_FEATURES
2043
2044/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002045 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2046 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002047 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002048 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2049 * the set of trusted certificates through a callback instead of a linked
2050 * list.
2051 *
2052 * This is useful for example in environments where a large number of trusted
2053 * certificates is present and storing them in a linked list isn't efficient
2054 * enough, or when the set of trusted certificates changes frequently.
2055 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002056 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002057 * `mbedtls_ssl_conf_ca_cb()` for more information.
2058 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002059 * Requires: MBEDTLS_X509_CRT_PARSE_C
2060 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002061 * Uncomment to enable trusted certificate callbacks.
2062 */
2063//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2064
2065/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002066 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002067 *
Chris Jones2c745862020-12-16 11:41:06 +00002068 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002069 *
Chris Jones2c745862020-12-16 11:41:06 +00002070 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002071 * and other functions/constants only used by these functions, thus reducing
2072 * the code footprint by several KB.
2073 */
Chris Jones2c745862020-12-16 11:41:06 +00002074//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002075
2076/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002077 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002078 *
2079 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2080 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2081 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002082 * Requires: MBEDTLS_PKCS1_V21
2083 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002084 * Comment this macro to disallow using RSASSA-PSS in certificates.
2085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002087/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002088
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002089/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002090 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002091 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002092 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002093 * \{
2094 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002095
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002096/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002097 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002098 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002099 * Enable AES-NI support on x86-64 or x86-32.
2100 *
2101 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002102 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002103 * - GCC, x86-64, target not explicitly supporting AESNI:
2104 * requires MBEDTLS_HAVE_ASM.
2105 * - GCC, x86-32, target not explicitly supporting AESNI:
2106 * not supported.
2107 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2108 * For this assembly-less implementation, you must currently compile
2109 * `library/aesni.c` and `library/aes.c` with machine options to enable
2110 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2111 * `clang -maes -mpclmul`.
2112 * - Non-x86 targets: this option is silently ignored.
2113 * - Other compilers: this option is silently ignored.
2114 *
2115 * \note
2116 * Above, "GCC" includes compatible compilers such as Clang.
2117 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002118 *
2119 * Module: library/aesni.c
2120 * Caller: library/aes.c
2121 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002122 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002123 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002124 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002127
2128/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002129 * \def MBEDTLS_AESCE_C
2130 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002131 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002132 *
2133 * Module: library/aesce.c
2134 * Caller: library/aes.c
2135 *
Jerry Yuf015a932023-04-25 10:38:03 +08002136 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002137 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002138 * \warning Runtime detection only works on Linux. For non-Linux operating
2139 * system, Armv8-A Cryptographic Extensions must be supported by
2140 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002141 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002142 * \note Minimum compiler versions for this feature when targeting aarch64
2143 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2144 * Minimum compiler versions for this feature when targeting 32-bit
2145 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002146 *
2147 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2148 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002149 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002150 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002151 */
2152#define MBEDTLS_AESCE_C
2153
2154/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002155 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002156 *
2157 * Enable the AES block cipher.
2158 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002159 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002160 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002161 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002162 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002163 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002164 * This module enables the following ciphersuites (if other requisites are
2165 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2167 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2168 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2169 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2170 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2171 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2172 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2173 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2174 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2175 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2176 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2177 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2178 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2179 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2180 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2181 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2182 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2183 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2184 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2185 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2186 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2187 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2188 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2189 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2190 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2191 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2192 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2193 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2194 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2195 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2196 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2197 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2198 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2199 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2200 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2201 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2202 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2203 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2204 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2205 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2206 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2207 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2208 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2209 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2210 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2211 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2212 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2213 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2214 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2215 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2216 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2217 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2218 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2219 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2220 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2221 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2222 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2223 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002224 *
Paul Bakkercff68422013-09-15 20:43:33 +02002225 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002228
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002229/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002230 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002231 *
2232 * Enable the generic ASN1 parser.
2233 *
2234 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002235 * Caller: library/x509.c
2236 * library/dhm.c
2237 * library/pkcs12.c
2238 * library/pkcs5.c
2239 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002240 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002242
2243/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002244 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002245 *
2246 * Enable the generic ASN1 writer.
2247 *
2248 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002249 * Caller: library/ecdsa.c
2250 * library/pkwrite.c
2251 * library/x509_create.c
2252 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002253 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002254 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002256
2257/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002258 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002259 *
2260 * Enable the Base64 module.
2261 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002262 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002263 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002264 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002265 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002268
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002269/**
Yanray Wange367e472023-10-31 17:23:04 +08002270 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2271 *
2272 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2273 *
2274 * \note This feature is incompatible with insecure block cipher,
2275 * MBEDTLS_DES_C, and cipher modes which always require decryption
2276 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002277 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2278 * this feature is incompatible with following supported PSA equivalence,
2279 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2280 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002281 *
2282 * Module: library/aes.c
2283 * library/aesce.c
2284 * library/aesni.c
2285 * library/aria.c
2286 * library/camellia.c
2287 * library/cipher.c
2288 */
2289//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2290
2291/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002292 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002293 *
Paul Bakker9a736322012-11-14 12:39:52 +00002294 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002295 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002296 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002297 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002298 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002299 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002300 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002301 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002302 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002303 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002304 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002305 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002306 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002307 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002308 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002309#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002310
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002311/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002313 *
2314 * Enable the Camellia block cipher.
2315 *
Paul Bakker38119b12009-01-10 23:31:23 +00002316 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002317 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002318 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002319 * This module enables the following ciphersuites (if other requisites are
2320 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2322 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2323 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2324 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2325 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2326 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2327 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2328 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2329 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2330 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2331 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2332 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2333 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2334 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2335 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2336 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2337 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2338 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2339 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2340 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2341 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2342 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2343 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2344 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2345 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2346 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2347 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2348 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2349 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2350 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2351 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2352 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2353 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2354 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2355 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2356 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2357 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2358 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2359 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2360 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2361 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2362 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002363 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002364#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002365
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002366/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002367 * \def MBEDTLS_ARIA_C
2368 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002369 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002370 *
2371 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002372 * Caller: library/cipher.c
2373 *
2374 * This module enables the following ciphersuites (if other requisites are
2375 * enabled as well):
2376 *
2377 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2378 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2379 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2380 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2381 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2382 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2383 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2384 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2385 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2386 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2387 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2388 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2389 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2390 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2391 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2392 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2393 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2394 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2395 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2396 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2397 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2398 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2399 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2400 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2401 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2402 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2403 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2404 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2405 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2406 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2407 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2408 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2409 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2410 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2411 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2412 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2413 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2414 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002415 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002416#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002417
2418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002420 *
2421 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2422 *
2423 * Module: library/ccm.c
2424 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002425 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2426 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002427 *
2428 * This module enables the AES-CCM ciphersuites, if other requisites are
2429 * enabled as well.
2430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002432
2433/**
Daniel King34b822c2016-05-15 17:28:08 -03002434 * \def MBEDTLS_CHACHA20_C
2435 *
2436 * Enable the ChaCha20 stream cipher.
2437 *
2438 * Module: library/chacha20.c
2439 */
2440#define MBEDTLS_CHACHA20_C
2441
2442/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002443 * \def MBEDTLS_CHACHAPOLY_C
2444 *
2445 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2446 *
2447 * Module: library/chachapoly.c
2448 *
2449 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2450 */
2451#define MBEDTLS_CHACHAPOLY_C
2452
2453/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002454 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002455 *
2456 * Enable the generic cipher layer.
2457 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002458 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002459 * Caller: library/ccm.c
2460 * library/cmac.c
2461 * library/gcm.c
2462 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002463 * library/pkcs12.c
2464 * library/pkcs5.c
2465 * library/psa_crypto_aead.c
2466 * library/psa_crypto_mac.c
2467 * library/ssl_ciphersuites.c
2468 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002469 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002470 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2471 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002472 *
2473 * Uncomment to enable generic cipher wrappers.
2474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002475#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002476
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002477/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002478 * \def MBEDTLS_CMAC_C
2479 *
Simon Butcher327398a2016-10-05 14:09:11 +01002480 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2481 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002482 *
2483 * Module: library/cmac.c
2484 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002485 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002486 *
2487 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002488#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002489
2490/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002492 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002493 * Enable the CTR_DRBG AES-based random generator.
2494 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002495 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002496 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002497 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002498 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2499 * is used.
2500 *
2501 * \warning When using PSA, the user should call `psa_crypto_init()` before
2502 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2503 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002504 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2505 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002506 * \note To achieve a 256-bit security strength with CTR_DRBG,
2507 * you must use AES-256 *and* use sufficient entropy.
2508 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002509 *
2510 * Module: library/ctr_drbg.c
2511 * Caller:
2512 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002513 * Requires: MBEDTLS_AES_C or
2514 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2515 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002516 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002517 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002520
2521/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002522 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002523 *
2524 * Enable the debug functions.
2525 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002526 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002527 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002528 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002529 * library/ssl_tls12_*.c
2530 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002531 *
2532 * This module provides debugging functions.
2533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002535
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002538 *
2539 * Enable the DES block cipher.
2540 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002541 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002542 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002543 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002544 *
Paul Bakkercff68422013-09-15 20:43:33 +02002545 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002546 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002547 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002548 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002550#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002551
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002554 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002555 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002556 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002557 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002558 * Caller: library/ssl_tls.c
2559 * library/ssl*_client.c
2560 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002561 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002562 * This module is used by the following key exchanges:
2563 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002564 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002565 * \warning Using DHE constitutes a security risk as it
2566 * is not possible to validate custom DH parameters.
2567 * If possible, it is recommended users should consider
2568 * preferring other methods of key exchange.
2569 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002570 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002572#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002573
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002574/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002576 *
2577 * Enable the elliptic curve Diffie-Hellman library.
2578 *
2579 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002580 * Caller: library/psa_crypto.c
2581 * library/ssl_tls.c
2582 * library/ssl*_client.c
2583 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002584 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002585 * This module is used by the following key exchanges:
2586 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002587 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002588 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002589 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002590#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002591
2592/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002594 *
2595 * Enable the elliptic curve DSA library.
2596 *
2597 * Module: library/ecdsa.c
2598 * Caller:
2599 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002600 * This module is used by the following key exchanges:
2601 * ECDHE-ECDSA
2602 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002603 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2604 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2605 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002606 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002608
2609/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002610 * \def MBEDTLS_ECJPAKE_C
2611 *
2612 * Enable the elliptic curve J-PAKE library.
2613 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002614 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2615 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002616 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002617 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002618 * Module: library/ecjpake.c
2619 * Caller:
2620 *
2621 * This module is used by the following key exchanges:
2622 * ECJPAKE
2623 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002624 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002625 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002626 * \warning If using a hash that is only provided by PSA drivers, you must
2627 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002628 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002629#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002630
2631/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002632 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002633 *
2634 * Enable the elliptic curve over GF(p) library.
2635 *
2636 * Module: library/ecp.c
2637 * Caller: library/ecdh.c
2638 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002639 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002640 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002642 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002644
2645/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002646 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002647 *
2648 * Enable the platform-specific entropy code.
2649 *
2650 * Module: library/entropy.c
2651 * Caller:
2652 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002653 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002654 *
2655 * This module provides a generic entropy pool
2656 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002658
2659/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002661 *
2662 * Enable error code to error string conversion.
2663 *
2664 * Module: library/error.c
2665 * Caller:
2666 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002668 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002670
2671/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002672 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002673 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002674 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002675 *
2676 * Module: library/gcm.c
2677 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002678 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2679 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002680 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002681 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2682 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002683 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002685
2686/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002687 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002688 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002689 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002690 * Can significantly increase throughput on systems without GCM hardware
2691 * acceleration (e.g., AESNI, AESCE).
2692 *
Matthias Schulz78266782024-02-08 13:54:48 +01002693 * The mbedtls_gcm_context size will increase by 3840 bytes.
2694 * The code size will increase by roughly 344 bytes.
2695 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002696 * Module: library/gcm.c
2697 *
2698 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002699 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002700//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002701
2702/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002703 * \def MBEDTLS_HKDF_C
2704 *
2705 * Enable the HKDF algorithm (RFC 5869).
2706 *
2707 * Module: library/hkdf.c
2708 * Caller:
2709 *
2710 * Requires: MBEDTLS_MD_C
2711 *
2712 * This module adds support for the Hashed Message Authentication Code
2713 * (HMAC)-based key derivation function (HKDF).
2714 */
2715#define MBEDTLS_HKDF_C
2716
2717/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002718 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002719 *
2720 * Enable the HMAC_DRBG random generator.
2721 *
2722 * Module: library/hmac_drbg.c
2723 * Caller:
2724 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002726 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002727 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002730
2731/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002732 * \def MBEDTLS_LMS_C
2733 *
2734 * Enable the LMS stateful-hash asymmetric signature algorithm.
2735 *
2736 * Module: library/lms.c
2737 * Caller:
2738 *
Raef Colesab4f8742022-09-01 12:24:31 +01002739 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002740 *
Raef Colesab4f8742022-09-01 12:24:31 +01002741 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002742 */
2743#define MBEDTLS_LMS_C
2744
2745/**
Raef Colesab4f8742022-09-01 12:24:31 +01002746 * \def MBEDTLS_LMS_PRIVATE
2747 *
2748 * Enable LMS private-key operations and signing code. Functions enabled by this
2749 * option are experimental, and should not be used in production.
2750 *
2751 * Requires: MBEDTLS_LMS_C
2752 *
2753 * Uncomment to enable the LMS signature algorithm and private key operations.
2754 */
Raef Coles5127e852022-10-07 10:35:56 +01002755//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002756
2757/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002758 * \def MBEDTLS_NIST_KW_C
2759 *
2760 * Enable the Key Wrapping mode for 128-bit block ciphers,
2761 * as defined in NIST SP 800-38F. Only KW and KWP modes
2762 * are supported. At the moment, only AES is approved by NIST.
2763 *
2764 * Module: library/nist_kw.c
2765 *
2766 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2767 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002768#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002769
2770/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002771 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002772 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002773 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002774 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002775 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2776 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002777 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002778 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002779 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002780 * Caller: library/constant_time.c
2781 * library/ecdsa.c
2782 * library/ecjpake.c
2783 * library/hkdf.c
2784 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002785 * library/pk.c
2786 * library/pkcs5.c
2787 * library/pkcs12.c
2788 * library/psa_crypto_ecp.c
2789 * library/psa_crypto_rsa.c
2790 * library/rsa.c
2791 * library/ssl_cookie.c
2792 * library/ssl_msg.c
2793 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002794 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002795 * library/x509_crt.c
2796 * library/x509write_crt.c
2797 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002798 *
2799 * Uncomment to enable generic message digest wrappers.
2800 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002802
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002803/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002805 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002806 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002807 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002808 * Module: library/md5.c
2809 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002810 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002811 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002812 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002813 * This module is required for TLS 1.2 depending on the handshake parameters.
2814 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2815 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002816 *
2817 * \warning MD5 is considered a weak message digest and its use constitutes a
2818 * security risk. If possible, we recommend avoiding dependencies on
2819 * it, and considering stronger message digests instead.
2820 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002821 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002823
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002824/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002825 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002826 *
2827 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002828 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002829 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002830 *
2831 * Module: library/memory_buffer_alloc.c
2832 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002834 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002835 *
2836 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002837 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002838//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002839
2840/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002841 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002842 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002843 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2844 *
Simon Butcherd567a232016-03-09 20:19:21 +00002845 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2846 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002847 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002848 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002849 * \note See also our Knowledge Base article about porting to a new
2850 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002851 * 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 +00002852 *
Andres AG788aa4a2016-09-14 14:32:09 +01002853 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002854 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002855 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002858
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002861 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002862 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002863 *
2864 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002865 * Caller: library/asn1write.c
2866 * library/pkcs5.c
2867 * library/pkparse.c
2868 * library/pkwrite.c
2869 * library/rsa.c
2870 * library/x509.c
2871 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002872 * library/x509_crl.c
2873 * library/x509_crt.c
2874 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002875 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002876 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002877 *
2878 * This modules translates between OIDs and internal values.
2879 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002881
2882/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002884 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002885 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002886 *
2887 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002888 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002889 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002890 * library/x509_crl.c
2891 * library/x509_crt.c
2892 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002893 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002894 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002895 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2896 *
2897 * \warning When parsing password-protected files, if MD5 is provided only by
2898 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002899 *
Paul Bakkercff68422013-09-15 20:43:33 +02002900 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002903
2904/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002905 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002906 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002907 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002908 *
2909 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002910 * Caller: library/pkwrite.c
2911 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002912 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002913 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002914 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002915 *
2916 * This modules adds support for encoding / writing PEM files.
2917 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002919
2920/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002921 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002922 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002923 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002924 *
2925 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002926 * Caller: library/psa_crypto_rsa.c
2927 * library/ssl_tls.c
2928 * library/ssl*_client.c
2929 * library/ssl*_server.c
2930 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002931 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002932 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002933 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002934 * Uncomment to enable generic public key wrappers.
2935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002936#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002937
2938/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002940 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002941 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002942 *
2943 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002944 * Caller: library/x509_crt.c
2945 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002946 *
Yanray Wang072a0682023-12-05 10:53:04 +08002947 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002948 *
2949 * Uncomment to enable generic public key parse functions.
2950 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002952
2953/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002955 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002956 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002957 *
2958 * Module: library/pkwrite.c
2959 * Caller: library/x509write.c
2960 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002961 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002962 *
2963 * Uncomment to enable generic public key write functions.
2964 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002966
2967/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002969 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002970 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002971 *
2972 * Module: library/pkcs5.c
2973 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002974 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002975 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002976 * \warning If using a hash that is only provided by PSA drivers, you must
2977 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002978 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002979 * This module adds support for the PKCS#5 functions.
2980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002982
2983/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002984 * \def MBEDTLS_PKCS7_C
2985 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002986 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002987 * RFC Link - https://tools.ietf.org/html/rfc2315
2988 *
2989 * Module: library/pkcs7.c
2990 *
2991 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002992 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2993 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002994 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002995 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002996 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002997#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002998
2999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003001 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003002 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003003 * Adds algorithms for parsing PKCS#8 encrypted private keys
3004 *
3005 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003006 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003007 *
Valerio Settie98ad592023-12-28 10:42:12 +01003008 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3009 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003010 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003011 * \warning If using a hash that is only provided by PSA drivers, you must
3012 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003013 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003014 * This module enables PKCS#12 functions.
3015 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003017
3018/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003020 *
3021 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003022 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003023 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003024 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3025 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003026 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003027 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003028 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003029 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003030 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003031 * Module: library/platform.c
3032 * Caller: Most other .c files
3033 *
3034 * This module enables abstraction of common (libc) functions.
3035 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003036#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003037
3038/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003039 * \def MBEDTLS_POLY1305_C
3040 *
3041 * Enable the Poly1305 MAC algorithm.
3042 *
3043 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003044 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003045 */
3046#define MBEDTLS_POLY1305_C
3047
3048/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003049 * \def MBEDTLS_PSA_CRYPTO_C
3050 *
3051 * Enable the Platform Security Architecture cryptography API.
3052 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003053 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003054 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003055 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003056 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003057 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3058 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3059 * is enabled in PSA (unless it's fully accelerated, see
3060 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003061 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003062#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003063
3064/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003065 * \def MBEDTLS_PSA_CRYPTO_SE_C
3066 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003067 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003068 * cryptography API.
3069 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003070 * \deprecated This feature is deprecated. Please switch to the PSA driver
3071 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003072 *
Ryan Everett32a64582024-03-05 18:16:18 +00003073 * \warning This feature is not thread-safe, and should not be used in a
3074 * multi-threaded environment.
3075 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003076 * Module: library/psa_crypto_se.c
3077 *
3078 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3079 *
3080 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003081//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003082
3083/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003084 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3085 *
3086 * Enable the Platform Security Architecture persistent key storage.
3087 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003088 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003089 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003090 * Requires: MBEDTLS_PSA_CRYPTO_C,
3091 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3092 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003093 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003094#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003095
3096/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003097 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003098 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003099 * Enable the emulation of the Platform Security Architecture
3100 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003101 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003102 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003103 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003104 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003105 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003106#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003107
3108/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003109 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003110 *
3111 * Enable the RIPEMD-160 hash algorithm.
3112 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003113 * Module: library/ripemd160.c
3114 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003115 *
3116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003117#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003118
3119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003121 *
3122 * Enable the RSA public-key cryptosystem.
3123 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003124 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003125 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003126 * Caller: library/pk.c
3127 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003128 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003129 * library/ssl*_client.c
3130 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003131 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003132 * This module is used by the following key exchanges:
3133 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003134 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003138
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003141 *
3142 * Enable the SHA1 cryptographic hash algorithm.
3143 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003144 * Module: library/sha1.c
3145 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003146 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003147 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003148 * This module is required for TLS 1.2 depending on the handshake parameters,
3149 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003150 *
3151 * \warning SHA-1 is considered a weak message digest and its use constitutes
3152 * a security risk. If possible, we recommend avoiding dependencies
3153 * on it, and considering stronger message digests instead.
3154 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003155 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003156#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003157
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003158/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003159 * \def MBEDTLS_SHA224_C
3160 *
3161 * Enable the SHA-224 cryptographic hash algorithm.
3162 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003163 * Module: library/sha256.c
3164 * Caller: library/md.c
3165 * library/ssl_cookie.c
3166 *
3167 * This module adds support for SHA-224.
3168 */
3169#define MBEDTLS_SHA224_C
3170
3171/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003173 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003174 * Enable the SHA-256 cryptographic hash algorithm.
3175 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003176 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003177 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003178 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003179 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003180 * library/ssl*_client.c
3181 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003182 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003183 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003184 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003185 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003187
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003188/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003189 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003190 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003191 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3192 * with the ARMv8 cryptographic extensions if they are available at runtime.
3193 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003194 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003195 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003196 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003197 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003198 * \note Minimum compiler versions for this feature are Clang 4.0,
3199 * armclang 6.6 or GCC 6.0.
3200 *
3201 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3202 * armclang <= 6.9
3203 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003204 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3205 * That name is deprecated, but may still be used as an alternative form for this
3206 * option.
3207 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003208 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3209 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003210 *
3211 * Requires: MBEDTLS_SHA256_C.
3212 *
3213 * Module: library/sha256.c
3214 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003215 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003216 * and use them if available.
3217 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003218//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003219
Dave Rodgmand85277c2023-10-13 09:22:54 +01003220/**
3221 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3222 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003223 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003224 * This name is now deprecated, but may still be used as an alternative form for
3225 * this option.
3226 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003227//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3228
3229/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003230 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003231 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003232 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3233 * with the ARMv8 cryptographic extensions, which must be available at runtime
3234 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003235 *
3236 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003237 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003238 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003239 * \note Minimum compiler versions for this feature are Clang 4.0,
3240 * armclang 6.6 or GCC 6.0.
3241 *
3242 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3243 * armclang <= 6.9
3244 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003245 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003246 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003247 * option.
3248 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003249 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3250 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003251 *
3252 * Requires: MBEDTLS_SHA256_C.
3253 *
3254 * Module: library/sha256.c
3255 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003256 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003257 * unconditionally.
3258 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003259//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003260
Dave Rodgmand85277c2023-10-13 09:22:54 +01003261/**
3262 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3263 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003264 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003265 * This name is now deprecated, but may still be used as an alternative form for
3266 * this option.
3267 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003268//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3269
3270/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003271 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003272 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003273 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003274 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003275 * Module: library/sha512.c
3276 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003277 * library/psa_crypto_hash.c
3278 * library/ssl_tls.c
3279 * library/ssl*_client.c
3280 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003281 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003282 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003283 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003284#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003285
3286/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003287 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003288 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003289 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003290 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003291 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003292 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003293 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003294 * library/ssl_tls.c
3295 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003296 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003297 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003300
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003301/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003302 * \def MBEDTLS_SHA3_C
3303 *
3304 * Enable the SHA3 cryptographic hash algorithm.
3305 *
3306 * Module: library/sha3.c
3307 *
3308 * This module adds support for SHA3.
3309 */
3310#define MBEDTLS_SHA3_C
3311
3312/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003313 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3314 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003315 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3316 * with the ARMv8 cryptographic extensions if they are available at runtime.
3317 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003318 *
3319 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3320 * for a non-Aarch64 build it will be silently ignored.
3321 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003322 * \note Minimum compiler versions for this feature are Clang 7.0,
3323 * armclang 6.9 or GCC 8.0.
3324 *
3325 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3326 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003327 *
3328 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3329 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3330 *
3331 * Requires: MBEDTLS_SHA512_C.
3332 *
3333 * Module: library/sha512.c
3334 *
3335 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3336 * and use them if available.
3337 */
3338//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3339
3340/**
3341 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3342 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003343 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3344 * with the ARMv8 cryptographic extensions, which must be available at runtime
3345 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003346 *
3347 * \note This allows builds with a smaller code size than with
3348 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3349 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003350 * \note Minimum compiler versions for this feature are Clang 7.0,
3351 * armclang 6.9 or GCC 8.0.
3352 *
3353 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3354 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003355 *
3356 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3357 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3358 *
3359 * Requires: MBEDTLS_SHA512_C.
3360 *
3361 * Module: library/sha512.c
3362 *
3363 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3364 * unconditionally.
3365 */
3366//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3367
3368/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003370 *
3371 * Enable simple SSL cache implementation.
3372 *
3373 * Module: library/ssl_cache.c
3374 * Caller:
3375 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003376 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003379
3380/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003382 *
3383 * Enable basic implementation of DTLS cookies for hello verification.
3384 *
3385 * Module: library/ssl_cookie.c
3386 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003388#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003389
3390/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003391 * \def MBEDTLS_SSL_TICKET_C
3392 *
3393 * Enable an implementation of TLS server-side callbacks for session tickets.
3394 *
3395 * Module: library/ssl_ticket.c
3396 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003397 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003398 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3399 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003400 */
3401#define MBEDTLS_SSL_TICKET_C
3402
3403/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003405 *
3406 * Enable the SSL/TLS client code.
3407 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003408 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003409 * Caller:
3410 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003411 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003412 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003413 * This module is required for SSL/TLS client support.
3414 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003416
Paul Bakker9a736322012-11-14 12:39:52 +00003417/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003419 *
3420 * Enable the SSL/TLS server code.
3421 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003422 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003423 * Caller:
3424 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003426 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003427 * This module is required for SSL/TLS server support.
3428 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003429#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003430
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003431/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003432 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003433 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003434 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003435 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003436 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003437 * Caller: library/ssl*_client.c
3438 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003439 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3441 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003442 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003443 * This module is required for SSL/TLS.
3444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003445#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003446
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003447/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003449 *
3450 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003451 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003452 * contexts are not shared between threads. If you do intend to use contexts
3453 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003454 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003455 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003456 *
3457 * Module: library/threading.c
3458 *
3459 * This allows different threading implementations (self-implemented or
3460 * provided).
3461 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462 * You will have to enable either MBEDTLS_THREADING_ALT or
3463 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003464 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003465 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003466 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003467//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003468
3469/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003470 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003471 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003472 * Enable the semi-portable timing interface.
3473 *
Simon Butcherd567a232016-03-09 20:19:21 +00003474 * \note The provided implementation only works on POSIX/Unix (including Linux,
3475 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003476 * module and provide your own implementations of the callbacks needed by
3477 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3478 * your own implementation of the whole module by setting
3479 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003480 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003481 * \note The timing module will include time.h on suitable platforms
3482 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3483 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3484 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003485 * \note See also our Knowledge Base article about porting to a new
3486 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003487 * 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 +00003488 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003489 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003490 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003491#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003492
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003493/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003495 *
3496 * Enable run-time version information.
3497 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003498 * Module: library/version.c
3499 *
3500 * This module provides run-time version information.
3501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003502#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003503
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003504/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003506 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003507 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003508 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003509 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003510 * Caller: library/x509_crl.c
3511 * library/x509_crt.c
3512 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003513 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003514 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003515 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3516 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003517 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3518 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003519 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003520 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003521 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003523
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003525 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003526 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003527 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003528 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003529 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003530 * Caller: library/ssl_tls.c
3531 * library/ssl*_client.c
3532 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003533 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003535 *
3536 * This module is required for X.509 certificate parsing.
3537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003538#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003539
3540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003542 *
3543 * Enable X.509 CRL parsing.
3544 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003545 * Module: library/x509_crl.c
3546 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003547 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003548 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003549 *
3550 * This module is required for X.509 CRL parsing.
3551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003553
3554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003556 *
3557 * Enable X.509 Certificate Signing Request (CSR) parsing.
3558 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003559 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003560 * Caller: library/x509_crt_write.c
3561 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003562 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003563 *
3564 * This module is used for reading X.509 certificate request.
3565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003567
3568/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003571 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003572 *
3573 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003574 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003575 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003576 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3577 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003578 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3579 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003580 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003581 * This module is the basis for creating X.509 certificates and CSRs.
3582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003583#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003584
3585/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003586 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003587 *
3588 * Enable creating X.509 certificates.
3589 *
3590 * Module: library/x509_crt_write.c
3591 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003592 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003593 *
3594 * This module is required for X.509 certificate creation.
3595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003597
3598/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003599 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003600 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003601 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003602 *
3603 * Module: library/x509_csr_write.c
3604 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003605 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003606 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003607 * This module is required for X.509 certificate request writing.
3608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003609#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003610
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003611/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003612
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003613/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003614 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003615 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003616 * This section contains Mbed TLS build settings that are not associated
3617 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003618 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003619 * \{
3620 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003621
Gilles Peskinea02c1242022-03-16 17:03:19 +01003622/**
3623 * \def MBEDTLS_CONFIG_FILE
3624 *
3625 * If defined, this is a header which will be included instead of
3626 * `"mbedtls/mbedtls_config.h"`.
3627 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003628 * Unlike other configuration options, this one must be defined on the
3629 * compiler command line: a definition in `mbedtls_config.h` would have
3630 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003631 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003632 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003633 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003634 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003635 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003636 * The value of this symbol is typically a path in double quotes, either
3637 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003638 */
3639//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3640
3641/**
3642 * \def MBEDTLS_USER_CONFIG_FILE
3643 *
3644 * If defined, this is a header which will be included after
3645 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003646 * This allows you to modify the default configuration, including the ability
3647 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003648 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003649 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003650 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003651 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003652 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003653 * The value of this symbol is typically a path in double quotes, either
3654 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003655 */
3656//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3657
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003658/**
3659 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3660 *
3661 * If defined, this is a header which will be included instead of
3662 * `"psa/crypto_config.h"`.
3663 * This header file specifies which cryptographic mechanisms are available
3664 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3665 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3666 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003667 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +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 Peskinef4c6eb02022-03-16 17:10:48 +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 Peskinef4c6eb02022-03-16 17:10:48 +01003673 */
3674//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3675
3676/**
3677 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3678 *
3679 * If defined, this is a header which will be included after
3680 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003681 * This allows you to modify the default configuration, including the ability
3682 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003683 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003684 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003685 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003686 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003687 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003688 * The value of this symbol is typically a path in double quotes, either
3689 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003690 */
3691//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3692
Gilles Peskineb1176f22023-02-22 22:07:28 +01003693/**
3694 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3695 *
3696 * If defined, this is a header which will be included instead of
3697 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3698 * as the one in Mbed TLS, but with definitions adapted to the platform on
3699 * which the library code will run.
3700 *
3701 * \note The required content of this header can vary from one version of
3702 * Mbed TLS to the next. Integrators who provide an alternative file
3703 * should review the changes in the original file whenever they
3704 * upgrade Mbed TLS.
3705 *
3706 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3707 * non-standard feature of the C language, so this feature is only available
3708 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3709 *
3710 * The value of this symbol is typically a path in double quotes, either
3711 * absolute or relative to a directory on the include search path.
3712 */
3713//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3714
3715/**
3716 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3717 *
3718 * If defined, this is a header which will be included instead of
3719 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3720 * as the one in Mbed TLS, but with definitions adapted to the environment
3721 * in which the library code will run. The typical use for this feature
3722 * is to provide alternative type definitions on the client side in
3723 * client-server integrations of PSA crypto, where operation structures
3724 * contain handles instead of cryptographic data.
3725 *
3726 * \note The required content of this header can vary from one version of
3727 * Mbed TLS to the next. Integrators who provide an alternative file
3728 * should review the changes in the original file whenever they
3729 * upgrade Mbed TLS.
3730 *
3731 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3732 * non-standard feature of the C language, so this feature is only available
3733 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3734 *
3735 * The value of this symbol is typically a path in double quotes, either
3736 * absolute or relative to a directory on the include search path.
3737 */
3738//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3739
Gilles Peskineba4162a2022-04-11 17:04:38 +02003740/** \} name SECTION: General configuration options */
3741
3742/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003743 * \name SECTION: Module configuration options
3744 *
3745 * This section allows for the setting of module specific sizes and
3746 * configuration options. The default values are already present in the
3747 * relevant header files and should suffice for the regular use cases.
3748 *
3749 * Our advice is to enable options and change their values here
3750 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003751 * \{
3752 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003753/* The Doxygen documentation here is used when a user comments out a
3754 * setting and runs doxygen themselves. On the other hand, when we typeset
3755 * the full documentation including disabled settings, the documentation
3756 * in specific modules' header files is used if present. When editing this
3757 * file, make sure that each option is documented in exactly one place,
3758 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3759 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003760
Paul Bakker088c5c52014-04-25 11:11:10 +02003761/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003762//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003763//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003764
Paul Bakker088c5c52014-04-25 11:11:10 +02003765/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003766//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3767//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3768//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3769//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3770//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003771
Paul Bakker088c5c52014-04-25 11:11:10 +02003772/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003773//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3774//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3775//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3776//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003777
Paul Bakker088c5c52014-04-25 11:11:10 +02003778/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003779//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003780//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003781
Paul Bakker088c5c52014-04-25 11:11:10 +02003782/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003783//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3784//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003785//#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 +01003786
Paul Bakker088c5c52014-04-25 11:11:10 +02003787/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003788//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003789
Paul Bakker088c5c52014-04-25 11:11:10 +02003790/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003791//#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 -04003792
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003793/** \def MBEDTLS_PLATFORM_STD_CALLOC
3794 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003795 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003796 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003797 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003798 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003799 * 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 -04003800 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3801 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003802 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003803 */
3804//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003805
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003806/** \def MBEDTLS_PLATFORM_STD_FREE
3807 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003808 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003809 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003810 * 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 -04003811 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3812 * 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 -04003813 */
3814//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003815//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003816//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003817//#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 +02003818//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3819//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003820/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003821//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003822//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3823//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003824//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3825//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3826//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003827
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003828/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003829/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003830//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3831//#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 +02003832//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003833//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003834//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3835//#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 +02003836//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3837//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro 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_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003840//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003841//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3842//#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 +08003843//#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 +08003844//#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 +02003845
Gilles Peskine3f106f72021-09-23 17:42:39 +02003846/** \def MBEDTLS_CHECK_RETURN
3847 *
3848 * This macro is used at the beginning of the declaration of a function
3849 * to indicate that its return value should be checked. It should
3850 * instruct the compiler to emit a warning or an error if the function
3851 * is called without checking its return value.
3852 *
3853 * There is a default implementation for popular compilers in platform_util.h.
3854 * You can override the default implementation by defining your own here.
3855 *
3856 * If the implementation here is empty, this will effectively disable the
3857 * checking of functions' return values.
3858 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003859//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003860
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003861/** \def MBEDTLS_IGNORE_RETURN
3862 *
3863 * This macro requires one argument, which should be a C function call.
3864 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3865 * warning is suppressed.
3866 */
3867//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3868
Gilles Peskineed038902020-11-13 21:33:21 +01003869/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003870/**
Gilles Peskineed038902020-11-13 21:33:21 +01003871 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3872 * PSA crypto subsystem.
3873 *
3874 * If this option is unset:
3875 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003876 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003877 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3878 * on unspecified heuristics.
3879 */
3880//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3881
Steven Cooreman863470a2021-02-15 14:03:19 +01003882/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003883 * Restrict the PSA library to supporting a maximum amount of simultaneously
3884 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3885 * volatile key, or a persistent key which is loaded temporarily by the
3886 * library as part of a crypto operation in flight.
3887 *
3888 * If this option is unset, the library will fall back to a default value of
3889 * 32 keys.
3890 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003891//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003892
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003893/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003894//#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 +00003895
Paul Bakker088c5c52014-04-25 11:11:10 +02003896/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003897//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3898//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003899
Paul Bakker088c5c52014-04-25 11:11:10 +02003900/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003901
Angus Grattond8213d02016-05-25 20:56:48 +10003902/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3903 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003904 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003905 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003906 * This determines the size of the incoming TLS I/O buffer in such a way
3907 * that it is capable of holding the specified amount of plaintext data,
3908 * regardless of the protection mechanism used.
3909 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003910 * \note When using a value less than the default of 16KB on the client, it is
3911 * recommended to use the Maximum Fragment Length (MFL) extension to
3912 * inform the server about this limitation. On the server, there
3913 * is no supported, standardized way of informing the client about
3914 * restriction on the maximum size of incoming messages, and unless
3915 * the limitation has been communicated by other means, it is recommended
3916 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3917 * while keeping the default value of 16KB for the incoming buffer.
3918 *
David Horstmann95d516f2021-05-04 18:36:56 +01003919 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003920 */
3921//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3922
Gilles Peskined3d02902020-03-04 21:35:27 +01003923/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3924 *
3925 * The maximum length of CIDs used for incoming DTLS messages.
3926 *
3927 */
3928//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3929
3930/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3931 *
3932 * The maximum length of CIDs used for outgoing DTLS messages.
3933 *
3934 */
3935//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3936
TRodziewicze8dd7092021-05-12 14:19:11 +02003937/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003938 *
3939 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003940 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003941 *
3942 * The padding will always be chosen so that the length of the
3943 * padded plaintext is a multiple of the value of this option.
3944 *
3945 * Note: A value of \c 1 means that no padding will be used
3946 * for outgoing records.
3947 *
3948 * Note: On systems lacking division instructions,
3949 * a power of two should be preferred.
3950 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003951//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003952
Angus Grattond8213d02016-05-25 20:56:48 +10003953/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3954 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003955 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003956 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003957 * This determines the size of the outgoing TLS I/O buffer in such a way
3958 * that it is capable of holding the specified amount of plaintext data,
3959 * regardless of the protection mechanism used.
3960 *
Angus Grattond8213d02016-05-25 20:56:48 +10003961 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3962 * the default inward 16384 byte buffer to conform to the TLS specification.
3963 *
3964 * The minimum required outward buffer size is determined by the handshake
3965 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3966 * The specific size requirement depends on the configured ciphers and any
3967 * certificate data which is sent during the handshake.
3968 *
David Horstmann95d516f2021-05-04 18:36:56 +01003969 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003970 */
3971//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3972
Hanno Beckere0b150f2018-08-21 15:51:03 +01003973/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3974 *
3975 * Maximum number of heap-allocated bytes for the purpose of
3976 * DTLS handshake message reassembly and future message buffering.
3977 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003978 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003979 * to account for a reassembled handshake message of maximum size,
3980 * together with its reassembly bitmap.
3981 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003982 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003983 * should be sufficient for all practical situations as it allows
3984 * to reassembly a large handshake message (such as a certificate)
3985 * while buffering multiple smaller handshake messages.
3986 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003987 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003988//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003989
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003990//#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 +02003991//#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 +02003992
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003993/**
3994 * Complete list of ciphersuites to use, in order of preference.
3995 *
3996 * \warning No dependency checking is done on that field! This option can only
3997 * be used to restrict the set of available ciphersuites. It is your
3998 * responsibility to make sure the needed modules are active.
3999 *
4000 * Use this to save a few hundred bytes of ROM (default ordering of all
4001 * available ciphersuites) and a few to a few hundred bytes of RAM.
4002 *
4003 * The value below is only an example, not the default.
4004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004005//#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 +02004006
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004007/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004008 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4009 *
4010 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004011 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004012 *
4013 * It must be positive and smaller than UINT32_MAX.
4014 *
4015 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4016 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004017 */
4018//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4019
4020/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004021 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4022 *
Jerry Yucf913512023-11-14 11:06:52 +08004023 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004024 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004025 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004026 * - The client ticket age is the time difference between the time when the
4027 * client proposes to the server to use the ticket and the time the client
4028 * received the ticket from the server.
4029 * - The server ticket age is the time difference between the time when the
4030 * server receives a proposition from the client to use the ticket and the
4031 * time when the ticket was created by the server.
4032 *
Jerry Yucf913512023-11-14 11:06:52 +08004033 * The ages might be different due to the client and server clocks not running
4034 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4035 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4036 * 6s, thus in the worst case clients and servers must sync up their system time
4037 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004038 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004039 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004040 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004041//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004042
4043/**
4044 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4045 *
4046 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4047 *
4048 * This must be less than 256.
4049 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004050//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004051
4052/**
4053 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4054 *
4055 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4056 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4057 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4058 *
4059 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004060//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004061
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004062/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004063//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004064//#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 +01004065
Gilles Peskine611179c2022-04-13 23:04:48 +02004066/** \} name SECTION: Module configuration options */