blob: 8f770d671d9f9d41a47df3748983e9a5aa113e6b [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
645 * are temporary limitations that should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200646 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100647 * Requires: MBEDTLS_ECP_C
648 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100649 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100650 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200651//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100652
653/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200654 * Uncomment to enable using new bignum code in the ECC modules.
655 *
656 * \warning This is currently experimental, incomplete and therefore should not
657 * be used in production.
658 */
659//#define MBEDTLS_ECP_WITH_MPI_UINT
660
661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200662 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100663 *
664 * Enable deterministic ECDSA (RFC 6979).
665 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
666 * may result in a compromise of the long-term signing key. This is avoided by
667 * the deterministic variant.
668 *
John Durkop36a82e52020-10-26 09:39:05 -0700669 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100670 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100671 * Comment this macro to disable deterministic ECDSA.
672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200673#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100674
675/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200676 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200677 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200678 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200679 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200680 * This enables the following ciphersuites (if other requisites are
681 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
683 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
684 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
685 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
686 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
687 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
688 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
689 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
690 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
691 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200692 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200694
695/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200696 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200697 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200698 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200699 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200701 *
702 * This enables the following ciphersuites (if other requisites are
703 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200704 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
705 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
706 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
707 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
708 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
709 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
710 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
711 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
712 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
713 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100714 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100715 * \warning Using DHE constitutes a security risk as it
716 * is not possible to validate custom DH parameters.
717 * If possible, it is recommended users should consider
718 * preferring other methods of key exchange.
719 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100720 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200721 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200723
724/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200726 *
727 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
728 *
Janos Follath277bba82024-11-19 16:14:00 +0000729 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200730 *
731 * This enables the following ciphersuites (if other requisites are
732 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200733 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
734 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
735 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
736 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
737 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
738 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200739 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200741
742/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200743 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200744 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200745 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200746 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200747 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
748 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200749 *
750 * This enables the following ciphersuites (if other requisites are
751 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200752 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
753 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
754 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
755 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
756 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
757 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
758 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
759 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
760 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
761 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
762 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
763 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200766
767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200769 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200770 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200771 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200772 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
773 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200774 *
775 * This enables the following ciphersuites (if other requisites are
776 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200777 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
778 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
779 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
780 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
781 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
782 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
783 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
784 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
785 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
786 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
787 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
788 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100789 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100790 * \warning Using DHE constitutes a security risk as it
791 * is not possible to validate custom DH parameters.
792 * If possible, it is recommended users should consider
793 * preferring other methods of key exchange.
794 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100795 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200798
799/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200801 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200802 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200803 *
Janos Follath277bba82024-11-19 16:14:00 +0000804 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200805 * MBEDTLS_RSA_C
806 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200808 *
809 * This enables the following ciphersuites (if other requisites are
810 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200811 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
812 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
813 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
814 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
815 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
816 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
817 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
818 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
819 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
820 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200821 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200822#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200823
824/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200825 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200826 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200827 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200828 *
Janos Follath277bba82024-11-19 16:14:00 +0000829 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
830 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200831 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200832 *
833 * This enables the following ciphersuites (if other requisites are
834 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
836 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
837 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
838 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
839 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
840 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
841 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
842 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
843 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
844 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200845 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200847
848/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200849 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100850 *
851 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
852 *
Janos Follath277bba82024-11-19 16:14:00 +0000853 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
854 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200855 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100856 *
857 * This enables the following ciphersuites (if other requisites are
858 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
860 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
861 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
862 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
863 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
864 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
865 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
866 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
867 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
868 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100869 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100871
872/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200873 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100874 *
875 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
876 *
Janos Follath277bba82024-11-19 16:14:00 +0000877 * Requires: MBEDTLS_ECDH_C or PSA_WANT_ALG_ECDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200878 * MBEDTLS_RSA_C
879 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100880 *
881 * This enables the following ciphersuites (if other requisites are
882 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
884 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
885 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
886 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
887 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
888 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
889 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
890 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
891 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
892 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100895
896/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200897 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
898 *
899 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
900 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200901 * \warning This is currently experimental. EC J-PAKE support is based on the
902 * Thread v1.0.0 specification; incompatible changes to the specification
903 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200904 *
Janos Follath277bba82024-11-19 16:14:00 +0000905 * Requires: MBEDTLS_ECJPAKE_C or PSA_WANT_ALG_JPAKE
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100906 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200907 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
908 *
909 * This enables the following ciphersuites (if other requisites are
910 * enabled as well):
911 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
912 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200913//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200914
915/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100917 *
918 * Enhance support for reading EC keys using variants of SEC1 not allowed by
919 * RFC 5915 and RFC 5480.
920 *
921 * Currently this means parsing the SpecifiedECDomain choice of EC
922 * parameters (only known groups are supported, not arbitrary domains, to
923 * avoid validation issues).
924 *
925 * Disable if you only need to support RFC 5915 + 5480 key formats.
926 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100928
929/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200930 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
931 *
932 * Enable the support for parsing public keys of type Short Weierstrass
933 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200934 * compressed point format. This parsing is done through ECP module's functions.
935 *
936 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
937 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
938 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200939 */
940#define MBEDTLS_PK_PARSE_EC_COMPRESSED
941
942/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200943 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100944 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945 * Enable a dummy error function to make use of mbedtls_strerror() in
946 * third party libraries easier when MBEDTLS_ERROR_C is disabled
947 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200948 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
950 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100951 *
952 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200953 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100954 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100956
957/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000959 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +0200960 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200961 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200962 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000963 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +0000965
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000966/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000968 *
969 * Enable functions that use the filesystem.
970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000972
973/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000975 *
TRodziewicz15a7b732021-06-16 11:22:53 +0200976 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +0000977 *
Shuo Chen95a0d112014-04-04 21:04:40 -0700978 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +0000979 * application.
980 *
981 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +0000982 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200983//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000984
985/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +0000987 *
988 * Do not use built-in platform entropy functions.
989 * This is useful if your platform does not support
990 * standards like the /dev/urandom or Windows CryptoAPI.
991 *
992 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +0000993 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +0000995
996/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +0100998 *
999 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1000 * default SHA-512 based one (if both are available).
1001 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001002 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001003 *
1004 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1005 * if you have performance concerns.
1006 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 * This option is only useful if both MBEDTLS_SHA256_C and
1008 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001010//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001011
1012/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001013 * \def MBEDTLS_ENTROPY_NV_SEED
1014 *
1015 * Enable the non-volatile (NV) seed file-based entropy source.
1016 * (Also enables the NV seed read/write functions in the platform layer)
1017 *
1018 * This is crucial (if not required) on systems that do not have a
1019 * cryptographic entropy source (in hardware or kernel) available.
1020 *
1021 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1022 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001023 * \note The read/write functions that are used by the entropy source are
1024 * determined in the platform layer, and can be modified at runtime and/or
1025 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1026 *
1027 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001028 * with regular fopen(), please make sure you make a seedfile with the
1029 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1030 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001031 * and written to or you will get an entropy source error! The default
1032 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1033 * bytes from the file.
1034 *
1035 * \note The entropy collector will write to the seed file before entropy is
1036 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001037 */
1038//#define MBEDTLS_ENTROPY_NV_SEED
1039
Ronald Cron71016a92020-08-28 19:01:50 +02001040/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001041 *
Ronald Cron71016a92020-08-28 19:01:50 +02001042 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001043 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001044 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1045 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001046 *
1047 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001048 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001049 */
Ronald Cron71016a92020-08-28 19:01:50 +02001050//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001051
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001052/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001054 *
1055 * Enable debugging of buffer allocator memory issues. Automatically prints
1056 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1057 * function for 'debug output' of allocated memory.
1058 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001060 *
1061 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001062 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001064
1065/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001067 *
1068 * Include backtrace information with each allocated block.
1069 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001071 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001072 *
1073 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001074 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001076
1077/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001079 *
1080 * Support external private RSA keys (eg from a HSM) in the PK layer.
1081 *
1082 * Comment this macro to disable support for external private RSA keys.
1083 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001084#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001085
1086/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001087 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001088 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001089 * Enable support for PKCS#1 v1.5 encoding.
1090 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001091 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001092 *
Paul Bakker48377d92013-08-30 12:06:24 +02001093 * This enables support for PKCS#1 v1.5 operations.
1094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001096
1097/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001099 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001100 * Enable support for PKCS#1 v2.1 encoding.
1101 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001102 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001103 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001104 * \warning If using a hash that is only provided by PSA drivers, you must
1105 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001106 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001107 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001110
Steven Cooreman6801f082021-02-19 17:21:22 +01001111/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1112 *
1113 * Enable support for platform built-in keys. If you enable this feature,
1114 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1115 * See the documentation of that function for more information.
1116 *
1117 * Built-in keys are typically derived from a hardware unique key or
1118 * stored in a secure element.
1119 *
1120 * Requires: MBEDTLS_PSA_CRYPTO_C.
1121 *
1122 * \warning This interface is experimental and may change or be removed
1123 * without notice.
1124 */
1125//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1126
Ronald Cron3768ac12021-01-26 16:58:00 +01001127/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1128 *
1129 * Enable support for PSA crypto client.
1130 *
1131 * \note This option allows to include the code necessary for a PSA
1132 * crypto client when the PSA crypto implementation is not included in
1133 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1134 * code to set and get PSA key attributes.
1135 * The development of PSA drivers partially relying on the library to
1136 * fulfill the hardware gaps is another possible usage of this option.
1137 *
1138 * \warning This interface is experimental and may change or be removed
1139 * without notice.
1140 */
1141//#define MBEDTLS_PSA_CRYPTO_CLIENT
1142
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001143/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1144 *
1145 * Make the PSA Crypto module use an external random generator provided
1146 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1147 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001148 * \note This random generator must deliver random numbers with cryptographic
1149 * quality and high performance. It must supply unpredictable numbers
1150 * with a uniform distribution. The implementation of this function
1151 * is responsible for ensuring that the random generator is seeded
1152 * with sufficient entropy. If you have a hardware TRNG which is slow
1153 * or delivers non-uniform output, declare it as an entropy source
1154 * with mbedtls_entropy_add_source() instead of enabling this option.
1155 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001156 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001157 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1158 * and define a function called mbedtls_psa_external_get_random()
1159 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001160 * ```
1161 * psa_status_t mbedtls_psa_external_get_random(
1162 * mbedtls_psa_external_random_context_t *context,
1163 * uint8_t *output, size_t output_size, size_t *output_length);
1164 * );
1165 * ```
1166 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001167 * The function must fill the \c output buffer with \c output_size bytes
1168 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001169 *
1170 * Requires: MBEDTLS_PSA_CRYPTO_C
1171 *
1172 * \warning If you enable this option, code that uses the PSA cryptography
1173 * interface will not use any of the entropy sources set up for
1174 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1175 * enables.
1176 *
1177 * \note This option is experimental and may be removed without notice.
1178 */
1179//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1180
Paul Bakker9dcc3222011-03-08 14:16:06 +00001181/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001182 * \def MBEDTLS_PSA_CRYPTO_SPM
1183 *
1184 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1185 * Partition Manager) integration which separates the code into two parts: a
1186 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1187 * Environment).
1188 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001189 * If you enable this option, your build environment must include a header
1190 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1191 * header files, or in another directory on the compiler's include search
1192 * path). Alternatively, your platform may customize the header
1193 * `psa/crypto_platform.h`, in which case it can skip or replace the
1194 * inclusion of `"crypto_spe.h"`.
1195 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001196 * Module: library/psa_crypto.c
1197 * Requires: MBEDTLS_PSA_CRYPTO_C
1198 *
1199 */
1200//#define MBEDTLS_PSA_CRYPTO_SPM
1201
1202/**
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02001203 * \def MBEDTLS_PSA_KEY_STORE_DYNAMIC
1204 *
1205 * Dynamically resize the PSA key store to accommodate any number of
1206 * volatile keys (until the heap memory is exhausted).
1207 *
1208 * If this option is disabled, the key store has a fixed size
1209 * #MBEDTLS_PSA_KEY_SLOT_COUNT for volatile keys and loaded persistent keys
1210 * together.
1211 *
1212 * This option has no effect when #MBEDTLS_PSA_CRYPTO_C is disabled.
1213 *
1214 * Module: library/psa_crypto.c
1215 * Requires: MBEDTLS_PSA_CRYPTO_C
1216 */
1217#define MBEDTLS_PSA_KEY_STORE_DYNAMIC
1218
1219/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001220 * Uncomment to enable p256-m. This is an alternative implementation of
1221 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1222 * Compared to the default implementation:
1223 *
1224 * - p256-m has a much smaller code size and RAM footprint.
Janos Follath277bba82024-11-19 16:14:00 +00001225 * - p256-m is only available via the PSA API. This includes the pk module.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001226 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1227 * over the core arithmetic, or deterministic derivation of keys.
1228 *
1229 * We recommend enabling this option if your application uses the PSA API
1230 * and the only elliptic curve support it needs is ECDH and ECDSA over
1231 * SECP256R1.
1232 *
1233 * If you enable this option, you do not need to enable any ECC-related
1234 * MBEDTLS_xxx option. You do need to separately request support for the
1235 * cryptographic mechanisms through the PSA API:
Ronald Cron93ba6252024-09-05 10:37:14 +02001236 * - #MBEDTLS_PSA_CRYPTO_C for PSA-based configuration;
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001237 * - #PSA_WANT_ECC_SECP_R1_256;
1238 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1239 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1240 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1241 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1242 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001243 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001244 * \note To benefit from the smaller code size of p256-m, make sure that you
1245 * do not enable any ECC-related option not supported by p256-m: this
1246 * would cause the built-in ECC implementation to be built as well, in
1247 * order to provide the required option.
1248 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001249 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1250 * SECP256R1 are disabled as they are not supported by this driver.
1251 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1252 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001253 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001254 */
1255//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1256
1257/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001258 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001259 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001260 * Enable support for entropy injection at first boot. This feature is
1261 * required on systems that do not have a built-in entropy source (TRNG).
1262 * This feature is currently not supported on systems that have a built-in
1263 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001264 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001265 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001266 *
1267 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001268//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001269
1270/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001271 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001272 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001273 * Assume all buffers passed to PSA functions are owned exclusively by the
1274 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001275 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001276 * This option may be enabled if all buffers passed to any PSA function reside
1277 * in memory that is accessible only to the PSA function during its execution.
1278 *
1279 * This option MUST be disabled whenever buffer arguments are in memory shared
1280 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001281 * across a trust boundary.
1282 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001283 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001284 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001285 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001286 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001287 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001288//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001289
1290/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001291 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001292 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001293 * Do not use the Chinese Remainder Theorem
1294 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001295 *
1296 * Uncomment this macro to disable the use of CRT in RSA.
1297 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001300
1301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001303 *
1304 * Enable the checkup functions (*_self_test).
1305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001306#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001307
1308/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001309 * \def MBEDTLS_SHA256_SMALLER
1310 *
1311 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1312 * lower performance.
1313 *
Adam Wolf039080f2019-09-10 09:53:08 -05001314 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001315 * performance and size. This version optimizes more aggressively for size at
1316 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1317 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1318 * 30%.
1319 *
1320 * Uncomment to enable the smaller implementation of SHA256.
1321 */
1322//#define MBEDTLS_SHA256_SMALLER
1323
1324/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001325 * \def MBEDTLS_SHA512_SMALLER
1326 *
1327 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1328 * lower performance.
1329 *
1330 * Uncomment to enable the smaller implementation of SHA512.
1331 */
1332//#define MBEDTLS_SHA512_SMALLER
1333
1334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001336 *
1337 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001338 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001339 * with other servers, only debugging of failures is harder.
1340 *
1341 * The advantage of not sending alert messages, is that no information is given
1342 * about reasons for failures thus preventing adversaries of gaining intel.
1343 *
1344 * Enable sending of all alert messages
1345 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001347
1348/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001349 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1350 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001351 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001352 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001353 * in the underlying transport. The CID functionality is described
1354 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001355 *
1356 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001357 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1358 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1359 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001360 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001361 * The maximum lengths of outgoing and incoming CIDs can be configured
1362 * through the options
1363 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1364 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1365 *
1366 * Requires: MBEDTLS_SSL_PROTO_DTLS
1367 *
1368 * Uncomment to enable the Connection ID extension.
1369 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001370#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1371
1372
1373/**
1374 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1375 *
1376 * Defines whether RFC 9146 (default) or the legacy version
1377 * (version draft-ietf-tls-dtls-connection-id-05,
1378 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1379 * is used.
1380 *
1381 * Set the value to 0 for the standard version, and
1382 * 1 for the legacy draft version.
1383 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001384 * \deprecated Support for the legacy version of the DTLS
1385 * Connection ID feature is deprecated. Please
1386 * switch to the standardized version defined
1387 * in RFC 9146 enabled by utilizing
1388 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1389 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1390 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001391 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1392 */
1393#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001394
1395/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001396 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1397 *
1398 * Enable asynchronous external private key operations in SSL. This allows
1399 * you to configure an SSL connection to call an external cryptographic
1400 * module to perform private key operations instead of performing the
1401 * operation inside the library.
1402 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001403 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001404 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001405//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001406
1407/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001408 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1409 *
1410 * Enable serialization of the TLS context structures, through use of the
1411 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1412 *
1413 * This pair of functions allows one side of a connection to serialize the
1414 * context associated with the connection, then free or re-use that context
1415 * while the serialized state is persisted elsewhere, and finally deserialize
1416 * that state to a live context for resuming read/write operations on the
1417 * connection. From a protocol perspective, the state of the connection is
1418 * unaffected, in particular this is entirely transparent to the peer.
1419 *
1420 * Note: this is distinct from TLS session resumption, which is part of the
1421 * protocol and fully visible by the peer. TLS session resumption enables
1422 * establishing new connections associated to a saved session with shorter,
1423 * lighter handshakes, while context serialization is a local optimization in
1424 * handling a single, potentially long-lived connection.
1425 *
1426 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1427 * saved after the handshake to allow for more efficient serialization, so if
1428 * you don't need this feature you'll save RAM by disabling it.
1429 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001430 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1431 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001432 * Comment to disable the context serialization APIs.
1433 */
1434#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1435
1436/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001437 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001438 *
1439 * Enable the debug messages in SSL module for all issues.
1440 * Debug messages have been disabled in some places to prevent timing
1441 * attacks due to (unbalanced) debugging function calls.
1442 *
1443 * If you need all error reporting you should enable this during debugging,
1444 * but remove this for production servers that should log as well.
1445 *
1446 * Uncomment this macro to report all debug messages on errors introducing
1447 * a timing side-channel.
1448 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001451
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001453 *
1454 * Enable support for Encrypt-then-MAC, RFC 7366.
1455 *
1456 * This allows peers that both support it to use a more robust protection for
1457 * ciphersuites using CBC, providing deep resistance against timing attacks
1458 * on the padding or underlying cipher.
1459 *
1460 * This only affects CBC ciphersuites, and is useless if none is defined.
1461 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001462 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001463 *
1464 * Comment this macro to disable support for Encrypt-then-MAC
1465 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001467
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001468/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001469 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001470 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1471 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001472 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001473 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001474 * attacks, but it is recommended to always use it (even if you disable
1475 * renegotiation), since it actually fixes a more fundamental issue in the
1476 * original SSL/TLS design, and has implications beyond Triple Handshake.
1477 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001478 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001479 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001480 * Comment this macro to disable support for Extended Master Secret.
1481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001483
Paul Bakkerd66f0702013-01-31 16:57:45 +01001484/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001485 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1486 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001487 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001488 * giving access to the peer's certificate after completion of the handshake.
1489 *
1490 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1491 * recommended to disable this option for reduced RAM usage.
1492 *
1493 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1494 * defined, but always returns \c NULL.
1495 *
1496 * \note This option has no influence on the protection against the
1497 * triple handshake attack. Even if it is disabled, Mbed TLS will
1498 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001499 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001500 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001501 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001502 *
1503 * Comment this macro to disable storing the peer's certificate
1504 * after the handshake.
1505 */
1506#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1507
1508/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001509 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001510 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001511 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001512 *
1513 * The two main uses of renegotiation are (1) refresh keys on long-lived
1514 * connections and (2) client authentication after the initial handshake.
1515 * If you don't need renegotiation, it's probably better to disable it, since
1516 * it has been associated with security issues in the past and is easy to
1517 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001518 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001519 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1520 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001521 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001522 *
1523 * \note Even if this option is disabled, both client and server are aware
1524 * of the Renegotiation Indication Extension (RFC 5746) used to
1525 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1526 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1527 * configuration of this extension).
1528 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001529 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001530#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001531
1532/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001533 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001534 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001535 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001536 *
1537 * Comment this macro to disable support for the max_fragment_length extension
1538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001539#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001540
1541/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001542 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1543 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001544 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001545 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001546 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1547 *
1548 * Uncomment this macro to enable support for the record_size_limit extension
1549 */
1550//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1551
1552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001553 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001554 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001555 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001556 *
Janos Follath277bba82024-11-19 16:14:00 +00001557 * Requires: PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001558 *
Janos Follath277bba82024-11-19 16:14:00 +00001559 * \warning You must call psa_crypto_init() before doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001560 *
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 *
Janos Follath277bba82024-11-19 16:14:00 +00001576 * \warning You must call psa_crypto_init() before doing any TLS operations.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001577 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001578 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001579 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001580#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001581
1582/**
Ronald Cronab65c522021-11-24 10:47:20 +01001583 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1584 *
1585 * Enable TLS 1.3 middlebox compatibility mode.
1586 *
1587 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1588 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1589 * expecting TLS 1.2 traffic.
1590 *
1591 * Turning on the compatibility mode comes at the cost of a few added bytes
1592 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1593 * that don't use it. Therefore, unless transmission bandwidth is critical and
1594 * you know that middlebox compatibility issues won't occur, it is therefore
1595 * recommended to set this option.
1596 *
1597 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001598 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1599 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001600 *
1601 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001602#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001603
1604/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001605 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1606 *
1607 * Enable TLS 1.3 PSK key exchange mode.
1608 *
1609 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1610 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1611 * effect on the build.
1612 *
1613 */
1614#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1615
1616/**
1617 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1618 *
1619 * Enable TLS 1.3 ephemeral key exchange mode.
1620 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001621 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001622 * MBEDTLS_X509_CRT_PARSE_C
1623 * and at least one of:
Janos Follath277bba82024-11-19 16:14:00 +00001624 * MBEDTLS_ECDSA_C or PSA_WANT_ALG_ECDSA
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001625 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001626 *
1627 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1628 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1629 * effect on the build.
1630 *
1631 */
1632#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1633
1634/**
1635 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1636 *
1637 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1638 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001639 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001640 *
1641 * Comment to disable support for the PSK ephemeral key exchange mode in
1642 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1643 * have any effect on the build.
1644 *
1645 */
1646#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1647
1648/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001649 * \def MBEDTLS_SSL_EARLY_DATA
1650 *
1651 * Enable support for RFC 8446 TLS 1.3 early data.
1652 *
1653 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1654 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1655 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1656 *
1657 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1658 * is not enabled, this option does not have any effect on the build.
1659 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001660 * \note The maximum amount of early data can be set with
1661 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1662 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001663 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001664//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001665
1666/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001667 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001668 *
1669 * Enable support for DTLS (all available versions).
1670 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001671 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001672 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001673 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001674 *
1675 * Comment this macro to disable support for DTLS
1676 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001678
1679/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001680 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001681 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001682 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001683 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001684 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001686#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001687
1688/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001689 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001690 *
1691 * Enable support for the anti-replay mechanism in DTLS.
1692 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001693 * Requires: MBEDTLS_SSL_TLS_C
1694 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001695 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001696 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001697 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001698 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001699 * Comment this to disable anti-replay in DTLS.
1700 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001701#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001702
1703/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001704 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001705 *
1706 * Enable support for HelloVerifyRequest on DTLS servers.
1707 *
1708 * This feature is highly recommended to prevent DTLS servers being used as
1709 * amplifiers in DoS attacks against other hosts. It should always be enabled
1710 * unless you know for sure amplification cannot be a problem in the
1711 * environment in which your server operates.
1712 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001713 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001714 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001715 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001716 *
1717 * Comment this to disable support for HelloVerifyRequest.
1718 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001720
1721/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001722 * \def MBEDTLS_SSL_DTLS_SRTP
1723 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001724 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001725 * through the use_srtp extension.
1726 *
1727 * \note This feature provides the minimum functionality required
1728 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1729 * the associated SRTP packet protection key material.
1730 * In particular, the SRTP packet protection itself, as well as the
1731 * demultiplexing of RTP and DTLS packets at the datagram layer
1732 * (see Section 5 of RFC 5764), are not handled by this feature.
1733 * Instead, after successful completion of a handshake negotiating
1734 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001735 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001736 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1737 * (this is implemented in the SSL example programs).
1738 * The resulting key should then be passed to an SRTP stack.
1739 *
1740 * Setting this option enables the runtime API
1741 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1742 * through which the supported DTLS-SRTP protection
1743 * profiles can be configured. You must call this API at
1744 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001745 *
1746 * Requires: MBEDTLS_SSL_PROTO_DTLS
1747 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001748 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001749 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001750//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001751
1752/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001753 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1754 *
1755 * Enable server-side support for clients that reconnect from the same port.
1756 *
1757 * Some clients unexpectedly close the connection and try to reconnect using the
1758 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001759 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001760 * flag enables that support.
1761 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001762 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001763 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001764 * Comment this to disable support for clients reusing the source port.
1765 */
1766#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1767
1768/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001770 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001771 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001772 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001773 * session store remains the responsibility of the application, though).
1774 * Server-side, you also need to provide callbacks for writing and parsing
1775 * tickets, including authenticated encryption and key management. Example
1776 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001777 *
1778 * Comment this macro to disable support for SSL session tickets
1779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001780#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001781
1782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001784 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001785 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001786 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001788 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001789 * Comment this macro to disable support for server name indication in SSL
1790 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001792
1793/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001794 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1795 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001796 * When this option is enabled, the SSL buffer will be resized automatically
1797 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001798 *
1799 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001800 */
1801//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1802
1803/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001804 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1805 *
1806 * Enable testing of the constant-flow nature of some sensitive functions with
1807 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001808 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001809 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001810 * This setting requires compiling with clang -fsanitize=memory. The test
1811 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001812 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001813 * \warning This macro is only used for extended testing; it is not considered
1814 * part of the library's API, so it may change or disappear at any time.
1815 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001816 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001817 */
1818//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1819
1820/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001821 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1822 *
1823 * Enable testing of the constant-flow nature of some sensitive functions with
1824 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001825 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001826 *
1827 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001828 * testing if the tests suites are run with valgrind's memcheck. This can be
1829 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1830 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001831 *
1832 * \warning This macro is only used for extended testing; it is not considered
1833 * part of the library's API, so it may change or disappear at any time.
1834 *
1835 * Uncomment to enable testing of the constant-flow nature of selected code.
1836 */
1837//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1838
1839/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001840 * \def MBEDTLS_TEST_HOOKS
1841 *
1842 * Enable features for invasive testing such as introspection functions and
1843 * hooks for fault injection. This enables additional unit tests.
1844 *
1845 * Merely enabling this feature should not change the behavior of the product.
1846 * It only adds new code, and new branching points where the default behavior
1847 * is the same as when this feature is disabled.
1848 * However, this feature increases the attack surface: there is an added
1849 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1850 * Therefore this feature must never be enabled in production.
1851 *
1852 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1853 * information.
1854 *
1855 * Uncomment to enable invasive tests.
1856 */
1857//#define MBEDTLS_TEST_HOOKS
1858
1859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001860 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001861 *
1862 * Provide your own alternate threading implementation.
1863 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001865 *
1866 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001867 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001869
1870/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001872 *
1873 * Enable the pthread wrapper layer for the threading layer.
1874 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001875 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001876 *
1877 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001878 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001880
1881/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001883 *
1884 * Allow run-time checking of compile-time enabled features. Thus allowing users
1885 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001887 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001888 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001889 *
1890 * Comment this to disable run-time checking and save ROM space
1891 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001893
1894/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001895 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1896 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001897 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001898 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1899 * the set of trusted certificates through a callback instead of a linked
1900 * list.
1901 *
1902 * This is useful for example in environments where a large number of trusted
1903 * certificates is present and storing them in a linked list isn't efficient
1904 * enough, or when the set of trusted certificates changes frequently.
1905 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001906 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001907 * `mbedtls_ssl_conf_ca_cb()` for more information.
1908 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01001909 * Requires: MBEDTLS_X509_CRT_PARSE_C
1910 *
Hanno Becker288dedc2019-03-27 11:00:53 +00001911 * Uncomment to enable trusted certificate callbacks.
1912 */
1913//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1914
1915/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001916 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001917 *
Chris Jones2c745862020-12-16 11:41:06 +00001918 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001919 *
Chris Jones2c745862020-12-16 11:41:06 +00001920 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06001921 * and other functions/constants only used by these functions, thus reducing
1922 * the code footprint by several KB.
1923 */
Chris Jones2c745862020-12-16 11:41:06 +00001924//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001925
1926/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001927 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001928 *
1929 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1930 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1931 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03001932 * Requires: MBEDTLS_PKCS1_V21
1933 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001934 * Comment this macro to disallow using RSASSA-PSS in certificates.
1935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001936#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001937/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001938
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001939/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001940 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001941 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001942 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001943 * \{
1944 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001945
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001946/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001948 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01001949 * Enable AES-NI support on x86-64 or x86-32.
1950 *
1951 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01001952 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01001953 * - GCC, x86-64, target not explicitly supporting AESNI:
1954 * requires MBEDTLS_HAVE_ASM.
1955 * - GCC, x86-32, target not explicitly supporting AESNI:
1956 * not supported.
1957 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
1958 * For this assembly-less implementation, you must currently compile
1959 * `library/aesni.c` and `library/aes.c` with machine options to enable
1960 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
1961 * `clang -maes -mpclmul`.
1962 * - Non-x86 targets: this option is silently ignored.
1963 * - Other compilers: this option is silently ignored.
1964 *
1965 * \note
1966 * Above, "GCC" includes compatible compilers such as Clang.
1967 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001968 *
1969 * Module: library/aesni.c
1970 * Caller: library/aes.c
1971 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01001972 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001973 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01001974 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001975 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001976#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001977
1978/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08001979 * \def MBEDTLS_AESCE_C
1980 *
Dave Rodgman18838f62023-10-08 12:28:51 +01001981 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08001982 *
1983 * Module: library/aesce.c
1984 * Caller: library/aes.c
1985 *
Jerry Yuf015a932023-04-25 10:38:03 +08001986 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08001987 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00001988 * \warning Runtime detection only works on Linux. For non-Linux operating
1989 * system, Armv8-A Cryptographic Extensions must be supported by
1990 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08001991 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01001992 * \note Minimum compiler versions for this feature when targeting aarch64
1993 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
1994 * Minimum compiler versions for this feature when targeting 32-bit
1995 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08001996 *
1997 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
1998 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08001999 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002000 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002001 */
2002#define MBEDTLS_AESCE_C
2003
2004/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002006 *
2007 * Enable the AES block cipher.
2008 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002009 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002010 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002011 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002012 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002013 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002014 * This module enables the following ciphersuites (if other requisites are
2015 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002016 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2017 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2018 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2019 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2020 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2021 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2022 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2023 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2024 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2025 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2026 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2027 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2028 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2029 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2030 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2031 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2032 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2033 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2034 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2035 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2036 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2037 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2038 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2039 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2040 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2041 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2042 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2043 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2044 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2045 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2046 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2047 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2048 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2049 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2050 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2051 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2052 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2053 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2054 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2055 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2056 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2057 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2058 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2059 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2060 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2061 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002062 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2063 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2064 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2065 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2066 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2067 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002068 *
Paul Bakkercff68422013-09-15 20:43:33 +02002069 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002070 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002071#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002072
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002073/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002075 *
2076 * Enable the generic ASN1 parser.
2077 *
2078 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002079 * Caller: library/x509.c
2080 * library/dhm.c
2081 * library/pkcs12.c
2082 * library/pkcs5.c
2083 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002084 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002085#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002086
2087/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002089 *
2090 * Enable the generic ASN1 writer.
2091 *
2092 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002093 * Caller: library/ecdsa.c
2094 * library/pkwrite.c
2095 * library/x509_create.c
2096 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002097 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002098 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002099#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002100
2101/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002102 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002103 *
2104 * Enable the Base64 module.
2105 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002106 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002107 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002108 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002109 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002110 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002112
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002113/**
Yanray Wange367e472023-10-31 17:23:04 +08002114 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2115 *
2116 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2117 *
2118 * \note This feature is incompatible with insecure block cipher,
2119 * MBEDTLS_DES_C, and cipher modes which always require decryption
2120 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Ronald Cron93ba6252024-09-05 10:37:14 +02002121 * MBEDTLS_NIST_KW_C. This feature is incompatible with following
2122 * supported PSA equivalence PSA_WANT_ALG_ECB_NO_PADDING,
2123 * PSA_WANT_ALG_CBC_NO_PADDING, PSA_WANT_ALG_CBC_PKCS7 and
2124 * PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002125 *
2126 * Module: library/aes.c
2127 * library/aesce.c
2128 * library/aesni.c
2129 * library/aria.c
2130 * library/camellia.c
2131 * library/cipher.c
2132 */
2133//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2134
2135/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002136 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002137 *
Paul Bakker9a736322012-11-14 12:39:52 +00002138 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002139 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002140 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002141 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002142 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002143 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002144 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002145 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002146 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002147 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002148 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002149 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002150 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002151 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002153#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002154
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002156 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002157 *
2158 * Enable the Camellia block cipher.
2159 *
Paul Bakker38119b12009-01-10 23:31:23 +00002160 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002161 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002162 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002163 * This module enables the following ciphersuites (if other requisites are
2164 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002165 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2166 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2167 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2168 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2169 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2170 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2171 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2172 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2173 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2174 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2175 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2176 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2177 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2178 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2179 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2180 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2181 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2182 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2183 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2184 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2185 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2186 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2187 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2188 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2189 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2190 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2191 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2192 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2193 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2194 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2195 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2196 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2197 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2198 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2200 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2201 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2202 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002203 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002205
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002206/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002207 * \def MBEDTLS_ARIA_C
2208 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002209 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002210 *
2211 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002212 * Caller: library/cipher.c
2213 *
2214 * This module enables the following ciphersuites (if other requisites are
2215 * enabled as well):
2216 *
2217 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2218 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2219 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2220 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2221 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2222 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2223 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2224 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2225 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2226 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2227 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2228 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2229 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2230 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2231 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2232 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2233 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2234 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2235 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2236 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2237 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2238 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2239 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2240 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2241 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2242 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2243 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2244 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002245 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2246 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2247 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2248 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002249 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2250 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002251 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002252#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002253
2254/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002256 *
2257 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2258 *
2259 * Module: library/ccm.c
2260 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002261 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2262 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002263 *
2264 * This module enables the AES-CCM ciphersuites, if other requisites are
2265 * enabled as well.
2266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002268
2269/**
Daniel King34b822c2016-05-15 17:28:08 -03002270 * \def MBEDTLS_CHACHA20_C
2271 *
2272 * Enable the ChaCha20 stream cipher.
2273 *
2274 * Module: library/chacha20.c
2275 */
2276#define MBEDTLS_CHACHA20_C
2277
2278/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002279 * \def MBEDTLS_CHACHAPOLY_C
2280 *
2281 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2282 *
2283 * Module: library/chachapoly.c
2284 *
2285 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2286 */
2287#define MBEDTLS_CHACHAPOLY_C
2288
2289/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002290 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002291 *
2292 * Enable the generic cipher layer.
2293 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002294 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002295 * Caller: library/ccm.c
2296 * library/cmac.c
2297 * library/gcm.c
2298 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002299 * library/pkcs12.c
2300 * library/pkcs5.c
2301 * library/psa_crypto_aead.c
2302 * library/psa_crypto_mac.c
2303 * library/ssl_ciphersuites.c
2304 * library/ssl_msg.c
Valerio Settid5cab812023-12-28 10:04:51 +01002305 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2306 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002307 *
2308 * Uncomment to enable generic cipher wrappers.
2309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002311
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002312/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002313 * \def MBEDTLS_CMAC_C
2314 *
Simon Butcher327398a2016-10-05 14:09:11 +01002315 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2316 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002317 *
2318 * Module: library/cmac.c
2319 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002320 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002321 *
2322 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002323#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002324
2325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002327 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002328 * Enable the CTR_DRBG AES-based random generator.
2329 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002330 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002331 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002332 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002333 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2334 * is used.
2335 *
2336 * \warning When using PSA, the user should call `psa_crypto_init()` before
2337 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2338 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002339 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2340 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002341 * \note To achieve a 256-bit security strength with CTR_DRBG,
2342 * you must use AES-256 *and* use sufficient entropy.
2343 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002344 *
2345 * Module: library/ctr_drbg.c
2346 * Caller:
2347 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002348 * Requires: MBEDTLS_AES_C or
2349 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2350 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002351 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002352 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002355
2356/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002357 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002358 *
2359 * Enable the debug functions.
2360 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002361 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002362 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002363 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002364 * library/ssl_tls12_*.c
2365 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002366 *
2367 * This module provides debugging functions.
2368 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002369#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002370
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002371/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002372 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002373 *
2374 * Enable the DES block cipher.
2375 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002376 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002377 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002378 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002379 *
Paul Bakkercff68422013-09-15 20:43:33 +02002380 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002381 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002382 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002383 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002384 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002385#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002386
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002387/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002388 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002389 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002390 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002391 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002392 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002393 * Caller: library/ssl_tls.c
2394 * library/ssl*_client.c
2395 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002396 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002397 * This module is used by the following key exchanges:
2398 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002399 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002400 * \warning Using DHE constitutes a security risk as it
2401 * is not possible to validate custom DH parameters.
2402 * If possible, it is recommended users should consider
2403 * preferring other methods of key exchange.
2404 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002405 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002407#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002408
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002409/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002411 *
2412 * Enable the elliptic curve Diffie-Hellman library.
2413 *
2414 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002415 * Caller: library/psa_crypto.c
2416 * library/ssl_tls.c
2417 * library/ssl*_client.c
2418 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002419 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002420 * This module is used by the following key exchanges:
2421 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002422 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002425#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002426
2427/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002428 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002429 *
2430 * Enable the elliptic curve DSA library.
2431 *
2432 * Module: library/ecdsa.c
2433 * Caller:
2434 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002435 * This module is used by the following key exchanges:
2436 * ECDHE-ECDSA
2437 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002438 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2439 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2440 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002441 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002443
2444/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002445 * \def MBEDTLS_ECJPAKE_C
2446 *
2447 * Enable the elliptic curve J-PAKE library.
2448 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002449 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2450 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002451 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002452 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002453 * Module: library/ecjpake.c
2454 * Caller:
2455 *
2456 * This module is used by the following key exchanges:
2457 * ECJPAKE
2458 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002459 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002460 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002461 * \warning If using a hash that is only provided by PSA drivers, you must
2462 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002463 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002464#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002465
2466/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002467 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002468 *
2469 * Enable the elliptic curve over GF(p) library.
2470 *
2471 * Module: library/ecp.c
2472 * Caller: library/ecdh.c
2473 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002474 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002475 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002476 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002479
2480/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002482 *
2483 * Enable the platform-specific entropy code.
2484 *
2485 * Module: library/entropy.c
2486 * Caller:
2487 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002489 *
2490 * This module provides a generic entropy pool
2491 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002492#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002493
2494/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002495 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002496 *
2497 * Enable error code to error string conversion.
2498 *
2499 * Module: library/error.c
2500 * Caller:
2501 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002504#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002505
2506/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002508 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002509 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002510 *
2511 * Module: library/gcm.c
2512 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002513 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2514 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002515 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002516 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2517 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002520
2521/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002522 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002523 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002524 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002525 * Can significantly increase throughput on systems without GCM hardware
2526 * acceleration (e.g., AESNI, AESCE).
2527 *
Matthias Schulz78266782024-02-08 13:54:48 +01002528 * The mbedtls_gcm_context size will increase by 3840 bytes.
2529 * The code size will increase by roughly 344 bytes.
2530 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002531 * Module: library/gcm.c
2532 *
2533 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002534 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002535//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002536
2537/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002538 * \def MBEDTLS_HKDF_C
2539 *
2540 * Enable the HKDF algorithm (RFC 5869).
2541 *
2542 * Module: library/hkdf.c
2543 * Caller:
2544 *
2545 * Requires: MBEDTLS_MD_C
2546 *
2547 * This module adds support for the Hashed Message Authentication Code
2548 * (HMAC)-based key derivation function (HKDF).
2549 */
2550#define MBEDTLS_HKDF_C
2551
2552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002554 *
2555 * Enable the HMAC_DRBG random generator.
2556 *
2557 * Module: library/hmac_drbg.c
2558 * Caller:
2559 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002561 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002562 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002565
2566/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002567 * \def MBEDTLS_LMS_C
2568 *
2569 * Enable the LMS stateful-hash asymmetric signature algorithm.
2570 *
2571 * Module: library/lms.c
2572 * Caller:
2573 *
Raef Colesab4f8742022-09-01 12:24:31 +01002574 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002575 *
Raef Colesab4f8742022-09-01 12:24:31 +01002576 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002577 */
2578#define MBEDTLS_LMS_C
2579
2580/**
Raef Colesab4f8742022-09-01 12:24:31 +01002581 * \def MBEDTLS_LMS_PRIVATE
2582 *
2583 * Enable LMS private-key operations and signing code. Functions enabled by this
2584 * option are experimental, and should not be used in production.
2585 *
2586 * Requires: MBEDTLS_LMS_C
2587 *
2588 * Uncomment to enable the LMS signature algorithm and private key operations.
2589 */
Raef Coles5127e852022-10-07 10:35:56 +01002590//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002591
2592/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002593 * \def MBEDTLS_NIST_KW_C
2594 *
2595 * Enable the Key Wrapping mode for 128-bit block ciphers,
2596 * as defined in NIST SP 800-38F. Only KW and KWP modes
2597 * are supported. At the moment, only AES is approved by NIST.
2598 *
2599 * Module: library/nist_kw.c
2600 *
2601 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2602 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002603#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002604
2605/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002606 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002607 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002608 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002609 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002610 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2611 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002612 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002613 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002614 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002615 * Caller: library/constant_time.c
2616 * library/ecdsa.c
2617 * library/ecjpake.c
2618 * library/hkdf.c
2619 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002620 * library/pk.c
2621 * library/pkcs5.c
2622 * library/pkcs12.c
2623 * library/psa_crypto_ecp.c
2624 * library/psa_crypto_rsa.c
2625 * library/rsa.c
2626 * library/ssl_cookie.c
2627 * library/ssl_msg.c
2628 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002629 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002630 * library/x509_crt.c
2631 * library/x509write_crt.c
2632 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002633 *
2634 * Uncomment to enable generic message digest wrappers.
2635 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002636#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002637
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002638/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002639 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002640 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002641 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002642 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002643 * Module: library/md5.c
2644 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002645 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002646 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002647 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002648 * This module is required for TLS 1.2 depending on the handshake parameters.
2649 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2650 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002651 *
2652 * \warning MD5 is considered a weak message digest and its use constitutes a
2653 * security risk. If possible, we recommend avoiding dependencies on
2654 * it, and considering stronger message digests instead.
2655 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002656 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002658
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002659/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002661 *
2662 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002663 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002664 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002665 *
2666 * Module: library/memory_buffer_alloc.c
2667 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002669 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002670 *
2671 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002674
2675/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002677 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002678 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2679 *
Simon Butcherd567a232016-03-09 20:19:21 +00002680 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2681 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002682 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002683 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002684 * \note See also our Knowledge Base article about porting to a new
2685 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002686 * 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 +00002687 *
Andres AG788aa4a2016-09-14 14:32:09 +01002688 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002689 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002690 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002691 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002693
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002694/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002696 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002697 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002698 *
2699 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002700 * Caller: library/asn1write.c
2701 * library/pkcs5.c
2702 * library/pkparse.c
2703 * library/pkwrite.c
2704 * library/rsa.c
2705 * library/x509.c
2706 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002707 * library/x509_crl.c
2708 * library/x509_crt.c
2709 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002710 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002711 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002712 *
2713 * This modules translates between OIDs and internal values.
2714 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002715#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002716
2717/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002718 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002719 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002720 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002721 *
2722 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002723 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002724 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002725 * library/x509_crl.c
2726 * library/x509_crt.c
2727 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002728 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002730 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2731 *
2732 * \warning When parsing password-protected files, if MD5 is provided only by
2733 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002734 *
Paul Bakkercff68422013-09-15 20:43:33 +02002735 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002736 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002738
2739/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002741 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002742 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002743 *
2744 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002745 * Caller: library/pkwrite.c
2746 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002747 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002748 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002750 *
2751 * This modules adds support for encoding / writing PEM files.
2752 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002753#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002754
2755/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002756 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002757 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002758 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002759 *
2760 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002761 * Caller: library/psa_crypto_rsa.c
2762 * library/ssl_tls.c
2763 * library/ssl*_client.c
2764 * library/ssl*_server.c
2765 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002766 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002767 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002768 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002769 * Uncomment to enable generic public key wrappers.
2770 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002771#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002772
2773/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002775 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002776 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002777 *
2778 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002779 * Caller: library/x509_crt.c
2780 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002781 *
Yanray Wang072a0682023-12-05 10:53:04 +08002782 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002783 *
2784 * Uncomment to enable generic public key parse functions.
2785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002787
2788/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002789 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002790 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002791 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002792 *
2793 * Module: library/pkwrite.c
2794 * Caller: library/x509write.c
2795 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002796 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002797 *
2798 * Uncomment to enable generic public key write functions.
2799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002800#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002801
2802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002804 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002805 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002806 *
2807 * Module: library/pkcs5.c
2808 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002809 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002810 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002811 * \warning If using a hash that is only provided by PSA drivers, you must
2812 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002813 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002814 * This module adds support for the PKCS#5 functions.
2815 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002816#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002817
2818/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002819 * \def MBEDTLS_PKCS7_C
2820 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002821 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002822 * RFC Link - https://tools.ietf.org/html/rfc2315
2823 *
2824 * Module: library/pkcs7.c
2825 *
2826 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002827 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2828 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002829 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002830 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002831 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002832#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002833
2834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002836 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002837 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002838 * Adds algorithms for parsing PKCS#8 encrypted private keys
2839 *
2840 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002841 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002842 *
Valerio Settie98ad592023-12-28 10:42:12 +01002843 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2844 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002845 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002846 * \warning If using a hash that is only provided by PSA drivers, you must
2847 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002848 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002849 * This module enables PKCS#12 functions.
2850 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002852
2853/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002855 *
2856 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002857 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002858 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2860 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002861 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002862 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002863 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002864 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002865 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002866 * Module: library/platform.c
2867 * Caller: Most other .c files
2868 *
2869 * This module enables abstraction of common (libc) functions.
2870 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002871#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002872
2873/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002874 * \def MBEDTLS_POLY1305_C
2875 *
2876 * Enable the Poly1305 MAC algorithm.
2877 *
2878 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002879 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002880 */
2881#define MBEDTLS_POLY1305_C
2882
2883/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002884 * \def MBEDTLS_PSA_CRYPTO_C
2885 *
2886 * Enable the Platform Security Architecture cryptography API.
2887 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002888 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002889 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002890 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002891 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01002892 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
2893 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
2894 * is enabled in PSA (unless it's fully accelerated, see
2895 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01002896 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002897#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002898
2899/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002900 * \def MBEDTLS_PSA_CRYPTO_SE_C
2901 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002902 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002903 * cryptography API.
2904 *
Ronald Crone6e6b752023-01-16 16:56:51 +01002905 * \deprecated This feature is deprecated. Please switch to the PSA driver
2906 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002907 *
Ryan Everett32a64582024-03-05 18:16:18 +00002908 * \warning This feature is not thread-safe, and should not be used in a
2909 * multi-threaded environment.
2910 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002911 * Module: library/psa_crypto_se.c
2912 *
2913 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2914 *
2915 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002916//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002917
2918/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002919 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2920 *
2921 * Enable the Platform Security Architecture persistent key storage.
2922 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002923 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002924 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002925 * Requires: MBEDTLS_PSA_CRYPTO_C,
2926 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2927 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002928 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002929#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002930
2931/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002932 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002933 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002934 * Enable the emulation of the Platform Security Architecture
2935 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002936 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002937 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002938 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002939 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002940 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002941#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002942
2943/**
Valerio Setti678e0fb2024-06-14 07:49:05 +02002944 * \def MBEDTLS_PSA_STATIC_KEY_SLOTS
2945 *
Valerio Setti933b7692024-08-13 11:08:26 +02002946 * Statically preallocate memory to store keys' material in PSA instead
2947 * of allocating it dynamically when required. This allows builds without a
2948 * heap, if none of the enabled cryptographic implementations or other features
2949 * require it.
2950 * This feature affects both volatile and persistent keys which means that
2951 * it's not possible to persistently store a key which is larger than
Valerio Settic2a6e8b2024-08-16 07:58:02 +02002952 * #MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE.
Valerio Setti678e0fb2024-06-14 07:49:05 +02002953 *
2954 * \note This feature comes with a (potentially) higher RAM usage since:
Valerio Setti83778d72024-10-04 13:46:37 +02002955 * - All the key slots are allocated no matter if they are used or not.
Valerio Settic2a6e8b2024-08-16 07:58:02 +02002956 * - Each key buffer's length is #MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE bytes.
Valerio Setti678e0fb2024-06-14 07:49:05 +02002957 *
2958 * Requires: MBEDTLS_PSA_CRYPTO_C
2959 *
2960 */
2961//#define MBEDTLS_PSA_STATIC_KEY_SLOTS
2962
2963/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002965 *
2966 * Enable the RIPEMD-160 hash algorithm.
2967 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002968 * Module: library/ripemd160.c
2969 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002970 *
2971 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002972#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002973
2974/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002976 *
2977 * Enable the RSA public-key cryptosystem.
2978 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002979 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002980 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002981 * Caller: library/pk.c
2982 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002983 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002984 * library/ssl*_client.c
2985 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002986 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002987 * This module is used by the following key exchanges:
Gilles Peskineb3ec1252024-09-20 18:22:04 +02002988 * RSA, DHE-RSA, ECDHE-RSA
Paul Bakker5690efc2011-05-26 13:16:06 +00002989 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002991 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002993
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002994/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002995 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002996 *
2997 * Enable the SHA1 cryptographic hash algorithm.
2998 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002999 * Module: library/sha1.c
3000 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003001 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003002 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003003 * This module is required for TLS 1.2 depending on the handshake parameters,
3004 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003005 *
3006 * \warning SHA-1 is considered a weak message digest and its use constitutes
3007 * a security risk. If possible, we recommend avoiding dependencies
3008 * on it, and considering stronger message digests instead.
3009 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003010 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003011#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003012
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003013/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003014 * \def MBEDTLS_SHA224_C
3015 *
3016 * Enable the SHA-224 cryptographic hash algorithm.
3017 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003018 * Module: library/sha256.c
3019 * Caller: library/md.c
3020 * library/ssl_cookie.c
3021 *
3022 * This module adds support for SHA-224.
3023 */
3024#define MBEDTLS_SHA224_C
3025
3026/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003028 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003029 * Enable the SHA-256 cryptographic hash algorithm.
3030 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003031 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003032 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003033 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003034 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003035 * library/ssl*_client.c
3036 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003037 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003038 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003039 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003040 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003042
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003043/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003044 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003045 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003046 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3047 * with the ARMv8 cryptographic extensions if they are available at runtime.
3048 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003049 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003050 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003051 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003052 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003053 * \note Minimum compiler versions for this feature are Clang 4.0,
3054 * armclang 6.6 or GCC 6.0.
3055 *
3056 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3057 * armclang <= 6.9
3058 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003059 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3060 * That name is deprecated, but may still be used as an alternative form for this
3061 * option.
3062 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003063 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3064 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003065 *
3066 * Requires: MBEDTLS_SHA256_C.
3067 *
3068 * Module: library/sha256.c
3069 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003070 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003071 * and use them if available.
3072 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003073//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003074
Dave Rodgmand85277c2023-10-13 09:22:54 +01003075/**
3076 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3077 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003078 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003079 * This name is now deprecated, but may still be used as an alternative form for
3080 * this option.
3081 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003082//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3083
3084/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003085 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003086 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003087 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3088 * with the ARMv8 cryptographic extensions, which must be available at runtime
3089 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003090 *
3091 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003092 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003093 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003094 * \note Minimum compiler versions for this feature are Clang 4.0,
3095 * armclang 6.6 or GCC 6.0.
3096 *
3097 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3098 * armclang <= 6.9
3099 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003100 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003101 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003102 * option.
3103 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003104 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3105 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003106 *
3107 * Requires: MBEDTLS_SHA256_C.
3108 *
3109 * Module: library/sha256.c
3110 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003111 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003112 * unconditionally.
3113 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003114//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003115
Dave Rodgmand85277c2023-10-13 09:22:54 +01003116/**
3117 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3118 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003119 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003120 * This name is now deprecated, but may still be used as an alternative form for
3121 * this option.
3122 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003123//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3124
3125/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003126 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003127 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003128 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003129 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003130 * Module: library/sha512.c
3131 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003132 * library/psa_crypto_hash.c
3133 * library/ssl_tls.c
3134 * library/ssl*_client.c
3135 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003136 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003137 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003138 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003139#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003140
3141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003143 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003144 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003145 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003146 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003147 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003148 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003149 * library/ssl_tls.c
3150 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003151 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003152 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003153 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003155
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003156/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003157 * \def MBEDTLS_SHA3_C
3158 *
3159 * Enable the SHA3 cryptographic hash algorithm.
3160 *
3161 * Module: library/sha3.c
3162 *
3163 * This module adds support for SHA3.
3164 */
3165#define MBEDTLS_SHA3_C
3166
3167/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003168 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3169 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003170 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3171 * with the ARMv8 cryptographic extensions if they are available at runtime.
3172 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003173 *
3174 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3175 * for a non-Aarch64 build it will be silently ignored.
3176 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003177 * \note Minimum compiler versions for this feature are Clang 7.0,
3178 * armclang 6.9 or GCC 8.0.
3179 *
3180 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3181 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003182 *
3183 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3184 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3185 *
3186 * Requires: MBEDTLS_SHA512_C.
3187 *
3188 * Module: library/sha512.c
3189 *
3190 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3191 * and use them if available.
3192 */
3193//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3194
3195/**
3196 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3197 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003198 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3199 * with the ARMv8 cryptographic extensions, which must be available at runtime
3200 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003201 *
3202 * \note This allows builds with a smaller code size than with
3203 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3204 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003205 * \note Minimum compiler versions for this feature are Clang 7.0,
3206 * armclang 6.9 or GCC 8.0.
3207 *
3208 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3209 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003210 *
3211 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3212 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3213 *
3214 * Requires: MBEDTLS_SHA512_C.
3215 *
3216 * Module: library/sha512.c
3217 *
3218 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3219 * unconditionally.
3220 */
3221//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3222
3223/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003224 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003225 *
3226 * Enable simple SSL cache implementation.
3227 *
3228 * Module: library/ssl_cache.c
3229 * Caller:
3230 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003231 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003234
3235/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003236 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003237 *
3238 * Enable basic implementation of DTLS cookies for hello verification.
3239 *
3240 * Module: library/ssl_cookie.c
3241 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003242 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003244
3245/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003246 * \def MBEDTLS_SSL_TICKET_C
3247 *
3248 * Enable an implementation of TLS server-side callbacks for session tickets.
3249 *
3250 * Module: library/ssl_ticket.c
3251 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003252 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003253 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3254 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003255 */
3256#define MBEDTLS_SSL_TICKET_C
3257
3258/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003260 *
3261 * Enable the SSL/TLS client code.
3262 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003263 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003264 * Caller:
3265 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003266 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003267 *
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 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003282 * This module is required for SSL/TLS server support.
3283 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003284#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003285
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003286/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003287 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003288 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003289 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003290 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003291 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003292 * Caller: library/ssl*_client.c
3293 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003294 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003295 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3296 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003297 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003298 * This module is required for SSL/TLS.
3299 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003300#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003301
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003302/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003304 *
3305 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003306 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003307 * contexts are not shared between threads. If you do intend to use contexts
3308 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003309 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003310 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003311 *
3312 * Module: library/threading.c
3313 *
3314 * This allows different threading implementations (self-implemented or
3315 * provided).
3316 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317 * You will have to enable either MBEDTLS_THREADING_ALT or
3318 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003319 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003320 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003321 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003323
3324/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003326 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003327 * Enable the semi-portable timing interface.
3328 *
Simon Butcherd567a232016-03-09 20:19:21 +00003329 * \note The provided implementation only works on POSIX/Unix (including Linux,
3330 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003331 * module and provide your own implementations of the callbacks needed by
3332 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3333 * your own implementation of the whole module by setting
3334 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003335 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003336 * \note The timing module will include time.h on suitable platforms
3337 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3338 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3339 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003340 * \note See also our Knowledge Base article about porting to a new
3341 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003342 * 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 +00003343 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003344 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003345 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003347
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003348/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003350 *
3351 * Enable run-time version information.
3352 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003353 * Module: library/version.c
3354 *
3355 * This module provides run-time version information.
3356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003357#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003358
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003359/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003360 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003361 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003362 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003363 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003364 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003365 * Caller: library/x509_crl.c
3366 * library/x509_crt.c
3367 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003368 *
Janos Follath277bba82024-11-19 16:14:00 +00003369 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C
Przemek Stekiel278b6672022-08-03 09:50:38 +02003370 *
Janos Follath277bba82024-11-19 16:14:00 +00003371 * \warning You must call psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003372 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003373 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003374 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003376
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003377/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003379 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003380 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003381 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003382 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003383 * Caller: library/ssl_tls.c
3384 * library/ssl*_client.c
3385 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003386 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003388 *
3389 * This module is required for X.509 certificate parsing.
3390 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003392
3393/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003395 *
3396 * Enable X.509 CRL parsing.
3397 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003398 * Module: library/x509_crl.c
3399 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003400 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003401 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003402 *
3403 * This module is required for X.509 CRL parsing.
3404 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003406
3407/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003408 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003409 *
3410 * Enable X.509 Certificate Signing Request (CSR) parsing.
3411 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003412 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003413 * Caller: library/x509_crt_write.c
3414 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003416 *
3417 * This module is used for reading X.509 certificate request.
3418 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003420
3421/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003423 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003424 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003425 *
3426 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003427 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003428 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003429 *
Janos Follath277bba82024-11-19 16:14:00 +00003430 * \warning You must call psa_crypto_init() before doing any X.509 operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003431 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003432 * This module is the basis for creating X.509 certificates and CSRs.
3433 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003434#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003435
3436/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003437 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003438 *
3439 * Enable creating X.509 certificates.
3440 *
3441 * Module: library/x509_crt_write.c
3442 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003443 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003444 *
3445 * This module is required for X.509 certificate creation.
3446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003447#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003448
3449/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003451 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003452 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003453 *
3454 * Module: library/x509_csr_write.c
3455 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003456 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003457 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003458 * This module is required for X.509 certificate request writing.
3459 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003461
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003462/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003463
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003464/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003465 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003466 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003467 * This section contains Mbed TLS build settings that are not associated
3468 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003469 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003470 * \{
3471 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003472
Gilles Peskinea02c1242022-03-16 17:03:19 +01003473/**
3474 * \def MBEDTLS_CONFIG_FILE
3475 *
3476 * If defined, this is a header which will be included instead of
3477 * `"mbedtls/mbedtls_config.h"`.
3478 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003479 * Unlike other configuration options, this one must be defined on the
3480 * compiler command line: a definition in `mbedtls_config.h` would have
3481 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003482 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003483 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003484 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003485 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003486 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003487 * The value of this symbol is typically a path in double quotes, either
3488 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003489 */
3490//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3491
3492/**
3493 * \def MBEDTLS_USER_CONFIG_FILE
3494 *
3495 * If defined, this is a header which will be included after
3496 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003497 * This allows you to modify the default configuration, including the ability
3498 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003499 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003500 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003501 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003502 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003503 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003504 * The value of this symbol is typically a path in double quotes, either
3505 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003506 */
3507//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3508
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003509/**
3510 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3511 *
3512 * If defined, this is a header which will be included instead of
3513 * `"psa/crypto_config.h"`.
3514 * This header file specifies which cryptographic mechanisms are available
Ronald Cron93ba6252024-09-05 10:37:14 +02003515 * through the PSA API.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003516 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003517 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003518 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003519 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003520 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003521 * The value of this symbol is typically a path in double quotes, either
3522 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003523 */
3524//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3525
3526/**
3527 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3528 *
3529 * If defined, this is a header which will be included after
3530 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003531 * This allows you to modify the default configuration, including the ability
3532 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003533 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003534 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003535 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003536 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003537 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003538 * The value of this symbol is typically a path in double quotes, either
3539 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003540 */
3541//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3542
Gilles Peskineb1176f22023-02-22 22:07:28 +01003543/**
3544 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3545 *
3546 * If defined, this is a header which will be included instead of
3547 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3548 * as the one in Mbed TLS, but with definitions adapted to the platform on
3549 * which the library code will run.
3550 *
3551 * \note The required content of this header can vary from one version of
3552 * Mbed TLS to the next. Integrators who provide an alternative file
3553 * should review the changes in the original file whenever they
3554 * upgrade Mbed TLS.
3555 *
3556 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3557 * non-standard feature of the C language, so this feature is only available
3558 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3559 *
3560 * The value of this symbol is typically a path in double quotes, either
3561 * absolute or relative to a directory on the include search path.
3562 */
3563//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3564
3565/**
3566 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3567 *
3568 * If defined, this is a header which will be included instead of
3569 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3570 * as the one in Mbed TLS, but with definitions adapted to the environment
3571 * in which the library code will run. The typical use for this feature
3572 * is to provide alternative type definitions on the client side in
3573 * client-server integrations of PSA crypto, where operation structures
3574 * contain handles instead of cryptographic data.
3575 *
3576 * \note The required content of this header can vary from one version of
3577 * Mbed TLS to the next. Integrators who provide an alternative file
3578 * should review the changes in the original file whenever they
3579 * upgrade Mbed TLS.
3580 *
3581 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3582 * non-standard feature of the C language, so this feature is only available
3583 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3584 *
3585 * The value of this symbol is typically a path in double quotes, either
3586 * absolute or relative to a directory on the include search path.
3587 */
3588//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3589
Gilles Peskineba4162a2022-04-11 17:04:38 +02003590/** \} name SECTION: General configuration options */
3591
3592/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003593 * \name SECTION: Module configuration options
3594 *
3595 * This section allows for the setting of module specific sizes and
3596 * configuration options. The default values are already present in the
3597 * relevant header files and should suffice for the regular use cases.
3598 *
3599 * Our advice is to enable options and change their values here
3600 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003601 * \{
3602 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003603/* The Doxygen documentation here is used when a user comments out a
3604 * setting and runs doxygen themselves. On the other hand, when we typeset
3605 * the full documentation including disabled settings, the documentation
3606 * in specific modules' header files is used if present. When editing this
3607 * file, make sure that each option is documented in exactly one place,
3608 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3609 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003610
Paul Bakker088c5c52014-04-25 11:11:10 +02003611/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003612//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003613//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003614
Paul Bakker088c5c52014-04-25 11:11:10 +02003615/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3617//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3618//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3619//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3620//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003621
Paul Bakker088c5c52014-04-25 11:11:10 +02003622/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003623//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3624//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3625//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3626//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003627
Paul Bakker088c5c52014-04-25 11:11:10 +02003628/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003629//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003630//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003631
Paul Bakker088c5c52014-04-25 11:11:10 +02003632/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003633//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3634//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003635//#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 +01003636
Paul Bakker088c5c52014-04-25 11:11:10 +02003637/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003638//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003639
Paul Bakker088c5c52014-04-25 11:11:10 +02003640/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003641//#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 -04003642
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003643/** \def MBEDTLS_PLATFORM_STD_CALLOC
3644 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003645 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003646 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003647 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003648 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003649 * 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 -04003650 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3651 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003652 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003653 */
3654//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003655
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003656/** \def MBEDTLS_PLATFORM_STD_FREE
3657 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003658 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003659 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003660 * 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 -04003661 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3662 * 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 -04003663 */
3664//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003665//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003666//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003667//#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 +02003668//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3669//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003670/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003671//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003672//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3673//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003674//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3675//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3676//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003677
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003678/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003679/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003680//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3681//#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 +02003682//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003683//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003684//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3685//#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 +02003686//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3687//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003688/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003689//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003690//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003691//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3692//#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 +08003693//#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 +08003694//#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 +02003695
Gilles Peskine3f106f72021-09-23 17:42:39 +02003696/** \def MBEDTLS_CHECK_RETURN
3697 *
3698 * This macro is used at the beginning of the declaration of a function
3699 * to indicate that its return value should be checked. It should
3700 * instruct the compiler to emit a warning or an error if the function
3701 * is called without checking its return value.
3702 *
3703 * There is a default implementation for popular compilers in platform_util.h.
3704 * You can override the default implementation by defining your own here.
3705 *
3706 * If the implementation here is empty, this will effectively disable the
3707 * checking of functions' return values.
3708 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003709//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003710
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003711/** \def MBEDTLS_IGNORE_RETURN
3712 *
3713 * This macro requires one argument, which should be a C function call.
3714 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3715 * warning is suppressed.
3716 */
3717//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3718
Gilles Peskineed038902020-11-13 21:33:21 +01003719/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003720/**
Gilles Peskineed038902020-11-13 21:33:21 +01003721 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3722 * PSA crypto subsystem.
3723 *
Gilles Peskine868d2522024-07-01 21:14:45 +02003724 * If this option is unset, the library chooses a hash (currently between
3725 * #MBEDTLS_MD_SHA512 and #MBEDTLS_MD_SHA256) based on availability and
3726 * unspecified heuristics.
3727 *
3728 * \note The PSA crypto subsystem uses the first available mechanism amongst
3729 * the following:
3730 * - #MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG if enabled;
3731 * - Entropy from #MBEDTLS_ENTROPY_C plus CTR_DRBG with AES
3732 * if #MBEDTLS_CTR_DRBG_C is enabled;
3733 * - Entropy from #MBEDTLS_ENTROPY_C plus HMAC_DRBG.
3734 *
3735 * A future version may reevaluate the prioritization of DRBG mechanisms.
Gilles Peskineed038902020-11-13 21:33:21 +01003736 */
3737//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3738
Steven Cooreman863470a2021-02-15 14:03:19 +01003739/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003740 *
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02003741 * When #MBEDTLS_PSA_KEY_STORE_DYNAMIC is disabled,
3742 * the maximum amount of PSA keys simultaneously in memory. This counts all
Gilles Peskine2cb03a52024-07-16 21:29:13 +02003743 * volatile keys, plus loaded persistent keys.
3744 *
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02003745 * When #MBEDTLS_PSA_KEY_STORE_DYNAMIC is enabled,
3746 * the maximum number of loaded persistent keys.
3747 *
Gilles Peskine2cb03a52024-07-16 21:29:13 +02003748 * Currently, persistent keys do not need to be loaded all the time while
3749 * a multipart operation is in progress, only while the operation is being
3750 * set up. This may change in future versions of the library.
3751 *
3752 * Currently, the library traverses of the whole table on each access to a
3753 * persistent key. Therefore large values may cause poor performance.
3754 *
3755 * This option has no effect when #MBEDTLS_PSA_CRYPTO_C is disabled.
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003756 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003757//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003758
Valerio Settia7ce5892024-08-13 10:44:02 +02003759/**
Valerio Setti933b7692024-08-13 11:08:26 +02003760 * \def MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE
Valerio Settia7ce5892024-08-13 10:44:02 +02003761 *
Valerio Settic2a6e8b2024-08-16 07:58:02 +02003762 * Define the size (in bytes) of each static key buffer when
3763 * #MBEDTLS_PSA_STATIC_KEY_SLOTS is set. If not
3764 * explicitly defined then it's automatically guessed from available PSA keys
3765 * enabled in the build through PSA_WANT_xxx symbols.
Valerio Settia7ce5892024-08-13 10:44:02 +02003766 * If required by the application this parameter can be set to higher values
3767 * in order to store larger objects (ex: raw keys), but please note that this
3768 * will increase RAM usage.
Valerio Settia7ce5892024-08-13 10:44:02 +02003769 */
3770//#define MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE 256
3771
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003772/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003773//#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 +00003774
Paul Bakker088c5c52014-04-25 11:11:10 +02003775/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003776//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3777//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003778
Paul Bakker088c5c52014-04-25 11:11:10 +02003779/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003780
Angus Grattond8213d02016-05-25 20:56:48 +10003781/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3782 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003783 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003784 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003785 * This determines the size of the incoming TLS I/O buffer in such a way
3786 * that it is capable of holding the specified amount of plaintext data,
3787 * regardless of the protection mechanism used.
3788 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003789 * \note When using a value less than the default of 16KB on the client, it is
3790 * recommended to use the Maximum Fragment Length (MFL) extension to
3791 * inform the server about this limitation. On the server, there
3792 * is no supported, standardized way of informing the client about
3793 * restriction on the maximum size of incoming messages, and unless
3794 * the limitation has been communicated by other means, it is recommended
3795 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3796 * while keeping the default value of 16KB for the incoming buffer.
3797 *
David Horstmann95d516f2021-05-04 18:36:56 +01003798 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003799 */
3800//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3801
Gilles Peskined3d02902020-03-04 21:35:27 +01003802/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3803 *
3804 * The maximum length of CIDs used for incoming DTLS messages.
3805 *
3806 */
3807//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3808
3809/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3810 *
3811 * The maximum length of CIDs used for outgoing DTLS messages.
3812 *
3813 */
3814//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3815
TRodziewicze8dd7092021-05-12 14:19:11 +02003816/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003817 *
3818 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003819 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003820 *
3821 * The padding will always be chosen so that the length of the
3822 * padded plaintext is a multiple of the value of this option.
3823 *
3824 * Note: A value of \c 1 means that no padding will be used
3825 * for outgoing records.
3826 *
3827 * Note: On systems lacking division instructions,
3828 * a power of two should be preferred.
3829 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003830//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003831
Angus Grattond8213d02016-05-25 20:56:48 +10003832/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3833 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003834 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003835 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003836 * This determines the size of the outgoing TLS I/O buffer in such a way
3837 * that it is capable of holding the specified amount of plaintext data,
3838 * regardless of the protection mechanism used.
3839 *
Angus Grattond8213d02016-05-25 20:56:48 +10003840 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3841 * the default inward 16384 byte buffer to conform to the TLS specification.
3842 *
3843 * The minimum required outward buffer size is determined by the handshake
3844 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3845 * The specific size requirement depends on the configured ciphers and any
3846 * certificate data which is sent during the handshake.
3847 *
David Horstmann95d516f2021-05-04 18:36:56 +01003848 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003849 */
3850//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3851
Hanno Beckere0b150f2018-08-21 15:51:03 +01003852/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3853 *
3854 * Maximum number of heap-allocated bytes for the purpose of
3855 * DTLS handshake message reassembly and future message buffering.
3856 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003857 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003858 * to account for a reassembled handshake message of maximum size,
3859 * together with its reassembly bitmap.
3860 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003861 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003862 * should be sufficient for all practical situations as it allows
3863 * to reassembly a large handshake message (such as a certificate)
3864 * while buffering multiple smaller handshake messages.
3865 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003866 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003867//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003868
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003869//#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 +02003870//#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 +02003871
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003872/**
3873 * Complete list of ciphersuites to use, in order of preference.
3874 *
3875 * \warning No dependency checking is done on that field! This option can only
3876 * be used to restrict the set of available ciphersuites. It is your
3877 * responsibility to make sure the needed modules are active.
3878 *
3879 * Use this to save a few hundred bytes of ROM (default ordering of all
3880 * available ciphersuites) and a few to a few hundred bytes of RAM.
3881 *
3882 * The value below is only an example, not the default.
3883 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003884//#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 +02003885
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003886/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003887 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3888 *
3889 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003890 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003891 *
3892 * It must be positive and smaller than UINT32_MAX.
3893 *
3894 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3895 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003896 */
3897//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3898
3899/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003900 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3901 *
Jerry Yucf913512023-11-14 11:06:52 +08003902 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003903 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003904 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003905 * - The client ticket age is the time difference between the time when the
3906 * client proposes to the server to use the ticket and the time the client
3907 * received the ticket from the server.
3908 * - The server ticket age is the time difference between the time when the
3909 * server receives a proposition from the client to use the ticket and the
3910 * time when the ticket was created by the server.
3911 *
Jerry Yucf913512023-11-14 11:06:52 +08003912 * The ages might be different due to the client and server clocks not running
3913 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3914 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3915 * 6s, thus in the worst case clients and servers must sync up their system time
3916 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003917 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003918 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003919 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003920//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003921
3922/**
3923 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3924 *
3925 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3926 *
3927 * This must be less than 256.
3928 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003929//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003930
3931/**
3932 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
3933 *
3934 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
3935 * after handshake completion. This is not used in TLS 1.2 and relevant only if
3936 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
3937 *
3938 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003939//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003940
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003941/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003942//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003943//#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 +01003944
Gilles Peskine611179c2022-04-13 23:04:48 +02003945/** \} name SECTION: Module configuration options */