blob: a256c3621160c0a5f09aaa427205654ccceeb53c [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_RIPEMD160_PROCESS_ALT
391//#define MBEDTLS_SHA1_PROCESS_ALT
392//#define MBEDTLS_SHA256_PROCESS_ALT
393//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200394//#define MBEDTLS_DES_SETKEY_ALT
395//#define MBEDTLS_DES_CRYPT_ECB_ALT
396//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200397//#define MBEDTLS_AES_SETKEY_ENC_ALT
398//#define MBEDTLS_AES_SETKEY_DEC_ALT
399//#define MBEDTLS_AES_ENCRYPT_ALT
400//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300401//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300402//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300403//#define MBEDTLS_ECDSA_VERIFY_ALT
404//#define MBEDTLS_ECDSA_SIGN_ALT
405//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200406
407/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200408 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200409 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200410 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200411 * hardware entropy collector.
412 *
413 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000414 * prototype as declared in library/entropy_poll.h, and accept NULL as first
415 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200416 *
417 * Uncomment to use your own hardware entropy collector.
418 */
419//#define MBEDTLS_ENTROPY_HARDWARE_ALT
420
421/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000423 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100424 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000425 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100426 * Uncomment this macro to use precomputed AES tables stored in ROM.
427 * Comment this macro to generate AES tables in RAM at runtime.
428 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100429 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
430 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100431 * initialization time before the first AES operation can be performed.
432 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
433 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
434 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100435 *
436 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200438//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000439
440/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100441 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200442 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100443 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200444 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100445 * Uncommenting this macro omits 75% of the AES tables from
446 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
447 * by computing their values on the fly during operations
448 * (the tables are entry-wise rotations of one another).
449 *
450 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100451 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100452 * runtime. Specifically, one has to compare 4 accesses within
453 * different tables to 4 accesses with additional arithmetic
454 * operations within the same table. The performance gain/loss
455 * depends on the system and memory details.
456 *
457 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200458 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100459//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200460
461/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800462 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
463 *
464 * Use only 128-bit keys in AES operations to save ROM.
465 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800466 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800467 * or 256-bit keys.
468 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800469 * Uncommenting this macro reduces the size of AES code by ~300 bytes
470 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800471 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800472 * Module: library/aes.c
473 *
474 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800475 */
476//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
477
Gilles Peskinea8861e02023-09-05 20:20:51 +0200478/*
479 * Disable plain C implementation for AES.
480 *
481 * When the plain C implementation is enabled, and an implementation using a
482 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
483 * detection will be used to select between them.
484 *
485 * If only one implementation is present, runtime detection will not be used.
486 * This configuration will crash at runtime if running on a CPU without the
487 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
488 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
489 */
490//#define MBEDTLS_AES_USE_HARDWARE_ONLY
491
Arto Kinnunen732ca322023-04-14 14:26:10 +0800492/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200493 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200494 *
495 * Use less ROM for the Camellia implementation (saves about 768 bytes).
496 *
497 * Uncomment this macro to use less memory for Camellia.
498 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200499//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200500
501/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200502 * \def MBEDTLS_CHECK_RETURN_WARNING
503 *
504 * If this macro is defined, emit a compile-time warning if application code
505 * calls a function without checking its return value, but the return value
506 * should generally be checked in portable applications.
507 *
508 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
509 * implemented. Otherwise this option has no effect.
510 *
511 * Uncomment to get warnings on using fallible functions without checking
512 * their return value.
513 *
514 * \note This feature is a work in progress.
515 * Warnings will be added to more functions in the future.
516 *
517 * \note A few functions are considered critical, and ignoring the return
518 * value of these functions will trigger a warning even if this
519 * macro is not defined. To completely disable return value check
520 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
521 */
522//#define MBEDTLS_CHECK_RETURN_WARNING
523
524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200526 *
527 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
528 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200529#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200530
531/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200532 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000533 *
534 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000537
538/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200539 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000540 *
541 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
542 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200543#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000544
545/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100546 * \def MBEDTLS_CIPHER_MODE_OFB
547 *
548 * Enable Output Feedback mode (OFB) for symmetric ciphers.
549 */
550#define MBEDTLS_CIPHER_MODE_OFB
551
552/**
553 * \def MBEDTLS_CIPHER_MODE_XTS
554 *
555 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
556 */
557#define MBEDTLS_CIPHER_MODE_XTS
558
559/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000561 *
562 * Enable NULL cipher.
563 * Warning: Only do so when you know what you are doing. This allows for
564 * encryption or channels without any security!
565 *
Ronald Croncee42702021-04-26 11:34:44 +0200566 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
568 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
569 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
570 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
571 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
572 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
573 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
574 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
575 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
576 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
577 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
578 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
579 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
580 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
581 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
582 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
583 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
584 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
585 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000586 *
587 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000588 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200589//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000590
591/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100592 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200593 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100594 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
595 * specific padding modes in the cipher layer with cipher modes that support
596 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200597 *
598 * If you disable all padding modes, only full blocks can be used with CBC.
599 *
600 * Enable padding modes in the cipher layer.
601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602#define MBEDTLS_CIPHER_PADDING_PKCS7
603#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
604#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
605#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200606
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200607/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
608 *
609 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800610 * Without this, CTR_DRBG uses a 256-bit key
611 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200612 */
613//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
614
Paul Bakker48e93c82013-08-14 12:21:18 +0200615/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200616 * Enable the verified implementations of ECDH primitives from Project Everest
617 * (currently only Curve25519). This feature changes the layout of ECDH
618 * contexts and therefore is a compatibility break for applications that access
619 * fields of a mbedtls_ecdh_context structure directly. See also
620 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000621 *
622 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
623 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200624 */
625//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
626
627/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100628 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200629 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100630 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
631 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200632 *
633 * Comment macros to disable the curve and functions for it
634 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200635/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200636#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
637#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
638#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
639#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
640#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
641#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
642#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
643#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
644#define MBEDTLS_ECP_DP_BP256R1_ENABLED
645#define MBEDTLS_ECP_DP_BP384R1_ENABLED
646#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200647/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200648#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000649#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200650
651/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200652 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200653 *
654 * Enable specific 'modulo p' routines for each NIST prime.
655 * Depending on the prime and architecture, makes operations 4 to 8 times
656 * faster on the corresponding curve.
657 *
658 * Comment this macro to disable NIST curves optimisation.
659 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200661
662/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200663 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100664 *
665 * Enable "non-blocking" ECC operations that can return early and be resumed.
666 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200667 * This allows various functions to pause by returning
668 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
669 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
670 * order to further progress and eventually complete their operation. This is
671 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
672 * number of ECC operations a function may perform before pausing; see
673 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100674 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200675 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200676 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100677 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100678 * This option:
679 * - Adds xxx_restartable() variants of existing operations in the
680 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100681 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
682 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100683 * - ECDSA: signature generation & verification;
684 * - PK: signature generation & verification;
685 * - X509: certificate chain verification.
686 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
687 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
688 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
689 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000690 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100691 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100692 * - verification of the server's key exchange signature;
693 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100694 * - generation of the client's signature if client authentication is used,
695 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100696 *
697 * \note In the cases above, the usual SSL/TLS functions, such as
698 * mbedtls_ssl_handshake(), can now return
699 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200700 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100701 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
702 * restartable operations in PK, X.509 and TLS (see above) are not
703 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100704 * PSA, and are not restartable. These are temporary limitations that
705 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200706 *
Ron Eldor19779c42018-11-05 16:58:13 +0200707 * \note This option only works with the default software implementation of
708 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100709 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100710 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100711 * Requires: MBEDTLS_ECP_C
712 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100713 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100714 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200715//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100716
717/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200718 * Uncomment to enable using new bignum code in the ECC modules.
719 *
720 * \warning This is currently experimental, incomplete and therefore should not
721 * be used in production.
722 */
723//#define MBEDTLS_ECP_WITH_MPI_UINT
724
725/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200726 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100727 *
728 * Enable deterministic ECDSA (RFC 6979).
729 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
730 * may result in a compromise of the long-term signing key. This is avoided by
731 * the deterministic variant.
732 *
John Durkop36a82e52020-10-26 09:39:05 -0700733 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100734 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100735 * Comment this macro to disable deterministic ECDSA.
736 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200737#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100738
739/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200741 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200742 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200743 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200744 * This enables the following ciphersuites (if other requisites are
745 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
747 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
748 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
749 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
750 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
751 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
752 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
753 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
754 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
755 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200756 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200758
759/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200760 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200761 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200762 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200763 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200765 *
766 * This enables the following ciphersuites (if other requisites are
767 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
769 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
770 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
771 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
772 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
773 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
774 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
775 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
776 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
777 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100778 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100779 * \warning Using DHE constitutes a security risk as it
780 * is not possible to validate custom DH parameters.
781 * If possible, it is recommended users should consider
782 * preferring other methods of key exchange.
783 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100784 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200787
788/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200789 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200790 *
791 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
792 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200793 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200794 *
795 * This enables the following ciphersuites (if other requisites are
796 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
798 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
799 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
800 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
801 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
802 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200803 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200804#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200805
806/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200808 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200809 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200810 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200811 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
812 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200813 *
814 * This enables the following ciphersuites (if other requisites are
815 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200816 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
817 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
818 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
819 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
820 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
821 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
822 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
823 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
824 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
825 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200826 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200827#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200828
829/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200830 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200831 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200832 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200833 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200834 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
835 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 *
837 * This enables the following ciphersuites (if other requisites are
838 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
840 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
841 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
842 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
843 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
844 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
845 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
846 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
847 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
848 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
849 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
850 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200852#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200853
854/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200855 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200857 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200858 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
860 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861 *
862 * This enables the following ciphersuites (if other requisites are
863 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200864 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
865 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
866 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
867 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
868 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
869 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
870 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
871 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
872 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
873 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
874 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
875 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100876 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100877 * \warning Using DHE constitutes a security risk as it
878 * is not possible to validate custom DH parameters.
879 * If possible, it is recommended users should consider
880 * preferring other methods of key exchange.
881 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100882 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200883 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200884#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200885
886/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200888 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200889 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200890 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200891 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
892 * MBEDTLS_RSA_C
893 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200895 *
896 * This enables the following ciphersuites (if other requisites are
897 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200898 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
899 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
900 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
901 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
902 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
903 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
904 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
905 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
906 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
907 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200908 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200910
911/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200913 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200914 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200915 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200916 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
917 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
918 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200919 *
920 * This enables the following ciphersuites (if other requisites are
921 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200922 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
923 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
924 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
925 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
926 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
927 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
928 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200932 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200933#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200934
935/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100937 *
938 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
939 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200940 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
941 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
942 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100943 *
944 * This enables the following ciphersuites (if other requisites are
945 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200946 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
947 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
948 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
949 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
950 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
951 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
952 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
955 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100956 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100958
959/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200960 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100961 *
962 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
963 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200964 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
965 * MBEDTLS_RSA_C
966 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100967 *
968 * This enables the following ciphersuites (if other requisites are
969 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
971 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
972 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
973 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
974 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
975 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
976 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
977 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
978 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
979 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100982
983/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200984 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
985 *
986 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
987 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200988 * \warning This is currently experimental. EC J-PAKE support is based on the
989 * Thread v1.0.0 specification; incompatible changes to the specification
990 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200991 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200992 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100993 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200994 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
995 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100996 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800997 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100998 * MBEDTLS_USE_PSA_CRYPTO is disabled).
999 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001000 * This enables the following ciphersuites (if other requisites are
1001 * enabled as well):
1002 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1003 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001004//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001005
1006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001008 *
1009 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1010 * RFC 5915 and RFC 5480.
1011 *
1012 * Currently this means parsing the SpecifiedECDomain choice of EC
1013 * parameters (only known groups are supported, not arbitrary domains, to
1014 * avoid validation issues).
1015 *
1016 * Disable if you only need to support RFC 5915 + 5480 key formats.
1017 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001018#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001019
1020/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001021 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1022 *
1023 * Enable the support for parsing public keys of type Short Weierstrass
1024 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001025 * compressed point format. This parsing is done through ECP module's functions.
1026 *
1027 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1028 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1029 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001030 */
1031#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1032
1033/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001035 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001036 * Enable a dummy error function to make use of mbedtls_strerror() in
1037 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1038 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001039 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1041 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001042 *
1043 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001045 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001046#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001047
1048/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001050 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001051 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001052 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001056
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001057/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001059 *
1060 * Enable functions that use the filesystem.
1061 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001063
1064/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001065 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001066 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001067 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001068 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001069 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001070 * application.
1071 *
1072 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001073 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001075
1076/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001078 *
1079 * Do not use built-in platform entropy functions.
1080 * This is useful if your platform does not support
1081 * standards like the /dev/urandom or Windows CryptoAPI.
1082 *
1083 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001084 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001086
1087/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001088 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001089 *
1090 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1091 * default SHA-512 based one (if both are available).
1092 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001093 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001094 *
1095 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1096 * if you have performance concerns.
1097 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 * This option is only useful if both MBEDTLS_SHA256_C and
1099 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001100 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001102
1103/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001104 * \def MBEDTLS_ENTROPY_NV_SEED
1105 *
1106 * Enable the non-volatile (NV) seed file-based entropy source.
1107 * (Also enables the NV seed read/write functions in the platform layer)
1108 *
1109 * This is crucial (if not required) on systems that do not have a
1110 * cryptographic entropy source (in hardware or kernel) available.
1111 *
1112 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1113 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001114 * \note The read/write functions that are used by the entropy source are
1115 * determined in the platform layer, and can be modified at runtime and/or
1116 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1117 *
1118 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001119 * with regular fopen(), please make sure you make a seedfile with the
1120 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1121 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001122 * and written to or you will get an entropy source error! The default
1123 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1124 * bytes from the file.
1125 *
1126 * \note The entropy collector will write to the seed file before entropy is
1127 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001128 */
1129//#define MBEDTLS_ENTROPY_NV_SEED
1130
Ronald Cron71016a92020-08-28 19:01:50 +02001131/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001132 *
Ronald Cron71016a92020-08-28 19:01:50 +02001133 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001134 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001135 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1136 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001137 *
1138 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001139 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001140 */
Ronald Cron71016a92020-08-28 19:01:50 +02001141//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001142
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001143/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001145 *
1146 * Enable debugging of buffer allocator memory issues. Automatically prints
1147 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1148 * function for 'debug output' of allocated memory.
1149 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001151 *
1152 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001153 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001154//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001155
1156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001158 *
1159 * Include backtrace information with each allocated block.
1160 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001161 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001162 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001163 *
1164 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001165 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001167
1168/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001170 *
1171 * Support external private RSA keys (eg from a HSM) in the PK layer.
1172 *
1173 * Comment this macro to disable support for external private RSA keys.
1174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001175#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001176
1177/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001179 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001180 * Enable support for PKCS#1 v1.5 encoding.
1181 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001182 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001183 *
Paul Bakker48377d92013-08-30 12:06:24 +02001184 * This enables support for PKCS#1 v1.5 operations.
1185 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001187
1188/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001190 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001191 * Enable support for PKCS#1 v2.1 encoding.
1192 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001193 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001194 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001195 * \warning If using a hash that is only provided by PSA drivers, you must
1196 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001197 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001198 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001200#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001201
Steven Cooreman6801f082021-02-19 17:21:22 +01001202/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1203 *
1204 * Enable support for platform built-in keys. If you enable this feature,
1205 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1206 * See the documentation of that function for more information.
1207 *
1208 * Built-in keys are typically derived from a hardware unique key or
1209 * stored in a secure element.
1210 *
1211 * Requires: MBEDTLS_PSA_CRYPTO_C.
1212 *
1213 * \warning This interface is experimental and may change or be removed
1214 * without notice.
1215 */
1216//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1217
Ronald Cron3768ac12021-01-26 16:58:00 +01001218/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1219 *
1220 * Enable support for PSA crypto client.
1221 *
1222 * \note This option allows to include the code necessary for a PSA
1223 * crypto client when the PSA crypto implementation is not included in
1224 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1225 * code to set and get PSA key attributes.
1226 * The development of PSA drivers partially relying on the library to
1227 * fulfill the hardware gaps is another possible usage of this option.
1228 *
1229 * \warning This interface is experimental and may change or be removed
1230 * without notice.
1231 */
1232//#define MBEDTLS_PSA_CRYPTO_CLIENT
1233
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001234/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1235 *
1236 * Make the PSA Crypto module use an external random generator provided
1237 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1238 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001239 * \note This random generator must deliver random numbers with cryptographic
1240 * quality and high performance. It must supply unpredictable numbers
1241 * with a uniform distribution. The implementation of this function
1242 * is responsible for ensuring that the random generator is seeded
1243 * with sufficient entropy. If you have a hardware TRNG which is slow
1244 * or delivers non-uniform output, declare it as an entropy source
1245 * with mbedtls_entropy_add_source() instead of enabling this option.
1246 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001247 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001248 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1249 * and define a function called mbedtls_psa_external_get_random()
1250 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001251 * ```
1252 * psa_status_t mbedtls_psa_external_get_random(
1253 * mbedtls_psa_external_random_context_t *context,
1254 * uint8_t *output, size_t output_size, size_t *output_length);
1255 * );
1256 * ```
1257 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001258 * The function must fill the \c output buffer with \c output_size bytes
1259 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001260 *
1261 * Requires: MBEDTLS_PSA_CRYPTO_C
1262 *
1263 * \warning If you enable this option, code that uses the PSA cryptography
1264 * interface will not use any of the entropy sources set up for
1265 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1266 * enables.
1267 *
1268 * \note This option is experimental and may be removed without notice.
1269 */
1270//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1271
Paul Bakker9dcc3222011-03-08 14:16:06 +00001272/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001273 * \def MBEDTLS_PSA_CRYPTO_SPM
1274 *
1275 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1276 * Partition Manager) integration which separates the code into two parts: a
1277 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1278 * Environment).
1279 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001280 * If you enable this option, your build environment must include a header
1281 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1282 * header files, or in another directory on the compiler's include search
1283 * path). Alternatively, your platform may customize the header
1284 * `psa/crypto_platform.h`, in which case it can skip or replace the
1285 * inclusion of `"crypto_spe.h"`.
1286 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001287 * Module: library/psa_crypto.c
1288 * Requires: MBEDTLS_PSA_CRYPTO_C
1289 *
1290 */
1291//#define MBEDTLS_PSA_CRYPTO_SPM
1292
1293/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001294 * Uncomment to enable p256-m. This is an alternative implementation of
1295 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1296 * Compared to the default implementation:
1297 *
1298 * - p256-m has a much smaller code size and RAM footprint.
1299 * - p256-m is only available via the PSA API. This includes the pk module
1300 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1301 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1302 * over the core arithmetic, or deterministic derivation of keys.
1303 *
1304 * We recommend enabling this option if your application uses the PSA API
1305 * and the only elliptic curve support it needs is ECDH and ECDSA over
1306 * SECP256R1.
1307 *
1308 * If you enable this option, you do not need to enable any ECC-related
1309 * MBEDTLS_xxx option. You do need to separately request support for the
1310 * cryptographic mechanisms through the PSA API:
1311 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1312 * configuration;
1313 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1314 * - #PSA_WANT_ECC_SECP_R1_256;
1315 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1316 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1317 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1318 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1319 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001320 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001321 * \note To benefit from the smaller code size of p256-m, make sure that you
1322 * do not enable any ECC-related option not supported by p256-m: this
1323 * would cause the built-in ECC implementation to be built as well, in
1324 * order to provide the required option.
1325 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001326 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1327 * SECP256R1 are disabled as they are not supported by this driver.
1328 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1329 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001330 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001331 */
1332//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1333
1334/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001335 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001336 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001337 * Enable support for entropy injection at first boot. This feature is
1338 * required on systems that do not have a built-in entropy source (TRNG).
1339 * This feature is currently not supported on systems that have a built-in
1340 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001341 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001342 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001343 *
1344 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001345//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001346
1347/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001348 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001349 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001350 * Assume all buffers passed to PSA functions are owned exclusively by the
1351 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001352 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001353 * This option may be enabled if all buffers passed to any PSA function reside
1354 * in memory that is accessible only to the PSA function during its execution.
1355 *
1356 * This option MUST be disabled whenever buffer arguments are in memory shared
1357 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001358 * across a trust boundary.
1359 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001360 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001361 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001362 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001363 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001364 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001365//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001366
1367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001368 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001369 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001370 * Do not use the Chinese Remainder Theorem
1371 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001372 *
1373 * Uncomment this macro to disable the use of CRT in RSA.
1374 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001375 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001376//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001377
1378/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001379 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001380 *
1381 * Enable the checkup functions (*_self_test).
1382 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001383#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001384
1385/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001386 * \def MBEDTLS_SHA256_SMALLER
1387 *
1388 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1389 * lower performance.
1390 *
Adam Wolf039080f2019-09-10 09:53:08 -05001391 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001392 * performance and size. This version optimizes more aggressively for size at
1393 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1394 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1395 * 30%.
1396 *
1397 * Uncomment to enable the smaller implementation of SHA256.
1398 */
1399//#define MBEDTLS_SHA256_SMALLER
1400
1401/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001402 * \def MBEDTLS_SHA512_SMALLER
1403 *
1404 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1405 * lower performance.
1406 *
1407 * Uncomment to enable the smaller implementation of SHA512.
1408 */
1409//#define MBEDTLS_SHA512_SMALLER
1410
1411/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001412 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001413 *
1414 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001415 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001416 * with other servers, only debugging of failures is harder.
1417 *
1418 * The advantage of not sending alert messages, is that no information is given
1419 * about reasons for failures thus preventing adversaries of gaining intel.
1420 *
1421 * Enable sending of all alert messages
1422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001424
1425/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001426 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1427 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001428 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001429 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001430 * in the underlying transport. The CID functionality is described
1431 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001432 *
1433 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001434 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1435 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1436 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001437 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001438 * The maximum lengths of outgoing and incoming CIDs can be configured
1439 * through the options
1440 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1441 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1442 *
1443 * Requires: MBEDTLS_SSL_PROTO_DTLS
1444 *
1445 * Uncomment to enable the Connection ID extension.
1446 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001447#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1448
1449
1450/**
1451 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1452 *
1453 * Defines whether RFC 9146 (default) or the legacy version
1454 * (version draft-ietf-tls-dtls-connection-id-05,
1455 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1456 * is used.
1457 *
1458 * Set the value to 0 for the standard version, and
1459 * 1 for the legacy draft version.
1460 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001461 * \deprecated Support for the legacy version of the DTLS
1462 * Connection ID feature is deprecated. Please
1463 * switch to the standardized version defined
1464 * in RFC 9146 enabled by utilizing
1465 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1466 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1467 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001468 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1469 */
1470#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001471
1472/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001473 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1474 *
1475 * Enable asynchronous external private key operations in SSL. This allows
1476 * you to configure an SSL connection to call an external cryptographic
1477 * module to perform private key operations instead of performing the
1478 * operation inside the library.
1479 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001480 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001481 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001482//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001483
1484/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001485 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1486 *
1487 * Enable serialization of the TLS context structures, through use of the
1488 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1489 *
1490 * This pair of functions allows one side of a connection to serialize the
1491 * context associated with the connection, then free or re-use that context
1492 * while the serialized state is persisted elsewhere, and finally deserialize
1493 * that state to a live context for resuming read/write operations on the
1494 * connection. From a protocol perspective, the state of the connection is
1495 * unaffected, in particular this is entirely transparent to the peer.
1496 *
1497 * Note: this is distinct from TLS session resumption, which is part of the
1498 * protocol and fully visible by the peer. TLS session resumption enables
1499 * establishing new connections associated to a saved session with shorter,
1500 * lighter handshakes, while context serialization is a local optimization in
1501 * handling a single, potentially long-lived connection.
1502 *
1503 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1504 * saved after the handshake to allow for more efficient serialization, so if
1505 * you don't need this feature you'll save RAM by disabling it.
1506 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001507 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1508 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001509 * Comment to disable the context serialization APIs.
1510 */
1511#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1512
1513/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001514 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001515 *
1516 * Enable the debug messages in SSL module for all issues.
1517 * Debug messages have been disabled in some places to prevent timing
1518 * attacks due to (unbalanced) debugging function calls.
1519 *
1520 * If you need all error reporting you should enable this during debugging,
1521 * but remove this for production servers that should log as well.
1522 *
1523 * Uncomment this macro to report all debug messages on errors introducing
1524 * a timing side-channel.
1525 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001527//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001528
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001529/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001530 *
1531 * Enable support for Encrypt-then-MAC, RFC 7366.
1532 *
1533 * This allows peers that both support it to use a more robust protection for
1534 * ciphersuites using CBC, providing deep resistance against timing attacks
1535 * on the padding or underlying cipher.
1536 *
1537 * This only affects CBC ciphersuites, and is useless if none is defined.
1538 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001539 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001540 *
1541 * Comment this macro to disable support for Encrypt-then-MAC
1542 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001543#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001544
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001545/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001546 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001547 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1548 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001549 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001550 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001551 * attacks, but it is recommended to always use it (even if you disable
1552 * renegotiation), since it actually fixes a more fundamental issue in the
1553 * original SSL/TLS design, and has implications beyond Triple Handshake.
1554 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001555 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001556 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001557 * Comment this macro to disable support for Extended Master Secret.
1558 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001560
Paul Bakkerd66f0702013-01-31 16:57:45 +01001561/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001562 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1563 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001564 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001565 * giving access to the peer's certificate after completion of the handshake.
1566 *
1567 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1568 * recommended to disable this option for reduced RAM usage.
1569 *
1570 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1571 * defined, but always returns \c NULL.
1572 *
1573 * \note This option has no influence on the protection against the
1574 * triple handshake attack. Even if it is disabled, Mbed TLS will
1575 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001576 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001577 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001578 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001579 *
1580 * Comment this macro to disable storing the peer's certificate
1581 * after the handshake.
1582 */
1583#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1584
1585/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001586 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001587 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001588 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001589 *
1590 * The two main uses of renegotiation are (1) refresh keys on long-lived
1591 * connections and (2) client authentication after the initial handshake.
1592 * If you don't need renegotiation, it's probably better to disable it, since
1593 * it has been associated with security issues in the past and is easy to
1594 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001595 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001596 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1597 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001598 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001599 *
1600 * \note Even if this option is disabled, both client and server are aware
1601 * of the Renegotiation Indication Extension (RFC 5746) used to
1602 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1603 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1604 * configuration of this extension).
1605 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001606 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001607#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001608
1609/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001610 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001611 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001612 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001613 *
1614 * Comment this macro to disable support for the max_fragment_length extension
1615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001616#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001617
1618/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001619 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1620 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001621 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001622 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001623 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1624 *
1625 * Uncomment this macro to enable support for the record_size_limit extension
1626 */
1627//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1628
1629/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001630 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001631 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001632 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001633 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001634 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001635 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1636 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001637 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001638 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001639 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001640 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1641 * are only provided by PSA drivers, you must call psa_crypto_init() before
1642 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001643 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001644 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001647
1648/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001649 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001650 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001651 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001652 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001653 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001654 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001655 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001656 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001657 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001658 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001659 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1660 * directly performed by TLS 1.3 code. As a consequence, you must
1661 * call psa_crypto_init() before the first TLS 1.3 handshake.
1662 *
1663 * \note Cryptographic operations performed indirectly via another module
1664 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1665 * running handshake hash) only use PSA crypto if
1666 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001667 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001668 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001669 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001670#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001671
1672/**
Ronald Cronab65c522021-11-24 10:47:20 +01001673 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1674 *
1675 * Enable TLS 1.3 middlebox compatibility mode.
1676 *
1677 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1678 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1679 * expecting TLS 1.2 traffic.
1680 *
1681 * Turning on the compatibility mode comes at the cost of a few added bytes
1682 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1683 * that don't use it. Therefore, unless transmission bandwidth is critical and
1684 * you know that middlebox compatibility issues won't occur, it is therefore
1685 * recommended to set this option.
1686 *
1687 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001688 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1689 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001690 *
1691 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001692#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001693
1694/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001695 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1696 *
1697 * Enable TLS 1.3 PSK key exchange mode.
1698 *
1699 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1700 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1701 * effect on the build.
1702 *
1703 */
1704#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1705
1706/**
1707 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1708 *
1709 * Enable TLS 1.3 ephemeral key exchange mode.
1710 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001711 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001712 * MBEDTLS_X509_CRT_PARSE_C
1713 * and at least one of:
1714 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1715 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001716 *
1717 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1718 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1719 * effect on the build.
1720 *
1721 */
1722#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1723
1724/**
1725 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1726 *
1727 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1728 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001729 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001730 *
1731 * Comment to disable support for the PSK ephemeral key exchange mode in
1732 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1733 * have any effect on the build.
1734 *
1735 */
1736#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1737
1738/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 * \def MBEDTLS_SSL_EARLY_DATA
1740 *
1741 * Enable support for RFC 8446 TLS 1.3 early data.
1742 *
1743 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1744 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1745 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1746 *
1747 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1748 * is not enabled, this option does not have any effect on the build.
1749 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001750 * \note The maximum amount of early data can be set with
1751 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1752 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001754//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001755
1756/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001758 *
1759 * Enable support for DTLS (all available versions).
1760 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001761 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001762 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001763 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001764 *
1765 * Comment this macro to disable support for DTLS
1766 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001768
1769/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001770 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001771 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001772 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001773 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001774 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001775 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001776#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001777
1778/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001779 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001780 *
1781 * Enable support for the anti-replay mechanism in DTLS.
1782 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783 * Requires: MBEDTLS_SSL_TLS_C
1784 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001785 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001786 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001787 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001788 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001789 * Comment this to disable anti-replay in DTLS.
1790 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001792
1793/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001795 *
1796 * Enable support for HelloVerifyRequest on DTLS servers.
1797 *
1798 * This feature is highly recommended to prevent DTLS servers being used as
1799 * amplifiers in DoS attacks against other hosts. It should always be enabled
1800 * unless you know for sure amplification cannot be a problem in the
1801 * environment in which your server operates.
1802 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001803 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001804 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001805 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001806 *
1807 * Comment this to disable support for HelloVerifyRequest.
1808 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001810
1811/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001812 * \def MBEDTLS_SSL_DTLS_SRTP
1813 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001814 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001815 * through the use_srtp extension.
1816 *
1817 * \note This feature provides the minimum functionality required
1818 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1819 * the associated SRTP packet protection key material.
1820 * In particular, the SRTP packet protection itself, as well as the
1821 * demultiplexing of RTP and DTLS packets at the datagram layer
1822 * (see Section 5 of RFC 5764), are not handled by this feature.
1823 * Instead, after successful completion of a handshake negotiating
1824 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001825 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001826 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1827 * (this is implemented in the SSL example programs).
1828 * The resulting key should then be passed to an SRTP stack.
1829 *
1830 * Setting this option enables the runtime API
1831 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1832 * through which the supported DTLS-SRTP protection
1833 * profiles can be configured. You must call this API at
1834 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001835 *
1836 * Requires: MBEDTLS_SSL_PROTO_DTLS
1837 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001838 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001839 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001840//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001841
1842/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001843 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1844 *
1845 * Enable server-side support for clients that reconnect from the same port.
1846 *
1847 * Some clients unexpectedly close the connection and try to reconnect using the
1848 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001849 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001850 * flag enables that support.
1851 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001852 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001853 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001854 * Comment this to disable support for clients reusing the source port.
1855 */
1856#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1857
1858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001859 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001860 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001861 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001862 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001863 * session store remains the responsibility of the application, though).
1864 * Server-side, you also need to provide callbacks for writing and parsing
1865 * tickets, including authenticated encryption and key management. Example
1866 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001867 *
1868 * Comment this macro to disable support for SSL session tickets
1869 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001871
1872/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001874 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001875 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001876 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001878 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001879 * Comment this macro to disable support for server name indication in SSL
1880 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001882
1883/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001884 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1885 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001886 * When this option is enabled, the SSL buffer will be resized automatically
1887 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001888 *
1889 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001890 */
1891//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1892
1893/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001894 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1895 *
1896 * Enable testing of the constant-flow nature of some sensitive functions with
1897 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001898 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001899 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001900 * This setting requires compiling with clang -fsanitize=memory. The test
1901 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001902 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001903 * \warning This macro is only used for extended testing; it is not considered
1904 * part of the library's API, so it may change or disappear at any time.
1905 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001906 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001907 */
1908//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1909
1910/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001911 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1912 *
1913 * Enable testing of the constant-flow nature of some sensitive functions with
1914 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001915 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001916 *
1917 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001918 * testing if the tests suites are run with valgrind's memcheck. This can be
1919 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1920 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001921 *
1922 * \warning This macro is only used for extended testing; it is not considered
1923 * part of the library's API, so it may change or disappear at any time.
1924 *
1925 * Uncomment to enable testing of the constant-flow nature of selected code.
1926 */
1927//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1928
1929/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001930 * \def MBEDTLS_TEST_HOOKS
1931 *
1932 * Enable features for invasive testing such as introspection functions and
1933 * hooks for fault injection. This enables additional unit tests.
1934 *
1935 * Merely enabling this feature should not change the behavior of the product.
1936 * It only adds new code, and new branching points where the default behavior
1937 * is the same as when this feature is disabled.
1938 * However, this feature increases the attack surface: there is an added
1939 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1940 * Therefore this feature must never be enabled in production.
1941 *
1942 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1943 * information.
1944 *
1945 * Uncomment to enable invasive tests.
1946 */
1947//#define MBEDTLS_TEST_HOOKS
1948
1949/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001951 *
1952 * Provide your own alternate threading implementation.
1953 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001955 *
1956 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001957 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001958//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001959
1960/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001961 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001962 *
1963 * Enable the pthread wrapper layer for the threading layer.
1964 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001965 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001966 *
1967 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001968 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001970
1971/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001972 * \def MBEDTLS_USE_PSA_CRYPTO
1973 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001974 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1975 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001976 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001977 * \note Development of this option is currently in progress, and parts of Mbed
1978 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001979 * will still continue to work as usual, so enabling this option should not
1980 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001981 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001982 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001983 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1984 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001985 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001986 * \note An important and desirable effect of this option is that it allows
1987 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1988 * 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 +02001989 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001990 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1991 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001992 *
1993 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001994 *
1995 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001996 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001997 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001998 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001999//#define MBEDTLS_USE_PSA_CRYPTO
2000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002002 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2003 *
John Durkop185764f2020-10-12 21:32:12 -07002004 * This setting allows support for cryptographic mechanisms through the PSA
2005 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002006 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002007 * When this option is disabled, the PSA API exposes the cryptographic
2008 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2009 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002010 *
2011 * When this option is enabled, the PSA API exposes the cryptographic
2012 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2013 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2014 * automatically enabled if required (i.e. if no PSA driver provides the
2015 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2016 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002017 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002018 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002019 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002020 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002021 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2022 * symbols is not completely finalized yet, and the configuration
2023 * tooling is not ideally adapted to having two separate configuration
2024 * files.
2025 * Future minor releases of Mbed TLS may make minor changes to those
2026 * symbols, but we will endeavor to provide a transition path.
2027 * Nonetheless, this option is considered mature enough to use in
2028 * production, as long as you accept that you may need to make
2029 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002030 */
2031//#define MBEDTLS_PSA_CRYPTO_CONFIG
2032
2033/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002034 * \def MBEDTLS_VERSION_FEATURES
2035 *
2036 * Allow run-time checking of compile-time enabled features. Thus allowing users
2037 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002038 * support via mbedtls_version_check_feature().
2039 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002040 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002041 *
2042 * Comment this to disable run-time checking and save ROM space
2043 */
2044#define MBEDTLS_VERSION_FEATURES
2045
2046/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002047 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2048 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002049 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002050 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2051 * the set of trusted certificates through a callback instead of a linked
2052 * list.
2053 *
2054 * This is useful for example in environments where a large number of trusted
2055 * certificates is present and storing them in a linked list isn't efficient
2056 * enough, or when the set of trusted certificates changes frequently.
2057 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002058 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002059 * `mbedtls_ssl_conf_ca_cb()` for more information.
2060 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002061 * Requires: MBEDTLS_X509_CRT_PARSE_C
2062 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002063 * Uncomment to enable trusted certificate callbacks.
2064 */
2065//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2066
2067/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002068 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002069 *
Chris Jones2c745862020-12-16 11:41:06 +00002070 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002071 *
Chris Jones2c745862020-12-16 11:41:06 +00002072 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002073 * and other functions/constants only used by these functions, thus reducing
2074 * the code footprint by several KB.
2075 */
Chris Jones2c745862020-12-16 11:41:06 +00002076//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002077
2078/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002080 *
2081 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2082 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2083 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002084 * Requires: MBEDTLS_PKCS1_V21
2085 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002086 * Comment this macro to disallow using RSASSA-PSS in certificates.
2087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002089/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002090
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002091/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002092 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002093 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002094 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002095 * \{
2096 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002097
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002098/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002099 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002100 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002101 * Enable AES-NI support on x86-64 or x86-32.
2102 *
2103 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002104 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002105 * - GCC, x86-64, target not explicitly supporting AESNI:
2106 * requires MBEDTLS_HAVE_ASM.
2107 * - GCC, x86-32, target not explicitly supporting AESNI:
2108 * not supported.
2109 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2110 * For this assembly-less implementation, you must currently compile
2111 * `library/aesni.c` and `library/aes.c` with machine options to enable
2112 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2113 * `clang -maes -mpclmul`.
2114 * - Non-x86 targets: this option is silently ignored.
2115 * - Other compilers: this option is silently ignored.
2116 *
2117 * \note
2118 * Above, "GCC" includes compatible compilers such as Clang.
2119 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002120 *
2121 * Module: library/aesni.c
2122 * Caller: library/aes.c
2123 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002124 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002125 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002126 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002128#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002129
2130/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002131 * \def MBEDTLS_AESCE_C
2132 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002133 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002134 *
2135 * Module: library/aesce.c
2136 * Caller: library/aes.c
2137 *
Jerry Yuf015a932023-04-25 10:38:03 +08002138 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002139 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002140 * \warning Runtime detection only works on Linux. For non-Linux operating
2141 * system, Armv8-A Cryptographic Extensions must be supported by
2142 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002143 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002144 * \note Minimum compiler versions for this feature when targeting aarch64
2145 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2146 * Minimum compiler versions for this feature when targeting 32-bit
2147 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002148 *
2149 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2150 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002151 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002152 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002153 */
2154#define MBEDTLS_AESCE_C
2155
2156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002158 *
2159 * Enable the AES block cipher.
2160 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002161 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002162 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002163 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002164 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002165 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002166 * This module enables the following ciphersuites (if other requisites are
2167 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002168 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2169 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2170 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2171 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2172 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2173 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2174 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2175 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2176 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2177 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2178 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2179 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2180 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2181 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2182 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2183 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2184 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2185 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2186 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2187 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2188 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2189 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2190 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2191 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2192 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2193 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2194 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2195 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2196 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2197 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2198 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2199 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2200 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2201 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2202 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2203 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2204 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2205 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2206 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2207 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2208 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2209 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2210 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2211 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2212 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2213 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2214 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2215 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2216 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2217 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2218 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2219 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2220 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2221 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2222 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2223 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2224 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2225 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002226 *
Paul Bakkercff68422013-09-15 20:43:33 +02002227 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002228 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002229#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002230
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002231/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002233 *
2234 * Enable the generic ASN1 parser.
2235 *
2236 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002237 * Caller: library/x509.c
2238 * library/dhm.c
2239 * library/pkcs12.c
2240 * library/pkcs5.c
2241 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002242 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002243#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002244
2245/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002246 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002247 *
2248 * Enable the generic ASN1 writer.
2249 *
2250 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002251 * Caller: library/ecdsa.c
2252 * library/pkwrite.c
2253 * library/x509_create.c
2254 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002255 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002257#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002258
2259/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002261 *
2262 * Enable the Base64 module.
2263 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002264 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002265 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002266 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002267 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002270
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002271/**
Yanray Wange367e472023-10-31 17:23:04 +08002272 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2273 *
2274 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2275 *
2276 * \note This feature is incompatible with insecure block cipher,
2277 * MBEDTLS_DES_C, and cipher modes which always require decryption
2278 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002279 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2280 * this feature is incompatible with following supported PSA equivalence,
2281 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2282 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002283 *
2284 * Module: library/aes.c
2285 * library/aesce.c
2286 * library/aesni.c
2287 * library/aria.c
2288 * library/camellia.c
2289 * library/cipher.c
2290 */
2291//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2292
2293/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002294 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002295 *
Paul Bakker9a736322012-11-14 12:39:52 +00002296 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002297 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002298 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002299 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002300 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002301 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002302 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002303 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002304 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002305 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002306 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002307 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002308 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002309 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002310 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002311#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002312
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002313/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002315 *
2316 * Enable the Camellia block cipher.
2317 *
Paul Bakker38119b12009-01-10 23:31:23 +00002318 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002319 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002320 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002321 * This module enables the following ciphersuites (if other requisites are
2322 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2324 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2325 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2326 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2327 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2328 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2329 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2330 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2331 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2332 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2333 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2334 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2335 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2336 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2337 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2338 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2339 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2340 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2341 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2342 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2343 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2344 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2345 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2346 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2347 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2348 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2349 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2350 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2351 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2352 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2353 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2354 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2355 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2356 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2357 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2358 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2359 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2360 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2361 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2362 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2363 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2364 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002365 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002366#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002367
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002368/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002369 * \def MBEDTLS_ARIA_C
2370 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002371 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002372 *
2373 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002374 * Caller: library/cipher.c
2375 *
2376 * This module enables the following ciphersuites (if other requisites are
2377 * enabled as well):
2378 *
2379 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2380 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2381 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2382 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2383 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2384 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2385 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2386 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2387 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2388 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2389 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2390 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2391 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2392 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2393 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2394 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2395 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2396 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2397 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2398 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2399 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2400 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2401 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2402 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2403 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2404 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2405 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2406 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2407 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2408 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2409 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2410 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2411 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2412 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2413 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2414 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2415 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2416 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002417 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002418#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002419
2420/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002422 *
2423 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2424 *
2425 * Module: library/ccm.c
2426 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002427 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2428 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002429 *
2430 * This module enables the AES-CCM ciphersuites, if other requisites are
2431 * enabled as well.
2432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002434
2435/**
Daniel King34b822c2016-05-15 17:28:08 -03002436 * \def MBEDTLS_CHACHA20_C
2437 *
2438 * Enable the ChaCha20 stream cipher.
2439 *
2440 * Module: library/chacha20.c
2441 */
2442#define MBEDTLS_CHACHA20_C
2443
2444/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002445 * \def MBEDTLS_CHACHAPOLY_C
2446 *
2447 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2448 *
2449 * Module: library/chachapoly.c
2450 *
2451 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2452 */
2453#define MBEDTLS_CHACHAPOLY_C
2454
2455/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002456 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002457 *
2458 * Enable the generic cipher layer.
2459 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002460 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002461 * Caller: library/ccm.c
2462 * library/cmac.c
2463 * library/gcm.c
2464 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002465 * library/pkcs12.c
2466 * library/pkcs5.c
2467 * library/psa_crypto_aead.c
2468 * library/psa_crypto_mac.c
2469 * library/ssl_ciphersuites.c
2470 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002471 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002472 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2473 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002474 *
2475 * Uncomment to enable generic cipher wrappers.
2476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002477#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002478
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002479/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002480 * \def MBEDTLS_CMAC_C
2481 *
Simon Butcher327398a2016-10-05 14:09:11 +01002482 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2483 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002484 *
2485 * Module: library/cmac.c
2486 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002487 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002488 *
2489 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002490#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002491
2492/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002493 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002494 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002495 * Enable the CTR_DRBG AES-based random generator.
2496 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002497 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002498 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002499 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002500 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2501 * is used.
2502 *
2503 * \warning When using PSA, the user should call `psa_crypto_init()` before
2504 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2505 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002506 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2507 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002508 * \note To achieve a 256-bit security strength with CTR_DRBG,
2509 * you must use AES-256 *and* use sufficient entropy.
2510 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002511 *
2512 * Module: library/ctr_drbg.c
2513 * Caller:
2514 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002515 * Requires: MBEDTLS_AES_C or
2516 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2517 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002518 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002519 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002520 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002521#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002522
2523/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002525 *
2526 * Enable the debug functions.
2527 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002528 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002529 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002530 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002531 * library/ssl_tls12_*.c
2532 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002533 *
2534 * This module provides debugging functions.
2535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002536#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002537
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002538/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002540 *
2541 * Enable the DES block cipher.
2542 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002543 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002544 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002545 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002546 *
Paul Bakkercff68422013-09-15 20:43:33 +02002547 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002548 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002549 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002550 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002553
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002556 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002557 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002558 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002559 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002560 * Caller: library/ssl_tls.c
2561 * library/ssl*_client.c
2562 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002563 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002564 * This module is used by the following key exchanges:
2565 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002566 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002567 * \warning Using DHE constitutes a security risk as it
2568 * is not possible to validate custom DH parameters.
2569 * If possible, it is recommended users should consider
2570 * preferring other methods of key exchange.
2571 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002572 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002574#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002575
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002576/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002578 *
2579 * Enable the elliptic curve Diffie-Hellman library.
2580 *
2581 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002582 * Caller: library/psa_crypto.c
2583 * library/ssl_tls.c
2584 * library/ssl*_client.c
2585 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002586 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002587 * This module is used by the following key exchanges:
2588 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002589 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002590 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002591 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002593
2594/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002596 *
2597 * Enable the elliptic curve DSA library.
2598 *
2599 * Module: library/ecdsa.c
2600 * Caller:
2601 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002602 * This module is used by the following key exchanges:
2603 * ECDHE-ECDSA
2604 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002605 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2606 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2607 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002610
2611/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002612 * \def MBEDTLS_ECJPAKE_C
2613 *
2614 * Enable the elliptic curve J-PAKE library.
2615 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002616 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2617 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002618 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002619 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002620 * Module: library/ecjpake.c
2621 * Caller:
2622 *
2623 * This module is used by the following key exchanges:
2624 * ECJPAKE
2625 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002626 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002627 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002628 * \warning If using a hash that is only provided by PSA drivers, you must
2629 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002630 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002631#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002632
2633/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002634 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002635 *
2636 * Enable the elliptic curve over GF(p) library.
2637 *
2638 * Module: library/ecp.c
2639 * Caller: library/ecdh.c
2640 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002641 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002642 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002644 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002645#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002646
2647/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002648 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002649 *
2650 * Enable the platform-specific entropy code.
2651 *
2652 * Module: library/entropy.c
2653 * Caller:
2654 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002656 *
2657 * This module provides a generic entropy pool
2658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002660
2661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002662 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002663 *
2664 * Enable error code to error string conversion.
2665 *
2666 * Module: library/error.c
2667 * Caller:
2668 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002670 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002672
2673/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002675 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002676 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002677 *
2678 * Module: library/gcm.c
2679 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002680 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2681 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002682 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002683 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2684 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002687
2688/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002689 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002690 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002691 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002692 * Can significantly increase throughput on systems without GCM hardware
2693 * acceleration (e.g., AESNI, AESCE).
2694 *
Matthias Schulz78266782024-02-08 13:54:48 +01002695 * The mbedtls_gcm_context size will increase by 3840 bytes.
2696 * The code size will increase by roughly 344 bytes.
2697 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002698 * Module: library/gcm.c
2699 *
2700 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002701 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002702//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002703
2704/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002705 * \def MBEDTLS_HKDF_C
2706 *
2707 * Enable the HKDF algorithm (RFC 5869).
2708 *
2709 * Module: library/hkdf.c
2710 * Caller:
2711 *
2712 * Requires: MBEDTLS_MD_C
2713 *
2714 * This module adds support for the Hashed Message Authentication Code
2715 * (HMAC)-based key derivation function (HKDF).
2716 */
2717#define MBEDTLS_HKDF_C
2718
2719/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002720 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002721 *
2722 * Enable the HMAC_DRBG random generator.
2723 *
2724 * Module: library/hmac_drbg.c
2725 * Caller:
2726 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002728 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002729 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002730 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002732
2733/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002734 * \def MBEDTLS_LMS_C
2735 *
2736 * Enable the LMS stateful-hash asymmetric signature algorithm.
2737 *
2738 * Module: library/lms.c
2739 * Caller:
2740 *
Raef Colesab4f8742022-09-01 12:24:31 +01002741 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002742 *
Raef Colesab4f8742022-09-01 12:24:31 +01002743 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002744 */
2745#define MBEDTLS_LMS_C
2746
2747/**
Raef Colesab4f8742022-09-01 12:24:31 +01002748 * \def MBEDTLS_LMS_PRIVATE
2749 *
2750 * Enable LMS private-key operations and signing code. Functions enabled by this
2751 * option are experimental, and should not be used in production.
2752 *
2753 * Requires: MBEDTLS_LMS_C
2754 *
2755 * Uncomment to enable the LMS signature algorithm and private key operations.
2756 */
Raef Coles5127e852022-10-07 10:35:56 +01002757//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002758
2759/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002760 * \def MBEDTLS_NIST_KW_C
2761 *
2762 * Enable the Key Wrapping mode for 128-bit block ciphers,
2763 * as defined in NIST SP 800-38F. Only KW and KWP modes
2764 * are supported. At the moment, only AES is approved by NIST.
2765 *
2766 * Module: library/nist_kw.c
2767 *
2768 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2769 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002770#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002771
2772/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002774 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002775 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002776 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002777 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2778 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002779 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002780 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002781 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002782 * Caller: library/constant_time.c
2783 * library/ecdsa.c
2784 * library/ecjpake.c
2785 * library/hkdf.c
2786 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002787 * library/pk.c
2788 * library/pkcs5.c
2789 * library/pkcs12.c
2790 * library/psa_crypto_ecp.c
2791 * library/psa_crypto_rsa.c
2792 * library/rsa.c
2793 * library/ssl_cookie.c
2794 * library/ssl_msg.c
2795 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002796 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002797 * library/x509_crt.c
2798 * library/x509write_crt.c
2799 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002800 *
2801 * Uncomment to enable generic message digest wrappers.
2802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002804
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002805/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002806 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002807 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002808 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002809 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002810 * Module: library/md5.c
2811 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002812 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002813 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002814 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002815 * This module is required for TLS 1.2 depending on the handshake parameters.
2816 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2817 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002818 *
2819 * \warning MD5 is considered a weak message digest and its use constitutes a
2820 * security risk. If possible, we recommend avoiding dependencies on
2821 * it, and considering stronger message digests instead.
2822 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002823 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002825
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002826/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002827 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002828 *
2829 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002830 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002831 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002832 *
2833 * Module: library/memory_buffer_alloc.c
2834 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002836 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002837 *
2838 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002839 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002840//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002841
2842/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002844 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002845 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2846 *
Simon Butcherd567a232016-03-09 20:19:21 +00002847 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2848 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002849 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002850 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002851 * \note See also our Knowledge Base article about porting to a new
2852 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002853 * 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 +00002854 *
Andres AG788aa4a2016-09-14 14:32:09 +01002855 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002856 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002857 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002858 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002860
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002861/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002863 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002864 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002865 *
2866 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002867 * Caller: library/asn1write.c
2868 * library/pkcs5.c
2869 * library/pkparse.c
2870 * library/pkwrite.c
2871 * library/rsa.c
2872 * library/x509.c
2873 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002874 * library/x509_crl.c
2875 * library/x509_crt.c
2876 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002877 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002878 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002879 *
2880 * This modules translates between OIDs and internal values.
2881 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002882#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002883
2884/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002885 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002886 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002887 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002888 *
2889 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002890 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002891 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002892 * library/x509_crl.c
2893 * library/x509_crt.c
2894 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002895 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002897 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2898 *
2899 * \warning When parsing password-protected files, if MD5 is provided only by
2900 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002901 *
Paul Bakkercff68422013-09-15 20:43:33 +02002902 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002903 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002905
2906/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002908 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002909 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002910 *
2911 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002912 * Caller: library/pkwrite.c
2913 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002914 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002915 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002917 *
2918 * This modules adds support for encoding / writing PEM files.
2919 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002920#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002921
2922/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002923 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002924 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002925 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002926 *
2927 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002928 * Caller: library/psa_crypto_rsa.c
2929 * library/ssl_tls.c
2930 * library/ssl*_client.c
2931 * library/ssl*_server.c
2932 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002933 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002934 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002935 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002936 * Uncomment to enable generic public key wrappers.
2937 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002939
2940/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002942 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002943 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002944 *
2945 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002946 * Caller: library/x509_crt.c
2947 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002948 *
Yanray Wang072a0682023-12-05 10:53:04 +08002949 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002950 *
2951 * Uncomment to enable generic public key parse functions.
2952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002954
2955/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002957 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002958 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002959 *
2960 * Module: library/pkwrite.c
2961 * Caller: library/x509write.c
2962 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002963 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002964 *
2965 * Uncomment to enable generic public key write functions.
2966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002968
2969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002971 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002972 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002973 *
2974 * Module: library/pkcs5.c
2975 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002976 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002977 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002978 * \warning If using a hash that is only provided by PSA drivers, you must
2979 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002980 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002981 * This module adds support for the PKCS#5 functions.
2982 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002984
2985/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002986 * \def MBEDTLS_PKCS7_C
2987 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002988 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002989 * RFC Link - https://tools.ietf.org/html/rfc2315
2990 *
2991 * Module: library/pkcs7.c
2992 *
2993 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002994 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2995 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002996 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002997 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002998 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002999#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003000
3001/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003003 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003004 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003005 * Adds algorithms for parsing PKCS#8 encrypted private keys
3006 *
3007 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003008 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003009 *
Valerio Settie98ad592023-12-28 10:42:12 +01003010 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3011 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003012 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003013 * \warning If using a hash that is only provided by PSA drivers, you must
3014 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003015 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003016 * This module enables PKCS#12 functions.
3017 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003019
3020/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003021 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003022 *
3023 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003024 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003025 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3027 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003028 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003029 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003030 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003031 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003032 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003033 * Module: library/platform.c
3034 * Caller: Most other .c files
3035 *
3036 * This module enables abstraction of common (libc) functions.
3037 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003038#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003039
3040/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003041 * \def MBEDTLS_POLY1305_C
3042 *
3043 * Enable the Poly1305 MAC algorithm.
3044 *
3045 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003046 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003047 */
3048#define MBEDTLS_POLY1305_C
3049
3050/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003051 * \def MBEDTLS_PSA_CRYPTO_C
3052 *
3053 * Enable the Platform Security Architecture cryptography API.
3054 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003055 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003056 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003057 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003058 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003059 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3060 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3061 * is enabled in PSA (unless it's fully accelerated, see
3062 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003063 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003064#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003065
3066/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003067 * \def MBEDTLS_PSA_CRYPTO_SE_C
3068 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003069 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003070 * cryptography API.
3071 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003072 * \deprecated This feature is deprecated. Please switch to the PSA driver
3073 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003074 *
Ryan Everett32a64582024-03-05 18:16:18 +00003075 * \warning This feature is not thread-safe, and should not be used in a
3076 * multi-threaded environment.
3077 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003078 * Module: library/psa_crypto_se.c
3079 *
3080 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3081 *
3082 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003083//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003084
3085/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003086 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3087 *
3088 * Enable the Platform Security Architecture persistent key storage.
3089 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003090 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003091 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003092 * Requires: MBEDTLS_PSA_CRYPTO_C,
3093 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3094 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003095 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003096#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003097
3098/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003099 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003100 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003101 * Enable the emulation of the Platform Security Architecture
3102 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003103 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003104 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003105 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003106 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003107 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003108#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003109
3110/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003111 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003112 *
3113 * Enable the RIPEMD-160 hash algorithm.
3114 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003115 * Module: library/ripemd160.c
3116 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003117 *
3118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003120
3121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003122 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003123 *
3124 * Enable the RSA public-key cryptosystem.
3125 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003126 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003127 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003128 * Caller: library/pk.c
3129 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003130 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003131 * library/ssl*_client.c
3132 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003133 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003134 * This module is used by the following key exchanges:
3135 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003136 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003140
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003143 *
3144 * Enable the SHA1 cryptographic hash algorithm.
3145 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003146 * Module: library/sha1.c
3147 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003148 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003149 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003150 * This module is required for TLS 1.2 depending on the handshake parameters,
3151 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003152 *
3153 * \warning SHA-1 is considered a weak message digest and its use constitutes
3154 * a security risk. If possible, we recommend avoiding dependencies
3155 * on it, and considering stronger message digests instead.
3156 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003157 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003159
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003160/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003161 * \def MBEDTLS_SHA224_C
3162 *
3163 * Enable the SHA-224 cryptographic hash algorithm.
3164 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003165 * Module: library/sha256.c
3166 * Caller: library/md.c
3167 * library/ssl_cookie.c
3168 *
3169 * This module adds support for SHA-224.
3170 */
3171#define MBEDTLS_SHA224_C
3172
3173/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003175 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003176 * Enable the SHA-256 cryptographic hash algorithm.
3177 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003178 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003179 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003180 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003181 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003182 * library/ssl*_client.c
3183 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003184 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003185 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003186 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003189
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003190/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003191 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003192 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003193 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3194 * with the ARMv8 cryptographic extensions if they are available at runtime.
3195 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003196 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003197 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003198 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003199 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003200 * \note Minimum compiler versions for this feature are Clang 4.0,
3201 * armclang 6.6 or GCC 6.0.
3202 *
3203 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3204 * armclang <= 6.9
3205 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003206 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3207 * That name is deprecated, but may still be used as an alternative form for this
3208 * option.
3209 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003210 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3211 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003212 *
3213 * Requires: MBEDTLS_SHA256_C.
3214 *
3215 * Module: library/sha256.c
3216 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003217 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003218 * and use them if available.
3219 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003220//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003221
Dave Rodgmand85277c2023-10-13 09:22:54 +01003222/**
3223 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3224 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003225 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003226 * This name is now deprecated, but may still be used as an alternative form for
3227 * this option.
3228 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003229//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3230
3231/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003232 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003233 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003234 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3235 * with the ARMv8 cryptographic extensions, which must be available at runtime
3236 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003237 *
3238 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003239 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003240 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003241 * \note Minimum compiler versions for this feature are Clang 4.0,
3242 * armclang 6.6 or GCC 6.0.
3243 *
3244 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3245 * armclang <= 6.9
3246 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003247 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003248 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003249 * option.
3250 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003251 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3252 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003253 *
3254 * Requires: MBEDTLS_SHA256_C.
3255 *
3256 * Module: library/sha256.c
3257 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003258 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003259 * unconditionally.
3260 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003261//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003262
Dave Rodgmand85277c2023-10-13 09:22:54 +01003263/**
3264 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3265 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003266 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003267 * This name is now deprecated, but may still be used as an alternative form for
3268 * this option.
3269 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003270//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3271
3272/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003273 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003274 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003275 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003276 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003277 * Module: library/sha512.c
3278 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003279 * library/psa_crypto_hash.c
3280 * library/ssl_tls.c
3281 * library/ssl*_client.c
3282 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003283 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003284 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003285 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003286#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003287
3288/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003290 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003291 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003292 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003293 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003294 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003295 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003296 * library/ssl_tls.c
3297 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003298 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003299 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003300 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003302
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003303/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003304 * \def MBEDTLS_SHA3_C
3305 *
3306 * Enable the SHA3 cryptographic hash algorithm.
3307 *
3308 * Module: library/sha3.c
3309 *
3310 * This module adds support for SHA3.
3311 */
3312#define MBEDTLS_SHA3_C
3313
3314/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003315 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3316 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003317 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3318 * with the ARMv8 cryptographic extensions if they are available at runtime.
3319 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003320 *
3321 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3322 * for a non-Aarch64 build it will be silently ignored.
3323 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003324 * \note Minimum compiler versions for this feature are Clang 7.0,
3325 * armclang 6.9 or GCC 8.0.
3326 *
3327 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3328 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003329 *
3330 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3331 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3332 *
3333 * Requires: MBEDTLS_SHA512_C.
3334 *
3335 * Module: library/sha512.c
3336 *
3337 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3338 * and use them if available.
3339 */
3340//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3341
3342/**
3343 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3344 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003345 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3346 * with the ARMv8 cryptographic extensions, which must be available at runtime
3347 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003348 *
3349 * \note This allows builds with a smaller code size than with
3350 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3351 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003352 * \note Minimum compiler versions for this feature are Clang 7.0,
3353 * armclang 6.9 or GCC 8.0.
3354 *
3355 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3356 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003357 *
3358 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3359 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3360 *
3361 * Requires: MBEDTLS_SHA512_C.
3362 *
3363 * Module: library/sha512.c
3364 *
3365 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3366 * unconditionally.
3367 */
3368//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3369
3370/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003372 *
3373 * Enable simple SSL cache implementation.
3374 *
3375 * Module: library/ssl_cache.c
3376 * Caller:
3377 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003379 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003381
3382/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003383 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003384 *
3385 * Enable basic implementation of DTLS cookies for hello verification.
3386 *
3387 * Module: library/ssl_cookie.c
3388 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003389 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003391
3392/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003393 * \def MBEDTLS_SSL_TICKET_C
3394 *
3395 * Enable an implementation of TLS server-side callbacks for session tickets.
3396 *
3397 * Module: library/ssl_ticket.c
3398 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003399 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003400 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3401 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003402 */
3403#define MBEDTLS_SSL_TICKET_C
3404
3405/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003406 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003407 *
3408 * Enable the SSL/TLS client code.
3409 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003410 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003411 * Caller:
3412 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003414 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003415 * This module is required for SSL/TLS client support.
3416 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003418
Paul Bakker9a736322012-11-14 12:39:52 +00003419/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003421 *
3422 * Enable the SSL/TLS server code.
3423 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003424 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003425 * Caller:
3426 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003428 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003429 * This module is required for SSL/TLS server support.
3430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003432
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003433/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003434 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003435 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003436 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003437 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003438 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003439 * Caller: library/ssl*_client.c
3440 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003441 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003442 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3443 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003444 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003445 * This module is required for SSL/TLS.
3446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003447#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003448
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003449/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003451 *
3452 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003453 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003454 * contexts are not shared between threads. If you do intend to use contexts
3455 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003456 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003457 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003458 *
3459 * Module: library/threading.c
3460 *
3461 * This allows different threading implementations (self-implemented or
3462 * provided).
3463 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003464 * You will have to enable either MBEDTLS_THREADING_ALT or
3465 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003466 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003467 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003468 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003469//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003470
3471/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003472 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003473 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003474 * Enable the semi-portable timing interface.
3475 *
Simon Butcherd567a232016-03-09 20:19:21 +00003476 * \note The provided implementation only works on POSIX/Unix (including Linux,
3477 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003478 * module and provide your own implementations of the callbacks needed by
3479 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3480 * your own implementation of the whole module by setting
3481 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003482 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003483 * \note The timing module will include time.h on suitable platforms
3484 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3485 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3486 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003487 * \note See also our Knowledge Base article about porting to a new
3488 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003489 * 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 +00003490 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003491 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003493#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003494
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003495/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003496 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003497 *
3498 * Enable run-time version information.
3499 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003500 * Module: library/version.c
3501 *
3502 * This module provides run-time version information.
3503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003505
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003506/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003508 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003509 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003510 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003511 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003512 * Caller: library/x509_crl.c
3513 * library/x509_crt.c
3514 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003515 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003516 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003517 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3518 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003519 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3520 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003521 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003522 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003523 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003524#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003525
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003526/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003527 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003528 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003529 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003530 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003531 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003532 * Caller: library/ssl_tls.c
3533 * library/ssl*_client.c
3534 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003535 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003537 *
3538 * This module is required for X.509 certificate parsing.
3539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003541
3542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003544 *
3545 * Enable X.509 CRL parsing.
3546 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003547 * Module: library/x509_crl.c
3548 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003549 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003551 *
3552 * This module is required for X.509 CRL parsing.
3553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003554#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003555
3556/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003557 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003558 *
3559 * Enable X.509 Certificate Signing Request (CSR) parsing.
3560 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003561 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003562 * Caller: library/x509_crt_write.c
3563 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003564 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003565 *
3566 * This module is used for reading X.509 certificate request.
3567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003568#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003569
3570/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003571 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003572 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003573 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003574 *
3575 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003576 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003577 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003578 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3579 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003580 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3581 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003582 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003583 * This module is the basis for creating X.509 certificates and CSRs.
3584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003585#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003586
3587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003589 *
3590 * Enable creating X.509 certificates.
3591 *
3592 * Module: library/x509_crt_write.c
3593 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003594 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003595 *
3596 * This module is required for X.509 certificate creation.
3597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003598#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003599
3600/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003602 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003603 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003604 *
3605 * Module: library/x509_csr_write.c
3606 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003607 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003608 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003609 * This module is required for X.509 certificate request writing.
3610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003611#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003612
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003613/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003614
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003615/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003616 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003617 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003618 * This section contains Mbed TLS build settings that are not associated
3619 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003620 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003621 * \{
3622 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003623
Gilles Peskinea02c1242022-03-16 17:03:19 +01003624/**
3625 * \def MBEDTLS_CONFIG_FILE
3626 *
3627 * If defined, this is a header which will be included instead of
3628 * `"mbedtls/mbedtls_config.h"`.
3629 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003630 * Unlike other configuration options, this one must be defined on the
3631 * compiler command line: a definition in `mbedtls_config.h` would have
3632 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003633 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003634 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003635 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003636 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003637 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003638 * The value of this symbol is typically a path in double quotes, either
3639 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003640 */
3641//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3642
3643/**
3644 * \def MBEDTLS_USER_CONFIG_FILE
3645 *
3646 * If defined, this is a header which will be included after
3647 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003648 * This allows you to modify the default configuration, including the ability
3649 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003650 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003651 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003652 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003653 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003654 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003655 * The value of this symbol is typically a path in double quotes, either
3656 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003657 */
3658//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3659
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003660/**
3661 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3662 *
3663 * If defined, this is a header which will be included instead of
3664 * `"psa/crypto_config.h"`.
3665 * This header file specifies which cryptographic mechanisms are available
3666 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3667 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3668 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003669 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003670 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003671 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003672 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003673 * The value of this symbol is typically a path in double quotes, either
3674 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003675 */
3676//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3677
3678/**
3679 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3680 *
3681 * If defined, this is a header which will be included after
3682 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003683 * This allows you to modify the default configuration, including the ability
3684 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003685 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003686 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003687 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003688 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003689 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003690 * The value of this symbol is typically a path in double quotes, either
3691 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003692 */
3693//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3694
Gilles Peskineb1176f22023-02-22 22:07:28 +01003695/**
3696 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3697 *
3698 * If defined, this is a header which will be included instead of
3699 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3700 * as the one in Mbed TLS, but with definitions adapted to the platform on
3701 * which the library code will run.
3702 *
3703 * \note The required content of this header can vary from one version of
3704 * Mbed TLS to the next. Integrators who provide an alternative file
3705 * should review the changes in the original file whenever they
3706 * upgrade Mbed TLS.
3707 *
3708 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3709 * non-standard feature of the C language, so this feature is only available
3710 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3711 *
3712 * The value of this symbol is typically a path in double quotes, either
3713 * absolute or relative to a directory on the include search path.
3714 */
3715//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3716
3717/**
3718 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3719 *
3720 * If defined, this is a header which will be included instead of
3721 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3722 * as the one in Mbed TLS, but with definitions adapted to the environment
3723 * in which the library code will run. The typical use for this feature
3724 * is to provide alternative type definitions on the client side in
3725 * client-server integrations of PSA crypto, where operation structures
3726 * contain handles instead of cryptographic data.
3727 *
3728 * \note The required content of this header can vary from one version of
3729 * Mbed TLS to the next. Integrators who provide an alternative file
3730 * should review the changes in the original file whenever they
3731 * upgrade Mbed TLS.
3732 *
3733 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3734 * non-standard feature of the C language, so this feature is only available
3735 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3736 *
3737 * The value of this symbol is typically a path in double quotes, either
3738 * absolute or relative to a directory on the include search path.
3739 */
3740//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3741
Gilles Peskineba4162a2022-04-11 17:04:38 +02003742/** \} name SECTION: General configuration options */
3743
3744/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003745 * \name SECTION: Module configuration options
3746 *
3747 * This section allows for the setting of module specific sizes and
3748 * configuration options. The default values are already present in the
3749 * relevant header files and should suffice for the regular use cases.
3750 *
3751 * Our advice is to enable options and change their values here
3752 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003753 * \{
3754 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003755/* The Doxygen documentation here is used when a user comments out a
3756 * setting and runs doxygen themselves. On the other hand, when we typeset
3757 * the full documentation including disabled settings, the documentation
3758 * in specific modules' header files is used if present. When editing this
3759 * file, make sure that each option is documented in exactly one place,
3760 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3761 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003762
Paul Bakker088c5c52014-04-25 11:11:10 +02003763/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003764//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003765//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003766
Paul Bakker088c5c52014-04-25 11:11:10 +02003767/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003768//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3769//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3770//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3771//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3772//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003773
Paul Bakker088c5c52014-04-25 11:11:10 +02003774/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003775//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3776//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3777//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3778//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003779
Paul Bakker088c5c52014-04-25 11:11:10 +02003780/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003781//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003782//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003783
Paul Bakker088c5c52014-04-25 11:11:10 +02003784/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003785//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3786//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003787//#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 +01003788
Paul Bakker088c5c52014-04-25 11:11:10 +02003789/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003790//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003791
Paul Bakker088c5c52014-04-25 11:11:10 +02003792/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003793//#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 -04003794
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003795/** \def MBEDTLS_PLATFORM_STD_CALLOC
3796 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003797 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003798 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003799 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003800 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003801 * 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 -04003802 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3803 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003804 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003805 */
3806//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003807
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003808/** \def MBEDTLS_PLATFORM_STD_FREE
3809 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003810 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003811 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003812 * 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 -04003813 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3814 * 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 -04003815 */
3816//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003817//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003818//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003819//#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 +02003820//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3821//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003822/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003823//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003824//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3825//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003826//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3827//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3828//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003829
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003830/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003831/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003832//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3833//#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 +02003834//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003835//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003836//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3837//#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 +02003838//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3839//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003840/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003841//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003842//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003843//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3844//#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 +08003845//#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 +08003846//#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 +02003847
Gilles Peskine3f106f72021-09-23 17:42:39 +02003848/** \def MBEDTLS_CHECK_RETURN
3849 *
3850 * This macro is used at the beginning of the declaration of a function
3851 * to indicate that its return value should be checked. It should
3852 * instruct the compiler to emit a warning or an error if the function
3853 * is called without checking its return value.
3854 *
3855 * There is a default implementation for popular compilers in platform_util.h.
3856 * You can override the default implementation by defining your own here.
3857 *
3858 * If the implementation here is empty, this will effectively disable the
3859 * checking of functions' return values.
3860 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003861//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003862
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003863/** \def MBEDTLS_IGNORE_RETURN
3864 *
3865 * This macro requires one argument, which should be a C function call.
3866 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3867 * warning is suppressed.
3868 */
3869//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3870
Gilles Peskineed038902020-11-13 21:33:21 +01003871/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003872/**
Gilles Peskineed038902020-11-13 21:33:21 +01003873 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3874 * PSA crypto subsystem.
3875 *
3876 * If this option is unset:
3877 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003878 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003879 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3880 * on unspecified heuristics.
3881 */
3882//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3883
Steven Cooreman863470a2021-02-15 14:03:19 +01003884/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003885 * Restrict the PSA library to supporting a maximum amount of simultaneously
3886 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3887 * volatile key, or a persistent key which is loaded temporarily by the
3888 * library as part of a crypto operation in flight.
3889 *
3890 * If this option is unset, the library will fall back to a default value of
3891 * 32 keys.
3892 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003893//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003894
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003895/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003896//#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 +00003897
Paul Bakker088c5c52014-04-25 11:11:10 +02003898/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003899//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3900//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003901
Paul Bakker088c5c52014-04-25 11:11:10 +02003902/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003903
Angus Grattond8213d02016-05-25 20:56:48 +10003904/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3905 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003906 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003907 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003908 * This determines the size of the incoming TLS I/O buffer in such a way
3909 * that it is capable of holding the specified amount of plaintext data,
3910 * regardless of the protection mechanism used.
3911 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003912 * \note When using a value less than the default of 16KB on the client, it is
3913 * recommended to use the Maximum Fragment Length (MFL) extension to
3914 * inform the server about this limitation. On the server, there
3915 * is no supported, standardized way of informing the client about
3916 * restriction on the maximum size of incoming messages, and unless
3917 * the limitation has been communicated by other means, it is recommended
3918 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3919 * while keeping the default value of 16KB for the incoming buffer.
3920 *
David Horstmann95d516f2021-05-04 18:36:56 +01003921 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003922 */
3923//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3924
Gilles Peskined3d02902020-03-04 21:35:27 +01003925/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3926 *
3927 * The maximum length of CIDs used for incoming DTLS messages.
3928 *
3929 */
3930//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3931
3932/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3933 *
3934 * The maximum length of CIDs used for outgoing DTLS messages.
3935 *
3936 */
3937//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3938
TRodziewicze8dd7092021-05-12 14:19:11 +02003939/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003940 *
3941 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003942 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003943 *
3944 * The padding will always be chosen so that the length of the
3945 * padded plaintext is a multiple of the value of this option.
3946 *
3947 * Note: A value of \c 1 means that no padding will be used
3948 * for outgoing records.
3949 *
3950 * Note: On systems lacking division instructions,
3951 * a power of two should be preferred.
3952 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003953//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003954
Angus Grattond8213d02016-05-25 20:56:48 +10003955/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3956 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003957 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003958 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003959 * This determines the size of the outgoing TLS I/O buffer in such a way
3960 * that it is capable of holding the specified amount of plaintext data,
3961 * regardless of the protection mechanism used.
3962 *
Angus Grattond8213d02016-05-25 20:56:48 +10003963 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3964 * the default inward 16384 byte buffer to conform to the TLS specification.
3965 *
3966 * The minimum required outward buffer size is determined by the handshake
3967 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3968 * The specific size requirement depends on the configured ciphers and any
3969 * certificate data which is sent during the handshake.
3970 *
David Horstmann95d516f2021-05-04 18:36:56 +01003971 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003972 */
3973//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3974
Hanno Beckere0b150f2018-08-21 15:51:03 +01003975/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3976 *
3977 * Maximum number of heap-allocated bytes for the purpose of
3978 * DTLS handshake message reassembly and future message buffering.
3979 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003980 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003981 * to account for a reassembled handshake message of maximum size,
3982 * together with its reassembly bitmap.
3983 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003984 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003985 * should be sufficient for all practical situations as it allows
3986 * to reassembly a large handshake message (such as a certificate)
3987 * while buffering multiple smaller handshake messages.
3988 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003989 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003990//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003991
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003992//#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 +02003993//#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 +02003994
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003995/**
3996 * Complete list of ciphersuites to use, in order of preference.
3997 *
3998 * \warning No dependency checking is done on that field! This option can only
3999 * be used to restrict the set of available ciphersuites. It is your
4000 * responsibility to make sure the needed modules are active.
4001 *
4002 * Use this to save a few hundred bytes of ROM (default ordering of all
4003 * available ciphersuites) and a few to a few hundred bytes of RAM.
4004 *
4005 * The value below is only an example, not the default.
4006 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004007//#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 +02004008
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004009/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004010 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4011 *
4012 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004013 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004014 *
4015 * It must be positive and smaller than UINT32_MAX.
4016 *
4017 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4018 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004019 */
4020//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4021
4022/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004023 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4024 *
Jerry Yucf913512023-11-14 11:06:52 +08004025 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004026 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004027 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004028 * - The client ticket age is the time difference between the time when the
4029 * client proposes to the server to use the ticket and the time the client
4030 * received the ticket from the server.
4031 * - The server ticket age is the time difference between the time when the
4032 * server receives a proposition from the client to use the ticket and the
4033 * time when the ticket was created by the server.
4034 *
Jerry Yucf913512023-11-14 11:06:52 +08004035 * The ages might be different due to the client and server clocks not running
4036 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4037 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4038 * 6s, thus in the worst case clients and servers must sync up their system time
4039 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004040 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004041 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004042 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004043//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004044
4045/**
4046 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4047 *
4048 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4049 *
4050 * This must be less than 256.
4051 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004052//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004053
4054/**
4055 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4056 *
4057 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4058 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4059 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4060 *
4061 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004062//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004063
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004064/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004065//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004066//#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 +01004067
Gilles Peskine611179c2022-04-13 23:04:48 +02004068/** \} name SECTION: Module configuration options */