blob: 28f0a0056e1d3b82af60d552dd9fb89be2e83065 [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_SHA1_PROCESS_ALT
391//#define MBEDTLS_SHA256_PROCESS_ALT
392//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200393//#define MBEDTLS_DES_SETKEY_ALT
394//#define MBEDTLS_DES_CRYPT_ECB_ALT
395//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200396//#define MBEDTLS_AES_SETKEY_ENC_ALT
397//#define MBEDTLS_AES_SETKEY_DEC_ALT
398//#define MBEDTLS_AES_ENCRYPT_ALT
399//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300400//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300401//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300402//#define MBEDTLS_ECDSA_VERIFY_ALT
403//#define MBEDTLS_ECDSA_SIGN_ALT
404//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200405
406/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200407 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200408 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200409 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200410 * hardware entropy collector.
411 *
412 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000413 * prototype as declared in library/entropy_poll.h, and accept NULL as first
414 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200415 *
416 * Uncomment to use your own hardware entropy collector.
417 */
418//#define MBEDTLS_ENTROPY_HARDWARE_ALT
419
420/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200421 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000422 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100423 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000424 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100425 * Uncomment this macro to use precomputed AES tables stored in ROM.
426 * Comment this macro to generate AES tables in RAM at runtime.
427 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100428 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
429 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100430 * initialization time before the first AES operation can be performed.
431 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
432 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
433 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100434 *
435 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000436 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200437//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000438
439/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100440 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200441 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100442 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200443 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100444 * Uncommenting this macro omits 75% of the AES tables from
445 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
446 * by computing their values on the fly during operations
447 * (the tables are entry-wise rotations of one another).
448 *
449 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100450 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100451 * runtime. Specifically, one has to compare 4 accesses within
452 * different tables to 4 accesses with additional arithmetic
453 * operations within the same table. The performance gain/loss
454 * depends on the system and memory details.
455 *
456 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200457 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100458//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200459
460/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800461 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
462 *
463 * Use only 128-bit keys in AES operations to save ROM.
464 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800465 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800466 * or 256-bit keys.
467 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800468 * Uncommenting this macro reduces the size of AES code by ~300 bytes
469 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800470 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800471 * Module: library/aes.c
472 *
473 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800474 */
475//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
476
Gilles Peskinea8861e02023-09-05 20:20:51 +0200477/*
478 * Disable plain C implementation for AES.
479 *
480 * When the plain C implementation is enabled, and an implementation using a
481 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
482 * detection will be used to select between them.
483 *
484 * If only one implementation is present, runtime detection will not be used.
485 * This configuration will crash at runtime if running on a CPU without the
486 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
487 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
488 */
489//#define MBEDTLS_AES_USE_HARDWARE_ONLY
490
Arto Kinnunen732ca322023-04-14 14:26:10 +0800491/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200492 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200493 *
494 * Use less ROM for the Camellia implementation (saves about 768 bytes).
495 *
496 * Uncomment this macro to use less memory for Camellia.
497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200498//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200499
500/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200501 * \def MBEDTLS_CHECK_RETURN_WARNING
502 *
503 * If this macro is defined, emit a compile-time warning if application code
504 * calls a function without checking its return value, but the return value
505 * should generally be checked in portable applications.
506 *
507 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
508 * implemented. Otherwise this option has no effect.
509 *
510 * Uncomment to get warnings on using fallible functions without checking
511 * their return value.
512 *
513 * \note This feature is a work in progress.
514 * Warnings will be added to more functions in the future.
515 *
516 * \note A few functions are considered critical, and ignoring the return
517 * value of these functions will trigger a warning even if this
518 * macro is not defined. To completely disable return value check
519 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
520 */
521//#define MBEDTLS_CHECK_RETURN_WARNING
522
523/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200524 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200525 *
526 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200528#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200529
530/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200531 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000532 *
533 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000536
537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200538 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000539 *
540 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000543
544/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100545 * \def MBEDTLS_CIPHER_MODE_OFB
546 *
547 * Enable Output Feedback mode (OFB) for symmetric ciphers.
548 */
549#define MBEDTLS_CIPHER_MODE_OFB
550
551/**
552 * \def MBEDTLS_CIPHER_MODE_XTS
553 *
554 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
555 */
556#define MBEDTLS_CIPHER_MODE_XTS
557
558/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200559 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000560 *
561 * Enable NULL cipher.
562 * Warning: Only do so when you know what you are doing. This allows for
563 * encryption or channels without any security!
564 *
Ronald Croncee42702021-04-26 11:34:44 +0200565 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200566 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
567 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
568 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
569 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
570 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
571 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
572 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
573 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
574 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
575 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
576 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
577 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
578 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
579 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
580 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
581 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
582 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
583 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
584 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000585 *
586 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000587 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200588//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000589
590/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100591 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200592 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100593 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
594 * specific padding modes in the cipher layer with cipher modes that support
595 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200596 *
597 * If you disable all padding modes, only full blocks can be used with CBC.
598 *
599 * Enable padding modes in the cipher layer.
600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200601#define MBEDTLS_CIPHER_PADDING_PKCS7
602#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
603#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
604#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200605
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200606/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
607 *
608 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800609 * Without this, CTR_DRBG uses a 256-bit key
610 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200611 */
612//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
613
Paul Bakker48e93c82013-08-14 12:21:18 +0200614/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200615 * Enable the verified implementations of ECDH primitives from Project Everest
616 * (currently only Curve25519). This feature changes the layout of ECDH
617 * contexts and therefore is a compatibility break for applications that access
618 * fields of a mbedtls_ecdh_context structure directly. See also
619 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000620 *
621 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
622 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200623 */
624//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
625
626/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100627 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200628 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100629 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
630 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200631 *
632 * Comment macros to disable the curve and functions for it
633 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200634/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200635#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
636#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
637#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
638#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
639#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
640#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
641#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
642#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
643#define MBEDTLS_ECP_DP_BP256R1_ENABLED
644#define MBEDTLS_ECP_DP_BP384R1_ENABLED
645#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200646/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200647#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000648#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200649
650/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200652 *
653 * Enable specific 'modulo p' routines for each NIST prime.
654 * Depending on the prime and architecture, makes operations 4 to 8 times
655 * faster on the corresponding curve.
656 *
657 * Comment this macro to disable NIST curves optimisation.
658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200659#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200660
661/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200662 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100663 *
664 * Enable "non-blocking" ECC operations that can return early and be resumed.
665 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200666 * This allows various functions to pause by returning
667 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
668 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
669 * order to further progress and eventually complete their operation. This is
670 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
671 * number of ECC operations a function may perform before pausing; see
672 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100673 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200674 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200675 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100676 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100677 * This option:
678 * - Adds xxx_restartable() variants of existing operations in the
679 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100680 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
681 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100682 * - ECDSA: signature generation & verification;
683 * - PK: signature generation & verification;
684 * - X509: certificate chain verification.
685 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
686 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
687 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
688 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000689 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100690 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100691 * - verification of the server's key exchange signature;
692 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100693 * - generation of the client's signature if client authentication is used,
694 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100695 *
696 * \note In the cases above, the usual SSL/TLS functions, such as
697 * mbedtls_ssl_handshake(), can now return
698 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200699 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100700 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
701 * restartable operations in PK, X.509 and TLS (see above) are not
702 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100703 * PSA, and are not restartable. These are temporary limitations that
704 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200705 *
Ron Eldor19779c42018-11-05 16:58:13 +0200706 * \note This option only works with the default software implementation of
707 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100708 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100709 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100710 * Requires: MBEDTLS_ECP_C
711 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100712 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100713 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200714//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100715
716/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200717 * Uncomment to enable using new bignum code in the ECC modules.
718 *
719 * \warning This is currently experimental, incomplete and therefore should not
720 * be used in production.
721 */
722//#define MBEDTLS_ECP_WITH_MPI_UINT
723
724/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100726 *
727 * Enable deterministic ECDSA (RFC 6979).
728 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
729 * may result in a compromise of the long-term signing key. This is avoided by
730 * the deterministic variant.
731 *
John Durkop36a82e52020-10-26 09:39:05 -0700732 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100733 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100734 * Comment this macro to disable deterministic ECDSA.
735 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100737
738/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200739 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200740 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200741 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200742 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200743 * This enables the following ciphersuites (if other requisites are
744 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
746 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
747 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
748 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
749 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
750 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
751 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
752 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
753 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
754 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200755 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200756#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200757
758/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200759 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200760 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200761 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200762 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200763 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200764 *
765 * This enables the following ciphersuites (if other requisites are
766 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
768 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
769 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
770 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
771 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
772 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
773 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
774 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
775 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
776 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100777 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100778 * \warning Using DHE constitutes a security risk as it
779 * is not possible to validate custom DH parameters.
780 * If possible, it is recommended users should consider
781 * preferring other methods of key exchange.
782 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100783 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200784 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200786
787/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200788 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200789 *
790 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
791 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200792 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200793 *
794 * This enables the following ciphersuites (if other requisites are
795 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200796 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
797 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
798 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
799 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
800 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
801 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200804
805/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200807 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200808 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200809 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
811 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200812 *
813 * This enables the following ciphersuites (if other requisites are
814 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200815 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
816 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
817 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
818 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
819 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
820 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
821 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
822 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
823 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
824 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200826#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200827
828/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200829 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200830 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200831 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200832 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200833 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
834 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200835 *
836 * This enables the following ciphersuites (if other requisites are
837 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
839 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
840 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
841 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
842 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
843 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
844 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
845 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
846 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
847 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
848 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
849 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200850 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200851#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200852
853/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200854 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200855 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200856 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200857 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
859 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200860 *
861 * This enables the following ciphersuites (if other requisites are
862 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200863 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
864 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
865 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
866 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
867 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
868 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
869 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
870 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
871 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
872 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
873 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
874 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100875 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100876 * \warning Using DHE constitutes a security risk as it
877 * is not possible to validate custom DH parameters.
878 * If possible, it is recommended users should consider
879 * preferring other methods of key exchange.
880 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100881 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200884
885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200886 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200887 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200888 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200889 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200890 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
891 * MBEDTLS_RSA_C
892 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200893 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200894 *
895 * This enables the following ciphersuites (if other requisites are
896 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
898 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
899 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
900 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
901 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
902 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
903 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
904 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
905 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
906 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200907 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200909
910/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200911 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200912 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200913 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200914 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200915 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
916 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
917 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200918 *
919 * This enables the following ciphersuites (if other requisites are
920 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
922 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
923 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
924 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
925 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
926 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
927 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
928 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200931 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200933
934/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100936 *
937 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
938 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200939 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
940 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
941 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100942 *
943 * This enables the following ciphersuites (if other requisites are
944 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
946 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
947 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
948 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
949 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
950 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
951 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
952 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100955 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200956#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100957
958/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100960 *
961 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
962 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200963 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
964 * MBEDTLS_RSA_C
965 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100966 *
967 * This enables the following ciphersuites (if other requisites are
968 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
970 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
971 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
972 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
973 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
974 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
975 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
976 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
977 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
978 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100979 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200980#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100981
982/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200983 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
984 *
985 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
986 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200987 * \warning This is currently experimental. EC J-PAKE support is based on the
988 * Thread v1.0.0 specification; incompatible changes to the specification
989 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200990 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200991 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100992 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200993 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
994 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100995 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800996 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100997 * MBEDTLS_USE_PSA_CRYPTO is disabled).
998 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200999 * This enables the following ciphersuites (if other requisites are
1000 * enabled as well):
1001 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1002 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001003//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001004
1005/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001007 *
1008 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1009 * RFC 5915 and RFC 5480.
1010 *
1011 * Currently this means parsing the SpecifiedECDomain choice of EC
1012 * parameters (only known groups are supported, not arbitrary domains, to
1013 * avoid validation issues).
1014 *
1015 * Disable if you only need to support RFC 5915 + 5480 key formats.
1016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001018
1019/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001020 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1021 *
1022 * Enable the support for parsing public keys of type Short Weierstrass
1023 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001024 * compressed point format. This parsing is done through ECP module's functions.
1025 *
1026 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1027 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1028 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001029 */
1030#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1031
1032/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001033 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001034 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035 * Enable a dummy error function to make use of mbedtls_strerror() in
1036 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1037 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001038 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1040 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001041 *
1042 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001044 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001046
1047/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001049 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001050 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001051 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001055
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001056/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001057 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001058 *
1059 * Enable functions that use the filesystem.
1060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001062
1063/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001064 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001065 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001066 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001067 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001068 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001069 * application.
1070 *
1071 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001072 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001074
1075/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001076 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001077 *
1078 * Do not use built-in platform entropy functions.
1079 * This is useful if your platform does not support
1080 * standards like the /dev/urandom or Windows CryptoAPI.
1081 *
1082 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001083 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001084//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001085
1086/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001087 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001088 *
1089 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1090 * default SHA-512 based one (if both are available).
1091 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001093 *
1094 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1095 * if you have performance concerns.
1096 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097 * This option is only useful if both MBEDTLS_SHA256_C and
1098 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001099 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001101
1102/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001103 * \def MBEDTLS_ENTROPY_NV_SEED
1104 *
1105 * Enable the non-volatile (NV) seed file-based entropy source.
1106 * (Also enables the NV seed read/write functions in the platform layer)
1107 *
1108 * This is crucial (if not required) on systems that do not have a
1109 * cryptographic entropy source (in hardware or kernel) available.
1110 *
1111 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1112 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001113 * \note The read/write functions that are used by the entropy source are
1114 * determined in the platform layer, and can be modified at runtime and/or
1115 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1116 *
1117 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001118 * with regular fopen(), please make sure you make a seedfile with the
1119 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1120 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001121 * and written to or you will get an entropy source error! The default
1122 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1123 * bytes from the file.
1124 *
1125 * \note The entropy collector will write to the seed file before entropy is
1126 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001127 */
1128//#define MBEDTLS_ENTROPY_NV_SEED
1129
Ronald Cron71016a92020-08-28 19:01:50 +02001130/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001131 *
Ronald Cron71016a92020-08-28 19:01:50 +02001132 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001133 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001134 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1135 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001136 *
1137 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001138 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001139 */
Ronald Cron71016a92020-08-28 19:01:50 +02001140//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001141
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001142/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001144 *
1145 * Enable debugging of buffer allocator memory issues. Automatically prints
1146 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1147 * function for 'debug output' of allocated memory.
1148 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001150 *
1151 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001154
1155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001157 *
1158 * Include backtrace information with each allocated block.
1159 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001161 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001162 *
1163 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001164 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001166
1167/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001168 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001169 *
1170 * Support external private RSA keys (eg from a HSM) in the PK layer.
1171 *
1172 * Comment this macro to disable support for external private RSA keys.
1173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001175
1176/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001178 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001179 * Enable support for PKCS#1 v1.5 encoding.
1180 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001181 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001182 *
Paul Bakker48377d92013-08-30 12:06:24 +02001183 * This enables support for PKCS#1 v1.5 operations.
1184 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001186
1187/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001189 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001190 * Enable support for PKCS#1 v2.1 encoding.
1191 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001192 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001193 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001194 * \warning If using a hash that is only provided by PSA drivers, you must
1195 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001196 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001197 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001200
Steven Cooreman6801f082021-02-19 17:21:22 +01001201/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1202 *
1203 * Enable support for platform built-in keys. If you enable this feature,
1204 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1205 * See the documentation of that function for more information.
1206 *
1207 * Built-in keys are typically derived from a hardware unique key or
1208 * stored in a secure element.
1209 *
1210 * Requires: MBEDTLS_PSA_CRYPTO_C.
1211 *
1212 * \warning This interface is experimental and may change or be removed
1213 * without notice.
1214 */
1215//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1216
Ronald Cron3768ac12021-01-26 16:58:00 +01001217/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1218 *
1219 * Enable support for PSA crypto client.
1220 *
1221 * \note This option allows to include the code necessary for a PSA
1222 * crypto client when the PSA crypto implementation is not included in
1223 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1224 * code to set and get PSA key attributes.
1225 * The development of PSA drivers partially relying on the library to
1226 * fulfill the hardware gaps is another possible usage of this option.
1227 *
1228 * \warning This interface is experimental and may change or be removed
1229 * without notice.
1230 */
1231//#define MBEDTLS_PSA_CRYPTO_CLIENT
1232
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001233/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1234 *
1235 * Make the PSA Crypto module use an external random generator provided
1236 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1237 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001238 * \note This random generator must deliver random numbers with cryptographic
1239 * quality and high performance. It must supply unpredictable numbers
1240 * with a uniform distribution. The implementation of this function
1241 * is responsible for ensuring that the random generator is seeded
1242 * with sufficient entropy. If you have a hardware TRNG which is slow
1243 * or delivers non-uniform output, declare it as an entropy source
1244 * with mbedtls_entropy_add_source() instead of enabling this option.
1245 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001246 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001247 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1248 * and define a function called mbedtls_psa_external_get_random()
1249 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001250 * ```
1251 * psa_status_t mbedtls_psa_external_get_random(
1252 * mbedtls_psa_external_random_context_t *context,
1253 * uint8_t *output, size_t output_size, size_t *output_length);
1254 * );
1255 * ```
1256 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001257 * The function must fill the \c output buffer with \c output_size bytes
1258 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001259 *
1260 * Requires: MBEDTLS_PSA_CRYPTO_C
1261 *
1262 * \warning If you enable this option, code that uses the PSA cryptography
1263 * interface will not use any of the entropy sources set up for
1264 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1265 * enables.
1266 *
1267 * \note This option is experimental and may be removed without notice.
1268 */
1269//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1270
Paul Bakker9dcc3222011-03-08 14:16:06 +00001271/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001272 * \def MBEDTLS_PSA_CRYPTO_SPM
1273 *
1274 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1275 * Partition Manager) integration which separates the code into two parts: a
1276 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1277 * Environment).
1278 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001279 * If you enable this option, your build environment must include a header
1280 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1281 * header files, or in another directory on the compiler's include search
1282 * path). Alternatively, your platform may customize the header
1283 * `psa/crypto_platform.h`, in which case it can skip or replace the
1284 * inclusion of `"crypto_spe.h"`.
1285 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001286 * Module: library/psa_crypto.c
1287 * Requires: MBEDTLS_PSA_CRYPTO_C
1288 *
1289 */
1290//#define MBEDTLS_PSA_CRYPTO_SPM
1291
1292/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001293 * Uncomment to enable p256-m. This is an alternative implementation of
1294 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1295 * Compared to the default implementation:
1296 *
1297 * - p256-m has a much smaller code size and RAM footprint.
1298 * - p256-m is only available via the PSA API. This includes the pk module
1299 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1300 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1301 * over the core arithmetic, or deterministic derivation of keys.
1302 *
1303 * We recommend enabling this option if your application uses the PSA API
1304 * and the only elliptic curve support it needs is ECDH and ECDSA over
1305 * SECP256R1.
1306 *
1307 * If you enable this option, you do not need to enable any ECC-related
1308 * MBEDTLS_xxx option. You do need to separately request support for the
1309 * cryptographic mechanisms through the PSA API:
1310 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1311 * configuration;
1312 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1313 * - #PSA_WANT_ECC_SECP_R1_256;
1314 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1315 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1316 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1317 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1318 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001319 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001320 * \note To benefit from the smaller code size of p256-m, make sure that you
1321 * do not enable any ECC-related option not supported by p256-m: this
1322 * would cause the built-in ECC implementation to be built as well, in
1323 * order to provide the required option.
1324 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001325 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1326 * SECP256R1 are disabled as they are not supported by this driver.
1327 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1328 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001329 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001330 */
1331//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1332
1333/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001334 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001335 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001336 * Enable support for entropy injection at first boot. This feature is
1337 * required on systems that do not have a built-in entropy source (TRNG).
1338 * This feature is currently not supported on systems that have a built-in
1339 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001340 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001341 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001342 *
1343 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001344//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001345
1346/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001347 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001348 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001349 * Assume all buffers passed to PSA functions are owned exclusively by the
1350 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001351 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001352 * This option may be enabled if all buffers passed to any PSA function reside
1353 * in memory that is accessible only to the PSA function during its execution.
1354 *
1355 * This option MUST be disabled whenever buffer arguments are in memory shared
1356 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001357 * across a trust boundary.
1358 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001359 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001360 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001361 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001362 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001363 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001364//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001365
1366/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001367 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001368 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001369 * Do not use the Chinese Remainder Theorem
1370 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001371 *
1372 * Uncomment this macro to disable the use of CRT in RSA.
1373 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001374 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001376
1377/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001378 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001379 *
1380 * Enable the checkup functions (*_self_test).
1381 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001382#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001383
1384/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001385 * \def MBEDTLS_SHA256_SMALLER
1386 *
1387 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1388 * lower performance.
1389 *
Adam Wolf039080f2019-09-10 09:53:08 -05001390 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001391 * performance and size. This version optimizes more aggressively for size at
1392 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1393 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1394 * 30%.
1395 *
1396 * Uncomment to enable the smaller implementation of SHA256.
1397 */
1398//#define MBEDTLS_SHA256_SMALLER
1399
1400/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001401 * \def MBEDTLS_SHA512_SMALLER
1402 *
1403 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1404 * lower performance.
1405 *
1406 * Uncomment to enable the smaller implementation of SHA512.
1407 */
1408//#define MBEDTLS_SHA512_SMALLER
1409
1410/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001411 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001412 *
1413 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001414 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001415 * with other servers, only debugging of failures is harder.
1416 *
1417 * The advantage of not sending alert messages, is that no information is given
1418 * about reasons for failures thus preventing adversaries of gaining intel.
1419 *
1420 * Enable sending of all alert messages
1421 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001422#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001423
1424/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001425 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1426 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001427 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001428 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001429 * in the underlying transport. The CID functionality is described
1430 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001431 *
1432 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001433 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1434 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1435 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001436 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001437 * The maximum lengths of outgoing and incoming CIDs can be configured
1438 * through the options
1439 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1440 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1441 *
1442 * Requires: MBEDTLS_SSL_PROTO_DTLS
1443 *
1444 * Uncomment to enable the Connection ID extension.
1445 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001446#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1447
1448
1449/**
1450 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1451 *
1452 * Defines whether RFC 9146 (default) or the legacy version
1453 * (version draft-ietf-tls-dtls-connection-id-05,
1454 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1455 * is used.
1456 *
1457 * Set the value to 0 for the standard version, and
1458 * 1 for the legacy draft version.
1459 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001460 * \deprecated Support for the legacy version of the DTLS
1461 * Connection ID feature is deprecated. Please
1462 * switch to the standardized version defined
1463 * in RFC 9146 enabled by utilizing
1464 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1465 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1466 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001467 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1468 */
1469#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001470
1471/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001472 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1473 *
1474 * Enable asynchronous external private key operations in SSL. This allows
1475 * you to configure an SSL connection to call an external cryptographic
1476 * module to perform private key operations instead of performing the
1477 * operation inside the library.
1478 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001479 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001480 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001481//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001482
1483/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001484 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1485 *
1486 * Enable serialization of the TLS context structures, through use of the
1487 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1488 *
1489 * This pair of functions allows one side of a connection to serialize the
1490 * context associated with the connection, then free or re-use that context
1491 * while the serialized state is persisted elsewhere, and finally deserialize
1492 * that state to a live context for resuming read/write operations on the
1493 * connection. From a protocol perspective, the state of the connection is
1494 * unaffected, in particular this is entirely transparent to the peer.
1495 *
1496 * Note: this is distinct from TLS session resumption, which is part of the
1497 * protocol and fully visible by the peer. TLS session resumption enables
1498 * establishing new connections associated to a saved session with shorter,
1499 * lighter handshakes, while context serialization is a local optimization in
1500 * handling a single, potentially long-lived connection.
1501 *
1502 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1503 * saved after the handshake to allow for more efficient serialization, so if
1504 * you don't need this feature you'll save RAM by disabling it.
1505 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001506 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1507 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001508 * Comment to disable the context serialization APIs.
1509 */
1510#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1511
1512/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001514 *
1515 * Enable the debug messages in SSL module for all issues.
1516 * Debug messages have been disabled in some places to prevent timing
1517 * attacks due to (unbalanced) debugging function calls.
1518 *
1519 * If you need all error reporting you should enable this during debugging,
1520 * but remove this for production servers that should log as well.
1521 *
1522 * Uncomment this macro to report all debug messages on errors introducing
1523 * a timing side-channel.
1524 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001526//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001529 *
1530 * Enable support for Encrypt-then-MAC, RFC 7366.
1531 *
1532 * This allows peers that both support it to use a more robust protection for
1533 * ciphersuites using CBC, providing deep resistance against timing attacks
1534 * on the padding or underlying cipher.
1535 *
1536 * This only affects CBC ciphersuites, and is useless if none is defined.
1537 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001538 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001539 *
1540 * Comment this macro to disable support for Encrypt-then-MAC
1541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001542#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001543
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001544/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001545 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001546 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1547 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001548 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001549 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001550 * attacks, but it is recommended to always use it (even if you disable
1551 * renegotiation), since it actually fixes a more fundamental issue in the
1552 * original SSL/TLS design, and has implications beyond Triple Handshake.
1553 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001554 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001555 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001556 * Comment this macro to disable support for Extended Master Secret.
1557 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001559
Paul Bakkerd66f0702013-01-31 16:57:45 +01001560/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001561 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1562 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001563 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001564 * giving access to the peer's certificate after completion of the handshake.
1565 *
1566 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1567 * recommended to disable this option for reduced RAM usage.
1568 *
1569 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1570 * defined, but always returns \c NULL.
1571 *
1572 * \note This option has no influence on the protection against the
1573 * triple handshake attack. Even if it is disabled, Mbed TLS will
1574 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001575 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001576 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001577 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001578 *
1579 * Comment this macro to disable storing the peer's certificate
1580 * after the handshake.
1581 */
1582#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1583
1584/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001586 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001587 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001588 *
1589 * The two main uses of renegotiation are (1) refresh keys on long-lived
1590 * connections and (2) client authentication after the initial handshake.
1591 * If you don't need renegotiation, it's probably better to disable it, since
1592 * it has been associated with security issues in the past and is easy to
1593 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001594 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001595 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1596 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001597 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001598 *
1599 * \note Even if this option is disabled, both client and server are aware
1600 * of the Renegotiation Indication Extension (RFC 5746) used to
1601 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1602 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1603 * configuration of this extension).
1604 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001606#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001607
1608/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001610 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001611 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001612 *
1613 * Comment this macro to disable support for the max_fragment_length extension
1614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001615#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001616
1617/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001618 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1619 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001620 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001621 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001622 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1623 *
1624 * Uncomment this macro to enable support for the record_size_limit extension
1625 */
1626//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1627
1628/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001630 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001631 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001632 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001633 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001634 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1635 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001636 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001637 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001638 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001639 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1640 * are only provided by PSA drivers, you must call psa_crypto_init() before
1641 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001642 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001643 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001644 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001645#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001646
1647/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001648 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001649 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001650 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001651 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001652 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001653 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001654 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001655 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001656 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001657 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001658 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1659 * directly performed by TLS 1.3 code. As a consequence, you must
1660 * call psa_crypto_init() before the first TLS 1.3 handshake.
1661 *
1662 * \note Cryptographic operations performed indirectly via another module
1663 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1664 * running handshake hash) only use PSA crypto if
1665 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001666 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001667 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001668 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001669#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001670
1671/**
Ronald Cronab65c522021-11-24 10:47:20 +01001672 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1673 *
1674 * Enable TLS 1.3 middlebox compatibility mode.
1675 *
1676 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1677 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1678 * expecting TLS 1.2 traffic.
1679 *
1680 * Turning on the compatibility mode comes at the cost of a few added bytes
1681 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1682 * that don't use it. Therefore, unless transmission bandwidth is critical and
1683 * you know that middlebox compatibility issues won't occur, it is therefore
1684 * recommended to set this option.
1685 *
1686 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001687 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1688 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001689 *
1690 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001691#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001692
1693/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001694 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1695 *
1696 * Enable TLS 1.3 PSK key exchange mode.
1697 *
1698 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1699 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1700 * effect on the build.
1701 *
1702 */
1703#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1704
1705/**
1706 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1707 *
1708 * Enable TLS 1.3 ephemeral key exchange mode.
1709 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001710 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001711 * MBEDTLS_X509_CRT_PARSE_C
1712 * and at least one of:
1713 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1714 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001715 *
1716 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1717 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1718 * effect on the build.
1719 *
1720 */
1721#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1722
1723/**
1724 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1725 *
1726 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1727 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001728 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001729 *
1730 * Comment to disable support for the PSK ephemeral key exchange mode in
1731 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1732 * have any effect on the build.
1733 *
1734 */
1735#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1736
1737/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 * \def MBEDTLS_SSL_EARLY_DATA
1739 *
1740 * Enable support for RFC 8446 TLS 1.3 early data.
1741 *
1742 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1743 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1744 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1745 *
1746 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1747 * is not enabled, this option does not have any effect on the build.
1748 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001749 * \note The maximum amount of early data can be set with
1750 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1751 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001753//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001754
1755/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001756 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001757 *
1758 * Enable support for DTLS (all available versions).
1759 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001760 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001761 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001762 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001763 *
1764 * Comment this macro to disable support for DTLS
1765 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001766#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001767
1768/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001770 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001771 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001772 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001773 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001774 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001776
1777/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001778 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001779 *
1780 * Enable support for the anti-replay mechanism in DTLS.
1781 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782 * Requires: MBEDTLS_SSL_TLS_C
1783 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001784 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001785 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001786 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001787 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001788 * Comment this to disable anti-replay in DTLS.
1789 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001791
1792/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001794 *
1795 * Enable support for HelloVerifyRequest on DTLS servers.
1796 *
1797 * This feature is highly recommended to prevent DTLS servers being used as
1798 * amplifiers in DoS attacks against other hosts. It should always be enabled
1799 * unless you know for sure amplification cannot be a problem in the
1800 * environment in which your server operates.
1801 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001802 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001803 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001804 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001805 *
1806 * Comment this to disable support for HelloVerifyRequest.
1807 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001808#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001809
1810/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001811 * \def MBEDTLS_SSL_DTLS_SRTP
1812 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001813 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001814 * through the use_srtp extension.
1815 *
1816 * \note This feature provides the minimum functionality required
1817 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1818 * the associated SRTP packet protection key material.
1819 * In particular, the SRTP packet protection itself, as well as the
1820 * demultiplexing of RTP and DTLS packets at the datagram layer
1821 * (see Section 5 of RFC 5764), are not handled by this feature.
1822 * Instead, after successful completion of a handshake negotiating
1823 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001824 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001825 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1826 * (this is implemented in the SSL example programs).
1827 * The resulting key should then be passed to an SRTP stack.
1828 *
1829 * Setting this option enables the runtime API
1830 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1831 * through which the supported DTLS-SRTP protection
1832 * profiles can be configured. You must call this API at
1833 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001834 *
1835 * Requires: MBEDTLS_SSL_PROTO_DTLS
1836 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001837 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001838 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001839//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001840
1841/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001842 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1843 *
1844 * Enable server-side support for clients that reconnect from the same port.
1845 *
1846 * Some clients unexpectedly close the connection and try to reconnect using the
1847 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001848 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001849 * flag enables that support.
1850 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001851 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001852 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001853 * Comment this to disable support for clients reusing the source port.
1854 */
1855#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1856
1857/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001859 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001860 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001861 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001862 * session store remains the responsibility of the application, though).
1863 * Server-side, you also need to provide callbacks for writing and parsing
1864 * tickets, including authenticated encryption and key management. Example
1865 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001866 *
1867 * Comment this macro to disable support for SSL session tickets
1868 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001870
1871/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001873 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001874 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001875 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001877 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001878 * Comment this macro to disable support for server name indication in SSL
1879 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001880#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001881
1882/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001883 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1884 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001885 * When this option is enabled, the SSL buffer will be resized automatically
1886 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001887 *
1888 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001889 */
1890//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1891
1892/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001893 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1894 *
1895 * Enable testing of the constant-flow nature of some sensitive functions with
1896 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001897 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001898 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001899 * This setting requires compiling with clang -fsanitize=memory. The test
1900 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001901 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001902 * \warning This macro is only used for extended testing; it is not considered
1903 * part of the library's API, so it may change or disappear at any time.
1904 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001905 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001906 */
1907//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1908
1909/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001910 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1911 *
1912 * Enable testing of the constant-flow nature of some sensitive functions with
1913 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001914 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001915 *
1916 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001917 * testing if the tests suites are run with valgrind's memcheck. This can be
1918 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1919 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001920 *
1921 * \warning This macro is only used for extended testing; it is not considered
1922 * part of the library's API, so it may change or disappear at any time.
1923 *
1924 * Uncomment to enable testing of the constant-flow nature of selected code.
1925 */
1926//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1927
1928/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001929 * \def MBEDTLS_TEST_HOOKS
1930 *
1931 * Enable features for invasive testing such as introspection functions and
1932 * hooks for fault injection. This enables additional unit tests.
1933 *
1934 * Merely enabling this feature should not change the behavior of the product.
1935 * It only adds new code, and new branching points where the default behavior
1936 * is the same as when this feature is disabled.
1937 * However, this feature increases the attack surface: there is an added
1938 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1939 * Therefore this feature must never be enabled in production.
1940 *
1941 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1942 * information.
1943 *
1944 * Uncomment to enable invasive tests.
1945 */
1946//#define MBEDTLS_TEST_HOOKS
1947
1948/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001949 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001950 *
1951 * Provide your own alternate threading implementation.
1952 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001954 *
1955 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001956 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001958
1959/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001960 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001961 *
1962 * Enable the pthread wrapper layer for the threading layer.
1963 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001965 *
1966 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001969
1970/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001971 * \def MBEDTLS_USE_PSA_CRYPTO
1972 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001973 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1974 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001975 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001976 * \note Development of this option is currently in progress, and parts of Mbed
1977 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001978 * will still continue to work as usual, so enabling this option should not
1979 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001980 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001981 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001982 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1983 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001984 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001985 * \note An important and desirable effect of this option is that it allows
1986 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1987 * 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 +02001988 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001989 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1990 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001991 *
1992 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001993 *
1994 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001995 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001996 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001998//#define MBEDTLS_USE_PSA_CRYPTO
1999
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002000/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002001 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2002 *
John Durkop185764f2020-10-12 21:32:12 -07002003 * This setting allows support for cryptographic mechanisms through the PSA
2004 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002005 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002006 * When this option is disabled, the PSA API exposes the cryptographic
2007 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2008 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002009 *
2010 * When this option is enabled, the PSA API exposes the cryptographic
2011 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2012 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2013 * automatically enabled if required (i.e. if no PSA driver provides the
2014 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2015 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002016 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002017 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002018 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002019 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002020 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2021 * symbols is not completely finalized yet, and the configuration
2022 * tooling is not ideally adapted to having two separate configuration
2023 * files.
2024 * Future minor releases of Mbed TLS may make minor changes to those
2025 * symbols, but we will endeavor to provide a transition path.
2026 * Nonetheless, this option is considered mature enough to use in
2027 * production, as long as you accept that you may need to make
2028 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002029 */
2030//#define MBEDTLS_PSA_CRYPTO_CONFIG
2031
2032/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002033 * \def MBEDTLS_VERSION_FEATURES
2034 *
2035 * Allow run-time checking of compile-time enabled features. Thus allowing users
2036 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002037 * support via mbedtls_version_check_feature().
2038 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002039 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002040 *
2041 * Comment this to disable run-time checking and save ROM space
2042 */
2043#define MBEDTLS_VERSION_FEATURES
2044
2045/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002046 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2047 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002048 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002049 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2050 * the set of trusted certificates through a callback instead of a linked
2051 * list.
2052 *
2053 * This is useful for example in environments where a large number of trusted
2054 * certificates is present and storing them in a linked list isn't efficient
2055 * enough, or when the set of trusted certificates changes frequently.
2056 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002057 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002058 * `mbedtls_ssl_conf_ca_cb()` for more information.
2059 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002060 * Requires: MBEDTLS_X509_CRT_PARSE_C
2061 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002062 * Uncomment to enable trusted certificate callbacks.
2063 */
2064//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2065
2066/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002067 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002068 *
Chris Jones2c745862020-12-16 11:41:06 +00002069 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002070 *
Chris Jones2c745862020-12-16 11:41:06 +00002071 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002072 * and other functions/constants only used by these functions, thus reducing
2073 * the code footprint by several KB.
2074 */
Chris Jones2c745862020-12-16 11:41:06 +00002075//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002076
2077/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002079 *
2080 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2081 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2082 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002083 * Requires: MBEDTLS_PKCS1_V21
2084 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002085 * Comment this macro to disallow using RSASSA-PSS in certificates.
2086 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002087#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002088/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002089
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002090/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002091 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002092 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002093 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002094 * \{
2095 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002096
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002097/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002098 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002099 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002100 * Enable AES-NI support on x86-64 or x86-32.
2101 *
2102 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002103 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002104 * - GCC, x86-64, target not explicitly supporting AESNI:
2105 * requires MBEDTLS_HAVE_ASM.
2106 * - GCC, x86-32, target not explicitly supporting AESNI:
2107 * not supported.
2108 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2109 * For this assembly-less implementation, you must currently compile
2110 * `library/aesni.c` and `library/aes.c` with machine options to enable
2111 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2112 * `clang -maes -mpclmul`.
2113 * - Non-x86 targets: this option is silently ignored.
2114 * - Other compilers: this option is silently ignored.
2115 *
2116 * \note
2117 * Above, "GCC" includes compatible compilers such as Clang.
2118 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002119 *
2120 * Module: library/aesni.c
2121 * Caller: library/aes.c
2122 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002123 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002124 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002125 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002127#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002128
2129/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002130 * \def MBEDTLS_AESCE_C
2131 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002132 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002133 *
2134 * Module: library/aesce.c
2135 * Caller: library/aes.c
2136 *
Jerry Yuf015a932023-04-25 10:38:03 +08002137 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002138 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002139 * \warning Runtime detection only works on Linux. For non-Linux operating
2140 * system, Armv8-A Cryptographic Extensions must be supported by
2141 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002142 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002143 * \note Minimum compiler versions for this feature when targeting aarch64
2144 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2145 * Minimum compiler versions for this feature when targeting 32-bit
2146 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002147 *
2148 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2149 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002150 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002151 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002152 */
2153#define MBEDTLS_AESCE_C
2154
2155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002156 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002157 *
2158 * Enable the AES block cipher.
2159 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002160 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002161 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002162 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002163 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002164 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002165 * This module enables the following ciphersuites (if other requisites are
2166 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2168 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2169 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2170 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2171 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2172 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2173 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2174 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2175 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2176 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2177 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2178 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2179 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2180 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2181 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2182 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2183 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2184 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2185 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2186 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2187 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2188 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2189 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2190 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2191 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2192 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2193 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2194 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2195 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2196 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2197 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2198 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2199 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2200 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2201 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2202 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2203 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2204 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2205 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2206 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2207 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2208 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2209 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2210 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2211 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2212 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2213 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2214 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2215 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2216 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2217 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2218 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2219 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2220 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2221 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2222 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2223 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2224 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002225 *
Paul Bakkercff68422013-09-15 20:43:33 +02002226 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002227 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002228#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002229
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002230/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002231 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002232 *
2233 * Enable the generic ASN1 parser.
2234 *
2235 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002236 * Caller: library/x509.c
2237 * library/dhm.c
2238 * library/pkcs12.c
2239 * library/pkcs5.c
2240 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002241 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002242#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002243
2244/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002246 *
2247 * Enable the generic ASN1 writer.
2248 *
2249 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002250 * Caller: library/ecdsa.c
2251 * library/pkwrite.c
2252 * library/x509_create.c
2253 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002254 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002256#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002257
2258/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002259 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002260 *
2261 * Enable the Base64 module.
2262 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002263 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002264 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002265 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002266 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002269
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002270/**
Yanray Wange367e472023-10-31 17:23:04 +08002271 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2272 *
2273 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2274 *
2275 * \note This feature is incompatible with insecure block cipher,
2276 * MBEDTLS_DES_C, and cipher modes which always require decryption
2277 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002278 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2279 * this feature is incompatible with following supported PSA equivalence,
2280 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2281 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002282 *
2283 * Module: library/aes.c
2284 * library/aesce.c
2285 * library/aesni.c
2286 * library/aria.c
2287 * library/camellia.c
2288 * library/cipher.c
2289 */
2290//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2291
2292/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002293 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002294 *
Paul Bakker9a736322012-11-14 12:39:52 +00002295 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002296 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002297 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002298 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002299 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002300 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002301 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002302 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002303 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002304 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002305 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002306 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002307 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002308 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002311
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002312/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002313 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002314 *
2315 * Enable the Camellia block cipher.
2316 *
Paul Bakker38119b12009-01-10 23:31:23 +00002317 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002318 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002319 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002320 * This module enables the following ciphersuites (if other requisites are
2321 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2323 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2324 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2325 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2326 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2327 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2328 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2329 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2330 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2331 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2332 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2333 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2334 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2335 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2336 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2337 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2338 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2339 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2340 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2341 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2342 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2343 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2344 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2345 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2346 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2347 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2348 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2349 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2350 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2351 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2352 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2353 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2354 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2355 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2356 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2357 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2358 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2359 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2360 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2361 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2362 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2363 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002365#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002366
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002367/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002368 * \def MBEDTLS_ARIA_C
2369 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002370 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002371 *
2372 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002373 * Caller: library/cipher.c
2374 *
2375 * This module enables the following ciphersuites (if other requisites are
2376 * enabled as well):
2377 *
2378 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2379 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2380 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2381 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2382 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2383 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2384 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2385 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2386 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2387 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2388 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2389 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2390 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2391 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2392 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2393 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2394 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2395 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2396 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2397 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2398 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2399 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2400 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2401 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2402 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2403 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2404 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2405 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2406 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2407 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2408 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2409 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2410 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2411 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2412 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2413 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2414 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2415 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002416 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002417#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002418
2419/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002420 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002421 *
2422 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2423 *
2424 * Module: library/ccm.c
2425 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002426 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2427 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002428 *
2429 * This module enables the AES-CCM ciphersuites, if other requisites are
2430 * enabled as well.
2431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002433
2434/**
Daniel King34b822c2016-05-15 17:28:08 -03002435 * \def MBEDTLS_CHACHA20_C
2436 *
2437 * Enable the ChaCha20 stream cipher.
2438 *
2439 * Module: library/chacha20.c
2440 */
2441#define MBEDTLS_CHACHA20_C
2442
2443/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002444 * \def MBEDTLS_CHACHAPOLY_C
2445 *
2446 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2447 *
2448 * Module: library/chachapoly.c
2449 *
2450 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2451 */
2452#define MBEDTLS_CHACHAPOLY_C
2453
2454/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002455 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002456 *
2457 * Enable the generic cipher layer.
2458 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002459 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002460 * Caller: library/ccm.c
2461 * library/cmac.c
2462 * library/gcm.c
2463 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002464 * library/pkcs12.c
2465 * library/pkcs5.c
2466 * library/psa_crypto_aead.c
2467 * library/psa_crypto_mac.c
2468 * library/ssl_ciphersuites.c
2469 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002470 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002471 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2472 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002473 *
2474 * Uncomment to enable generic cipher wrappers.
2475 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002476#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002477
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002478/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002479 * \def MBEDTLS_CMAC_C
2480 *
Simon Butcher327398a2016-10-05 14:09:11 +01002481 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2482 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002483 *
2484 * Module: library/cmac.c
2485 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002486 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002487 *
2488 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002489#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002490
2491/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002492 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002493 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002494 * Enable the CTR_DRBG AES-based random generator.
2495 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002496 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002497 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002498 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002499 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2500 * is used.
2501 *
2502 * \warning When using PSA, the user should call `psa_crypto_init()` before
2503 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2504 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002505 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2506 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002507 * \note To achieve a 256-bit security strength with CTR_DRBG,
2508 * you must use AES-256 *and* use sufficient entropy.
2509 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002510 *
2511 * Module: library/ctr_drbg.c
2512 * Caller:
2513 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002514 * Requires: MBEDTLS_AES_C or
2515 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2516 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002517 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002518 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002520#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002521
2522/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002524 *
2525 * Enable the debug functions.
2526 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002527 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002528 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002529 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002530 * library/ssl_tls12_*.c
2531 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002532 *
2533 * This module provides debugging functions.
2534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002535#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002536
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002539 *
2540 * Enable the DES block cipher.
2541 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002542 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002543 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002544 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002545 *
Paul Bakkercff68422013-09-15 20:43:33 +02002546 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002547 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002548 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002549 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002552
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002553/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002555 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002556 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002557 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002558 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002559 * Caller: library/ssl_tls.c
2560 * library/ssl*_client.c
2561 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002562 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002563 * This module is used by the following key exchanges:
2564 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002565 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002566 * \warning Using DHE constitutes a security risk as it
2567 * is not possible to validate custom DH parameters.
2568 * If possible, it is recommended users should consider
2569 * preferring other methods of key exchange.
2570 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002571 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002572 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002574
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002575/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002577 *
2578 * Enable the elliptic curve Diffie-Hellman library.
2579 *
2580 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002581 * Caller: library/psa_crypto.c
2582 * library/ssl_tls.c
2583 * library/ssl*_client.c
2584 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002585 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002586 * This module is used by the following key exchanges:
2587 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002588 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002590 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002591#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002592
2593/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002594 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002595 *
2596 * Enable the elliptic curve DSA library.
2597 *
2598 * Module: library/ecdsa.c
2599 * Caller:
2600 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002601 * This module is used by the following key exchanges:
2602 * ECDHE-ECDSA
2603 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002604 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2605 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2606 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002609
2610/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002611 * \def MBEDTLS_ECJPAKE_C
2612 *
2613 * Enable the elliptic curve J-PAKE library.
2614 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002615 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2616 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002617 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002618 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002619 * Module: library/ecjpake.c
2620 * Caller:
2621 *
2622 * This module is used by the following key exchanges:
2623 * ECJPAKE
2624 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002625 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002626 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002627 * \warning If using a hash that is only provided by PSA drivers, you must
2628 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002629 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002630#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002631
2632/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002633 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002634 *
2635 * Enable the elliptic curve over GF(p) library.
2636 *
2637 * Module: library/ecp.c
2638 * Caller: library/ecdh.c
2639 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002640 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002641 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002643 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002645
2646/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002648 *
2649 * Enable the platform-specific entropy code.
2650 *
2651 * Module: library/entropy.c
2652 * Caller:
2653 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002655 *
2656 * This module provides a generic entropy pool
2657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002659
2660/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002662 *
2663 * Enable error code to error string conversion.
2664 *
2665 * Module: library/error.c
2666 * Caller:
2667 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002669 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002671
2672/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002674 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002675 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002676 *
2677 * Module: library/gcm.c
2678 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002679 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2680 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002681 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002682 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2683 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002684 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002686
2687/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002688 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002689 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002690 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002691 * Can significantly increase throughput on systems without GCM hardware
2692 * acceleration (e.g., AESNI, AESCE).
2693 *
Matthias Schulz78266782024-02-08 13:54:48 +01002694 * The mbedtls_gcm_context size will increase by 3840 bytes.
2695 * The code size will increase by roughly 344 bytes.
2696 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002697 * Module: library/gcm.c
2698 *
2699 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002700 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002701//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002702
2703/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002704 * \def MBEDTLS_HKDF_C
2705 *
2706 * Enable the HKDF algorithm (RFC 5869).
2707 *
2708 * Module: library/hkdf.c
2709 * Caller:
2710 *
2711 * Requires: MBEDTLS_MD_C
2712 *
2713 * This module adds support for the Hashed Message Authentication Code
2714 * (HMAC)-based key derivation function (HKDF).
2715 */
2716#define MBEDTLS_HKDF_C
2717
2718/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002720 *
2721 * Enable the HMAC_DRBG random generator.
2722 *
2723 * Module: library/hmac_drbg.c
2724 * Caller:
2725 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002727 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002728 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002729 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002731
2732/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002733 * \def MBEDTLS_LMS_C
2734 *
2735 * Enable the LMS stateful-hash asymmetric signature algorithm.
2736 *
2737 * Module: library/lms.c
2738 * Caller:
2739 *
Raef Colesab4f8742022-09-01 12:24:31 +01002740 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002741 *
Raef Colesab4f8742022-09-01 12:24:31 +01002742 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002743 */
2744#define MBEDTLS_LMS_C
2745
2746/**
Raef Colesab4f8742022-09-01 12:24:31 +01002747 * \def MBEDTLS_LMS_PRIVATE
2748 *
2749 * Enable LMS private-key operations and signing code. Functions enabled by this
2750 * option are experimental, and should not be used in production.
2751 *
2752 * Requires: MBEDTLS_LMS_C
2753 *
2754 * Uncomment to enable the LMS signature algorithm and private key operations.
2755 */
Raef Coles5127e852022-10-07 10:35:56 +01002756//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002757
2758/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002759 * \def MBEDTLS_NIST_KW_C
2760 *
2761 * Enable the Key Wrapping mode for 128-bit block ciphers,
2762 * as defined in NIST SP 800-38F. Only KW and KWP modes
2763 * are supported. At the moment, only AES is approved by NIST.
2764 *
2765 * Module: library/nist_kw.c
2766 *
2767 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2768 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002769#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002770
2771/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002773 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002774 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002775 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002776 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2777 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002778 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002779 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002780 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002781 * Caller: library/constant_time.c
2782 * library/ecdsa.c
2783 * library/ecjpake.c
2784 * library/hkdf.c
2785 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002786 * library/pk.c
2787 * library/pkcs5.c
2788 * library/pkcs12.c
2789 * library/psa_crypto_ecp.c
2790 * library/psa_crypto_rsa.c
2791 * library/rsa.c
2792 * library/ssl_cookie.c
2793 * library/ssl_msg.c
2794 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002795 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002796 * library/x509_crt.c
2797 * library/x509write_crt.c
2798 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002799 *
2800 * Uncomment to enable generic message digest wrappers.
2801 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002803
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002804/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002806 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002807 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002808 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002809 * Module: library/md5.c
2810 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002811 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002812 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002813 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002814 * This module is required for TLS 1.2 depending on the handshake parameters.
2815 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2816 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002817 *
2818 * \warning MD5 is considered a weak message digest and its use constitutes a
2819 * security risk. If possible, we recommend avoiding dependencies on
2820 * it, and considering stronger message digests instead.
2821 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002822 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002823#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002824
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002825/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002827 *
2828 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002829 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002830 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002831 *
2832 * Module: library/memory_buffer_alloc.c
2833 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002835 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002836 *
2837 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002838 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002840
2841/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002843 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002844 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2845 *
Simon Butcherd567a232016-03-09 20:19:21 +00002846 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2847 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002848 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002849 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002850 * \note See also our Knowledge Base article about porting to a new
2851 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002852 * 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 +00002853 *
Andres AG788aa4a2016-09-14 14:32:09 +01002854 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002855 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002856 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002857 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002859
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002860/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002862 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002863 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002864 *
2865 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002866 * Caller: library/asn1write.c
2867 * library/pkcs5.c
2868 * library/pkparse.c
2869 * library/pkwrite.c
2870 * library/rsa.c
2871 * library/x509.c
2872 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002873 * library/x509_crl.c
2874 * library/x509_crt.c
2875 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002876 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002877 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002878 *
2879 * This modules translates between OIDs and internal values.
2880 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002881#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002882
2883/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002884 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002885 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002886 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002887 *
2888 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002889 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002890 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002891 * library/x509_crl.c
2892 * library/x509_crt.c
2893 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002894 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002896 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2897 *
2898 * \warning When parsing password-protected files, if MD5 is provided only by
2899 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002900 *
Paul Bakkercff68422013-09-15 20:43:33 +02002901 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002902 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002903#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002904
2905/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002907 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002908 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002909 *
2910 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002911 * Caller: library/pkwrite.c
2912 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002913 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002914 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002916 *
2917 * This modules adds support for encoding / writing PEM files.
2918 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002920
2921/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002923 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002924 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002925 *
2926 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002927 * Caller: library/psa_crypto_rsa.c
2928 * library/ssl_tls.c
2929 * library/ssl*_client.c
2930 * library/ssl*_server.c
2931 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002932 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002933 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002934 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002935 * Uncomment to enable generic public key wrappers.
2936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002937#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002938
2939/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002940 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002941 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002942 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002943 *
2944 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002945 * Caller: library/x509_crt.c
2946 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002947 *
Yanray Wang072a0682023-12-05 10:53:04 +08002948 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002949 *
2950 * Uncomment to enable generic public key parse functions.
2951 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002952#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002953
2954/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002956 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002957 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002958 *
2959 * Module: library/pkwrite.c
2960 * Caller: library/x509write.c
2961 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002962 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002963 *
2964 * Uncomment to enable generic public key write functions.
2965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002967
2968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002970 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002971 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002972 *
2973 * Module: library/pkcs5.c
2974 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002975 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002976 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002977 * \warning If using a hash that is only provided by PSA drivers, you must
2978 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002979 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002980 * This module adds support for the PKCS#5 functions.
2981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002983
2984/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002985 * \def MBEDTLS_PKCS7_C
2986 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002987 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002988 * RFC Link - https://tools.ietf.org/html/rfc2315
2989 *
2990 * Module: library/pkcs7.c
2991 *
2992 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002993 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2994 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002995 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002996 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002997 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002998#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002999
3000/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003002 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003003 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003004 * Adds algorithms for parsing PKCS#8 encrypted private keys
3005 *
3006 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003007 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003008 *
Valerio Settie98ad592023-12-28 10:42:12 +01003009 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3010 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003011 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003012 * \warning If using a hash that is only provided by PSA drivers, you must
3013 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003014 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003015 * This module enables PKCS#12 functions.
3016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003018
3019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003021 *
3022 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003023 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003024 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3026 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003027 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003028 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003029 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003030 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003031 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003032 * Module: library/platform.c
3033 * Caller: Most other .c files
3034 *
3035 * This module enables abstraction of common (libc) functions.
3036 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003037#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003038
3039/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003040 * \def MBEDTLS_POLY1305_C
3041 *
3042 * Enable the Poly1305 MAC algorithm.
3043 *
3044 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003045 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003046 */
3047#define MBEDTLS_POLY1305_C
3048
3049/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003050 * \def MBEDTLS_PSA_CRYPTO_C
3051 *
3052 * Enable the Platform Security Architecture cryptography API.
3053 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003054 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003055 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003056 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003057 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003058 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3059 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3060 * is enabled in PSA (unless it's fully accelerated, see
3061 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003062 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003063#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003064
3065/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003066 * \def MBEDTLS_PSA_CRYPTO_SE_C
3067 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003068 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003069 * cryptography API.
3070 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003071 * \deprecated This feature is deprecated. Please switch to the PSA driver
3072 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003073 *
Ryan Everett32a64582024-03-05 18:16:18 +00003074 * \warning This feature is not thread-safe, and should not be used in a
3075 * multi-threaded environment.
3076 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003077 * Module: library/psa_crypto_se.c
3078 *
3079 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3080 *
3081 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003082//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003083
3084/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003085 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3086 *
3087 * Enable the Platform Security Architecture persistent key storage.
3088 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003089 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003090 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003091 * Requires: MBEDTLS_PSA_CRYPTO_C,
3092 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3093 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003094 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003095#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003096
3097/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003098 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003099 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003100 * Enable the emulation of the Platform Security Architecture
3101 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003102 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003103 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003104 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003105 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003106 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003107#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003108
3109/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003110 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003111 *
3112 * Enable the RIPEMD-160 hash algorithm.
3113 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003114 * Module: library/ripemd160.c
3115 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003116 *
3117 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003119
3120/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003121 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003122 *
3123 * Enable the RSA public-key cryptosystem.
3124 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003125 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003126 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003127 * Caller: library/pk.c
3128 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003129 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003130 * library/ssl*_client.c
3131 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003132 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003133 * This module is used by the following key exchanges:
3134 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003135 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003138#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003139
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003140/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003141 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003142 *
3143 * Enable the SHA1 cryptographic hash algorithm.
3144 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003145 * Module: library/sha1.c
3146 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003147 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003148 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003149 * This module is required for TLS 1.2 depending on the handshake parameters,
3150 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003151 *
3152 * \warning SHA-1 is considered a weak message digest and its use constitutes
3153 * a security risk. If possible, we recommend avoiding dependencies
3154 * on it, and considering stronger message digests instead.
3155 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003156 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003158
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003159/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003160 * \def MBEDTLS_SHA224_C
3161 *
3162 * Enable the SHA-224 cryptographic hash algorithm.
3163 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003164 * Module: library/sha256.c
3165 * Caller: library/md.c
3166 * library/ssl_cookie.c
3167 *
3168 * This module adds support for SHA-224.
3169 */
3170#define MBEDTLS_SHA224_C
3171
3172/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003173 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003174 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003175 * Enable the SHA-256 cryptographic hash algorithm.
3176 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003177 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003178 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003179 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003180 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003181 * library/ssl*_client.c
3182 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003183 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003184 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003185 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003188
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003189/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003190 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003191 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003192 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3193 * with the ARMv8 cryptographic extensions if they are available at runtime.
3194 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003195 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003196 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003197 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003198 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003199 * \note Minimum compiler versions for this feature are Clang 4.0,
3200 * armclang 6.6 or GCC 6.0.
3201 *
3202 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3203 * armclang <= 6.9
3204 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003205 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3206 * That name is deprecated, but may still be used as an alternative form for this
3207 * option.
3208 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003209 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3210 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003211 *
3212 * Requires: MBEDTLS_SHA256_C.
3213 *
3214 * Module: library/sha256.c
3215 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003216 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003217 * and use them if available.
3218 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003219//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003220
Dave Rodgmand85277c2023-10-13 09:22:54 +01003221/**
3222 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3223 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003224 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003225 * This name is now deprecated, but may still be used as an alternative form for
3226 * this option.
3227 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003228//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3229
3230/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003231 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003232 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003233 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3234 * with the ARMv8 cryptographic extensions, which must be available at runtime
3235 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003236 *
3237 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003238 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003239 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003240 * \note Minimum compiler versions for this feature are Clang 4.0,
3241 * armclang 6.6 or GCC 6.0.
3242 *
3243 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3244 * armclang <= 6.9
3245 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003246 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003247 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003248 * option.
3249 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003250 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3251 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003252 *
3253 * Requires: MBEDTLS_SHA256_C.
3254 *
3255 * Module: library/sha256.c
3256 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003257 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003258 * unconditionally.
3259 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003260//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003261
Dave Rodgmand85277c2023-10-13 09:22:54 +01003262/**
3263 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3264 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003265 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003266 * This name is now deprecated, but may still be used as an alternative form for
3267 * this option.
3268 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003269//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3270
3271/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003272 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003273 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003274 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003275 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003276 * Module: library/sha512.c
3277 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003278 * library/psa_crypto_hash.c
3279 * library/ssl_tls.c
3280 * library/ssl*_client.c
3281 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003282 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003283 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003284 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003285#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003286
3287/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003288 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003289 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003290 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003291 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003292 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003293 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003294 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003295 * library/ssl_tls.c
3296 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003297 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003298 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003299 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003300#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003301
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003302/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003303 * \def MBEDTLS_SHA3_C
3304 *
3305 * Enable the SHA3 cryptographic hash algorithm.
3306 *
3307 * Module: library/sha3.c
3308 *
3309 * This module adds support for SHA3.
3310 */
3311#define MBEDTLS_SHA3_C
3312
3313/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003314 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3315 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003316 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3317 * with the ARMv8 cryptographic extensions if they are available at runtime.
3318 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003319 *
3320 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3321 * for a non-Aarch64 build it will be silently ignored.
3322 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003323 * \note Minimum compiler versions for this feature are Clang 7.0,
3324 * armclang 6.9 or GCC 8.0.
3325 *
3326 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3327 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003328 *
3329 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3330 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3331 *
3332 * Requires: MBEDTLS_SHA512_C.
3333 *
3334 * Module: library/sha512.c
3335 *
3336 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3337 * and use them if available.
3338 */
3339//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3340
3341/**
3342 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3343 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003344 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3345 * with the ARMv8 cryptographic extensions, which must be available at runtime
3346 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003347 *
3348 * \note This allows builds with a smaller code size than with
3349 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3350 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003351 * \note Minimum compiler versions for this feature are Clang 7.0,
3352 * armclang 6.9 or GCC 8.0.
3353 *
3354 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3355 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003356 *
3357 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3358 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3359 *
3360 * Requires: MBEDTLS_SHA512_C.
3361 *
3362 * Module: library/sha512.c
3363 *
3364 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3365 * unconditionally.
3366 */
3367//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3368
3369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003371 *
3372 * Enable simple SSL cache implementation.
3373 *
3374 * Module: library/ssl_cache.c
3375 * Caller:
3376 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003377 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003380
3381/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003383 *
3384 * Enable basic implementation of DTLS cookies for hello verification.
3385 *
3386 * Module: library/ssl_cookie.c
3387 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003390
3391/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003392 * \def MBEDTLS_SSL_TICKET_C
3393 *
3394 * Enable an implementation of TLS server-side callbacks for session tickets.
3395 *
3396 * Module: library/ssl_ticket.c
3397 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003398 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003399 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3400 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003401 */
3402#define MBEDTLS_SSL_TICKET_C
3403
3404/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003406 *
3407 * Enable the SSL/TLS client code.
3408 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003409 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003410 * Caller:
3411 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003412 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003413 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003414 * This module is required for SSL/TLS client support.
3415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003417
Paul Bakker9a736322012-11-14 12:39:52 +00003418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003420 *
3421 * Enable the SSL/TLS server code.
3422 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003423 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003424 * Caller:
3425 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003427 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003428 * This module is required for SSL/TLS server support.
3429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003431
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003432/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003434 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003435 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003436 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003437 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003438 * Caller: library/ssl*_client.c
3439 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003440 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3442 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003443 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003444 * This module is required for SSL/TLS.
3445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003447
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003448/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003449 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003450 *
3451 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003452 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003453 * contexts are not shared between threads. If you do intend to use contexts
3454 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003455 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003456 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003457 *
3458 * Module: library/threading.c
3459 *
3460 * This allows different threading implementations (self-implemented or
3461 * provided).
3462 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003463 * You will have to enable either MBEDTLS_THREADING_ALT or
3464 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003465 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003466 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003467 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003468//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003469
3470/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003471 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003472 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003473 * Enable the semi-portable timing interface.
3474 *
Simon Butcherd567a232016-03-09 20:19:21 +00003475 * \note The provided implementation only works on POSIX/Unix (including Linux,
3476 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003477 * module and provide your own implementations of the callbacks needed by
3478 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3479 * your own implementation of the whole module by setting
3480 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003481 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003482 * \note The timing module will include time.h on suitable platforms
3483 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3484 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3485 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003486 * \note See also our Knowledge Base article about porting to a new
3487 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003488 * 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 +00003489 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003490 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003491 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003492#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003493
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003494/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003496 *
3497 * Enable run-time version information.
3498 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003499 * Module: library/version.c
3500 *
3501 * This module provides run-time version information.
3502 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003503#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003504
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003506 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003507 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003508 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003509 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003510 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003511 * Caller: library/x509_crl.c
3512 * library/x509_crt.c
3513 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003514 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003515 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003516 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3517 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003518 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3519 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003520 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003521 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003523#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003524
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003525/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003526 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003527 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003528 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003529 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003530 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003531 * Caller: library/ssl_tls.c
3532 * library/ssl*_client.c
3533 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003534 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003535 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003536 *
3537 * This module is required for X.509 certificate parsing.
3538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003539#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003540
3541/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003543 *
3544 * Enable X.509 CRL parsing.
3545 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003546 * Module: library/x509_crl.c
3547 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003548 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003550 *
3551 * This module is required for X.509 CRL parsing.
3552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003553#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003554
3555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003556 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003557 *
3558 * Enable X.509 Certificate Signing Request (CSR) parsing.
3559 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003560 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003561 * Caller: library/x509_crt_write.c
3562 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003563 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003564 *
3565 * This module is used for reading X.509 certificate request.
3566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003567#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003568
3569/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003570 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003571 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003572 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003573 *
3574 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003575 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003576 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003577 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3578 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003579 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3580 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003581 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003582 * This module is the basis for creating X.509 certificates and CSRs.
3583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003584#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003585
3586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003587 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003588 *
3589 * Enable creating X.509 certificates.
3590 *
3591 * Module: library/x509_crt_write.c
3592 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003593 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003594 *
3595 * This module is required for X.509 certificate creation.
3596 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003597#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003598
3599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003600 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003601 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003602 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003603 *
3604 * Module: library/x509_csr_write.c
3605 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003606 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003607 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003608 * This module is required for X.509 certificate request writing.
3609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003610#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003611
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003612/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003613
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003614/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003615 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003616 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003617 * This section contains Mbed TLS build settings that are not associated
3618 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003619 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003620 * \{
3621 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003622
Gilles Peskinea02c1242022-03-16 17:03:19 +01003623/**
3624 * \def MBEDTLS_CONFIG_FILE
3625 *
3626 * If defined, this is a header which will be included instead of
3627 * `"mbedtls/mbedtls_config.h"`.
3628 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003629 * Unlike other configuration options, this one must be defined on the
3630 * compiler command line: a definition in `mbedtls_config.h` would have
3631 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003632 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003633 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003634 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003635 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003636 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003637 * The value of this symbol is typically a path in double quotes, either
3638 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003639 */
3640//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3641
3642/**
3643 * \def MBEDTLS_USER_CONFIG_FILE
3644 *
3645 * If defined, this is a header which will be included after
3646 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003647 * This allows you to modify the default configuration, including the ability
3648 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003649 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003650 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003651 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003652 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003653 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003654 * The value of this symbol is typically a path in double quotes, either
3655 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003656 */
3657//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3658
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003659/**
3660 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3661 *
3662 * If defined, this is a header which will be included instead of
3663 * `"psa/crypto_config.h"`.
3664 * This header file specifies which cryptographic mechanisms are available
3665 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3666 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3667 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003668 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003669 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003670 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003671 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003672 * The value of this symbol is typically a path in double quotes, either
3673 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003674 */
3675//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3676
3677/**
3678 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3679 *
3680 * If defined, this is a header which will be included after
3681 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003682 * This allows you to modify the default configuration, including the ability
3683 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003684 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003685 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003686 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003687 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003688 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003689 * The value of this symbol is typically a path in double quotes, either
3690 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003691 */
3692//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3693
Gilles Peskineb1176f22023-02-22 22:07:28 +01003694/**
3695 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3696 *
3697 * If defined, this is a header which will be included instead of
3698 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3699 * as the one in Mbed TLS, but with definitions adapted to the platform on
3700 * which the library code will run.
3701 *
3702 * \note The required content of this header can vary from one version of
3703 * Mbed TLS to the next. Integrators who provide an alternative file
3704 * should review the changes in the original file whenever they
3705 * upgrade Mbed TLS.
3706 *
3707 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3708 * non-standard feature of the C language, so this feature is only available
3709 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3710 *
3711 * The value of this symbol is typically a path in double quotes, either
3712 * absolute or relative to a directory on the include search path.
3713 */
3714//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3715
3716/**
3717 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3718 *
3719 * If defined, this is a header which will be included instead of
3720 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3721 * as the one in Mbed TLS, but with definitions adapted to the environment
3722 * in which the library code will run. The typical use for this feature
3723 * is to provide alternative type definitions on the client side in
3724 * client-server integrations of PSA crypto, where operation structures
3725 * contain handles instead of cryptographic data.
3726 *
3727 * \note The required content of this header can vary from one version of
3728 * Mbed TLS to the next. Integrators who provide an alternative file
3729 * should review the changes in the original file whenever they
3730 * upgrade Mbed TLS.
3731 *
3732 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3733 * non-standard feature of the C language, so this feature is only available
3734 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3735 *
3736 * The value of this symbol is typically a path in double quotes, either
3737 * absolute or relative to a directory on the include search path.
3738 */
3739//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3740
Gilles Peskineba4162a2022-04-11 17:04:38 +02003741/** \} name SECTION: General configuration options */
3742
3743/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003744 * \name SECTION: Module configuration options
3745 *
3746 * This section allows for the setting of module specific sizes and
3747 * configuration options. The default values are already present in the
3748 * relevant header files and should suffice for the regular use cases.
3749 *
3750 * Our advice is to enable options and change their values here
3751 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003752 * \{
3753 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003754/* The Doxygen documentation here is used when a user comments out a
3755 * setting and runs doxygen themselves. On the other hand, when we typeset
3756 * the full documentation including disabled settings, the documentation
3757 * in specific modules' header files is used if present. When editing this
3758 * file, make sure that each option is documented in exactly one place,
3759 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3760 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003761
Paul Bakker088c5c52014-04-25 11:11:10 +02003762/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003763//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003764//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003765
Paul Bakker088c5c52014-04-25 11:11:10 +02003766/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003767//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3768//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3769//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3770//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3771//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003772
Paul Bakker088c5c52014-04-25 11:11:10 +02003773/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003774//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3775//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3776//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3777//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003778
Paul Bakker088c5c52014-04-25 11:11:10 +02003779/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003780//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003781//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003782
Paul Bakker088c5c52014-04-25 11:11:10 +02003783/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003784//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3785//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003786//#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 +01003787
Paul Bakker088c5c52014-04-25 11:11:10 +02003788/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003789//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003790
Paul Bakker088c5c52014-04-25 11:11:10 +02003791/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003792//#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 -04003793
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003794/** \def MBEDTLS_PLATFORM_STD_CALLOC
3795 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003796 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003797 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003798 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003799 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003800 * 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 -04003801 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3802 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003803 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003804 */
3805//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003806
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003807/** \def MBEDTLS_PLATFORM_STD_FREE
3808 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003809 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003810 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003811 * 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 -04003812 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3813 * 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 -04003814 */
3815//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003816//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003817//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003818//#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 +02003819//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3820//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003821/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003822//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003823//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3824//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003825//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3826//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3827//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003828
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003829/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003830/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003831//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3832//#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 +02003833//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003834//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003835//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3836//#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 +02003837//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3838//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003839/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003840//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003841//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003842//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3843//#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 +08003844//#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 +08003845//#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 +02003846
Gilles Peskine3f106f72021-09-23 17:42:39 +02003847/** \def MBEDTLS_CHECK_RETURN
3848 *
3849 * This macro is used at the beginning of the declaration of a function
3850 * to indicate that its return value should be checked. It should
3851 * instruct the compiler to emit a warning or an error if the function
3852 * is called without checking its return value.
3853 *
3854 * There is a default implementation for popular compilers in platform_util.h.
3855 * You can override the default implementation by defining your own here.
3856 *
3857 * If the implementation here is empty, this will effectively disable the
3858 * checking of functions' return values.
3859 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003860//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003861
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003862/** \def MBEDTLS_IGNORE_RETURN
3863 *
3864 * This macro requires one argument, which should be a C function call.
3865 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3866 * warning is suppressed.
3867 */
3868//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3869
Gilles Peskineed038902020-11-13 21:33:21 +01003870/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003871/**
Gilles Peskineed038902020-11-13 21:33:21 +01003872 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3873 * PSA crypto subsystem.
3874 *
3875 * If this option is unset:
3876 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003877 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003878 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3879 * on unspecified heuristics.
3880 */
3881//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3882
Steven Cooreman863470a2021-02-15 14:03:19 +01003883/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003884 * Restrict the PSA library to supporting a maximum amount of simultaneously
3885 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3886 * volatile key, or a persistent key which is loaded temporarily by the
3887 * library as part of a crypto operation in flight.
3888 *
3889 * If this option is unset, the library will fall back to a default value of
3890 * 32 keys.
3891 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003892//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003893
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003894/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003895//#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 +00003896
Paul Bakker088c5c52014-04-25 11:11:10 +02003897/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003898//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3899//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003900
Paul Bakker088c5c52014-04-25 11:11:10 +02003901/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003902
Angus Grattond8213d02016-05-25 20:56:48 +10003903/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3904 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003905 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003906 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003907 * This determines the size of the incoming TLS I/O buffer in such a way
3908 * that it is capable of holding the specified amount of plaintext data,
3909 * regardless of the protection mechanism used.
3910 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003911 * \note When using a value less than the default of 16KB on the client, it is
3912 * recommended to use the Maximum Fragment Length (MFL) extension to
3913 * inform the server about this limitation. On the server, there
3914 * is no supported, standardized way of informing the client about
3915 * restriction on the maximum size of incoming messages, and unless
3916 * the limitation has been communicated by other means, it is recommended
3917 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3918 * while keeping the default value of 16KB for the incoming buffer.
3919 *
David Horstmann95d516f2021-05-04 18:36:56 +01003920 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003921 */
3922//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3923
Gilles Peskined3d02902020-03-04 21:35:27 +01003924/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3925 *
3926 * The maximum length of CIDs used for incoming DTLS messages.
3927 *
3928 */
3929//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3930
3931/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3932 *
3933 * The maximum length of CIDs used for outgoing DTLS messages.
3934 *
3935 */
3936//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3937
TRodziewicze8dd7092021-05-12 14:19:11 +02003938/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003939 *
3940 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003941 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003942 *
3943 * The padding will always be chosen so that the length of the
3944 * padded plaintext is a multiple of the value of this option.
3945 *
3946 * Note: A value of \c 1 means that no padding will be used
3947 * for outgoing records.
3948 *
3949 * Note: On systems lacking division instructions,
3950 * a power of two should be preferred.
3951 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003952//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003953
Angus Grattond8213d02016-05-25 20:56:48 +10003954/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3955 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003956 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003957 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003958 * This determines the size of the outgoing TLS I/O buffer in such a way
3959 * that it is capable of holding the specified amount of plaintext data,
3960 * regardless of the protection mechanism used.
3961 *
Angus Grattond8213d02016-05-25 20:56:48 +10003962 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3963 * the default inward 16384 byte buffer to conform to the TLS specification.
3964 *
3965 * The minimum required outward buffer size is determined by the handshake
3966 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3967 * The specific size requirement depends on the configured ciphers and any
3968 * certificate data which is sent during the handshake.
3969 *
David Horstmann95d516f2021-05-04 18:36:56 +01003970 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003971 */
3972//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3973
Hanno Beckere0b150f2018-08-21 15:51:03 +01003974/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3975 *
3976 * Maximum number of heap-allocated bytes for the purpose of
3977 * DTLS handshake message reassembly and future message buffering.
3978 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003979 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003980 * to account for a reassembled handshake message of maximum size,
3981 * together with its reassembly bitmap.
3982 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003983 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003984 * should be sufficient for all practical situations as it allows
3985 * to reassembly a large handshake message (such as a certificate)
3986 * while buffering multiple smaller handshake messages.
3987 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003988 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003989//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003990
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003991//#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 +02003992//#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 +02003993
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003994/**
3995 * Complete list of ciphersuites to use, in order of preference.
3996 *
3997 * \warning No dependency checking is done on that field! This option can only
3998 * be used to restrict the set of available ciphersuites. It is your
3999 * responsibility to make sure the needed modules are active.
4000 *
4001 * Use this to save a few hundred bytes of ROM (default ordering of all
4002 * available ciphersuites) and a few to a few hundred bytes of RAM.
4003 *
4004 * The value below is only an example, not the default.
4005 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004006//#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 +02004007
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004008/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004009 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4010 *
4011 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004012 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004013 *
4014 * It must be positive and smaller than UINT32_MAX.
4015 *
4016 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4017 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004018 */
4019//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4020
4021/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004022 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4023 *
Jerry Yucf913512023-11-14 11:06:52 +08004024 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004025 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004026 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004027 * - The client ticket age is the time difference between the time when the
4028 * client proposes to the server to use the ticket and the time the client
4029 * received the ticket from the server.
4030 * - The server ticket age is the time difference between the time when the
4031 * server receives a proposition from the client to use the ticket and the
4032 * time when the ticket was created by the server.
4033 *
Jerry Yucf913512023-11-14 11:06:52 +08004034 * The ages might be different due to the client and server clocks not running
4035 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4036 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4037 * 6s, thus in the worst case clients and servers must sync up their system time
4038 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004039 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004040 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004041 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004042//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004043
4044/**
4045 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4046 *
4047 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4048 *
4049 * This must be less than 256.
4050 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004051//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004052
4053/**
4054 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4055 *
4056 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4057 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4058 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4059 *
4060 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004061//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004062
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004063/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004064//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004065//#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 +01004066
Gilles Peskine611179c2022-04-13 23:04:48 +02004067/** \} name SECTION: Module configuration options */