blob: 0f1b54e226d9b73b3b24d0e3ab24526723e65721 [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_MD5_PROCESS_ALT
391//#define MBEDTLS_RIPEMD160_PROCESS_ALT
392//#define MBEDTLS_SHA1_PROCESS_ALT
393//#define MBEDTLS_SHA256_PROCESS_ALT
394//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200395//#define MBEDTLS_DES_SETKEY_ALT
396//#define MBEDTLS_DES_CRYPT_ECB_ALT
397//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200398//#define MBEDTLS_AES_SETKEY_ENC_ALT
399//#define MBEDTLS_AES_SETKEY_DEC_ALT
400//#define MBEDTLS_AES_ENCRYPT_ALT
401//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300402//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300403//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300404//#define MBEDTLS_ECDSA_VERIFY_ALT
405//#define MBEDTLS_ECDSA_SIGN_ALT
406//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200407
408/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200409 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200410 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200411 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200412 * hardware entropy collector.
413 *
414 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000415 * prototype as declared in library/entropy_poll.h, and accept NULL as first
416 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200417 *
418 * Uncomment to use your own hardware entropy collector.
419 */
420//#define MBEDTLS_ENTROPY_HARDWARE_ALT
421
422/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200423 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000424 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100425 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000426 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100427 * Uncomment this macro to use precomputed AES tables stored in ROM.
428 * Comment this macro to generate AES tables in RAM at runtime.
429 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100430 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
431 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100432 * initialization time before the first AES operation can be performed.
433 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
434 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
435 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100436 *
437 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000438 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000440
441/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100442 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200443 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100444 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200445 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100446 * Uncommenting this macro omits 75% of the AES tables from
447 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
448 * by computing their values on the fly during operations
449 * (the tables are entry-wise rotations of one another).
450 *
451 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100452 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100453 * runtime. Specifically, one has to compare 4 accesses within
454 * different tables to 4 accesses with additional arithmetic
455 * operations within the same table. The performance gain/loss
456 * depends on the system and memory details.
457 *
458 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200459 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100460//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200461
462/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800463 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
464 *
465 * Use only 128-bit keys in AES operations to save ROM.
466 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800467 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800468 * or 256-bit keys.
469 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800470 * Uncommenting this macro reduces the size of AES code by ~300 bytes
471 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800472 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800473 * Module: library/aes.c
474 *
475 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800476 */
477//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
478
Gilles Peskinea8861e02023-09-05 20:20:51 +0200479/*
480 * Disable plain C implementation for AES.
481 *
482 * When the plain C implementation is enabled, and an implementation using a
483 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
484 * detection will be used to select between them.
485 *
486 * If only one implementation is present, runtime detection will not be used.
487 * This configuration will crash at runtime if running on a CPU without the
488 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
489 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
490 */
491//#define MBEDTLS_AES_USE_HARDWARE_ONLY
492
Arto Kinnunen732ca322023-04-14 14:26:10 +0800493/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200494 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200495 *
496 * Use less ROM for the Camellia implementation (saves about 768 bytes).
497 *
498 * Uncomment this macro to use less memory for Camellia.
499 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200500//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200501
502/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200503 * \def MBEDTLS_CHECK_RETURN_WARNING
504 *
505 * If this macro is defined, emit a compile-time warning if application code
506 * calls a function without checking its return value, but the return value
507 * should generally be checked in portable applications.
508 *
509 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
510 * implemented. Otherwise this option has no effect.
511 *
512 * Uncomment to get warnings on using fallible functions without checking
513 * their return value.
514 *
515 * \note This feature is a work in progress.
516 * Warnings will be added to more functions in the future.
517 *
518 * \note A few functions are considered critical, and ignoring the return
519 * value of these functions will trigger a warning even if this
520 * macro is not defined. To completely disable return value check
521 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
522 */
523//#define MBEDTLS_CHECK_RETURN_WARNING
524
525/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200527 *
528 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
529 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200530#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200531
532/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000534 *
535 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200537#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000538
539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000541 *
542 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000545
546/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100547 * \def MBEDTLS_CIPHER_MODE_OFB
548 *
549 * Enable Output Feedback mode (OFB) for symmetric ciphers.
550 */
551#define MBEDTLS_CIPHER_MODE_OFB
552
553/**
554 * \def MBEDTLS_CIPHER_MODE_XTS
555 *
556 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
557 */
558#define MBEDTLS_CIPHER_MODE_XTS
559
560/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200561 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000562 *
563 * Enable NULL cipher.
564 * Warning: Only do so when you know what you are doing. This allows for
565 * encryption or channels without any security!
566 *
Ronald Croncee42702021-04-26 11:34:44 +0200567 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200568 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
569 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
570 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
571 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
572 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
573 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
574 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
575 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
576 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
577 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
578 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
579 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
580 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
581 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
582 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
583 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
584 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
585 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
586 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000587 *
588 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000589 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200590//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000591
592/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100593 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200594 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100595 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
596 * specific padding modes in the cipher layer with cipher modes that support
597 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200598 *
599 * If you disable all padding modes, only full blocks can be used with CBC.
600 *
601 * Enable padding modes in the cipher layer.
602 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603#define MBEDTLS_CIPHER_PADDING_PKCS7
604#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
605#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
606#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200607
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200608/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
609 *
610 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800611 * Without this, CTR_DRBG uses a 256-bit key
612 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200613 */
614//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
615
Paul Bakker48e93c82013-08-14 12:21:18 +0200616/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200617 * Enable the verified implementations of ECDH primitives from Project Everest
618 * (currently only Curve25519). This feature changes the layout of ECDH
619 * contexts and therefore is a compatibility break for applications that access
620 * fields of a mbedtls_ecdh_context structure directly. See also
621 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000622 *
623 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
624 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200625 */
626//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
627
628/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100629 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200630 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100631 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
632 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200633 *
634 * Comment macros to disable the curve and functions for it
635 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200636/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200637#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
638#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
639#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
640#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
641#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
642#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
643#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
644#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
645#define MBEDTLS_ECP_DP_BP256R1_ENABLED
646#define MBEDTLS_ECP_DP_BP384R1_ENABLED
647#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200648/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200649#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000650#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200651
652/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200654 *
655 * Enable specific 'modulo p' routines for each NIST prime.
656 * Depending on the prime and architecture, makes operations 4 to 8 times
657 * faster on the corresponding curve.
658 *
659 * Comment this macro to disable NIST curves optimisation.
660 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200662
663/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200664 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100665 *
666 * Enable "non-blocking" ECC operations that can return early and be resumed.
667 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200668 * This allows various functions to pause by returning
669 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
670 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
671 * order to further progress and eventually complete their operation. This is
672 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
673 * number of ECC operations a function may perform before pausing; see
674 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100675 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200676 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200677 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100678 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100679 * This option:
680 * - Adds xxx_restartable() variants of existing operations in the
681 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100682 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
683 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100684 * - ECDSA: signature generation & verification;
685 * - PK: signature generation & verification;
686 * - X509: certificate chain verification.
687 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
688 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
689 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
690 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000691 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100692 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100693 * - verification of the server's key exchange signature;
694 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100695 * - generation of the client's signature if client authentication is used,
696 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100697 *
698 * \note In the cases above, the usual SSL/TLS functions, such as
699 * mbedtls_ssl_handshake(), can now return
700 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200701 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100702 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
703 * restartable operations in PK, X.509 and TLS (see above) are not
704 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100705 * PSA, and are not restartable. These are temporary limitations that
706 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200707 *
Ron Eldor19779c42018-11-05 16:58:13 +0200708 * \note This option only works with the default software implementation of
709 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100710 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100711 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100712 * Requires: MBEDTLS_ECP_C
713 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100714 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100715 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200716//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100717
718/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200719 * Uncomment to enable using new bignum code in the ECC modules.
720 *
721 * \warning This is currently experimental, incomplete and therefore should not
722 * be used in production.
723 */
724//#define MBEDTLS_ECP_WITH_MPI_UINT
725
726/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200727 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100728 *
729 * Enable deterministic ECDSA (RFC 6979).
730 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
731 * may result in a compromise of the long-term signing key. This is avoided by
732 * the deterministic variant.
733 *
John Durkop36a82e52020-10-26 09:39:05 -0700734 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100735 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100736 * Comment this macro to disable deterministic ECDSA.
737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100739
740/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200741 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200742 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200743 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200744 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200745 * This enables the following ciphersuites (if other requisites are
746 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200747 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
748 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
749 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
750 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
751 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
752 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
753 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
754 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
755 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
756 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200757 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200759
760/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200762 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200763 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200764 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200766 *
767 * This enables the following ciphersuites (if other requisites are
768 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
770 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
771 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
772 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
773 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
774 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
775 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
776 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
777 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
778 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100779 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100780 * \warning Using DHE constitutes a security risk as it
781 * is not possible to validate custom DH parameters.
782 * If possible, it is recommended users should consider
783 * preferring other methods of key exchange.
784 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100785 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200786 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200788
789/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200790 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200791 *
792 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
793 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200794 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200795 *
796 * This enables the following ciphersuites (if other requisites are
797 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
799 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
800 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
801 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
802 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
803 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200804 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200806
807/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200808 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200809 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200810 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200811 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200812 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
813 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200814 *
815 * This enables the following ciphersuites (if other requisites are
816 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200817 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
818 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
819 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
820 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
821 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
822 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
823 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
824 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
825 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
826 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200827 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200829
830/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200831 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200832 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200833 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200834 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
836 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200837 *
838 * This enables the following ciphersuites (if other requisites are
839 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
841 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
842 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
843 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
844 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
845 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
846 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
847 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
848 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
849 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
850 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
851 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200852 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200853#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200854
855/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200856 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200857 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200858 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200859 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
861 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200862 *
863 * This enables the following ciphersuites (if other requisites are
864 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
866 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
867 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
868 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
869 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
870 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
871 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
872 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
873 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
874 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
875 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
876 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100877 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100878 * \warning Using DHE constitutes a security risk as it
879 * is not possible to validate custom DH parameters.
880 * If possible, it is recommended users should consider
881 * preferring other methods of key exchange.
882 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100883 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200884 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200886
887/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200889 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200890 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200891 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200892 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
893 * MBEDTLS_RSA_C
894 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200896 *
897 * This enables the following ciphersuites (if other requisites are
898 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200899 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
900 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
901 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
902 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
903 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
904 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
905 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
906 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
907 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
908 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200909 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200911
912/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200913 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200914 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200915 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200916 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200917 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
918 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
919 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200920 *
921 * This enables the following ciphersuites (if other requisites are
922 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200923 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
924 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
925 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
926 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
927 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
928 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200935
936/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100938 *
939 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
940 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200941 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
942 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
943 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100944 *
945 * This enables the following ciphersuites (if other requisites are
946 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
948 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
949 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
950 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
951 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
952 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
955 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
956 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100957 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100959
960/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100962 *
963 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
964 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200965 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
966 * MBEDTLS_RSA_C
967 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100968 *
969 * This enables the following ciphersuites (if other requisites are
970 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
972 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
973 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
974 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
975 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
976 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
977 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
978 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
979 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
980 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100983
984/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200985 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
986 *
987 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
988 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200989 * \warning This is currently experimental. EC J-PAKE support is based on the
990 * Thread v1.0.0 specification; incompatible changes to the specification
991 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200992 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200993 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100994 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200995 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
996 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100997 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800998 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100999 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1000 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001001 * This enables the following ciphersuites (if other requisites are
1002 * enabled as well):
1003 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1004 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001005//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001006
1007/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001009 *
1010 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1011 * RFC 5915 and RFC 5480.
1012 *
1013 * Currently this means parsing the SpecifiedECDomain choice of EC
1014 * parameters (only known groups are supported, not arbitrary domains, to
1015 * avoid validation issues).
1016 *
1017 * Disable if you only need to support RFC 5915 + 5480 key formats.
1018 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001020
1021/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001022 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1023 *
1024 * Enable the support for parsing public keys of type Short Weierstrass
1025 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001026 * compressed point format. This parsing is done through ECP module's functions.
1027 *
1028 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1029 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1030 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001031 */
1032#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1033
1034/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001036 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037 * Enable a dummy error function to make use of mbedtls_strerror() in
1038 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1039 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001040 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1042 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001043 *
1044 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001046 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001048
1049/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001051 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001052 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001053 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001057
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001058/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001060 *
1061 * Enable functions that use the filesystem.
1062 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001064
1065/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001067 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001068 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001069 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001070 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001071 * application.
1072 *
1073 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001074 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001076
1077/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001079 *
1080 * Do not use built-in platform entropy functions.
1081 * This is useful if your platform does not support
1082 * standards like the /dev/urandom or Windows CryptoAPI.
1083 *
1084 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001087
1088/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001090 *
1091 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1092 * default SHA-512 based one (if both are available).
1093 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001095 *
1096 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1097 * if you have performance concerns.
1098 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001099 * This option is only useful if both MBEDTLS_SHA256_C and
1100 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001101 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001103
1104/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001105 * \def MBEDTLS_ENTROPY_NV_SEED
1106 *
1107 * Enable the non-volatile (NV) seed file-based entropy source.
1108 * (Also enables the NV seed read/write functions in the platform layer)
1109 *
1110 * This is crucial (if not required) on systems that do not have a
1111 * cryptographic entropy source (in hardware or kernel) available.
1112 *
1113 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1114 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001115 * \note The read/write functions that are used by the entropy source are
1116 * determined in the platform layer, and can be modified at runtime and/or
1117 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1118 *
1119 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001120 * with regular fopen(), please make sure you make a seedfile with the
1121 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1122 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001123 * and written to or you will get an entropy source error! The default
1124 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1125 * bytes from the file.
1126 *
1127 * \note The entropy collector will write to the seed file before entropy is
1128 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001129 */
1130//#define MBEDTLS_ENTROPY_NV_SEED
1131
Ronald Cron71016a92020-08-28 19:01:50 +02001132/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001133 *
Ronald Cron71016a92020-08-28 19:01:50 +02001134 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001135 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001136 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1137 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001138 *
1139 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001140 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001141 */
Ronald Cron71016a92020-08-28 19:01:50 +02001142//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001143
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001144/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001145 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001146 *
1147 * Enable debugging of buffer allocator memory issues. Automatically prints
1148 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1149 * function for 'debug output' of allocated memory.
1150 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001152 *
1153 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001154 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001156
1157/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001159 *
1160 * Include backtrace information with each allocated block.
1161 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001163 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001164 *
1165 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001168
1169/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001171 *
1172 * Support external private RSA keys (eg from a HSM) in the PK layer.
1173 *
1174 * Comment this macro to disable support for external private RSA keys.
1175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001177
1178/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001180 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001181 * Enable support for PKCS#1 v1.5 encoding.
1182 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001183 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001184 *
Paul Bakker48377d92013-08-30 12:06:24 +02001185 * This enables support for PKCS#1 v1.5 operations.
1186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001188
1189/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001190 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001191 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001192 * Enable support for PKCS#1 v2.1 encoding.
1193 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001194 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001195 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001196 * \warning If using a hash that is only provided by PSA drivers, you must
1197 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001198 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001199 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001202
Steven Cooreman6801f082021-02-19 17:21:22 +01001203/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1204 *
1205 * Enable support for platform built-in keys. If you enable this feature,
1206 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1207 * See the documentation of that function for more information.
1208 *
1209 * Built-in keys are typically derived from a hardware unique key or
1210 * stored in a secure element.
1211 *
1212 * Requires: MBEDTLS_PSA_CRYPTO_C.
1213 *
1214 * \warning This interface is experimental and may change or be removed
1215 * without notice.
1216 */
1217//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1218
Ronald Cron3768ac12021-01-26 16:58:00 +01001219/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1220 *
1221 * Enable support for PSA crypto client.
1222 *
1223 * \note This option allows to include the code necessary for a PSA
1224 * crypto client when the PSA crypto implementation is not included in
1225 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1226 * code to set and get PSA key attributes.
1227 * The development of PSA drivers partially relying on the library to
1228 * fulfill the hardware gaps is another possible usage of this option.
1229 *
1230 * \warning This interface is experimental and may change or be removed
1231 * without notice.
1232 */
1233//#define MBEDTLS_PSA_CRYPTO_CLIENT
1234
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001235/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1236 *
1237 * Make the PSA Crypto module use an external random generator provided
1238 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1239 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001240 * \note This random generator must deliver random numbers with cryptographic
1241 * quality and high performance. It must supply unpredictable numbers
1242 * with a uniform distribution. The implementation of this function
1243 * is responsible for ensuring that the random generator is seeded
1244 * with sufficient entropy. If you have a hardware TRNG which is slow
1245 * or delivers non-uniform output, declare it as an entropy source
1246 * with mbedtls_entropy_add_source() instead of enabling this option.
1247 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001248 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001249 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1250 * and define a function called mbedtls_psa_external_get_random()
1251 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001252 * ```
1253 * psa_status_t mbedtls_psa_external_get_random(
1254 * mbedtls_psa_external_random_context_t *context,
1255 * uint8_t *output, size_t output_size, size_t *output_length);
1256 * );
1257 * ```
1258 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001259 * The function must fill the \c output buffer with \c output_size bytes
1260 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001261 *
1262 * Requires: MBEDTLS_PSA_CRYPTO_C
1263 *
1264 * \warning If you enable this option, code that uses the PSA cryptography
1265 * interface will not use any of the entropy sources set up for
1266 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1267 * enables.
1268 *
1269 * \note This option is experimental and may be removed without notice.
1270 */
1271//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1272
Paul Bakker9dcc3222011-03-08 14:16:06 +00001273/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001274 * \def MBEDTLS_PSA_CRYPTO_SPM
1275 *
1276 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1277 * Partition Manager) integration which separates the code into two parts: a
1278 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1279 * Environment).
1280 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001281 * If you enable this option, your build environment must include a header
1282 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1283 * header files, or in another directory on the compiler's include search
1284 * path). Alternatively, your platform may customize the header
1285 * `psa/crypto_platform.h`, in which case it can skip or replace the
1286 * inclusion of `"crypto_spe.h"`.
1287 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001288 * Module: library/psa_crypto.c
1289 * Requires: MBEDTLS_PSA_CRYPTO_C
1290 *
1291 */
1292//#define MBEDTLS_PSA_CRYPTO_SPM
1293
1294/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001295 * Uncomment to enable p256-m. This is an alternative implementation of
1296 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1297 * Compared to the default implementation:
1298 *
1299 * - p256-m has a much smaller code size and RAM footprint.
1300 * - p256-m is only available via the PSA API. This includes the pk module
1301 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1302 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1303 * over the core arithmetic, or deterministic derivation of keys.
1304 *
1305 * We recommend enabling this option if your application uses the PSA API
1306 * and the only elliptic curve support it needs is ECDH and ECDSA over
1307 * SECP256R1.
1308 *
1309 * If you enable this option, you do not need to enable any ECC-related
1310 * MBEDTLS_xxx option. You do need to separately request support for the
1311 * cryptographic mechanisms through the PSA API:
1312 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1313 * configuration;
1314 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1315 * - #PSA_WANT_ECC_SECP_R1_256;
1316 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1317 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1318 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1319 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1320 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001321 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001322 * \note To benefit from the smaller code size of p256-m, make sure that you
1323 * do not enable any ECC-related option not supported by p256-m: this
1324 * would cause the built-in ECC implementation to be built as well, in
1325 * order to provide the required option.
1326 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001327 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1328 * SECP256R1 are disabled as they are not supported by this driver.
1329 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1330 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001331 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001332 */
1333//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1334
1335/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001336 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001337 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001338 * Enable support for entropy injection at first boot. This feature is
1339 * required on systems that do not have a built-in entropy source (TRNG).
1340 * This feature is currently not supported on systems that have a built-in
1341 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001342 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001343 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001344 *
1345 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001346//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001347
1348/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001349 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001350 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001351 * Assume all buffers passed to PSA functions are owned exclusively by the
1352 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001353 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001354 * This option may be enabled if all buffers passed to any PSA function reside
1355 * in memory that is accessible only to the PSA function during its execution.
1356 *
1357 * This option MUST be disabled whenever buffer arguments are in memory shared
1358 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001359 * across a trust boundary.
1360 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001361 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001362 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001363 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001364 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001365 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001366//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001367
1368/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001369 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001370 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001371 * Do not use the Chinese Remainder Theorem
1372 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001373 *
1374 * Uncomment this macro to disable the use of CRT in RSA.
1375 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001378
1379/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001380 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001381 *
1382 * Enable the checkup functions (*_self_test).
1383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001384#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001385
1386/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001387 * \def MBEDTLS_SHA256_SMALLER
1388 *
1389 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1390 * lower performance.
1391 *
Adam Wolf039080f2019-09-10 09:53:08 -05001392 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001393 * performance and size. This version optimizes more aggressively for size at
1394 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1395 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1396 * 30%.
1397 *
1398 * Uncomment to enable the smaller implementation of SHA256.
1399 */
1400//#define MBEDTLS_SHA256_SMALLER
1401
1402/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001403 * \def MBEDTLS_SHA512_SMALLER
1404 *
1405 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1406 * lower performance.
1407 *
1408 * Uncomment to enable the smaller implementation of SHA512.
1409 */
1410//#define MBEDTLS_SHA512_SMALLER
1411
1412/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001413 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001414 *
1415 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001416 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001417 * with other servers, only debugging of failures is harder.
1418 *
1419 * The advantage of not sending alert messages, is that no information is given
1420 * about reasons for failures thus preventing adversaries of gaining intel.
1421 *
1422 * Enable sending of all alert messages
1423 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001424#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001425
1426/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001427 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1428 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001429 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001430 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001431 * in the underlying transport. The CID functionality is described
1432 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001433 *
1434 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001435 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1436 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1437 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001438 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001439 * The maximum lengths of outgoing and incoming CIDs can be configured
1440 * through the options
1441 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1442 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1443 *
1444 * Requires: MBEDTLS_SSL_PROTO_DTLS
1445 *
1446 * Uncomment to enable the Connection ID extension.
1447 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001448#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1449
1450
1451/**
1452 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1453 *
1454 * Defines whether RFC 9146 (default) or the legacy version
1455 * (version draft-ietf-tls-dtls-connection-id-05,
1456 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1457 * is used.
1458 *
1459 * Set the value to 0 for the standard version, and
1460 * 1 for the legacy draft version.
1461 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001462 * \deprecated Support for the legacy version of the DTLS
1463 * Connection ID feature is deprecated. Please
1464 * switch to the standardized version defined
1465 * in RFC 9146 enabled by utilizing
1466 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1467 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1468 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001469 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1470 */
1471#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001472
1473/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001474 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1475 *
1476 * Enable asynchronous external private key operations in SSL. This allows
1477 * you to configure an SSL connection to call an external cryptographic
1478 * module to perform private key operations instead of performing the
1479 * operation inside the library.
1480 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001481 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001482 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001483//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001484
1485/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001486 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1487 *
1488 * Enable serialization of the TLS context structures, through use of the
1489 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1490 *
1491 * This pair of functions allows one side of a connection to serialize the
1492 * context associated with the connection, then free or re-use that context
1493 * while the serialized state is persisted elsewhere, and finally deserialize
1494 * that state to a live context for resuming read/write operations on the
1495 * connection. From a protocol perspective, the state of the connection is
1496 * unaffected, in particular this is entirely transparent to the peer.
1497 *
1498 * Note: this is distinct from TLS session resumption, which is part of the
1499 * protocol and fully visible by the peer. TLS session resumption enables
1500 * establishing new connections associated to a saved session with shorter,
1501 * lighter handshakes, while context serialization is a local optimization in
1502 * handling a single, potentially long-lived connection.
1503 *
1504 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1505 * saved after the handshake to allow for more efficient serialization, so if
1506 * you don't need this feature you'll save RAM by disabling it.
1507 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001508 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1509 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001510 * Comment to disable the context serialization APIs.
1511 */
1512#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1513
1514/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001515 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001516 *
1517 * Enable the debug messages in SSL module for all issues.
1518 * Debug messages have been disabled in some places to prevent timing
1519 * attacks due to (unbalanced) debugging function calls.
1520 *
1521 * If you need all error reporting you should enable this during debugging,
1522 * but remove this for production servers that should log as well.
1523 *
1524 * Uncomment this macro to report all debug messages on errors introducing
1525 * a timing side-channel.
1526 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001529
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001530/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001531 *
1532 * Enable support for Encrypt-then-MAC, RFC 7366.
1533 *
1534 * This allows peers that both support it to use a more robust protection for
1535 * ciphersuites using CBC, providing deep resistance against timing attacks
1536 * on the padding or underlying cipher.
1537 *
1538 * This only affects CBC ciphersuites, and is useless if none is defined.
1539 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001540 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001541 *
1542 * Comment this macro to disable support for Encrypt-then-MAC
1543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001544#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001547 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001548 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1549 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001550 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001551 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001552 * attacks, but it is recommended to always use it (even if you disable
1553 * renegotiation), since it actually fixes a more fundamental issue in the
1554 * original SSL/TLS design, and has implications beyond Triple Handshake.
1555 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001556 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001557 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001558 * Comment this macro to disable support for Extended Master Secret.
1559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001561
Paul Bakkerd66f0702013-01-31 16:57:45 +01001562/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001563 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1564 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001565 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001566 * giving access to the peer's certificate after completion of the handshake.
1567 *
1568 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1569 * recommended to disable this option for reduced RAM usage.
1570 *
1571 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1572 * defined, but always returns \c NULL.
1573 *
1574 * \note This option has no influence on the protection against the
1575 * triple handshake attack. Even if it is disabled, Mbed TLS will
1576 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001577 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001578 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001579 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001580 *
1581 * Comment this macro to disable storing the peer's certificate
1582 * after the handshake.
1583 */
1584#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1585
1586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001587 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001588 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001589 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001590 *
1591 * The two main uses of renegotiation are (1) refresh keys on long-lived
1592 * connections and (2) client authentication after the initial handshake.
1593 * If you don't need renegotiation, it's probably better to disable it, since
1594 * it has been associated with security issues in the past and is easy to
1595 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001596 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001597 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1598 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001599 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001600 *
1601 * \note Even if this option is disabled, both client and server are aware
1602 * of the Renegotiation Indication Extension (RFC 5746) used to
1603 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1604 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1605 * configuration of this extension).
1606 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001609
1610/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001611 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001612 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001613 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001614 *
1615 * Comment this macro to disable support for the max_fragment_length extension
1616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001617#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001618
1619/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001620 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1621 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001622 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001623 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001624 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1625 *
1626 * Uncomment this macro to enable support for the record_size_limit extension
1627 */
1628//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1629
1630/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001632 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001633 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001634 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001635 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001636 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1637 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001638 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001639 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001640 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001641 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1642 * are only provided by PSA drivers, you must call psa_crypto_init() before
1643 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001644 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001645 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001646 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001648
1649/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001650 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001651 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001652 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001653 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001654 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001655 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001656 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001657 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001658 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001659 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001660 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1661 * directly performed by TLS 1.3 code. As a consequence, you must
1662 * call psa_crypto_init() before the first TLS 1.3 handshake.
1663 *
1664 * \note Cryptographic operations performed indirectly via another module
1665 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1666 * running handshake hash) only use PSA crypto if
1667 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001668 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001669 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001670 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001671#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001672
1673/**
Ronald Cronab65c522021-11-24 10:47:20 +01001674 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1675 *
1676 * Enable TLS 1.3 middlebox compatibility mode.
1677 *
1678 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1679 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1680 * expecting TLS 1.2 traffic.
1681 *
1682 * Turning on the compatibility mode comes at the cost of a few added bytes
1683 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1684 * that don't use it. Therefore, unless transmission bandwidth is critical and
1685 * you know that middlebox compatibility issues won't occur, it is therefore
1686 * recommended to set this option.
1687 *
1688 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001689 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1690 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001691 *
1692 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001693#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001694
1695/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001696 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1697 *
1698 * Enable TLS 1.3 PSK key exchange mode.
1699 *
1700 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1701 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1702 * effect on the build.
1703 *
1704 */
1705#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1706
1707/**
1708 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1709 *
1710 * Enable TLS 1.3 ephemeral key exchange mode.
1711 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001712 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001713 * MBEDTLS_X509_CRT_PARSE_C
1714 * and at least one of:
1715 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1716 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001717 *
1718 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1719 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1720 * effect on the build.
1721 *
1722 */
1723#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1724
1725/**
1726 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1727 *
1728 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1729 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001730 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001731 *
1732 * Comment to disable support for the PSK ephemeral key exchange mode in
1733 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1734 * have any effect on the build.
1735 *
1736 */
1737#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1738
1739/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 * \def MBEDTLS_SSL_EARLY_DATA
1741 *
1742 * Enable support for RFC 8446 TLS 1.3 early data.
1743 *
1744 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1745 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1746 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1747 *
1748 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1749 * is not enabled, this option does not have any effect on the build.
1750 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001751 * \note The maximum amount of early data can be set with
1752 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1753 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001755//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001756
1757/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001759 *
1760 * Enable support for DTLS (all available versions).
1761 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001762 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001763 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001764 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001765 *
1766 * Comment this macro to disable support for DTLS
1767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001769
1770/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001772 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001773 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001774 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001775 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001777#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001778
1779/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001780 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001781 *
1782 * Enable support for the anti-replay mechanism in DTLS.
1783 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001784 * Requires: MBEDTLS_SSL_TLS_C
1785 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001786 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001787 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001788 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001789 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001790 * Comment this to disable anti-replay in DTLS.
1791 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001792#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001793
1794/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001796 *
1797 * Enable support for HelloVerifyRequest on DTLS servers.
1798 *
1799 * This feature is highly recommended to prevent DTLS servers being used as
1800 * amplifiers in DoS attacks against other hosts. It should always be enabled
1801 * unless you know for sure amplification cannot be a problem in the
1802 * environment in which your server operates.
1803 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001804 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001805 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001806 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001807 *
1808 * Comment this to disable support for HelloVerifyRequest.
1809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001811
1812/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001813 * \def MBEDTLS_SSL_DTLS_SRTP
1814 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001815 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001816 * through the use_srtp extension.
1817 *
1818 * \note This feature provides the minimum functionality required
1819 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1820 * the associated SRTP packet protection key material.
1821 * In particular, the SRTP packet protection itself, as well as the
1822 * demultiplexing of RTP and DTLS packets at the datagram layer
1823 * (see Section 5 of RFC 5764), are not handled by this feature.
1824 * Instead, after successful completion of a handshake negotiating
1825 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001826 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001827 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1828 * (this is implemented in the SSL example programs).
1829 * The resulting key should then be passed to an SRTP stack.
1830 *
1831 * Setting this option enables the runtime API
1832 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1833 * through which the supported DTLS-SRTP protection
1834 * profiles can be configured. You must call this API at
1835 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001836 *
1837 * Requires: MBEDTLS_SSL_PROTO_DTLS
1838 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001839 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001840 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001841//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001842
1843/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001844 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1845 *
1846 * Enable server-side support for clients that reconnect from the same port.
1847 *
1848 * Some clients unexpectedly close the connection and try to reconnect using the
1849 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001850 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001851 * flag enables that support.
1852 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001853 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001854 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001855 * Comment this to disable support for clients reusing the source port.
1856 */
1857#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1858
1859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001860 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001861 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001862 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001863 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001864 * session store remains the responsibility of the application, though).
1865 * Server-side, you also need to provide callbacks for writing and parsing
1866 * tickets, including authenticated encryption and key management. Example
1867 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001868 *
1869 * Comment this macro to disable support for SSL session tickets
1870 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001872
1873/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001875 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001876 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001877 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001878 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001879 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001880 * Comment this macro to disable support for server name indication in SSL
1881 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001883
1884/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001885 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1886 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001887 * When this option is enabled, the SSL buffer will be resized automatically
1888 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001889 *
1890 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001891 */
1892//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1893
1894/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001895 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1896 *
1897 * Enable testing of the constant-flow nature of some sensitive functions with
1898 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001899 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001900 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001901 * This setting requires compiling with clang -fsanitize=memory. The test
1902 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001903 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001904 * \warning This macro is only used for extended testing; it is not considered
1905 * part of the library's API, so it may change or disappear at any time.
1906 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001907 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001908 */
1909//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1910
1911/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001912 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1913 *
1914 * Enable testing of the constant-flow nature of some sensitive functions with
1915 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001916 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001917 *
1918 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001919 * testing if the tests suites are run with valgrind's memcheck. This can be
1920 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1921 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001922 *
1923 * \warning This macro is only used for extended testing; it is not considered
1924 * part of the library's API, so it may change or disappear at any time.
1925 *
1926 * Uncomment to enable testing of the constant-flow nature of selected code.
1927 */
1928//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1929
1930/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001931 * \def MBEDTLS_TEST_HOOKS
1932 *
1933 * Enable features for invasive testing such as introspection functions and
1934 * hooks for fault injection. This enables additional unit tests.
1935 *
1936 * Merely enabling this feature should not change the behavior of the product.
1937 * It only adds new code, and new branching points where the default behavior
1938 * is the same as when this feature is disabled.
1939 * However, this feature increases the attack surface: there is an added
1940 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1941 * Therefore this feature must never be enabled in production.
1942 *
1943 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1944 * information.
1945 *
1946 * Uncomment to enable invasive tests.
1947 */
1948//#define MBEDTLS_TEST_HOOKS
1949
1950/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001951 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001952 *
1953 * Provide your own alternate threading implementation.
1954 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001955 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001956 *
1957 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001958 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001960
1961/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001963 *
1964 * Enable the pthread wrapper layer for the threading layer.
1965 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001967 *
1968 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001971
1972/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001973 * \def MBEDTLS_USE_PSA_CRYPTO
1974 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001975 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1976 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001977 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001978 * \note Development of this option is currently in progress, and parts of Mbed
1979 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001980 * will still continue to work as usual, so enabling this option should not
1981 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001982 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001983 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001984 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1985 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001986 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001987 * \note An important and desirable effect of this option is that it allows
1988 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1989 * 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 +02001990 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001991 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1992 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001993 *
1994 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001995 *
1996 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001997 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001998 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001999 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002000//#define MBEDTLS_USE_PSA_CRYPTO
2001
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002003 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2004 *
John Durkop185764f2020-10-12 21:32:12 -07002005 * This setting allows support for cryptographic mechanisms through the PSA
2006 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002007 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002008 * When this option is disabled, the PSA API exposes the cryptographic
2009 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2010 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002011 *
2012 * When this option is enabled, the PSA API exposes the cryptographic
2013 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2014 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2015 * automatically enabled if required (i.e. if no PSA driver provides the
2016 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2017 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002018 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002019 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002020 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002021 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002022 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2023 * symbols is not completely finalized yet, and the configuration
2024 * tooling is not ideally adapted to having two separate configuration
2025 * files.
2026 * Future minor releases of Mbed TLS may make minor changes to those
2027 * symbols, but we will endeavor to provide a transition path.
2028 * Nonetheless, this option is considered mature enough to use in
2029 * production, as long as you accept that you may need to make
2030 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002031 */
2032//#define MBEDTLS_PSA_CRYPTO_CONFIG
2033
2034/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002035 * \def MBEDTLS_VERSION_FEATURES
2036 *
2037 * Allow run-time checking of compile-time enabled features. Thus allowing users
2038 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002039 * support via mbedtls_version_check_feature().
2040 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002041 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002042 *
2043 * Comment this to disable run-time checking and save ROM space
2044 */
2045#define MBEDTLS_VERSION_FEATURES
2046
2047/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002048 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2049 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002050 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002051 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2052 * the set of trusted certificates through a callback instead of a linked
2053 * list.
2054 *
2055 * This is useful for example in environments where a large number of trusted
2056 * certificates is present and storing them in a linked list isn't efficient
2057 * enough, or when the set of trusted certificates changes frequently.
2058 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002059 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002060 * `mbedtls_ssl_conf_ca_cb()` for more information.
2061 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002062 * Requires: MBEDTLS_X509_CRT_PARSE_C
2063 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002064 * Uncomment to enable trusted certificate callbacks.
2065 */
2066//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2067
2068/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002069 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002070 *
Chris Jones2c745862020-12-16 11:41:06 +00002071 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002072 *
Chris Jones2c745862020-12-16 11:41:06 +00002073 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002074 * and other functions/constants only used by these functions, thus reducing
2075 * the code footprint by several KB.
2076 */
Chris Jones2c745862020-12-16 11:41:06 +00002077//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002078
2079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002081 *
2082 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2083 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2084 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002085 * Requires: MBEDTLS_PKCS1_V21
2086 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002087 * Comment this macro to disallow using RSASSA-PSS in certificates.
2088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002089#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002090/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002091
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002092/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002093 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002094 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002095 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002096 * \{
2097 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002098
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002099/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002100 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002101 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002102 * Enable AES-NI support on x86-64 or x86-32.
2103 *
2104 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002105 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002106 * - GCC, x86-64, target not explicitly supporting AESNI:
2107 * requires MBEDTLS_HAVE_ASM.
2108 * - GCC, x86-32, target not explicitly supporting AESNI:
2109 * not supported.
2110 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2111 * For this assembly-less implementation, you must currently compile
2112 * `library/aesni.c` and `library/aes.c` with machine options to enable
2113 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2114 * `clang -maes -mpclmul`.
2115 * - Non-x86 targets: this option is silently ignored.
2116 * - Other compilers: this option is silently ignored.
2117 *
2118 * \note
2119 * Above, "GCC" includes compatible compilers such as Clang.
2120 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002121 *
2122 * Module: library/aesni.c
2123 * Caller: library/aes.c
2124 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002125 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002126 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002127 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002129#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002130
2131/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002132 * \def MBEDTLS_AESCE_C
2133 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002134 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002135 *
2136 * Module: library/aesce.c
2137 * Caller: library/aes.c
2138 *
Jerry Yuf015a932023-04-25 10:38:03 +08002139 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002140 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002141 * \warning Runtime detection only works on Linux. For non-Linux operating
2142 * system, Armv8-A Cryptographic Extensions must be supported by
2143 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002144 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002145 * \note Minimum compiler versions for this feature when targeting aarch64
2146 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2147 * Minimum compiler versions for this feature when targeting 32-bit
2148 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002149 *
2150 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2151 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002152 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002153 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002154 */
2155#define MBEDTLS_AESCE_C
2156
2157/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002158 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002159 *
2160 * Enable the AES block cipher.
2161 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002162 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002163 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002164 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002165 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002166 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002167 * This module enables the following ciphersuites (if other requisites are
2168 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002169 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2170 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2171 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2172 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2173 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2174 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2175 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2176 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2177 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2178 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2179 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2180 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2181 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2182 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2183 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2184 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2185 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2186 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2187 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2188 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2189 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2190 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2191 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2192 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2193 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2194 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2195 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2196 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2197 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2198 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2199 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2200 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2201 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2202 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2203 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2204 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2205 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2206 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2207 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2208 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2209 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2210 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2211 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2212 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2213 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2214 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2215 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2216 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2217 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2218 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2219 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2220 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2221 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2222 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2223 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2224 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2225 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2226 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002227 *
Paul Bakkercff68422013-09-15 20:43:33 +02002228 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002229 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002230#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002231
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002232/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002233 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002234 *
2235 * Enable the generic ASN1 parser.
2236 *
2237 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002238 * Caller: library/x509.c
2239 * library/dhm.c
2240 * library/pkcs12.c
2241 * library/pkcs5.c
2242 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002244#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002245
2246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002247 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002248 *
2249 * Enable the generic ASN1 writer.
2250 *
2251 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002252 * Caller: library/ecdsa.c
2253 * library/pkwrite.c
2254 * library/x509_create.c
2255 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002256 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002257 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002258#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002259
2260/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002262 *
2263 * Enable the Base64 module.
2264 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002265 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002266 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002267 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002268 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002269 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002271
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002272/**
Yanray Wange367e472023-10-31 17:23:04 +08002273 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2274 *
2275 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2276 *
2277 * \note This feature is incompatible with insecure block cipher,
2278 * MBEDTLS_DES_C, and cipher modes which always require decryption
2279 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002280 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2281 * this feature is incompatible with following supported PSA equivalence,
2282 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2283 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002284 *
2285 * Module: library/aes.c
2286 * library/aesce.c
2287 * library/aesni.c
2288 * library/aria.c
2289 * library/camellia.c
2290 * library/cipher.c
2291 */
2292//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2293
2294/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002296 *
Paul Bakker9a736322012-11-14 12:39:52 +00002297 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002298 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002299 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002300 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002301 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002302 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002303 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002304 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002305 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002306 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002307 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002308 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002309 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002310 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002313
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002314/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002315 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002316 *
2317 * Enable the Camellia block cipher.
2318 *
Paul Bakker38119b12009-01-10 23:31:23 +00002319 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002320 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002321 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002322 * This module enables the following ciphersuites (if other requisites are
2323 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2325 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2326 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2327 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2328 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2329 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2330 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2331 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2332 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2333 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2334 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2335 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2336 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2337 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2338 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2339 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2340 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2341 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2342 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2343 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2344 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2345 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2346 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2347 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2348 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2349 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2350 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2351 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2352 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2353 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2354 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2355 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2356 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2357 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2358 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2359 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2360 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2361 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2362 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2363 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2364 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2365 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002366 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002367#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002368
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002369/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002370 * \def MBEDTLS_ARIA_C
2371 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002372 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002373 *
2374 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002375 * Caller: library/cipher.c
2376 *
2377 * This module enables the following ciphersuites (if other requisites are
2378 * enabled as well):
2379 *
2380 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2381 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2382 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2383 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2384 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2385 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2386 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2387 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2388 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2389 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2390 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2391 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2392 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2393 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2394 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2395 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2396 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2397 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2398 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2399 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2400 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2401 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2402 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2403 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2404 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2405 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2406 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2407 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2408 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2409 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2410 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2411 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2412 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2413 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2414 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2415 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2416 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2417 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002418 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002419#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002420
2421/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002422 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002423 *
2424 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2425 *
2426 * Module: library/ccm.c
2427 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002428 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2429 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002430 *
2431 * This module enables the AES-CCM ciphersuites, if other requisites are
2432 * enabled as well.
2433 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002434#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002435
2436/**
Daniel King34b822c2016-05-15 17:28:08 -03002437 * \def MBEDTLS_CHACHA20_C
2438 *
2439 * Enable the ChaCha20 stream cipher.
2440 *
2441 * Module: library/chacha20.c
2442 */
2443#define MBEDTLS_CHACHA20_C
2444
2445/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002446 * \def MBEDTLS_CHACHAPOLY_C
2447 *
2448 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2449 *
2450 * Module: library/chachapoly.c
2451 *
2452 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2453 */
2454#define MBEDTLS_CHACHAPOLY_C
2455
2456/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002457 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002458 *
2459 * Enable the generic cipher layer.
2460 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002461 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002462 * Caller: library/ccm.c
2463 * library/cmac.c
2464 * library/gcm.c
2465 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002466 * library/pkcs12.c
2467 * library/pkcs5.c
2468 * library/psa_crypto_aead.c
2469 * library/psa_crypto_mac.c
2470 * library/ssl_ciphersuites.c
2471 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002472 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002473 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2474 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002475 *
2476 * Uncomment to enable generic cipher wrappers.
2477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002479
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002480/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002481 * \def MBEDTLS_CMAC_C
2482 *
Simon Butcher327398a2016-10-05 14:09:11 +01002483 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2484 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002485 *
2486 * Module: library/cmac.c
2487 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002488 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002489 *
2490 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002491#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002492
2493/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002495 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002496 * Enable the CTR_DRBG AES-based random generator.
2497 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002498 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002499 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002500 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002501 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2502 * is used.
2503 *
2504 * \warning When using PSA, the user should call `psa_crypto_init()` before
2505 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2506 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002507 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2508 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002509 * \note To achieve a 256-bit security strength with CTR_DRBG,
2510 * you must use AES-256 *and* use sufficient entropy.
2511 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002512 *
2513 * Module: library/ctr_drbg.c
2514 * Caller:
2515 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002516 * Requires: MBEDTLS_AES_C or
2517 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2518 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002519 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002520 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002521 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002522#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002523
2524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002525 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002526 *
2527 * Enable the debug functions.
2528 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002529 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002530 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002531 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002532 * library/ssl_tls12_*.c
2533 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002534 *
2535 * This module provides debugging functions.
2536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002538
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002541 *
2542 * Enable the DES block cipher.
2543 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002544 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002545 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002546 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002547 *
Paul Bakkercff68422013-09-15 20:43:33 +02002548 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002549 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002550 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002551 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002554
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002557 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002558 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002559 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002560 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002561 * Caller: library/ssl_tls.c
2562 * library/ssl*_client.c
2563 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002564 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002565 * This module is used by the following key exchanges:
2566 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002567 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002568 * \warning Using DHE constitutes a security risk as it
2569 * is not possible to validate custom DH parameters.
2570 * If possible, it is recommended users should consider
2571 * preferring other methods of key exchange.
2572 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002573 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002574 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002576
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002577/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002578 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002579 *
2580 * Enable the elliptic curve Diffie-Hellman library.
2581 *
2582 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002583 * Caller: library/psa_crypto.c
2584 * library/ssl_tls.c
2585 * library/ssl*_client.c
2586 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002587 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002588 * This module is used by the following key exchanges:
2589 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002590 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002591 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002592 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002594
2595/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002597 *
2598 * Enable the elliptic curve DSA library.
2599 *
2600 * Module: library/ecdsa.c
2601 * Caller:
2602 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002603 * This module is used by the following key exchanges:
2604 * ECDHE-ECDSA
2605 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002606 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2607 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2608 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002610#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002611
2612/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002613 * \def MBEDTLS_ECJPAKE_C
2614 *
2615 * Enable the elliptic curve J-PAKE library.
2616 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002617 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2618 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002619 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002620 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002621 * Module: library/ecjpake.c
2622 * Caller:
2623 *
2624 * This module is used by the following key exchanges:
2625 * ECJPAKE
2626 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002627 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002628 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002629 * \warning If using a hash that is only provided by PSA drivers, you must
2630 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002631 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002632#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002633
2634/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002635 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002636 *
2637 * Enable the elliptic curve over GF(p) library.
2638 *
2639 * Module: library/ecp.c
2640 * Caller: library/ecdh.c
2641 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002642 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002643 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002646#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002647
2648/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002650 *
2651 * Enable the platform-specific entropy code.
2652 *
2653 * Module: library/entropy.c
2654 * Caller:
2655 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002657 *
2658 * This module provides a generic entropy pool
2659 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002661
2662/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002664 *
2665 * Enable error code to error string conversion.
2666 *
2667 * Module: library/error.c
2668 * Caller:
2669 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002671 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002672#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002673
2674/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002676 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002677 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002678 *
2679 * Module: library/gcm.c
2680 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002681 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2682 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002683 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002684 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2685 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002688
2689/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002690 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002691 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002692 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002693 * Can significantly increase throughput on systems without GCM hardware
2694 * acceleration (e.g., AESNI, AESCE).
2695 *
Matthias Schulz78266782024-02-08 13:54:48 +01002696 * The mbedtls_gcm_context size will increase by 3840 bytes.
2697 * The code size will increase by roughly 344 bytes.
2698 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002699 * Module: library/gcm.c
2700 *
2701 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002702 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002703//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002704
2705/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002706 * \def MBEDTLS_HKDF_C
2707 *
2708 * Enable the HKDF algorithm (RFC 5869).
2709 *
2710 * Module: library/hkdf.c
2711 * Caller:
2712 *
2713 * Requires: MBEDTLS_MD_C
2714 *
2715 * This module adds support for the Hashed Message Authentication Code
2716 * (HMAC)-based key derivation function (HKDF).
2717 */
2718#define MBEDTLS_HKDF_C
2719
2720/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002721 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002722 *
2723 * Enable the HMAC_DRBG random generator.
2724 *
2725 * Module: library/hmac_drbg.c
2726 * Caller:
2727 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002729 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002730 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002731 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002733
2734/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002735 * \def MBEDTLS_LMS_C
2736 *
2737 * Enable the LMS stateful-hash asymmetric signature algorithm.
2738 *
2739 * Module: library/lms.c
2740 * Caller:
2741 *
Raef Colesab4f8742022-09-01 12:24:31 +01002742 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002743 *
Raef Colesab4f8742022-09-01 12:24:31 +01002744 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002745 */
2746#define MBEDTLS_LMS_C
2747
2748/**
Raef Colesab4f8742022-09-01 12:24:31 +01002749 * \def MBEDTLS_LMS_PRIVATE
2750 *
2751 * Enable LMS private-key operations and signing code. Functions enabled by this
2752 * option are experimental, and should not be used in production.
2753 *
2754 * Requires: MBEDTLS_LMS_C
2755 *
2756 * Uncomment to enable the LMS signature algorithm and private key operations.
2757 */
Raef Coles5127e852022-10-07 10:35:56 +01002758//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002759
2760/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002761 * \def MBEDTLS_NIST_KW_C
2762 *
2763 * Enable the Key Wrapping mode for 128-bit block ciphers,
2764 * as defined in NIST SP 800-38F. Only KW and KWP modes
2765 * are supported. At the moment, only AES is approved by NIST.
2766 *
2767 * Module: library/nist_kw.c
2768 *
2769 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2770 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002771#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002772
2773/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002775 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002776 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002777 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002778 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2779 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002780 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002781 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002782 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002783 * Caller: library/constant_time.c
2784 * library/ecdsa.c
2785 * library/ecjpake.c
2786 * library/hkdf.c
2787 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002788 * library/pk.c
2789 * library/pkcs5.c
2790 * library/pkcs12.c
2791 * library/psa_crypto_ecp.c
2792 * library/psa_crypto_rsa.c
2793 * library/rsa.c
2794 * library/ssl_cookie.c
2795 * library/ssl_msg.c
2796 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002797 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002798 * library/x509_crt.c
2799 * library/x509write_crt.c
2800 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002801 *
2802 * Uncomment to enable generic message digest wrappers.
2803 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002805
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002806/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002807 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002808 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002809 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002810 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002811 * Module: library/md5.c
2812 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002813 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002814 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002815 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002816 * This module is required for TLS 1.2 depending on the handshake parameters.
2817 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2818 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002819 *
2820 * \warning MD5 is considered a weak message digest and its use constitutes a
2821 * security risk. If possible, we recommend avoiding dependencies on
2822 * it, and considering stronger message digests instead.
2823 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002824 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002825#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002826
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002827/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002828 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002829 *
2830 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002831 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002832 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002833 *
2834 * Module: library/memory_buffer_alloc.c
2835 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002836 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002837 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002838 *
2839 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002840 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002841//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002842
2843/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002845 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002846 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2847 *
Simon Butcherd567a232016-03-09 20:19:21 +00002848 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2849 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002850 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002851 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002852 * \note See also our Knowledge Base article about porting to a new
2853 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002854 * 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 +00002855 *
Andres AG788aa4a2016-09-14 14:32:09 +01002856 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002857 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002858 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002861
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002862/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002863 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002864 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002865 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002866 *
2867 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002868 * Caller: library/asn1write.c
2869 * library/pkcs5.c
2870 * library/pkparse.c
2871 * library/pkwrite.c
2872 * library/rsa.c
2873 * library/x509.c
2874 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002875 * library/x509_crl.c
2876 * library/x509_crt.c
2877 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002878 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002879 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002880 *
2881 * This modules translates between OIDs and internal values.
2882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002884
2885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002887 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002888 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002889 *
2890 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002891 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002892 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002893 * library/x509_crl.c
2894 * library/x509_crt.c
2895 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002896 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002897 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002898 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2899 *
2900 * \warning When parsing password-protected files, if MD5 is provided only by
2901 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002902 *
Paul Bakkercff68422013-09-15 20:43:33 +02002903 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002905#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002906
2907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002909 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002910 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002911 *
2912 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002913 * Caller: library/pkwrite.c
2914 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002915 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002916 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002917 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002918 *
2919 * This modules adds support for encoding / writing PEM files.
2920 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002921#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002922
2923/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002924 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002925 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002926 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002927 *
2928 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002929 * Caller: library/psa_crypto_rsa.c
2930 * library/ssl_tls.c
2931 * library/ssl*_client.c
2932 * library/ssl*_server.c
2933 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002934 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002935 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002936 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002937 * Uncomment to enable generic public key wrappers.
2938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002940
2941/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002943 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002944 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002945 *
2946 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002947 * Caller: library/x509_crt.c
2948 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002949 *
Yanray Wang072a0682023-12-05 10:53:04 +08002950 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002951 *
2952 * Uncomment to enable generic public key parse functions.
2953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002955
2956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002958 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002959 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002960 *
2961 * Module: library/pkwrite.c
2962 * Caller: library/x509write.c
2963 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002964 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002965 *
2966 * Uncomment to enable generic public key write functions.
2967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002969
2970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002972 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002973 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002974 *
2975 * Module: library/pkcs5.c
2976 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002977 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002978 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002979 * \warning If using a hash that is only provided by PSA drivers, you must
2980 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002981 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002982 * This module adds support for the PKCS#5 functions.
2983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002985
2986/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002987 * \def MBEDTLS_PKCS7_C
2988 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002989 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002990 * RFC Link - https://tools.ietf.org/html/rfc2315
2991 *
2992 * Module: library/pkcs7.c
2993 *
2994 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002995 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2996 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002997 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002998 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002999 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003000#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003001
3002/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003003 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003004 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003005 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003006 * Adds algorithms for parsing PKCS#8 encrypted private keys
3007 *
3008 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003009 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003010 *
Valerio Settie98ad592023-12-28 10:42:12 +01003011 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3012 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003013 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003014 * \warning If using a hash that is only provided by PSA drivers, you must
3015 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003016 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003017 * This module enables PKCS#12 functions.
3018 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003020
3021/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003022 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003023 *
3024 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003025 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003026 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3028 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003029 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003030 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003031 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003032 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003033 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003034 * Module: library/platform.c
3035 * Caller: Most other .c files
3036 *
3037 * This module enables abstraction of common (libc) functions.
3038 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003039#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003040
3041/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003042 * \def MBEDTLS_POLY1305_C
3043 *
3044 * Enable the Poly1305 MAC algorithm.
3045 *
3046 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003047 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003048 */
3049#define MBEDTLS_POLY1305_C
3050
3051/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003052 * \def MBEDTLS_PSA_CRYPTO_C
3053 *
3054 * Enable the Platform Security Architecture cryptography API.
3055 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003056 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003057 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003058 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003059 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003060 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3061 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3062 * is enabled in PSA (unless it's fully accelerated, see
3063 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003064 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003065#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003066
3067/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003068 * \def MBEDTLS_PSA_CRYPTO_SE_C
3069 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003070 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003071 * cryptography API.
3072 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003073 * \deprecated This feature is deprecated. Please switch to the PSA driver
3074 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003075 *
Ryan Everett32a64582024-03-05 18:16:18 +00003076 * \warning This feature is not thread-safe, and should not be used in a
3077 * multi-threaded environment.
3078 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003079 * Module: library/psa_crypto_se.c
3080 *
3081 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3082 *
3083 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003084//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003085
3086/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003087 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3088 *
3089 * Enable the Platform Security Architecture persistent key storage.
3090 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003091 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003092 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003093 * Requires: MBEDTLS_PSA_CRYPTO_C,
3094 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3095 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003096 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003097#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003098
3099/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003100 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003101 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003102 * Enable the emulation of the Platform Security Architecture
3103 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003104 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003105 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003106 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003107 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003108 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003109#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003110
3111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003113 *
3114 * Enable the RIPEMD-160 hash algorithm.
3115 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003116 * Module: library/ripemd160.c
3117 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003118 *
3119 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003121
3122/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003124 *
3125 * Enable the RSA public-key cryptosystem.
3126 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003127 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003128 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003129 * Caller: library/pk.c
3130 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003131 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003132 * library/ssl*_client.c
3133 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003134 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003135 * This module is used by the following key exchanges:
3136 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003137 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003138 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003139 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003141
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003142/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003144 *
3145 * Enable the SHA1 cryptographic hash algorithm.
3146 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003147 * Module: library/sha1.c
3148 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003149 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003150 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003151 * This module is required for TLS 1.2 depending on the handshake parameters,
3152 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003153 *
3154 * \warning SHA-1 is considered a weak message digest and its use constitutes
3155 * a security risk. If possible, we recommend avoiding dependencies
3156 * on it, and considering stronger message digests instead.
3157 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003158 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003160
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003161/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003162 * \def MBEDTLS_SHA224_C
3163 *
3164 * Enable the SHA-224 cryptographic hash algorithm.
3165 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003166 * Module: library/sha256.c
3167 * Caller: library/md.c
3168 * library/ssl_cookie.c
3169 *
3170 * This module adds support for SHA-224.
3171 */
3172#define MBEDTLS_SHA224_C
3173
3174/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003175 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003176 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003177 * Enable the SHA-256 cryptographic hash algorithm.
3178 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003179 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003180 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003181 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003182 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003183 * library/ssl*_client.c
3184 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003185 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003186 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003187 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003188 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003189#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003190
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003191/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003192 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003193 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003194 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3195 * with the ARMv8 cryptographic extensions if they are available at runtime.
3196 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003197 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003198 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003199 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003200 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003201 * \note Minimum compiler versions for this feature are Clang 4.0,
3202 * armclang 6.6 or GCC 6.0.
3203 *
3204 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3205 * armclang <= 6.9
3206 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003207 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3208 * That name is deprecated, but may still be used as an alternative form for this
3209 * option.
3210 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003211 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3212 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003213 *
3214 * Requires: MBEDTLS_SHA256_C.
3215 *
3216 * Module: library/sha256.c
3217 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003218 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003219 * and use them if available.
3220 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003221//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003222
Dave Rodgmand85277c2023-10-13 09:22:54 +01003223/**
3224 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3225 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003226 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003227 * This name is now deprecated, but may still be used as an alternative form for
3228 * this option.
3229 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003230//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3231
3232/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003233 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003234 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003235 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3236 * with the ARMv8 cryptographic extensions, which must be available at runtime
3237 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003238 *
3239 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003240 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003241 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003242 * \note Minimum compiler versions for this feature are Clang 4.0,
3243 * armclang 6.6 or GCC 6.0.
3244 *
3245 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3246 * armclang <= 6.9
3247 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003248 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003249 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003250 * option.
3251 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003252 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3253 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003254 *
3255 * Requires: MBEDTLS_SHA256_C.
3256 *
3257 * Module: library/sha256.c
3258 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003259 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003260 * unconditionally.
3261 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003262//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003263
Dave Rodgmand85277c2023-10-13 09:22:54 +01003264/**
3265 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3266 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003267 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003268 * This name is now deprecated, but may still be used as an alternative form for
3269 * this option.
3270 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003271//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3272
3273/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003274 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003275 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003276 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003277 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003278 * Module: library/sha512.c
3279 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003280 * library/psa_crypto_hash.c
3281 * library/ssl_tls.c
3282 * library/ssl*_client.c
3283 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003284 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003285 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003286 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003287#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003288
3289/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003290 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003291 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003292 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003293 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003294 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003295 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003296 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003297 * library/ssl_tls.c
3298 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003299 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003300 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003301 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003302#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003303
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003304/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003305 * \def MBEDTLS_SHA3_C
3306 *
3307 * Enable the SHA3 cryptographic hash algorithm.
3308 *
3309 * Module: library/sha3.c
3310 *
3311 * This module adds support for SHA3.
3312 */
3313#define MBEDTLS_SHA3_C
3314
3315/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003316 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3317 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003318 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3319 * with the ARMv8 cryptographic extensions if they are available at runtime.
3320 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003321 *
3322 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3323 * for a non-Aarch64 build it will be silently ignored.
3324 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003325 * \note Minimum compiler versions for this feature are Clang 7.0,
3326 * armclang 6.9 or GCC 8.0.
3327 *
3328 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3329 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003330 *
3331 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3332 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3333 *
3334 * Requires: MBEDTLS_SHA512_C.
3335 *
3336 * Module: library/sha512.c
3337 *
3338 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3339 * and use them if available.
3340 */
3341//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3342
3343/**
3344 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3345 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003346 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3347 * with the ARMv8 cryptographic extensions, which must be available at runtime
3348 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003349 *
3350 * \note This allows builds with a smaller code size than with
3351 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3352 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003353 * \note Minimum compiler versions for this feature are Clang 7.0,
3354 * armclang 6.9 or GCC 8.0.
3355 *
3356 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3357 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003358 *
3359 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3360 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3361 *
3362 * Requires: MBEDTLS_SHA512_C.
3363 *
3364 * Module: library/sha512.c
3365 *
3366 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3367 * unconditionally.
3368 */
3369//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3370
3371/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003372 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003373 *
3374 * Enable simple SSL cache implementation.
3375 *
3376 * Module: library/ssl_cache.c
3377 * Caller:
3378 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003382
3383/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003385 *
3386 * Enable basic implementation of DTLS cookies for hello verification.
3387 *
3388 * Module: library/ssl_cookie.c
3389 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003390 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003392
3393/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003394 * \def MBEDTLS_SSL_TICKET_C
3395 *
3396 * Enable an implementation of TLS server-side callbacks for session tickets.
3397 *
3398 * Module: library/ssl_ticket.c
3399 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003400 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003401 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3402 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003403 */
3404#define MBEDTLS_SSL_TICKET_C
3405
3406/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003407 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003408 *
3409 * Enable the SSL/TLS client code.
3410 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003411 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003412 * Caller:
3413 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003414 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003415 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003416 * This module is required for SSL/TLS client support.
3417 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003419
Paul Bakker9a736322012-11-14 12:39:52 +00003420/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003421 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003422 *
3423 * Enable the SSL/TLS server code.
3424 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003425 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003426 * Caller:
3427 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003429 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003430 * This module is required for SSL/TLS server support.
3431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003432#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003433
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003434/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003436 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003437 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003438 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003439 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003440 * Caller: library/ssl*_client.c
3441 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003442 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003443 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3444 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003445 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003446 * This module is required for SSL/TLS.
3447 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003449
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003450/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003451 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003452 *
3453 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003454 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003455 * contexts are not shared between threads. If you do intend to use contexts
3456 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003457 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003458 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003459 *
3460 * Module: library/threading.c
3461 *
3462 * This allows different threading implementations (self-implemented or
3463 * provided).
3464 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465 * You will have to enable either MBEDTLS_THREADING_ALT or
3466 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003467 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003468 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003469 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003470//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003471
3472/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003474 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003475 * Enable the semi-portable timing interface.
3476 *
Simon Butcherd567a232016-03-09 20:19:21 +00003477 * \note The provided implementation only works on POSIX/Unix (including Linux,
3478 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003479 * module and provide your own implementations of the callbacks needed by
3480 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3481 * your own implementation of the whole module by setting
3482 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003483 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003484 * \note The timing module will include time.h on suitable platforms
3485 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3486 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3487 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003488 * \note See also our Knowledge Base article about porting to a new
3489 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003490 * 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 +00003491 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003492 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003495
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003498 *
3499 * Enable run-time version information.
3500 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003501 * Module: library/version.c
3502 *
3503 * This module provides run-time version information.
3504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003506
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003509 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003510 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003511 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003512 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003513 * Caller: library/x509_crl.c
3514 * library/x509_crt.c
3515 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003516 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003517 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003518 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3519 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003520 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3521 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003522 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003523 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003524 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003525#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003526
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003527/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003528 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003529 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003530 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003531 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003532 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003533 * Caller: library/ssl_tls.c
3534 * library/ssl*_client.c
3535 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003536 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003538 *
3539 * This module is required for X.509 certificate parsing.
3540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003542
3543/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003545 *
3546 * Enable X.509 CRL parsing.
3547 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003548 * Module: library/x509_crl.c
3549 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003550 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003551 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003552 *
3553 * This module is required for X.509 CRL parsing.
3554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003556
3557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003559 *
3560 * Enable X.509 Certificate Signing Request (CSR) parsing.
3561 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003562 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003563 * Caller: library/x509_crt_write.c
3564 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003565 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003566 *
3567 * This module is used for reading X.509 certificate request.
3568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570
3571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003573 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003574 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003575 *
3576 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003577 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003578 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003579 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3580 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003581 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3582 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003583 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003584 * This module is the basis for creating X.509 certificates and CSRs.
3585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003586#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003587
3588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003589 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003590 *
3591 * Enable creating X.509 certificates.
3592 *
3593 * Module: library/x509_crt_write.c
3594 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003595 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003596 *
3597 * This module is required for X.509 certificate creation.
3598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003599#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003600
3601/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003603 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003604 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003605 *
3606 * Module: library/x509_csr_write.c
3607 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003608 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003609 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003610 * This module is required for X.509 certificate request writing.
3611 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003612#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003613
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003614/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003615
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003616/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003617 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003618 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003619 * This section contains Mbed TLS build settings that are not associated
3620 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003621 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003622 * \{
3623 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003624
Gilles Peskinea02c1242022-03-16 17:03:19 +01003625/**
3626 * \def MBEDTLS_CONFIG_FILE
3627 *
3628 * If defined, this is a header which will be included instead of
3629 * `"mbedtls/mbedtls_config.h"`.
3630 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003631 * Unlike other configuration options, this one must be defined on the
3632 * compiler command line: a definition in `mbedtls_config.h` would have
3633 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003634 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003635 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003636 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003637 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003638 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003639 * The value of this symbol is typically a path in double quotes, either
3640 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003641 */
3642//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3643
3644/**
3645 * \def MBEDTLS_USER_CONFIG_FILE
3646 *
3647 * If defined, this is a header which will be included after
3648 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003649 * This allows you to modify the default configuration, including the ability
3650 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003651 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003652 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003653 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003654 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003655 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003656 * The value of this symbol is typically a path in double quotes, either
3657 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003658 */
3659//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3660
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003661/**
3662 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3663 *
3664 * If defined, this is a header which will be included instead of
3665 * `"psa/crypto_config.h"`.
3666 * This header file specifies which cryptographic mechanisms are available
3667 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3668 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3669 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003670 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003671 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003672 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003673 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003674 * The value of this symbol is typically a path in double quotes, either
3675 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003676 */
3677//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3678
3679/**
3680 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3681 *
3682 * If defined, this is a header which will be included after
3683 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003684 * This allows you to modify the default configuration, including the ability
3685 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003686 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003687 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003688 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003689 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003690 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003691 * The value of this symbol is typically a path in double quotes, either
3692 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003693 */
3694//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3695
Gilles Peskineb1176f22023-02-22 22:07:28 +01003696/**
3697 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3698 *
3699 * If defined, this is a header which will be included instead of
3700 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3701 * as the one in Mbed TLS, but with definitions adapted to the platform on
3702 * which the library code will run.
3703 *
3704 * \note The required content of this header can vary from one version of
3705 * Mbed TLS to the next. Integrators who provide an alternative file
3706 * should review the changes in the original file whenever they
3707 * upgrade Mbed TLS.
3708 *
3709 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3710 * non-standard feature of the C language, so this feature is only available
3711 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3712 *
3713 * The value of this symbol is typically a path in double quotes, either
3714 * absolute or relative to a directory on the include search path.
3715 */
3716//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3717
3718/**
3719 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3720 *
3721 * If defined, this is a header which will be included instead of
3722 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3723 * as the one in Mbed TLS, but with definitions adapted to the environment
3724 * in which the library code will run. The typical use for this feature
3725 * is to provide alternative type definitions on the client side in
3726 * client-server integrations of PSA crypto, where operation structures
3727 * contain handles instead of cryptographic data.
3728 *
3729 * \note The required content of this header can vary from one version of
3730 * Mbed TLS to the next. Integrators who provide an alternative file
3731 * should review the changes in the original file whenever they
3732 * upgrade Mbed TLS.
3733 *
3734 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3735 * non-standard feature of the C language, so this feature is only available
3736 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3737 *
3738 * The value of this symbol is typically a path in double quotes, either
3739 * absolute or relative to a directory on the include search path.
3740 */
3741//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3742
Gilles Peskineba4162a2022-04-11 17:04:38 +02003743/** \} name SECTION: General configuration options */
3744
3745/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003746 * \name SECTION: Module configuration options
3747 *
3748 * This section allows for the setting of module specific sizes and
3749 * configuration options. The default values are already present in the
3750 * relevant header files and should suffice for the regular use cases.
3751 *
3752 * Our advice is to enable options and change their values here
3753 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003754 * \{
3755 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003756/* The Doxygen documentation here is used when a user comments out a
3757 * setting and runs doxygen themselves. On the other hand, when we typeset
3758 * the full documentation including disabled settings, the documentation
3759 * in specific modules' header files is used if present. When editing this
3760 * file, make sure that each option is documented in exactly one place,
3761 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3762 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003763
Paul Bakker088c5c52014-04-25 11:11:10 +02003764/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003765//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003766//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003767
Paul Bakker088c5c52014-04-25 11:11:10 +02003768/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003769//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3770//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3771//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3772//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3773//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003774
Paul Bakker088c5c52014-04-25 11:11:10 +02003775/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003776//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3777//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3778//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3779//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003780
Paul Bakker088c5c52014-04-25 11:11:10 +02003781/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003782//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003783//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003784
Paul Bakker088c5c52014-04-25 11:11:10 +02003785/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003786//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3787//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003788//#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 +01003789
Paul Bakker088c5c52014-04-25 11:11:10 +02003790/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003791//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003792
Paul Bakker088c5c52014-04-25 11:11:10 +02003793/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003794//#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 -04003795
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003796/** \def MBEDTLS_PLATFORM_STD_CALLOC
3797 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003798 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003799 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003800 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003801 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003802 * 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 -04003803 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3804 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003805 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003806 */
3807//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003808
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003809/** \def MBEDTLS_PLATFORM_STD_FREE
3810 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003811 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003812 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003813 * 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 -04003814 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3815 * 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 -04003816 */
3817//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003818//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003819//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003820//#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 +02003821//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3822//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003823/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003824//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003825//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3826//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003827//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3828//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3829//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003830
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003831/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003832/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003833//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3834//#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 +02003835//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003836//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003837//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3838//#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 +02003839//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3840//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003841/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003842//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003843//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003844//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3845//#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 +08003846//#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 +08003847//#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 +02003848
Gilles Peskine3f106f72021-09-23 17:42:39 +02003849/** \def MBEDTLS_CHECK_RETURN
3850 *
3851 * This macro is used at the beginning of the declaration of a function
3852 * to indicate that its return value should be checked. It should
3853 * instruct the compiler to emit a warning or an error if the function
3854 * is called without checking its return value.
3855 *
3856 * There is a default implementation for popular compilers in platform_util.h.
3857 * You can override the default implementation by defining your own here.
3858 *
3859 * If the implementation here is empty, this will effectively disable the
3860 * checking of functions' return values.
3861 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003862//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003863
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003864/** \def MBEDTLS_IGNORE_RETURN
3865 *
3866 * This macro requires one argument, which should be a C function call.
3867 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3868 * warning is suppressed.
3869 */
3870//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3871
Gilles Peskineed038902020-11-13 21:33:21 +01003872/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003873/**
Gilles Peskineed038902020-11-13 21:33:21 +01003874 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3875 * PSA crypto subsystem.
3876 *
3877 * If this option is unset:
3878 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003879 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003880 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3881 * on unspecified heuristics.
3882 */
3883//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3884
Steven Cooreman863470a2021-02-15 14:03:19 +01003885/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003886 * Restrict the PSA library to supporting a maximum amount of simultaneously
3887 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3888 * volatile key, or a persistent key which is loaded temporarily by the
3889 * library as part of a crypto operation in flight.
3890 *
3891 * If this option is unset, the library will fall back to a default value of
3892 * 32 keys.
3893 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003894//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003895
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003896/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003897//#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 +00003898
Paul Bakker088c5c52014-04-25 11:11:10 +02003899/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003900//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3901//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003902
Paul Bakker088c5c52014-04-25 11:11:10 +02003903/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003904
Angus Grattond8213d02016-05-25 20:56:48 +10003905/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3906 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003907 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003908 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003909 * This determines the size of the incoming TLS I/O buffer in such a way
3910 * that it is capable of holding the specified amount of plaintext data,
3911 * regardless of the protection mechanism used.
3912 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003913 * \note When using a value less than the default of 16KB on the client, it is
3914 * recommended to use the Maximum Fragment Length (MFL) extension to
3915 * inform the server about this limitation. On the server, there
3916 * is no supported, standardized way of informing the client about
3917 * restriction on the maximum size of incoming messages, and unless
3918 * the limitation has been communicated by other means, it is recommended
3919 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3920 * while keeping the default value of 16KB for the incoming buffer.
3921 *
David Horstmann95d516f2021-05-04 18:36:56 +01003922 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003923 */
3924//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3925
Gilles Peskined3d02902020-03-04 21:35:27 +01003926/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3927 *
3928 * The maximum length of CIDs used for incoming DTLS messages.
3929 *
3930 */
3931//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3932
3933/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3934 *
3935 * The maximum length of CIDs used for outgoing DTLS messages.
3936 *
3937 */
3938//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3939
TRodziewicze8dd7092021-05-12 14:19:11 +02003940/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003941 *
3942 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003943 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003944 *
3945 * The padding will always be chosen so that the length of the
3946 * padded plaintext is a multiple of the value of this option.
3947 *
3948 * Note: A value of \c 1 means that no padding will be used
3949 * for outgoing records.
3950 *
3951 * Note: On systems lacking division instructions,
3952 * a power of two should be preferred.
3953 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003954//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003955
Angus Grattond8213d02016-05-25 20:56:48 +10003956/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3957 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003958 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003959 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003960 * This determines the size of the outgoing TLS I/O buffer in such a way
3961 * that it is capable of holding the specified amount of plaintext data,
3962 * regardless of the protection mechanism used.
3963 *
Angus Grattond8213d02016-05-25 20:56:48 +10003964 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3965 * the default inward 16384 byte buffer to conform to the TLS specification.
3966 *
3967 * The minimum required outward buffer size is determined by the handshake
3968 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3969 * The specific size requirement depends on the configured ciphers and any
3970 * certificate data which is sent during the handshake.
3971 *
David Horstmann95d516f2021-05-04 18:36:56 +01003972 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003973 */
3974//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3975
Hanno Beckere0b150f2018-08-21 15:51:03 +01003976/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3977 *
3978 * Maximum number of heap-allocated bytes for the purpose of
3979 * DTLS handshake message reassembly and future message buffering.
3980 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003981 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003982 * to account for a reassembled handshake message of maximum size,
3983 * together with its reassembly bitmap.
3984 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003985 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003986 * should be sufficient for all practical situations as it allows
3987 * to reassembly a large handshake message (such as a certificate)
3988 * while buffering multiple smaller handshake messages.
3989 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003990 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003991//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003992
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003993//#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 +02003994//#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 +02003995
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003996/**
3997 * Complete list of ciphersuites to use, in order of preference.
3998 *
3999 * \warning No dependency checking is done on that field! This option can only
4000 * be used to restrict the set of available ciphersuites. It is your
4001 * responsibility to make sure the needed modules are active.
4002 *
4003 * Use this to save a few hundred bytes of ROM (default ordering of all
4004 * available ciphersuites) and a few to a few hundred bytes of RAM.
4005 *
4006 * The value below is only an example, not the default.
4007 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004008//#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 +02004009
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004010/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004011 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4012 *
4013 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004014 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004015 *
4016 * It must be positive and smaller than UINT32_MAX.
4017 *
4018 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4019 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004020 */
4021//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4022
4023/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004024 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4025 *
Jerry Yucf913512023-11-14 11:06:52 +08004026 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004027 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004028 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004029 * - The client ticket age is the time difference between the time when the
4030 * client proposes to the server to use the ticket and the time the client
4031 * received the ticket from the server.
4032 * - The server ticket age is the time difference between the time when the
4033 * server receives a proposition from the client to use the ticket and the
4034 * time when the ticket was created by the server.
4035 *
Jerry Yucf913512023-11-14 11:06:52 +08004036 * The ages might be different due to the client and server clocks not running
4037 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4038 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4039 * 6s, thus in the worst case clients and servers must sync up their system time
4040 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004041 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004042 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004043 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004044//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004045
4046/**
4047 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4048 *
4049 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4050 *
4051 * This must be less than 256.
4052 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004053//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004054
4055/**
4056 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4057 *
4058 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4059 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4060 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4061 *
4062 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004063//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004064
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004065/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004066//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004067//#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 +01004068
Gilles Peskine611179c2022-04-13 23:04:48 +02004069/** \} name SECTION: Module configuration options */