blob: 975b23c7f1b937c0febb53ab085ee882d0cef46a [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/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200354 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200355 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200356 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200357 * hardware entropy collector.
358 *
359 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000360 * prototype as declared in library/entropy_poll.h, and accept NULL as first
361 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200362 *
363 * Uncomment to use your own hardware entropy collector.
364 */
365//#define MBEDTLS_ENTROPY_HARDWARE_ALT
366
367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000369 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100370 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000371 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100372 * Uncomment this macro to use precomputed AES tables stored in ROM.
373 * Comment this macro to generate AES tables in RAM at runtime.
374 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100375 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
376 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100377 * initialization time before the first AES operation can be performed.
378 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
379 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
380 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100381 *
382 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000385
386/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100387 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200388 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100389 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200390 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100391 * Uncommenting this macro omits 75% of the AES tables from
392 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
393 * by computing their values on the fly during operations
394 * (the tables are entry-wise rotations of one another).
395 *
396 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100397 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100398 * runtime. Specifically, one has to compare 4 accesses within
399 * different tables to 4 accesses with additional arithmetic
400 * operations within the same table. The performance gain/loss
401 * depends on the system and memory details.
402 *
403 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200404 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100405//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200406
407/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800408 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
409 *
410 * Use only 128-bit keys in AES operations to save ROM.
411 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800412 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800413 * or 256-bit keys.
414 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800415 * Uncommenting this macro reduces the size of AES code by ~300 bytes
416 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800417 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800418 * Module: library/aes.c
419 *
420 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800421 */
422//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
423
Gilles Peskinea8861e02023-09-05 20:20:51 +0200424/*
425 * Disable plain C implementation for AES.
426 *
427 * When the plain C implementation is enabled, and an implementation using a
428 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
429 * detection will be used to select between them.
430 *
431 * If only one implementation is present, runtime detection will not be used.
432 * This configuration will crash at runtime if running on a CPU without the
433 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
434 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
435 */
436//#define MBEDTLS_AES_USE_HARDWARE_ONLY
437
Arto Kinnunen732ca322023-04-14 14:26:10 +0800438/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200440 *
441 * Use less ROM for the Camellia implementation (saves about 768 bytes).
442 *
443 * Uncomment this macro to use less memory for Camellia.
444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200446
447/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200448 * \def MBEDTLS_CHECK_RETURN_WARNING
449 *
450 * If this macro is defined, emit a compile-time warning if application code
451 * calls a function without checking its return value, but the return value
452 * should generally be checked in portable applications.
453 *
454 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
455 * implemented. Otherwise this option has no effect.
456 *
457 * Uncomment to get warnings on using fallible functions without checking
458 * their return value.
459 *
460 * \note This feature is a work in progress.
461 * Warnings will be added to more functions in the future.
462 *
463 * \note A few functions are considered critical, and ignoring the return
464 * value of these functions will trigger a warning even if this
465 * macro is not defined. To completely disable return value check
466 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
467 */
468//#define MBEDTLS_CHECK_RETURN_WARNING
469
470/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200471 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200472 *
473 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200475#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200476
477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000479 *
480 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000483
484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200485 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000486 *
487 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200489#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000490
491/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100492 * \def MBEDTLS_CIPHER_MODE_OFB
493 *
494 * Enable Output Feedback mode (OFB) for symmetric ciphers.
495 */
496#define MBEDTLS_CIPHER_MODE_OFB
497
498/**
499 * \def MBEDTLS_CIPHER_MODE_XTS
500 *
501 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
502 */
503#define MBEDTLS_CIPHER_MODE_XTS
504
505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200506 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000507 *
508 * Enable NULL cipher.
509 * Warning: Only do so when you know what you are doing. This allows for
510 * encryption or channels without any security!
511 *
Ronald Croncee42702021-04-26 11:34:44 +0200512 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
514 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
515 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
516 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
517 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
518 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
519 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
520 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
521 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
522 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
523 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
524 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
525 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
527 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
528 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000529 *
530 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000531 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200532//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000533
534/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100535 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200536 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100537 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
538 * specific padding modes in the cipher layer with cipher modes that support
539 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200540 *
541 * If you disable all padding modes, only full blocks can be used with CBC.
542 *
543 * Enable padding modes in the cipher layer.
544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545#define MBEDTLS_CIPHER_PADDING_PKCS7
546#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
547#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
548#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200549
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200550/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
551 *
552 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800553 * Without this, CTR_DRBG uses a 256-bit key
554 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200555 */
556//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
557
Paul Bakker48e93c82013-08-14 12:21:18 +0200558/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200559 * Enable the verified implementations of ECDH primitives from Project Everest
560 * (currently only Curve25519). This feature changes the layout of ECDH
561 * contexts and therefore is a compatibility break for applications that access
562 * fields of a mbedtls_ecdh_context structure directly. See also
563 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000564 *
565 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
566 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200567 */
568//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
569
570/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100571 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200572 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100573 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
574 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200575 *
576 * Comment macros to disable the curve and functions for it
577 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200578/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200579#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
580#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
581#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
582#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
583#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
584#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
585#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
586#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
587#define MBEDTLS_ECP_DP_BP256R1_ENABLED
588#define MBEDTLS_ECP_DP_BP384R1_ENABLED
589#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200590/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200591#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000592#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200593
594/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200595 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200596 *
597 * Enable specific 'modulo p' routines for each NIST prime.
598 * Depending on the prime and architecture, makes operations 4 to 8 times
599 * faster on the corresponding curve.
600 *
601 * Comment this macro to disable NIST curves optimisation.
602 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200604
605/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200606 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100607 *
608 * Enable "non-blocking" ECC operations that can return early and be resumed.
609 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200610 * This allows various functions to pause by returning
611 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
612 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
613 * order to further progress and eventually complete their operation. This is
614 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
615 * number of ECC operations a function may perform before pausing; see
616 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100617 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200618 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200619 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100620 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100621 * This option:
622 * - Adds xxx_restartable() variants of existing operations in the
623 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100624 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
625 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100626 * - ECDSA: signature generation & verification;
627 * - PK: signature generation & verification;
628 * - X509: certificate chain verification.
629 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
630 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
631 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
632 * computations restartable:
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100633 * - verification of the server's key exchange signature;
634 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100635 * - generation of the client's signature if client authentication is used,
636 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100637 *
638 * \note In the cases above, the usual SSL/TLS functions, such as
639 * mbedtls_ssl_handshake(), can now return
640 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200641 *
Janos Follath277bba82024-11-19 16:14:00 +0000642 * \note When this option is enabled, restartable operations in PK, X.509
643 * and TLS (see above) are not using PSA. On the other hand, ECDH
644 * computations in TLS are using PSA, and are not restartable. These
Janos Follath2761d182024-12-02 13:58:15 +0000645 * are temporary limitations that should be lifted in the future. (See
646 * https://github.com/Mbed-TLS/mbedtls/issues/9784 and
647 * https://github.com/Mbed-TLS/mbedtls/issues/9817)
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200648 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100649 * Requires: MBEDTLS_ECP_C
650 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100651 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100652 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200653//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100654
655/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200656 * Uncomment to enable using new bignum code in the ECC modules.
657 *
658 * \warning This is currently experimental, incomplete and therefore should not
659 * be used in production.
660 */
661//#define MBEDTLS_ECP_WITH_MPI_UINT
662
663/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200664 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100665 *
666 * Enable deterministic ECDSA (RFC 6979).
667 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
668 * may result in a compromise of the long-term signing key. This is avoided by
669 * the deterministic variant.
670 *
John Durkop36a82e52020-10-26 09:39:05 -0700671 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100672 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100673 * Comment this macro to disable deterministic ECDSA.
674 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100676
677/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200678 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200679 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200680 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200681 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200682 * This enables the following ciphersuites (if other requisites are
683 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
685 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
686 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
687 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
688 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
689 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
690 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
691 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
692 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
693 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200694 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200696
697/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200698 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200699 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200700 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200701 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200703 *
704 * This enables the following ciphersuites (if other requisites are
705 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
707 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
708 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
709 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
710 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
711 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
712 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
713 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
714 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
715 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100716 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100717 * \warning Using DHE constitutes a security risk as it
718 * is not possible to validate custom DH parameters.
719 * If possible, it is recommended users should consider
720 * preferring other methods of key exchange.
721 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100722 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200723 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200725
726/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200727 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200728 *
729 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
730 *
Janos Follath277bba82024-11-19 16:14:00 +0000731 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200732 *
733 * This enables the following ciphersuites (if other requisites are
734 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200735 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
736 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
737 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
738 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
739 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
740 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200741 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200742#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200743
744/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200746 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200747 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200748 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200749 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
750 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200751 *
752 * This enables the following ciphersuites (if other requisites are
753 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200754 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
755 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
756 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
757 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
758 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
759 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
760 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
761 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
762 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
763 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
764 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
765 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200766 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200768
769/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200770 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200771 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200772 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200773 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200774 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
775 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200776 *
777 * This enables the following ciphersuites (if other requisites are
778 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200779 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
780 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
781 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
782 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
783 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
784 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
785 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
786 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
787 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
788 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
789 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
790 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100791 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100792 * \warning Using DHE constitutes a security risk as it
793 * is not possible to validate custom DH parameters.
794 * If possible, it is recommended users should consider
795 * preferring other methods of key exchange.
796 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100797 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200798 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200799#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200800
801/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200803 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200804 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200805 *
Janos Follath277bba82024-11-19 16:14:00 +0000806 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200807 * MBEDTLS_RSA_C
808 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200810 *
811 * This enables the following ciphersuites (if other requisites are
812 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
814 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
815 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
816 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
817 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
818 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
819 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
820 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
821 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
822 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200823 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200824#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200825
826/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200827 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200828 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200829 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200830 *
Janos Follath277bba82024-11-19 16:14:00 +0000831 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
832 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200833 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200834 *
835 * This enables the following ciphersuites (if other requisites are
836 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
838 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
839 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
840 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
841 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
842 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
843 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
844 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
845 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
846 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200847 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200848#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200849
850/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200851 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100852 *
853 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
854 *
Janos Follath277bba82024-11-19 16:14:00 +0000855 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
856 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200857 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100858 *
859 * This enables the following ciphersuites (if other requisites are
860 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200861 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
862 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
863 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
864 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
865 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
866 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
867 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
868 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
869 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
870 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100873
874/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100876 *
877 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
878 *
Janos Follath277bba82024-11-19 16:14:00 +0000879 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200880 * MBEDTLS_RSA_C
881 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100882 *
883 * This enables the following ciphersuites (if other requisites are
884 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
886 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
887 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
888 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
889 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
890 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
891 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
892 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
893 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
894 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100895 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100897
898/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200899 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
900 *
901 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
902 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200903 * \warning This is currently experimental. EC J-PAKE support is based on the
904 * Thread v1.0.0 specification; incompatible changes to the specification
905 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200906 *
Janos Follath277bba82024-11-19 16:14:00 +0000907 * Requires: MBEDTLS_ECJPAKE_C or PSA_WANT_ALG_JPAKE
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100908 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200909 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
910 *
911 * This enables the following ciphersuites (if other requisites are
912 * enabled as well):
913 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
914 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200915//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200916
917/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100919 *
920 * Enhance support for reading EC keys using variants of SEC1 not allowed by
921 * RFC 5915 and RFC 5480.
922 *
923 * Currently this means parsing the SpecifiedECDomain choice of EC
924 * parameters (only known groups are supported, not arbitrary domains, to
925 * avoid validation issues).
926 *
927 * Disable if you only need to support RFC 5915 + 5480 key formats.
928 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200929#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100930
931/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200932 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
933 *
934 * Enable the support for parsing public keys of type Short Weierstrass
935 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200936 * compressed point format. This parsing is done through ECP module's functions.
937 *
938 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
939 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
940 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200941 */
942#define MBEDTLS_PK_PARSE_EC_COMPRESSED
943
944/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100946 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947 * Enable a dummy error function to make use of mbedtls_strerror() in
948 * third party libraries easier when MBEDTLS_ERROR_C is disabled
949 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200950 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200951 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
952 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100953 *
954 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100956 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100958
959/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200960 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000961 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +0200962 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200963 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200966#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +0000967
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000970 *
971 * Enable functions that use the filesystem.
972 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200973#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000974
975/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200976 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000977 *
TRodziewicz15a7b732021-06-16 11:22:53 +0200978 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +0000979 *
Shuo Chen95a0d112014-04-04 21:04:40 -0700980 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +0000981 * application.
982 *
983 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +0000984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000986
987/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +0000989 *
990 * Do not use built-in platform entropy functions.
991 * This is useful if your platform does not support
992 * standards like the /dev/urandom or Windows CryptoAPI.
993 *
994 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +0000995 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +0000997
998/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200999 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001000 *
1001 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1002 * default SHA-512 based one (if both are available).
1003 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001005 *
1006 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1007 * if you have performance concerns.
1008 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 * This option is only useful if both MBEDTLS_SHA256_C and
1010 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001011 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001013
1014/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001015 * \def MBEDTLS_ENTROPY_NV_SEED
1016 *
1017 * Enable the non-volatile (NV) seed file-based entropy source.
1018 * (Also enables the NV seed read/write functions in the platform layer)
1019 *
1020 * This is crucial (if not required) on systems that do not have a
1021 * cryptographic entropy source (in hardware or kernel) available.
1022 *
1023 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1024 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001025 * \note The read/write functions that are used by the entropy source are
1026 * determined in the platform layer, and can be modified at runtime and/or
1027 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1028 *
1029 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001030 * with regular fopen(), please make sure you make a seedfile with the
1031 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1032 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001033 * and written to or you will get an entropy source error! The default
1034 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1035 * bytes from the file.
1036 *
1037 * \note The entropy collector will write to the seed file before entropy is
1038 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001039 */
1040//#define MBEDTLS_ENTROPY_NV_SEED
1041
Ronald Cron71016a92020-08-28 19:01:50 +02001042/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001043 *
Ronald Cron71016a92020-08-28 19:01:50 +02001044 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001045 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001046 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1047 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001048 *
1049 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001050 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001051 */
Ronald Cron71016a92020-08-28 19:01:50 +02001052//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001053
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001054/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001056 *
1057 * Enable debugging of buffer allocator memory issues. Automatically prints
1058 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1059 * function for 'debug output' of allocated memory.
1060 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001062 *
1063 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001065//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001066
1067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001069 *
1070 * Include backtrace information with each allocated block.
1071 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001072 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001073 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001074 *
1075 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001078
1079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001081 *
1082 * Support external private RSA keys (eg from a HSM) in the PK layer.
1083 *
1084 * Comment this macro to disable support for external private RSA keys.
1085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001087
1088/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001090 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001091 * Enable support for PKCS#1 v1.5 encoding.
1092 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001093 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001094 *
Paul Bakker48377d92013-08-30 12:06:24 +02001095 * This enables support for PKCS#1 v1.5 operations.
1096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001098
1099/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001101 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001102 * Enable support for PKCS#1 v2.1 encoding.
1103 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001104 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001105 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001106 * \warning If using a hash that is only provided by PSA drivers, you must
1107 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001108 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001109 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1110 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001111#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001112
Steven Cooreman6801f082021-02-19 17:21:22 +01001113/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1114 *
1115 * Enable support for platform built-in keys. If you enable this feature,
1116 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1117 * See the documentation of that function for more information.
1118 *
1119 * Built-in keys are typically derived from a hardware unique key or
1120 * stored in a secure element.
1121 *
1122 * Requires: MBEDTLS_PSA_CRYPTO_C.
1123 *
1124 * \warning This interface is experimental and may change or be removed
1125 * without notice.
1126 */
1127//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1128
Ronald Cron3768ac12021-01-26 16:58:00 +01001129/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1130 *
1131 * Enable support for PSA crypto client.
1132 *
1133 * \note This option allows to include the code necessary for a PSA
1134 * crypto client when the PSA crypto implementation is not included in
1135 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1136 * code to set and get PSA key attributes.
1137 * The development of PSA drivers partially relying on the library to
1138 * fulfill the hardware gaps is another possible usage of this option.
1139 *
1140 * \warning This interface is experimental and may change or be removed
1141 * without notice.
1142 */
1143//#define MBEDTLS_PSA_CRYPTO_CLIENT
1144
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001145/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1146 *
1147 * Make the PSA Crypto module use an external random generator provided
1148 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1149 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001150 * \note This random generator must deliver random numbers with cryptographic
1151 * quality and high performance. It must supply unpredictable numbers
1152 * with a uniform distribution. The implementation of this function
1153 * is responsible for ensuring that the random generator is seeded
1154 * with sufficient entropy. If you have a hardware TRNG which is slow
1155 * or delivers non-uniform output, declare it as an entropy source
1156 * with mbedtls_entropy_add_source() instead of enabling this option.
1157 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001158 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001159 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1160 * and define a function called mbedtls_psa_external_get_random()
1161 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001162 * ```
1163 * psa_status_t mbedtls_psa_external_get_random(
1164 * mbedtls_psa_external_random_context_t *context,
1165 * uint8_t *output, size_t output_size, size_t *output_length);
1166 * );
1167 * ```
1168 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001169 * The function must fill the \c output buffer with \c output_size bytes
1170 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001171 *
1172 * Requires: MBEDTLS_PSA_CRYPTO_C
1173 *
1174 * \warning If you enable this option, code that uses the PSA cryptography
1175 * interface will not use any of the entropy sources set up for
1176 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1177 * enables.
1178 *
1179 * \note This option is experimental and may be removed without notice.
1180 */
1181//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1182
Paul Bakker9dcc3222011-03-08 14:16:06 +00001183/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001184 * \def MBEDTLS_PSA_CRYPTO_SPM
1185 *
1186 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1187 * Partition Manager) integration which separates the code into two parts: a
1188 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1189 * Environment).
1190 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001191 * If you enable this option, your build environment must include a header
1192 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1193 * header files, or in another directory on the compiler's include search
1194 * path). Alternatively, your platform may customize the header
1195 * `psa/crypto_platform.h`, in which case it can skip or replace the
1196 * inclusion of `"crypto_spe.h"`.
1197 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001198 * Module: library/psa_crypto.c
1199 * Requires: MBEDTLS_PSA_CRYPTO_C
1200 *
1201 */
1202//#define MBEDTLS_PSA_CRYPTO_SPM
1203
1204/**
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02001205 * \def MBEDTLS_PSA_KEY_STORE_DYNAMIC
1206 *
1207 * Dynamically resize the PSA key store to accommodate any number of
1208 * volatile keys (until the heap memory is exhausted).
1209 *
1210 * If this option is disabled, the key store has a fixed size
1211 * #MBEDTLS_PSA_KEY_SLOT_COUNT for volatile keys and loaded persistent keys
1212 * together.
1213 *
1214 * This option has no effect when #MBEDTLS_PSA_CRYPTO_C is disabled.
1215 *
1216 * Module: library/psa_crypto.c
1217 * Requires: MBEDTLS_PSA_CRYPTO_C
1218 */
1219#define MBEDTLS_PSA_KEY_STORE_DYNAMIC
1220
1221/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001222 * Uncomment to enable p256-m. This is an alternative implementation of
1223 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1224 * Compared to the default implementation:
1225 *
1226 * - p256-m has a much smaller code size and RAM footprint.
Janos Follath277bba82024-11-19 16:14:00 +00001227 * - p256-m is only available via the PSA API. This includes the pk module.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001228 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1229 * over the core arithmetic, or deterministic derivation of keys.
1230 *
1231 * We recommend enabling this option if your application uses the PSA API
1232 * and the only elliptic curve support it needs is ECDH and ECDSA over
1233 * SECP256R1.
1234 *
1235 * If you enable this option, you do not need to enable any ECC-related
1236 * MBEDTLS_xxx option. You do need to separately request support for the
1237 * cryptographic mechanisms through the PSA API:
Ronald Cron93ba6252024-09-05 10:37:14 +02001238 * - #MBEDTLS_PSA_CRYPTO_C for PSA-based configuration;
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001239 * - #PSA_WANT_ECC_SECP_R1_256;
1240 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1241 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1242 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1243 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1244 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001245 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001246 * \note To benefit from the smaller code size of p256-m, make sure that you
1247 * do not enable any ECC-related option not supported by p256-m: this
1248 * would cause the built-in ECC implementation to be built as well, in
1249 * order to provide the required option.
1250 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001251 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1252 * SECP256R1 are disabled as they are not supported by this driver.
1253 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1254 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001255 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001256 */
1257//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1258
1259/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001260 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001261 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001262 * Enable support for entropy injection at first boot. This feature is
1263 * required on systems that do not have a built-in entropy source (TRNG).
1264 * This feature is currently not supported on systems that have a built-in
1265 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001266 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001267 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001268 *
1269 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001270//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001271
1272/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001273 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001274 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001275 * Assume all buffers passed to PSA functions are owned exclusively by the
1276 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001277 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001278 * This option may be enabled if all buffers passed to any PSA function reside
1279 * in memory that is accessible only to the PSA function during its execution.
1280 *
1281 * This option MUST be disabled whenever buffer arguments are in memory shared
1282 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001283 * across a trust boundary.
1284 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001285 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001286 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001287 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001288 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001289 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001290//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001291
1292/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001293 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001294 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001295 * Do not use the Chinese Remainder Theorem
1296 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001297 *
1298 * Uncomment this macro to disable the use of CRT in RSA.
1299 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001300 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001302
1303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001304 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001305 *
1306 * Enable the checkup functions (*_self_test).
1307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001309
1310/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001311 * \def MBEDTLS_SHA256_SMALLER
1312 *
1313 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1314 * lower performance.
1315 *
Adam Wolf039080f2019-09-10 09:53:08 -05001316 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001317 * performance and size. This version optimizes more aggressively for size at
1318 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1319 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1320 * 30%.
1321 *
1322 * Uncomment to enable the smaller implementation of SHA256.
1323 */
1324//#define MBEDTLS_SHA256_SMALLER
1325
1326/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001327 * \def MBEDTLS_SHA512_SMALLER
1328 *
1329 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1330 * lower performance.
1331 *
1332 * Uncomment to enable the smaller implementation of SHA512.
1333 */
1334//#define MBEDTLS_SHA512_SMALLER
1335
1336/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001337 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001338 *
1339 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001340 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001341 * with other servers, only debugging of failures is harder.
1342 *
1343 * The advantage of not sending alert messages, is that no information is given
1344 * about reasons for failures thus preventing adversaries of gaining intel.
1345 *
1346 * Enable sending of all alert messages
1347 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001349
1350/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001351 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1352 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001353 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001354 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001355 * in the underlying transport. The CID functionality is described
1356 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001357 *
1358 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001359 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1360 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1361 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001362 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001363 * The maximum lengths of outgoing and incoming CIDs can be configured
1364 * through the options
1365 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1366 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1367 *
1368 * Requires: MBEDTLS_SSL_PROTO_DTLS
1369 *
1370 * Uncomment to enable the Connection ID extension.
1371 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001372#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1373
1374
1375/**
1376 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1377 *
1378 * Defines whether RFC 9146 (default) or the legacy version
1379 * (version draft-ietf-tls-dtls-connection-id-05,
1380 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1381 * is used.
1382 *
1383 * Set the value to 0 for the standard version, and
1384 * 1 for the legacy draft version.
1385 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001386 * \deprecated Support for the legacy version of the DTLS
1387 * Connection ID feature is deprecated. Please
1388 * switch to the standardized version defined
1389 * in RFC 9146 enabled by utilizing
1390 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1391 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1392 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001393 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1394 */
1395#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001396
1397/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001398 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1399 *
1400 * Enable asynchronous external private key operations in SSL. This allows
1401 * you to configure an SSL connection to call an external cryptographic
1402 * module to perform private key operations instead of performing the
1403 * operation inside the library.
1404 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001405 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001406 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001407//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001408
1409/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001410 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1411 *
1412 * Enable serialization of the TLS context structures, through use of the
1413 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1414 *
1415 * This pair of functions allows one side of a connection to serialize the
1416 * context associated with the connection, then free or re-use that context
1417 * while the serialized state is persisted elsewhere, and finally deserialize
1418 * that state to a live context for resuming read/write operations on the
1419 * connection. From a protocol perspective, the state of the connection is
1420 * unaffected, in particular this is entirely transparent to the peer.
1421 *
1422 * Note: this is distinct from TLS session resumption, which is part of the
1423 * protocol and fully visible by the peer. TLS session resumption enables
1424 * establishing new connections associated to a saved session with shorter,
1425 * lighter handshakes, while context serialization is a local optimization in
1426 * handling a single, potentially long-lived connection.
1427 *
1428 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1429 * saved after the handshake to allow for more efficient serialization, so if
1430 * you don't need this feature you'll save RAM by disabling it.
1431 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001432 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1433 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001434 * Comment to disable the context serialization APIs.
1435 */
1436#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1437
1438/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001439 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001440 *
1441 * Enable the debug messages in SSL module for all issues.
1442 * Debug messages have been disabled in some places to prevent timing
1443 * attacks due to (unbalanced) debugging function calls.
1444 *
1445 * If you need all error reporting you should enable this during debugging,
1446 * but remove this for production servers that should log as well.
1447 *
1448 * Uncomment this macro to report all debug messages on errors introducing
1449 * a timing side-channel.
1450 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001451 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001453
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001454/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001455 *
1456 * Enable support for Encrypt-then-MAC, RFC 7366.
1457 *
1458 * This allows peers that both support it to use a more robust protection for
1459 * ciphersuites using CBC, providing deep resistance against timing attacks
1460 * on the padding or underlying cipher.
1461 *
1462 * This only affects CBC ciphersuites, and is useless if none is defined.
1463 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001464 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001465 *
1466 * Comment this macro to disable support for Encrypt-then-MAC
1467 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001468#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001470/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001471 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001472 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1473 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001474 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001475 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001476 * attacks, but it is recommended to always use it (even if you disable
1477 * renegotiation), since it actually fixes a more fundamental issue in the
1478 * original SSL/TLS design, and has implications beyond Triple Handshake.
1479 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001480 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001481 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001482 * Comment this macro to disable support for Extended Master Secret.
1483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001484#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001485
Paul Bakkerd66f0702013-01-31 16:57:45 +01001486/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001487 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1488 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001489 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001490 * giving access to the peer's certificate after completion of the handshake.
1491 *
1492 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1493 * recommended to disable this option for reduced RAM usage.
1494 *
1495 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1496 * defined, but always returns \c NULL.
1497 *
1498 * \note This option has no influence on the protection against the
1499 * triple handshake attack. Even if it is disabled, Mbed TLS will
1500 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001501 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001502 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001503 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001504 *
1505 * Comment this macro to disable storing the peer's certificate
1506 * after the handshake.
1507 */
1508#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1509
1510/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001511 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001512 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001513 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001514 *
1515 * The two main uses of renegotiation are (1) refresh keys on long-lived
1516 * connections and (2) client authentication after the initial handshake.
1517 * If you don't need renegotiation, it's probably better to disable it, since
1518 * it has been associated with security issues in the past and is easy to
1519 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001520 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001521 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1522 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001523 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001524 *
1525 * \note Even if this option is disabled, both client and server are aware
1526 * of the Renegotiation Indication Extension (RFC 5746) used to
1527 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1528 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1529 * configuration of this extension).
1530 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001531 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001532#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001533
1534/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001536 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001537 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001538 *
1539 * Comment this macro to disable support for the max_fragment_length extension
1540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001541#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001542
1543/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001544 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1545 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001546 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001547 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001548 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1549 *
1550 * Uncomment this macro to enable support for the record_size_limit extension
1551 */
1552//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1553
1554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001556 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001557 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001558 *
Janos Follath277bba82024-11-19 16:14:00 +00001559 * Requires: PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001560 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001561 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001562 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001563#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001564
1565/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001566 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001567 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001568 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001569 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001570 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001571 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001572 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001573 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001574 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001575 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001576 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001577 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001578#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001579
1580/**
Ronald Cronab65c522021-11-24 10:47:20 +01001581 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1582 *
1583 * Enable TLS 1.3 middlebox compatibility mode.
1584 *
1585 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1586 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1587 * expecting TLS 1.2 traffic.
1588 *
1589 * Turning on the compatibility mode comes at the cost of a few added bytes
1590 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1591 * that don't use it. Therefore, unless transmission bandwidth is critical and
1592 * you know that middlebox compatibility issues won't occur, it is therefore
1593 * recommended to set this option.
1594 *
1595 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001596 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1597 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001598 *
1599 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001600#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001601
1602/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001603 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1604 *
1605 * Enable TLS 1.3 PSK key exchange mode.
1606 *
1607 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1608 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1609 * effect on the build.
1610 *
1611 */
1612#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1613
1614/**
1615 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1616 *
1617 * Enable TLS 1.3 ephemeral key exchange mode.
1618 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001619 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001620 * MBEDTLS_X509_CRT_PARSE_C
1621 * and at least one of:
Janos Follath277bba82024-11-19 16:14:00 +00001622 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001623 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001624 *
1625 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1626 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1627 * effect on the build.
1628 *
1629 */
1630#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1631
1632/**
1633 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1634 *
1635 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1636 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001637 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001638 *
1639 * Comment to disable support for the PSK ephemeral key exchange mode in
1640 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1641 * have any effect on the build.
1642 *
1643 */
1644#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1645
1646/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 * \def MBEDTLS_SSL_EARLY_DATA
1648 *
1649 * Enable support for RFC 8446 TLS 1.3 early data.
1650 *
1651 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1652 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1653 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1654 *
1655 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1656 * is not enabled, this option does not have any effect on the build.
1657 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001658 * \note The maximum amount of early data can be set with
1659 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1660 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001662//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001663
1664/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001665 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001666 *
1667 * Enable support for DTLS (all available versions).
1668 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001669 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001670 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001671 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001672 *
1673 * Comment this macro to disable support for DTLS
1674 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001675#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001676
1677/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001678 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001679 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001680 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001681 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001682 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001683 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001685
1686/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001688 *
1689 * Enable support for the anti-replay mechanism in DTLS.
1690 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001691 * Requires: MBEDTLS_SSL_TLS_C
1692 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001693 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001694 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001695 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001696 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001697 * Comment this to disable anti-replay in DTLS.
1698 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001700
1701/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001703 *
1704 * Enable support for HelloVerifyRequest on DTLS servers.
1705 *
1706 * This feature is highly recommended to prevent DTLS servers being used as
1707 * amplifiers in DoS attacks against other hosts. It should always be enabled
1708 * unless you know for sure amplification cannot be a problem in the
1709 * environment in which your server operates.
1710 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001711 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001712 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001713 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001714 *
1715 * Comment this to disable support for HelloVerifyRequest.
1716 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001718
1719/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001720 * \def MBEDTLS_SSL_DTLS_SRTP
1721 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001722 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001723 * through the use_srtp extension.
1724 *
1725 * \note This feature provides the minimum functionality required
1726 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1727 * the associated SRTP packet protection key material.
1728 * In particular, the SRTP packet protection itself, as well as the
1729 * demultiplexing of RTP and DTLS packets at the datagram layer
1730 * (see Section 5 of RFC 5764), are not handled by this feature.
1731 * Instead, after successful completion of a handshake negotiating
1732 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001733 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001734 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1735 * (this is implemented in the SSL example programs).
1736 * The resulting key should then be passed to an SRTP stack.
1737 *
1738 * Setting this option enables the runtime API
1739 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1740 * through which the supported DTLS-SRTP protection
1741 * profiles can be configured. You must call this API at
1742 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001743 *
1744 * Requires: MBEDTLS_SSL_PROTO_DTLS
1745 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001746 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001747 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001748//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001749
1750/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001751 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1752 *
1753 * Enable server-side support for clients that reconnect from the same port.
1754 *
1755 * Some clients unexpectedly close the connection and try to reconnect using the
1756 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001757 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001758 * flag enables that support.
1759 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001760 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001761 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001762 * Comment this to disable support for clients reusing the source port.
1763 */
1764#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1765
1766/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001768 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001769 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001770 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001771 * session store remains the responsibility of the application, though).
1772 * Server-side, you also need to provide callbacks for writing and parsing
1773 * tickets, including authenticated encryption and key management. Example
1774 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001775 *
1776 * Comment this macro to disable support for SSL session tickets
1777 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001778#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001779
1780/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001781 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001782 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001783 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001784 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001785 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001786 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001787 * Comment this macro to disable support for server name indication in SSL
1788 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001789#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001790
1791/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001792 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1793 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001794 * When this option is enabled, the SSL buffer will be resized automatically
1795 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001796 *
1797 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001798 */
1799//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1800
1801/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001802 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1803 *
1804 * Enable testing of the constant-flow nature of some sensitive functions with
1805 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001806 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001807 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001808 * This setting requires compiling with clang -fsanitize=memory. The test
1809 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001810 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001811 * \warning This macro is only used for extended testing; it is not considered
1812 * part of the library's API, so it may change or disappear at any time.
1813 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001814 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001815 */
1816//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1817
1818/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001819 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1820 *
1821 * Enable testing of the constant-flow nature of some sensitive functions with
1822 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001823 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001824 *
1825 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001826 * testing if the tests suites are run with valgrind's memcheck. This can be
1827 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1828 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001829 *
1830 * \warning This macro is only used for extended testing; it is not considered
1831 * part of the library's API, so it may change or disappear at any time.
1832 *
1833 * Uncomment to enable testing of the constant-flow nature of selected code.
1834 */
1835//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1836
1837/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001838 * \def MBEDTLS_TEST_HOOKS
1839 *
1840 * Enable features for invasive testing such as introspection functions and
1841 * hooks for fault injection. This enables additional unit tests.
1842 *
1843 * Merely enabling this feature should not change the behavior of the product.
1844 * It only adds new code, and new branching points where the default behavior
1845 * is the same as when this feature is disabled.
1846 * However, this feature increases the attack surface: there is an added
1847 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1848 * Therefore this feature must never be enabled in production.
1849 *
1850 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1851 * information.
1852 *
1853 * Uncomment to enable invasive tests.
1854 */
1855//#define MBEDTLS_TEST_HOOKS
1856
1857/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001859 *
1860 * Provide your own alternate threading implementation.
1861 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001862 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001863 *
1864 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001865 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001867
1868/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001870 *
1871 * Enable the pthread wrapper layer for the threading layer.
1872 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001874 *
1875 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001876 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001878
1879/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001880 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001881 *
1882 * Allow run-time checking of compile-time enabled features. Thus allowing users
1883 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001885 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001887 *
1888 * Comment this to disable run-time checking and save ROM space
1889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001891
1892/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001893 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1894 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001895 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001896 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1897 * the set of trusted certificates through a callback instead of a linked
1898 * list.
1899 *
1900 * This is useful for example in environments where a large number of trusted
1901 * certificates is present and storing them in a linked list isn't efficient
1902 * enough, or when the set of trusted certificates changes frequently.
1903 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001904 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001905 * `mbedtls_ssl_conf_ca_cb()` for more information.
1906 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01001907 * Requires: MBEDTLS_X509_CRT_PARSE_C
1908 *
Hanno Becker288dedc2019-03-27 11:00:53 +00001909 * Uncomment to enable trusted certificate callbacks.
1910 */
1911//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1912
1913/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001914 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001915 *
Chris Jones2c745862020-12-16 11:41:06 +00001916 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001917 *
Chris Jones2c745862020-12-16 11:41:06 +00001918 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06001919 * and other functions/constants only used by these functions, thus reducing
1920 * the code footprint by several KB.
1921 */
Chris Jones2c745862020-12-16 11:41:06 +00001922//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001923
1924/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001925 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001926 *
1927 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1928 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1929 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03001930 * Requires: MBEDTLS_PKCS1_V21
1931 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001932 * Comment this macro to disallow using RSASSA-PSS in certificates.
1933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001934#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001935/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001936
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001937/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001938 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001939 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001940 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001941 * \{
1942 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001943
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001944/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001946 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01001947 * Enable AES-NI support on x86-64 or x86-32.
1948 *
1949 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01001950 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01001951 * - GCC, x86-64, target not explicitly supporting AESNI:
1952 * requires MBEDTLS_HAVE_ASM.
1953 * - GCC, x86-32, target not explicitly supporting AESNI:
1954 * not supported.
1955 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
1956 * For this assembly-less implementation, you must currently compile
1957 * `library/aesni.c` and `library/aes.c` with machine options to enable
1958 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
1959 * `clang -maes -mpclmul`.
1960 * - Non-x86 targets: this option is silently ignored.
1961 * - Other compilers: this option is silently ignored.
1962 *
1963 * \note
1964 * Above, "GCC" includes compatible compilers such as Clang.
1965 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001966 *
1967 * Module: library/aesni.c
1968 * Caller: library/aes.c
1969 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01001970 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001971 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01001972 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001973 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001975
1976/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08001977 * \def MBEDTLS_AESCE_C
1978 *
Dave Rodgman18838f62023-10-08 12:28:51 +01001979 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08001980 *
1981 * Module: library/aesce.c
1982 * Caller: library/aes.c
1983 *
Jerry Yuf015a932023-04-25 10:38:03 +08001984 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08001985 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00001986 * \warning Runtime detection only works on Linux. For non-Linux operating
1987 * system, Armv8-A Cryptographic Extensions must be supported by
1988 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08001989 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01001990 * \note Minimum compiler versions for this feature when targeting aarch64
1991 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
1992 * Minimum compiler versions for this feature when targeting 32-bit
1993 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08001994 *
1995 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
1996 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08001997 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01001998 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08001999 */
2000#define MBEDTLS_AESCE_C
2001
2002/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002004 *
2005 * Enable the AES block cipher.
2006 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002007 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002008 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002009 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002010 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002011 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002012 * This module enables the following ciphersuites (if other requisites are
2013 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002014 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2015 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2016 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2017 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2018 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2019 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2020 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2021 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2022 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2023 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2024 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2025 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2026 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2027 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2028 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2029 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2030 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2031 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2032 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2033 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2034 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2035 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2036 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2037 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2038 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2039 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2040 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2041 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2042 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2043 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2044 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2045 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2046 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2047 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2048 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2049 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2050 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2051 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2052 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2053 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2054 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2055 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2056 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2057 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2058 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2059 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002060 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2061 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2062 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2063 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2064 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2065 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002066 *
Paul Bakkercff68422013-09-15 20:43:33 +02002067 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002068 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002070
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002071/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002073 *
2074 * Enable the generic ASN1 parser.
2075 *
2076 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002077 * Caller: library/x509.c
2078 * library/dhm.c
2079 * library/pkcs12.c
2080 * library/pkcs5.c
2081 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002082 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002083#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002084
2085/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002087 *
2088 * Enable the generic ASN1 writer.
2089 *
2090 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002091 * Caller: library/ecdsa.c
2092 * library/pkwrite.c
2093 * library/x509_create.c
2094 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002095 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002097#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002098
2099/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002100 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002101 *
2102 * Enable the Base64 module.
2103 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002104 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002105 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002106 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002107 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002110
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002111/**
Yanray Wange367e472023-10-31 17:23:04 +08002112 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2113 *
2114 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2115 *
2116 * \note This feature is incompatible with insecure block cipher,
2117 * MBEDTLS_DES_C, and cipher modes which always require decryption
2118 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Ronald Cron93ba6252024-09-05 10:37:14 +02002119 * MBEDTLS_NIST_KW_C. This feature is incompatible with following
2120 * supported PSA equivalence PSA_WANT_ALG_ECB_NO_PADDING,
2121 * PSA_WANT_ALG_CBC_NO_PADDING, PSA_WANT_ALG_CBC_PKCS7 and
2122 * PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002123 *
2124 * Module: library/aes.c
2125 * library/aesce.c
2126 * library/aesni.c
2127 * library/aria.c
2128 * library/camellia.c
2129 * library/cipher.c
2130 */
2131//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2132
2133/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002134 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002135 *
Paul Bakker9a736322012-11-14 12:39:52 +00002136 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002137 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002138 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002139 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002140 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002141 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002142 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002143 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002144 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002145 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002146 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002147 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002148 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002149 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002152
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002153/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002155 *
2156 * Enable the Camellia block cipher.
2157 *
Paul Bakker38119b12009-01-10 23:31:23 +00002158 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002159 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002160 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002161 * This module enables the following ciphersuites (if other requisites are
2162 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2164 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2165 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2166 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2167 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2168 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2169 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2170 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2171 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2172 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2173 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2174 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2175 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2176 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2177 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2178 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2179 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2180 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2181 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2182 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2183 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2184 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2185 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2186 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2187 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2188 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2189 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2190 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2191 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2192 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2193 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2194 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2195 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2196 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2198 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2199 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2200 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002201 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002202#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002203
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002204/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002205 * \def MBEDTLS_ARIA_C
2206 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002207 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002208 *
2209 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002210 * Caller: library/cipher.c
2211 *
2212 * This module enables the following ciphersuites (if other requisites are
2213 * enabled as well):
2214 *
2215 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2216 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2217 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2218 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2219 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2220 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2221 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2222 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2223 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2224 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2225 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2226 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2227 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2228 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2229 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2230 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2231 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2232 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2233 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2234 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2235 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2236 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2237 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2238 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2239 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2240 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2241 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2242 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002243 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2244 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2245 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2246 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002247 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2248 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002249 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002250#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002251
2252/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002254 *
2255 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2256 *
2257 * Module: library/ccm.c
2258 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002259 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2260 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002261 *
2262 * This module enables the AES-CCM ciphersuites, if other requisites are
2263 * enabled as well.
2264 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002265#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002266
2267/**
Daniel King34b822c2016-05-15 17:28:08 -03002268 * \def MBEDTLS_CHACHA20_C
2269 *
2270 * Enable the ChaCha20 stream cipher.
2271 *
2272 * Module: library/chacha20.c
2273 */
2274#define MBEDTLS_CHACHA20_C
2275
2276/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002277 * \def MBEDTLS_CHACHAPOLY_C
2278 *
2279 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2280 *
2281 * Module: library/chachapoly.c
2282 *
2283 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2284 */
2285#define MBEDTLS_CHACHAPOLY_C
2286
2287/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002288 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002289 *
2290 * Enable the generic cipher layer.
2291 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002292 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002293 * Caller: library/ccm.c
2294 * library/cmac.c
2295 * library/gcm.c
2296 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002297 * library/pkcs12.c
2298 * library/pkcs5.c
2299 * library/psa_crypto_aead.c
2300 * library/psa_crypto_mac.c
2301 * library/ssl_ciphersuites.c
2302 * library/ssl_msg.c
Valerio Settid5cab812023-12-28 10:04:51 +01002303 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2304 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002305 *
2306 * Uncomment to enable generic cipher wrappers.
2307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002308#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002309
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002310/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002311 * \def MBEDTLS_CMAC_C
2312 *
Simon Butcher327398a2016-10-05 14:09:11 +01002313 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2314 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002315 *
2316 * Module: library/cmac.c
2317 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002318 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002319 *
2320 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002321#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002322
2323/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002325 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002326 * Enable the CTR_DRBG AES-based random generator.
2327 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002328 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002329 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002330 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002331 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2332 * is used.
2333 *
2334 * \warning When using PSA, the user should call `psa_crypto_init()` before
2335 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2336 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002337 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2338 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002339 * \note To achieve a 256-bit security strength with CTR_DRBG,
2340 * you must use AES-256 *and* use sufficient entropy.
2341 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002342 *
2343 * Module: library/ctr_drbg.c
2344 * Caller:
2345 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002346 * Requires: MBEDTLS_AES_C or
2347 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2348 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002349 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002350 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002352#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002353
2354/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002355 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002356 *
2357 * Enable the debug functions.
2358 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002359 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002360 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002361 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002362 * library/ssl_tls12_*.c
2363 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002364 *
2365 * This module provides debugging functions.
2366 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002367#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002368
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002371 *
2372 * Enable the DES block cipher.
2373 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002374 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002375 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002376 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002377 *
Paul Bakkercff68422013-09-15 20:43:33 +02002378 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002379 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002380 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002381 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002382 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002383#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002384
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002385/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002386 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002387 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002388 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002389 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002390 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002391 * Caller: library/ssl_tls.c
2392 * library/ssl*_client.c
2393 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002394 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002395 * This module is used by the following key exchanges:
2396 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002397 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002398 * \warning Using DHE constitutes a security risk as it
2399 * is not possible to validate custom DH parameters.
2400 * If possible, it is recommended users should consider
2401 * preferring other methods of key exchange.
2402 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002403 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002404 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002405#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002406
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002407/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002409 *
2410 * Enable the elliptic curve Diffie-Hellman library.
2411 *
2412 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002413 * Caller: library/psa_crypto.c
2414 * library/ssl_tls.c
2415 * library/ssl*_client.c
2416 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002417 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002418 * This module is used by the following key exchanges:
2419 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002420 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002424
2425/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002427 *
2428 * Enable the elliptic curve DSA library.
2429 *
2430 * Module: library/ecdsa.c
2431 * Caller:
2432 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002433 * This module is used by the following key exchanges:
2434 * ECDHE-ECDSA
2435 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002436 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2437 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2438 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002439 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002440#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002441
2442/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002443 * \def MBEDTLS_ECJPAKE_C
2444 *
2445 * Enable the elliptic curve J-PAKE library.
2446 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002447 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2448 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002449 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002450 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002451 * Module: library/ecjpake.c
2452 * Caller:
2453 *
2454 * This module is used by the following key exchanges:
2455 * ECJPAKE
2456 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002457 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002458 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002459 * \warning If using a hash that is only provided by PSA drivers, you must
2460 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002461 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002462#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002463
2464/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002465 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002466 *
2467 * Enable the elliptic curve over GF(p) library.
2468 *
2469 * Module: library/ecp.c
2470 * Caller: library/ecdh.c
2471 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002472 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002473 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002474 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002475 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002476#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002477
2478/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002479 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002480 *
2481 * Enable the platform-specific entropy code.
2482 *
2483 * Module: library/entropy.c
2484 * Caller:
2485 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002487 *
2488 * This module provides a generic entropy pool
2489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002490#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002491
2492/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002493 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002494 *
2495 * Enable error code to error string conversion.
2496 *
2497 * Module: library/error.c
2498 * Caller:
2499 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002500 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002503
2504/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002506 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002507 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002508 *
2509 * Module: library/gcm.c
2510 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002511 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2512 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002513 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002514 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2515 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002517#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002518
2519/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002520 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002521 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002522 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002523 * Can significantly increase throughput on systems without GCM hardware
2524 * acceleration (e.g., AESNI, AESCE).
2525 *
Matthias Schulz78266782024-02-08 13:54:48 +01002526 * The mbedtls_gcm_context size will increase by 3840 bytes.
2527 * The code size will increase by roughly 344 bytes.
2528 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002529 * Module: library/gcm.c
2530 *
2531 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002532 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002533//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002534
2535/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002536 * \def MBEDTLS_HKDF_C
2537 *
2538 * Enable the HKDF algorithm (RFC 5869).
2539 *
2540 * Module: library/hkdf.c
2541 * Caller:
2542 *
2543 * Requires: MBEDTLS_MD_C
2544 *
2545 * This module adds support for the Hashed Message Authentication Code
2546 * (HMAC)-based key derivation function (HKDF).
2547 */
2548#define MBEDTLS_HKDF_C
2549
2550/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002552 *
2553 * Enable the HMAC_DRBG random generator.
2554 *
2555 * Module: library/hmac_drbg.c
2556 * Caller:
2557 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002558 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002559 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002560 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002563
2564/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002565 * \def MBEDTLS_LMS_C
2566 *
2567 * Enable the LMS stateful-hash asymmetric signature algorithm.
2568 *
2569 * Module: library/lms.c
2570 * Caller:
2571 *
Raef Colesab4f8742022-09-01 12:24:31 +01002572 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002573 *
Raef Colesab4f8742022-09-01 12:24:31 +01002574 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002575 */
2576#define MBEDTLS_LMS_C
2577
2578/**
Raef Colesab4f8742022-09-01 12:24:31 +01002579 * \def MBEDTLS_LMS_PRIVATE
2580 *
2581 * Enable LMS private-key operations and signing code. Functions enabled by this
2582 * option are experimental, and should not be used in production.
2583 *
2584 * Requires: MBEDTLS_LMS_C
2585 *
2586 * Uncomment to enable the LMS signature algorithm and private key operations.
2587 */
Raef Coles5127e852022-10-07 10:35:56 +01002588//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002589
2590/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002591 * \def MBEDTLS_NIST_KW_C
2592 *
2593 * Enable the Key Wrapping mode for 128-bit block ciphers,
2594 * as defined in NIST SP 800-38F. Only KW and KWP modes
2595 * are supported. At the moment, only AES is approved by NIST.
2596 *
2597 * Module: library/nist_kw.c
2598 *
2599 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2600 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002601#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002602
2603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002605 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002606 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002607 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002608 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2609 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002610 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002611 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002612 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002613 * Caller: library/constant_time.c
2614 * library/ecdsa.c
2615 * library/ecjpake.c
2616 * library/hkdf.c
2617 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002618 * library/pk.c
2619 * library/pkcs5.c
2620 * library/pkcs12.c
2621 * library/psa_crypto_ecp.c
2622 * library/psa_crypto_rsa.c
2623 * library/rsa.c
2624 * library/ssl_cookie.c
2625 * library/ssl_msg.c
2626 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002627 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002628 * library/x509_crt.c
2629 * library/x509write_crt.c
2630 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002631 *
2632 * Uncomment to enable generic message digest wrappers.
2633 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002634#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002635
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002636/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002638 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002639 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002640 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002641 * Module: library/md5.c
2642 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002643 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002644 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002645 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002646 * This module is required for TLS 1.2 depending on the handshake parameters.
2647 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2648 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002649 *
2650 * \warning MD5 is considered a weak message digest and its use constitutes a
2651 * security risk. If possible, we recommend avoiding dependencies on
2652 * it, and considering stronger message digests instead.
2653 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002656
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002657/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002659 *
2660 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002661 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002662 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002663 *
2664 * Module: library/memory_buffer_alloc.c
2665 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002667 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002668 *
2669 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002670 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002672
2673/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002675 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002676 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2677 *
Simon Butcherd567a232016-03-09 20:19:21 +00002678 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2679 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002680 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002681 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002682 * \note See also our Knowledge Base article about porting to a new
2683 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002684 * 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 +00002685 *
Andres AG788aa4a2016-09-14 14:32:09 +01002686 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002687 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002688 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002689 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002691
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002692/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002694 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002695 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002696 *
2697 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002698 * Caller: library/asn1write.c
2699 * library/pkcs5.c
2700 * library/pkparse.c
2701 * library/pkwrite.c
2702 * library/rsa.c
2703 * library/x509.c
2704 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002705 * library/x509_crl.c
2706 * library/x509_crt.c
2707 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002708 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002709 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002710 *
2711 * This modules translates between OIDs and internal values.
2712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002714
2715/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002717 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002718 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002719 *
2720 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002721 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002722 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002723 * library/x509_crl.c
2724 * library/x509_crt.c
2725 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002726 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002728 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2729 *
2730 * \warning When parsing password-protected files, if MD5 is provided only by
2731 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002732 *
Paul Bakkercff68422013-09-15 20:43:33 +02002733 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002736
2737/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002739 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002740 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002741 *
2742 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002743 * Caller: library/pkwrite.c
2744 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002745 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002746 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002747 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002748 *
2749 * This modules adds support for encoding / writing PEM files.
2750 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002751#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002752
2753/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002754 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002755 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002756 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002757 *
2758 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002759 * Caller: library/psa_crypto_rsa.c
2760 * library/ssl_tls.c
2761 * library/ssl*_client.c
2762 * library/ssl*_server.c
2763 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002764 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002765 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002766 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002767 * Uncomment to enable generic public key wrappers.
2768 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002770
2771/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002773 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002774 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002775 *
2776 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002777 * Caller: library/x509_crt.c
2778 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002779 *
Yanray Wang072a0682023-12-05 10:53:04 +08002780 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002781 *
2782 * Uncomment to enable generic public key parse functions.
2783 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002784#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002785
2786/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002787 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002788 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002789 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002790 *
2791 * Module: library/pkwrite.c
2792 * Caller: library/x509write.c
2793 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002794 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002795 *
2796 * Uncomment to enable generic public key write functions.
2797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002799
2800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002802 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002803 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002804 *
2805 * Module: library/pkcs5.c
2806 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002807 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002808 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002809 * \warning If using a hash that is only provided by PSA drivers, you must
2810 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002811 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002812 * This module adds support for the PKCS#5 functions.
2813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002815
2816/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002817 * \def MBEDTLS_PKCS7_C
2818 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002819 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002820 * RFC Link - https://tools.ietf.org/html/rfc2315
2821 *
2822 * Module: library/pkcs7.c
2823 *
2824 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002825 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2826 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002827 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002828 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002829 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002830#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002831
2832/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002834 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002835 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002836 * Adds algorithms for parsing PKCS#8 encrypted private keys
2837 *
2838 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002839 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002840 *
Valerio Settie98ad592023-12-28 10:42:12 +01002841 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2842 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002843 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002844 * \warning If using a hash that is only provided by PSA drivers, you must
2845 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002846 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002847 * This module enables PKCS#12 functions.
2848 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002850
2851/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002853 *
2854 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002855 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002856 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2858 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002859 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002860 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002861 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002862 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002863 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002864 * Module: library/platform.c
2865 * Caller: Most other .c files
2866 *
2867 * This module enables abstraction of common (libc) functions.
2868 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002869#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002870
2871/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002872 * \def MBEDTLS_POLY1305_C
2873 *
2874 * Enable the Poly1305 MAC algorithm.
2875 *
2876 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002877 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002878 */
2879#define MBEDTLS_POLY1305_C
2880
2881/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002882 * \def MBEDTLS_PSA_CRYPTO_C
2883 *
2884 * Enable the Platform Security Architecture cryptography API.
2885 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002886 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002887 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002888 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002889 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01002890 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
2891 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
2892 * is enabled in PSA (unless it's fully accelerated, see
2893 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01002894 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002895#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002896
2897/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002898 * \def MBEDTLS_PSA_CRYPTO_SE_C
2899 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002900 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002901 * cryptography API.
2902 *
Ronald Crone6e6b752023-01-16 16:56:51 +01002903 * \deprecated This feature is deprecated. Please switch to the PSA driver
2904 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002905 *
Ryan Everett32a64582024-03-05 18:16:18 +00002906 * \warning This feature is not thread-safe, and should not be used in a
2907 * multi-threaded environment.
2908 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002909 * Module: library/psa_crypto_se.c
2910 *
2911 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2912 *
2913 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002914//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002915
2916/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002917 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2918 *
2919 * Enable the Platform Security Architecture persistent key storage.
2920 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002921 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002922 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002923 * Requires: MBEDTLS_PSA_CRYPTO_C,
2924 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2925 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002926 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002927#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002928
2929/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002930 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002931 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002932 * Enable the emulation of the Platform Security Architecture
2933 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002934 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002935 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002936 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002937 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002938 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002939#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002940
2941/**
Valerio Setti678e0fb2024-06-14 07:49:05 +02002942 * \def MBEDTLS_PSA_STATIC_KEY_SLOTS
2943 *
Valerio Setti933b7692024-08-13 11:08:26 +02002944 * Statically preallocate memory to store keys' material in PSA instead
2945 * of allocating it dynamically when required. This allows builds without a
2946 * heap, if none of the enabled cryptographic implementations or other features
2947 * require it.
2948 * This feature affects both volatile and persistent keys which means that
2949 * it's not possible to persistently store a key which is larger than
Valerio Settic2a6e8b2024-08-16 07:58:02 +02002950 * #MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE.
Valerio Setti678e0fb2024-06-14 07:49:05 +02002951 *
2952 * \note This feature comes with a (potentially) higher RAM usage since:
Valerio Setti83778d72024-10-04 13:46:37 +02002953 * - All the key slots are allocated no matter if they are used or not.
Valerio Settic2a6e8b2024-08-16 07:58:02 +02002954 * - Each key buffer's length is #MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE bytes.
Valerio Setti678e0fb2024-06-14 07:49:05 +02002955 *
2956 * Requires: MBEDTLS_PSA_CRYPTO_C
2957 *
2958 */
2959//#define MBEDTLS_PSA_STATIC_KEY_SLOTS
2960
2961/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002963 *
2964 * Enable the RIPEMD-160 hash algorithm.
2965 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002966 * Module: library/ripemd160.c
2967 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002968 *
2969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002971
2972/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002974 *
2975 * Enable the RSA public-key cryptosystem.
2976 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002977 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002978 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002979 * Caller: library/pk.c
2980 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002981 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002982 * library/ssl*_client.c
2983 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002984 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002985 * This module is used by the following key exchanges:
Gilles Peskineb3ec1252024-09-20 18:22:04 +02002986 * RSA, DHE-RSA, ECDHE-RSA
Paul Bakker5690efc2011-05-26 13:16:06 +00002987 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002989 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002991
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002992/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002993 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002994 *
2995 * Enable the SHA1 cryptographic hash algorithm.
2996 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002997 * Module: library/sha1.c
2998 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002999 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003000 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003001 * This module is required for TLS 1.2 depending on the handshake parameters,
3002 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003003 *
3004 * \warning SHA-1 is considered a weak message digest and its use constitutes
3005 * a security risk. If possible, we recommend avoiding dependencies
3006 * on it, and considering stronger message digests instead.
3007 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003010
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003011/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003012 * \def MBEDTLS_SHA224_C
3013 *
3014 * Enable the SHA-224 cryptographic hash algorithm.
3015 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003016 * Module: library/sha256.c
3017 * Caller: library/md.c
3018 * library/ssl_cookie.c
3019 *
3020 * This module adds support for SHA-224.
3021 */
3022#define MBEDTLS_SHA224_C
3023
3024/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003026 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003027 * Enable the SHA-256 cryptographic hash algorithm.
3028 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003029 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003030 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003031 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003032 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003033 * library/ssl*_client.c
3034 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003035 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003036 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003037 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003040
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003041/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003042 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003043 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003044 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3045 * with the ARMv8 cryptographic extensions if they are available at runtime.
3046 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003047 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003048 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003049 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003050 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003051 * \note Minimum compiler versions for this feature are Clang 4.0,
3052 * armclang 6.6 or GCC 6.0.
3053 *
3054 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3055 * armclang <= 6.9
3056 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003057 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3058 * That name is deprecated, but may still be used as an alternative form for this
3059 * option.
3060 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003061 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3062 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003063 *
3064 * Requires: MBEDTLS_SHA256_C.
3065 *
3066 * Module: library/sha256.c
3067 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003068 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003069 * and use them if available.
3070 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003071//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003072
Dave Rodgmand85277c2023-10-13 09:22:54 +01003073/**
3074 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3075 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003076 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003077 * This name is now deprecated, but may still be used as an alternative form for
3078 * this option.
3079 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003080//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3081
3082/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003083 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003084 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003085 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3086 * with the ARMv8 cryptographic extensions, which must be available at runtime
3087 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003088 *
3089 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003090 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003091 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003092 * \note Minimum compiler versions for this feature are Clang 4.0,
3093 * armclang 6.6 or GCC 6.0.
3094 *
3095 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3096 * armclang <= 6.9
3097 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003098 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003099 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003100 * option.
3101 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003102 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3103 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003104 *
3105 * Requires: MBEDTLS_SHA256_C.
3106 *
3107 * Module: library/sha256.c
3108 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003109 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003110 * unconditionally.
3111 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003112//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003113
Dave Rodgmand85277c2023-10-13 09:22:54 +01003114/**
3115 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3116 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003117 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003118 * This name is now deprecated, but may still be used as an alternative form for
3119 * this option.
3120 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003121//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3122
3123/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003124 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003125 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003126 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003127 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003128 * Module: library/sha512.c
3129 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003130 * library/psa_crypto_hash.c
3131 * library/ssl_tls.c
3132 * library/ssl*_client.c
3133 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003134 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003135 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003136 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003137#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003138
3139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003141 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003142 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003143 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003144 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003145 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003146 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003147 * library/ssl_tls.c
3148 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003149 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003150 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003152#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003153
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003154/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003155 * \def MBEDTLS_SHA3_C
3156 *
3157 * Enable the SHA3 cryptographic hash algorithm.
3158 *
3159 * Module: library/sha3.c
3160 *
3161 * This module adds support for SHA3.
3162 */
3163#define MBEDTLS_SHA3_C
3164
3165/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003166 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3167 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003168 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3169 * with the ARMv8 cryptographic extensions if they are available at runtime.
3170 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003171 *
3172 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3173 * for a non-Aarch64 build it will be silently ignored.
3174 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003175 * \note Minimum compiler versions for this feature are Clang 7.0,
3176 * armclang 6.9 or GCC 8.0.
3177 *
3178 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3179 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003180 *
3181 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3182 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3183 *
3184 * Requires: MBEDTLS_SHA512_C.
3185 *
3186 * Module: library/sha512.c
3187 *
3188 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3189 * and use them if available.
3190 */
3191//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3192
3193/**
3194 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3195 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003196 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3197 * with the ARMv8 cryptographic extensions, which must be available at runtime
3198 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003199 *
3200 * \note This allows builds with a smaller code size than with
3201 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3202 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003203 * \note Minimum compiler versions for this feature are Clang 7.0,
3204 * armclang 6.9 or GCC 8.0.
3205 *
3206 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3207 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003208 *
3209 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3210 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3211 *
3212 * Requires: MBEDTLS_SHA512_C.
3213 *
3214 * Module: library/sha512.c
3215 *
3216 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3217 * unconditionally.
3218 */
3219//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3220
3221/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003222 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003223 *
3224 * Enable simple SSL cache implementation.
3225 *
3226 * Module: library/ssl_cache.c
3227 * Caller:
3228 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003229 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003230 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003231#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003232
3233/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003235 *
3236 * Enable basic implementation of DTLS cookies for hello verification.
3237 *
3238 * Module: library/ssl_cookie.c
3239 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003240 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003242
3243/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003244 * \def MBEDTLS_SSL_TICKET_C
3245 *
3246 * Enable an implementation of TLS server-side callbacks for session tickets.
3247 *
3248 * Module: library/ssl_ticket.c
3249 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003250 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003251 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3252 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003253 */
3254#define MBEDTLS_SSL_TICKET_C
3255
3256/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003257 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003258 *
3259 * Enable the SSL/TLS client code.
3260 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003261 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003262 * Caller:
3263 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003264 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003265 *
Janos Follath745e5612024-12-02 13:22:34 +00003266 * \warning You must call psa_crypto_init() before doing any TLS operations.
3267 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003268 * This module is required for SSL/TLS client support.
3269 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003270#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003271
Paul Bakker9a736322012-11-14 12:39:52 +00003272/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003273 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003274 *
3275 * Enable the SSL/TLS server code.
3276 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003277 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003278 * Caller:
3279 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003280 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003281 *
Janos Follath745e5612024-12-02 13:22:34 +00003282 * \warning You must call psa_crypto_init() before doing any TLS operations.
3283 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003284 * This module is required for SSL/TLS server support.
3285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003286#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003287
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003288/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003290 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003291 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003292 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003293 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003294 * Caller: library/ssl*_client.c
3295 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003296 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003297 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3298 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003299 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003300 * This module is required for SSL/TLS.
3301 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003302#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003303
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003304/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003305 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003306 *
3307 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003308 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003309 * contexts are not shared between threads. If you do intend to use contexts
3310 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003311 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003312 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003313 *
3314 * Module: library/threading.c
3315 *
3316 * This allows different threading implementations (self-implemented or
3317 * provided).
3318 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003319 * You will have to enable either MBEDTLS_THREADING_ALT or
3320 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003321 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003322 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003323 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003325
3326/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003327 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003328 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003329 * Enable the semi-portable timing interface.
3330 *
Simon Butcherd567a232016-03-09 20:19:21 +00003331 * \note The provided implementation only works on POSIX/Unix (including Linux,
3332 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003333 * module and provide your own implementations of the callbacks needed by
3334 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3335 * your own implementation of the whole module by setting
3336 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003337 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003338 * \note The timing module will include time.h on suitable platforms
3339 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3340 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3341 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003342 * \note See also our Knowledge Base article about porting to a new
3343 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003344 * 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 +00003345 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003346 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003347 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003349
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003350/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003351 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003352 *
3353 * Enable run-time version information.
3354 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003355 * Module: library/version.c
3356 *
3357 * This module provides run-time version information.
3358 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003360
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003361/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003363 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003364 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003365 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003366 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003367 * Caller: library/x509_crl.c
3368 * library/x509_crt.c
3369 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003370 *
Janos Follath277bba82024-11-19 16:14:00 +00003371 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C
Przemek Stekiel278b6672022-08-03 09:50:38 +02003372 *
Janos Follath277bba82024-11-19 16:14:00 +00003373 * \warning You must call psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003374 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003375 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003377#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003378
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003379/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003381 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003382 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003383 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003384 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003385 * Caller: library/ssl_tls.c
3386 * library/ssl*_client.c
3387 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003388 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003390 *
3391 * This module is required for X.509 certificate parsing.
3392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003394
3395/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003397 *
3398 * Enable X.509 CRL parsing.
3399 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003400 * Module: library/x509_crl.c
3401 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003402 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003403 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003404 *
3405 * This module is required for X.509 CRL parsing.
3406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003407#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003408
3409/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003411 *
3412 * Enable X.509 Certificate Signing Request (CSR) parsing.
3413 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003414 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003415 * Caller: library/x509_crt_write.c
3416 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003418 *
3419 * This module is used for reading X.509 certificate request.
3420 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003421#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003422
3423/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003425 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003426 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003427 *
3428 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003429 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003430 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003431 *
Janos Follath277bba82024-11-19 16:14:00 +00003432 * \warning You must call psa_crypto_init() before doing any X.509 operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003433 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003434 * This module is the basis for creating X.509 certificates and CSRs.
3435 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003436#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003437
3438/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003439 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003440 *
3441 * Enable creating X.509 certificates.
3442 *
3443 * Module: library/x509_crt_write.c
3444 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003445 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003446 *
3447 * This module is required for X.509 certificate creation.
3448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003449#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003450
3451/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003452 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003453 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003454 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003455 *
3456 * Module: library/x509_csr_write.c
3457 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003458 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003459 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003460 * This module is required for X.509 certificate request writing.
3461 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003463
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003464/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003465
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003466/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003467 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003468 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003469 * This section contains Mbed TLS build settings that are not associated
3470 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003471 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003472 * \{
3473 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003474
Gilles Peskinea02c1242022-03-16 17:03:19 +01003475/**
3476 * \def MBEDTLS_CONFIG_FILE
3477 *
3478 * If defined, this is a header which will be included instead of
3479 * `"mbedtls/mbedtls_config.h"`.
3480 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003481 * Unlike other configuration options, this one must be defined on the
3482 * compiler command line: a definition in `mbedtls_config.h` would have
3483 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003484 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003485 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003486 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003487 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003488 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003489 * The value of this symbol is typically a path in double quotes, either
3490 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003491 */
3492//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3493
3494/**
3495 * \def MBEDTLS_USER_CONFIG_FILE
3496 *
3497 * If defined, this is a header which will be included after
3498 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003499 * This allows you to modify the default configuration, including the ability
3500 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003501 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003502 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003503 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003504 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003505 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003506 * The value of this symbol is typically a path in double quotes, either
3507 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003508 */
3509//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3510
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003511/**
3512 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3513 *
3514 * If defined, this is a header which will be included instead of
3515 * `"psa/crypto_config.h"`.
3516 * This header file specifies which cryptographic mechanisms are available
Ronald Cron93ba6252024-09-05 10:37:14 +02003517 * through the PSA API.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003518 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003519 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003520 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003521 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003522 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003523 * The value of this symbol is typically a path in double quotes, either
3524 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003525 */
3526//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3527
3528/**
3529 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3530 *
3531 * If defined, this is a header which will be included after
3532 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003533 * This allows you to modify the default configuration, including the ability
3534 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003535 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003536 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003537 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003538 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003539 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003540 * The value of this symbol is typically a path in double quotes, either
3541 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003542 */
3543//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3544
Gilles Peskineb1176f22023-02-22 22:07:28 +01003545/**
3546 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3547 *
3548 * If defined, this is a header which will be included instead of
3549 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3550 * as the one in Mbed TLS, but with definitions adapted to the platform on
3551 * which the library code will run.
3552 *
3553 * \note The required content of this header can vary from one version of
3554 * Mbed TLS to the next. Integrators who provide an alternative file
3555 * should review the changes in the original file whenever they
3556 * upgrade Mbed TLS.
3557 *
3558 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3559 * non-standard feature of the C language, so this feature is only available
3560 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3561 *
3562 * The value of this symbol is typically a path in double quotes, either
3563 * absolute or relative to a directory on the include search path.
3564 */
3565//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3566
3567/**
3568 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3569 *
3570 * If defined, this is a header which will be included instead of
3571 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3572 * as the one in Mbed TLS, but with definitions adapted to the environment
3573 * in which the library code will run. The typical use for this feature
3574 * is to provide alternative type definitions on the client side in
3575 * client-server integrations of PSA crypto, where operation structures
3576 * contain handles instead of cryptographic data.
3577 *
3578 * \note The required content of this header can vary from one version of
3579 * Mbed TLS to the next. Integrators who provide an alternative file
3580 * should review the changes in the original file whenever they
3581 * upgrade Mbed TLS.
3582 *
3583 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3584 * non-standard feature of the C language, so this feature is only available
3585 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3586 *
3587 * The value of this symbol is typically a path in double quotes, either
3588 * absolute or relative to a directory on the include search path.
3589 */
3590//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3591
Gilles Peskineba4162a2022-04-11 17:04:38 +02003592/** \} name SECTION: General configuration options */
3593
3594/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003595 * \name SECTION: Module configuration options
3596 *
3597 * This section allows for the setting of module specific sizes and
3598 * configuration options. The default values are already present in the
3599 * relevant header files and should suffice for the regular use cases.
3600 *
3601 * Our advice is to enable options and change their values here
3602 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003603 * \{
3604 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003605/* The Doxygen documentation here is used when a user comments out a
3606 * setting and runs doxygen themselves. On the other hand, when we typeset
3607 * the full documentation including disabled settings, the documentation
3608 * in specific modules' header files is used if present. When editing this
3609 * file, make sure that each option is documented in exactly one place,
3610 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3611 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003612
Paul Bakker088c5c52014-04-25 11:11:10 +02003613/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003614//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003615//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003616
Paul Bakker088c5c52014-04-25 11:11:10 +02003617/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003618//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3619//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3620//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3621//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3622//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003623
Paul Bakker088c5c52014-04-25 11:11:10 +02003624/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003625//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3626//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3627//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3628//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003629
Paul Bakker088c5c52014-04-25 11:11:10 +02003630/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003631//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003632//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003633
Paul Bakker088c5c52014-04-25 11:11:10 +02003634/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003635//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3636//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003637//#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 +01003638
Paul Bakker088c5c52014-04-25 11:11:10 +02003639/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003640//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003641
Paul Bakker088c5c52014-04-25 11:11:10 +02003642/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003643//#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 -04003644
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003645/** \def MBEDTLS_PLATFORM_STD_CALLOC
3646 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003647 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003648 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003649 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003650 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003651 * 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 -04003652 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3653 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003654 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003655 */
3656//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003657
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003658/** \def MBEDTLS_PLATFORM_STD_FREE
3659 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003660 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003661 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003662 * 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 -04003663 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3664 * 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 -04003665 */
3666//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003667//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003668//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003669//#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 +02003670//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3671//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003672/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003673//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003674//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3675//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003676//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3677//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3678//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003679
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003680/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003681/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003682//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3683//#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 +02003684//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003685//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003686//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3687//#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 +02003688//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3689//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003690/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003691//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003692//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003693//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3694//#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 +08003695//#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 +08003696//#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 +02003697
Gilles Peskine3f106f72021-09-23 17:42:39 +02003698/** \def MBEDTLS_CHECK_RETURN
3699 *
3700 * This macro is used at the beginning of the declaration of a function
3701 * to indicate that its return value should be checked. It should
3702 * instruct the compiler to emit a warning or an error if the function
3703 * is called without checking its return value.
3704 *
3705 * There is a default implementation for popular compilers in platform_util.h.
3706 * You can override the default implementation by defining your own here.
3707 *
3708 * If the implementation here is empty, this will effectively disable the
3709 * checking of functions' return values.
3710 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003711//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003712
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003713/** \def MBEDTLS_IGNORE_RETURN
3714 *
3715 * This macro requires one argument, which should be a C function call.
3716 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3717 * warning is suppressed.
3718 */
3719//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3720
Gilles Peskineed038902020-11-13 21:33:21 +01003721/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003722/**
Gilles Peskineed038902020-11-13 21:33:21 +01003723 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3724 * PSA crypto subsystem.
3725 *
Gilles Peskine868d2522024-07-01 21:14:45 +02003726 * If this option is unset, the library chooses a hash (currently between
3727 * #MBEDTLS_MD_SHA512 and #MBEDTLS_MD_SHA256) based on availability and
3728 * unspecified heuristics.
3729 *
3730 * \note The PSA crypto subsystem uses the first available mechanism amongst
3731 * the following:
3732 * - #MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG if enabled;
3733 * - Entropy from #MBEDTLS_ENTROPY_C plus CTR_DRBG with AES
3734 * if #MBEDTLS_CTR_DRBG_C is enabled;
3735 * - Entropy from #MBEDTLS_ENTROPY_C plus HMAC_DRBG.
3736 *
3737 * A future version may reevaluate the prioritization of DRBG mechanisms.
Gilles Peskineed038902020-11-13 21:33:21 +01003738 */
3739//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3740
Steven Cooreman863470a2021-02-15 14:03:19 +01003741/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003742 *
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02003743 * When #MBEDTLS_PSA_KEY_STORE_DYNAMIC is disabled,
3744 * the maximum amount of PSA keys simultaneously in memory. This counts all
Gilles Peskine2cb03a52024-07-16 21:29:13 +02003745 * volatile keys, plus loaded persistent keys.
3746 *
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02003747 * When #MBEDTLS_PSA_KEY_STORE_DYNAMIC is enabled,
3748 * the maximum number of loaded persistent keys.
3749 *
Gilles Peskine2cb03a52024-07-16 21:29:13 +02003750 * Currently, persistent keys do not need to be loaded all the time while
3751 * a multipart operation is in progress, only while the operation is being
3752 * set up. This may change in future versions of the library.
3753 *
3754 * Currently, the library traverses of the whole table on each access to a
3755 * persistent key. Therefore large values may cause poor performance.
3756 *
3757 * This option has no effect when #MBEDTLS_PSA_CRYPTO_C is disabled.
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003758 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003759//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003760
Valerio Settia7ce5892024-08-13 10:44:02 +02003761/**
Valerio Setti933b7692024-08-13 11:08:26 +02003762 * \def MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE
Valerio Settia7ce5892024-08-13 10:44:02 +02003763 *
Valerio Settic2a6e8b2024-08-16 07:58:02 +02003764 * Define the size (in bytes) of each static key buffer when
3765 * #MBEDTLS_PSA_STATIC_KEY_SLOTS is set. If not
3766 * explicitly defined then it's automatically guessed from available PSA keys
3767 * enabled in the build through PSA_WANT_xxx symbols.
Valerio Settia7ce5892024-08-13 10:44:02 +02003768 * If required by the application this parameter can be set to higher values
3769 * in order to store larger objects (ex: raw keys), but please note that this
3770 * will increase RAM usage.
Valerio Settia7ce5892024-08-13 10:44:02 +02003771 */
3772//#define MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE 256
3773
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003774/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003775//#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 +00003776
Paul Bakker088c5c52014-04-25 11:11:10 +02003777/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003778//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3779//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003780
Paul Bakker088c5c52014-04-25 11:11:10 +02003781/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003782
Angus Grattond8213d02016-05-25 20:56:48 +10003783/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3784 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003785 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003786 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003787 * This determines the size of the incoming TLS I/O buffer in such a way
3788 * that it is capable of holding the specified amount of plaintext data,
3789 * regardless of the protection mechanism used.
3790 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003791 * \note When using a value less than the default of 16KB on the client, it is
3792 * recommended to use the Maximum Fragment Length (MFL) extension to
3793 * inform the server about this limitation. On the server, there
3794 * is no supported, standardized way of informing the client about
3795 * restriction on the maximum size of incoming messages, and unless
3796 * the limitation has been communicated by other means, it is recommended
3797 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3798 * while keeping the default value of 16KB for the incoming buffer.
3799 *
David Horstmann95d516f2021-05-04 18:36:56 +01003800 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003801 */
3802//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3803
Gilles Peskined3d02902020-03-04 21:35:27 +01003804/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3805 *
3806 * The maximum length of CIDs used for incoming DTLS messages.
3807 *
3808 */
3809//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3810
3811/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3812 *
3813 * The maximum length of CIDs used for outgoing DTLS messages.
3814 *
3815 */
3816//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3817
TRodziewicze8dd7092021-05-12 14:19:11 +02003818/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003819 *
3820 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003821 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003822 *
3823 * The padding will always be chosen so that the length of the
3824 * padded plaintext is a multiple of the value of this option.
3825 *
3826 * Note: A value of \c 1 means that no padding will be used
3827 * for outgoing records.
3828 *
3829 * Note: On systems lacking division instructions,
3830 * a power of two should be preferred.
3831 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003832//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003833
Angus Grattond8213d02016-05-25 20:56:48 +10003834/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3835 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003836 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003837 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003838 * This determines the size of the outgoing TLS I/O buffer in such a way
3839 * that it is capable of holding the specified amount of plaintext data,
3840 * regardless of the protection mechanism used.
3841 *
Angus Grattond8213d02016-05-25 20:56:48 +10003842 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3843 * the default inward 16384 byte buffer to conform to the TLS specification.
3844 *
3845 * The minimum required outward buffer size is determined by the handshake
3846 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3847 * The specific size requirement depends on the configured ciphers and any
3848 * certificate data which is sent during the handshake.
3849 *
David Horstmann95d516f2021-05-04 18:36:56 +01003850 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003851 */
3852//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3853
Hanno Beckere0b150f2018-08-21 15:51:03 +01003854/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3855 *
3856 * Maximum number of heap-allocated bytes for the purpose of
3857 * DTLS handshake message reassembly and future message buffering.
3858 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003859 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003860 * to account for a reassembled handshake message of maximum size,
3861 * together with its reassembly bitmap.
3862 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003863 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003864 * should be sufficient for all practical situations as it allows
3865 * to reassembly a large handshake message (such as a certificate)
3866 * while buffering multiple smaller handshake messages.
3867 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003868 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003869//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003870
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003871//#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 +02003872//#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 +02003873
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003874/**
3875 * Complete list of ciphersuites to use, in order of preference.
3876 *
3877 * \warning No dependency checking is done on that field! This option can only
3878 * be used to restrict the set of available ciphersuites. It is your
3879 * responsibility to make sure the needed modules are active.
3880 *
3881 * Use this to save a few hundred bytes of ROM (default ordering of all
3882 * available ciphersuites) and a few to a few hundred bytes of RAM.
3883 *
3884 * The value below is only an example, not the default.
3885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003886//#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 +02003887
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003888/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003889 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3890 *
3891 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003892 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003893 *
3894 * It must be positive and smaller than UINT32_MAX.
3895 *
3896 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3897 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003898 */
3899//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3900
3901/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003902 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3903 *
Jerry Yucf913512023-11-14 11:06:52 +08003904 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003905 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003906 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003907 * - The client ticket age is the time difference between the time when the
3908 * client proposes to the server to use the ticket and the time the client
3909 * received the ticket from the server.
3910 * - The server ticket age is the time difference between the time when the
3911 * server receives a proposition from the client to use the ticket and the
3912 * time when the ticket was created by the server.
3913 *
Jerry Yucf913512023-11-14 11:06:52 +08003914 * The ages might be different due to the client and server clocks not running
3915 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3916 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3917 * 6s, thus in the worst case clients and servers must sync up their system time
3918 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003919 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003920 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003921 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003922//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003923
3924/**
3925 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3926 *
3927 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3928 *
3929 * This must be less than 256.
3930 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003931//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003932
3933/**
3934 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
3935 *
3936 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
3937 * after handshake completion. This is not used in TLS 1.2 and relevant only if
3938 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
3939 *
3940 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003941//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003942
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003943/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003944//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003945//#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 +01003946
Gilles Peskine611179c2022-04-13 23:04:48 +02003947/** \} name SECTION: Module configuration options */