blob: 3349d4e555db95189aa2189f19876fad7007fdab [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
Ron Eldor3226d362017-10-12 14:17:48 +0300353//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300354//#define MBEDTLS_ECDSA_VERIFY_ALT
355//#define MBEDTLS_ECDSA_SIGN_ALT
356//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200357
358/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200359 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200360 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200361 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200362 * hardware entropy collector.
363 *
364 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000365 * prototype as declared in library/entropy_poll.h, and accept NULL as first
366 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200367 *
368 * Uncomment to use your own hardware entropy collector.
369 */
370//#define MBEDTLS_ENTROPY_HARDWARE_ALT
371
372/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000374 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100375 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000376 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100377 * Uncomment this macro to use precomputed AES tables stored in ROM.
378 * Comment this macro to generate AES tables in RAM at runtime.
379 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100380 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
381 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100382 * initialization time before the first AES operation can be performed.
383 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
384 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
385 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100386 *
387 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200389//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000390
391/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100392 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200393 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100394 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200395 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100396 * Uncommenting this macro omits 75% of the AES tables from
397 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
398 * by computing their values on the fly during operations
399 * (the tables are entry-wise rotations of one another).
400 *
401 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100402 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100403 * runtime. Specifically, one has to compare 4 accesses within
404 * different tables to 4 accesses with additional arithmetic
405 * operations within the same table. The performance gain/loss
406 * depends on the system and memory details.
407 *
408 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200409 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100410//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200411
412/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800413 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
414 *
415 * Use only 128-bit keys in AES operations to save ROM.
416 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800417 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800418 * or 256-bit keys.
419 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800420 * Uncommenting this macro reduces the size of AES code by ~300 bytes
421 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800422 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800423 * Module: library/aes.c
424 *
425 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800426 */
427//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
428
Gilles Peskinea8861e02023-09-05 20:20:51 +0200429/*
430 * Disable plain C implementation for AES.
431 *
432 * When the plain C implementation is enabled, and an implementation using a
433 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
434 * detection will be used to select between them.
435 *
436 * If only one implementation is present, runtime detection will not be used.
437 * This configuration will crash at runtime if running on a CPU without the
438 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
439 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
440 */
441//#define MBEDTLS_AES_USE_HARDWARE_ONLY
442
Arto Kinnunen732ca322023-04-14 14:26:10 +0800443/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200444 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200445 *
446 * Use less ROM for the Camellia implementation (saves about 768 bytes).
447 *
448 * Uncomment this macro to use less memory for Camellia.
449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200450//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200451
452/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200453 * \def MBEDTLS_CHECK_RETURN_WARNING
454 *
455 * If this macro is defined, emit a compile-time warning if application code
456 * calls a function without checking its return value, but the return value
457 * should generally be checked in portable applications.
458 *
459 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
460 * implemented. Otherwise this option has no effect.
461 *
462 * Uncomment to get warnings on using fallible functions without checking
463 * their return value.
464 *
465 * \note This feature is a work in progress.
466 * Warnings will be added to more functions in the future.
467 *
468 * \note A few functions are considered critical, and ignoring the return
469 * value of these functions will trigger a warning even if this
470 * macro is not defined. To completely disable return value check
471 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
472 */
473//#define MBEDTLS_CHECK_RETURN_WARNING
474
475/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200476 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200477 *
478 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200480#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200481
482/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200483 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000484 *
485 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200487#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000488
489/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200490 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000491 *
492 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200494#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000495
496/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100497 * \def MBEDTLS_CIPHER_MODE_OFB
498 *
499 * Enable Output Feedback mode (OFB) for symmetric ciphers.
500 */
501#define MBEDTLS_CIPHER_MODE_OFB
502
503/**
504 * \def MBEDTLS_CIPHER_MODE_XTS
505 *
506 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
507 */
508#define MBEDTLS_CIPHER_MODE_XTS
509
510/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200511 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000512 *
513 * Enable NULL cipher.
514 * Warning: Only do so when you know what you are doing. This allows for
515 * encryption or channels without any security!
516 *
Ronald Croncee42702021-04-26 11:34:44 +0200517 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200518 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
519 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
520 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
521 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
522 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
523 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
524 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
525 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
526 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
527 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
528 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
529 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
530 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
531 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
532 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
533 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
534 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
535 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
536 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000537 *
538 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000541
542/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100543 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200544 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100545 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
546 * specific padding modes in the cipher layer with cipher modes that support
547 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200548 *
549 * If you disable all padding modes, only full blocks can be used with CBC.
550 *
551 * Enable padding modes in the cipher layer.
552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200553#define MBEDTLS_CIPHER_PADDING_PKCS7
554#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
555#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
556#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200557
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200558/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
559 *
560 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800561 * Without this, CTR_DRBG uses a 256-bit key
562 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200563 */
564//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
565
Paul Bakker48e93c82013-08-14 12:21:18 +0200566/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200567 * Enable the verified implementations of ECDH primitives from Project Everest
568 * (currently only Curve25519). This feature changes the layout of ECDH
569 * contexts and therefore is a compatibility break for applications that access
570 * fields of a mbedtls_ecdh_context structure directly. See also
571 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000572 *
573 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
574 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200575 */
576//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
577
578/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100579 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200580 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100581 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
582 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200583 *
584 * Comment macros to disable the curve and functions for it
585 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200586/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200587#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
588#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
589#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
590#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
591#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
592#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
593#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
594#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
595#define MBEDTLS_ECP_DP_BP256R1_ENABLED
596#define MBEDTLS_ECP_DP_BP384R1_ENABLED
597#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200598/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200599#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000600#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200601
602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200604 *
605 * Enable specific 'modulo p' routines for each NIST prime.
606 * Depending on the prime and architecture, makes operations 4 to 8 times
607 * faster on the corresponding curve.
608 *
609 * Comment this macro to disable NIST curves optimisation.
610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200611#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200612
613/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200614 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100615 *
616 * Enable "non-blocking" ECC operations that can return early and be resumed.
617 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200618 * This allows various functions to pause by returning
619 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
620 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
621 * order to further progress and eventually complete their operation. This is
622 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
623 * number of ECC operations a function may perform before pausing; see
624 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100625 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200626 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200627 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100628 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100629 * This option:
630 * - Adds xxx_restartable() variants of existing operations in the
631 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100632 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
633 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100634 * - ECDSA: signature generation & verification;
635 * - PK: signature generation & verification;
636 * - X509: certificate chain verification.
637 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
638 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
639 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
640 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000641 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100642 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100643 * - verification of the server's key exchange signature;
644 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100645 * - generation of the client's signature if client authentication is used,
646 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100647 *
648 * \note In the cases above, the usual SSL/TLS functions, such as
649 * mbedtls_ssl_handshake(), can now return
650 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200651 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100652 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
653 * restartable operations in PK, X.509 and TLS (see above) are not
654 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100655 * PSA, and are not restartable. These are temporary limitations that
656 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200657 *
Ron Eldor19779c42018-11-05 16:58:13 +0200658 * \note This option only works with the default software implementation of
659 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100660 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100661 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100662 * Requires: MBEDTLS_ECP_C
663 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100664 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100665 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200666//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100667
668/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200669 * Uncomment to enable using new bignum code in the ECC modules.
670 *
671 * \warning This is currently experimental, incomplete and therefore should not
672 * be used in production.
673 */
674//#define MBEDTLS_ECP_WITH_MPI_UINT
675
676/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100678 *
679 * Enable deterministic ECDSA (RFC 6979).
680 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
681 * may result in a compromise of the long-term signing key. This is avoided by
682 * the deterministic variant.
683 *
John Durkop36a82e52020-10-26 09:39:05 -0700684 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100685 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100686 * Comment this macro to disable deterministic ECDSA.
687 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100689
690/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200691 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200692 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200693 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200694 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200695 * This enables the following ciphersuites (if other requisites are
696 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200697 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
698 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
699 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
700 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
701 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
702 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
703 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
704 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
705 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
706 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200707 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200708#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200709
710/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200711 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200712 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200713 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200714 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200716 *
717 * This enables the following ciphersuites (if other requisites are
718 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200719 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
720 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
721 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
722 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
723 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
724 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
725 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
726 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
727 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
728 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100729 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100730 * \warning Using DHE constitutes a security risk as it
731 * is not possible to validate custom DH parameters.
732 * If possible, it is recommended users should consider
733 * preferring other methods of key exchange.
734 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100735 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200736 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200737#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200738
739/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200741 *
742 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
743 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200744 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200745 *
746 * This enables the following ciphersuites (if other requisites are
747 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
749 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
750 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
751 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
752 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
753 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200754 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200755#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200756
757/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200759 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200760 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200761 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
763 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200764 *
765 * This enables the following ciphersuites (if other requisites are
766 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
768 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
769 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
770 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
771 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
772 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
773 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
774 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
775 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
776 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200777 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200778#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200779
780/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200782 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200783 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200784 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
786 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200787 *
788 * This enables the following ciphersuites (if other requisites are
789 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200790 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
791 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
792 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
793 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
794 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
795 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
796 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
797 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
798 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
799 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
800 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
801 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200804
805/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200807 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200808 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200809 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
811 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200812 *
813 * This enables the following ciphersuites (if other requisites are
814 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200815 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
816 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
817 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
818 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
819 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
820 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
821 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
822 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
823 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
824 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
825 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
826 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100827 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100828 * \warning Using DHE constitutes a security risk as it
829 * is not possible to validate custom DH parameters.
830 * If possible, it is recommended users should consider
831 * preferring other methods of key exchange.
832 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100833 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200834 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836
837/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200839 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200840 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200841 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200842 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
843 * MBEDTLS_RSA_C
844 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200846 *
847 * This enables the following ciphersuites (if other requisites are
848 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200849 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
850 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
851 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
852 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
853 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
854 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
855 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
856 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
857 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
858 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861
862/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200863 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200864 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200865 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200866 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200867 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
868 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
869 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200870 *
871 * This enables the following ciphersuites (if other requisites are
872 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200873 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
874 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
875 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
876 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
877 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
878 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
879 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
880 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
881 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
882 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200883 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200884#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200885
886/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100888 *
889 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
890 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200891 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
892 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
893 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100894 *
895 * This enables the following ciphersuites (if other requisites are
896 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
898 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
899 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
900 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
901 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
902 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
903 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
904 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
905 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
906 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100907 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100909
910/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200911 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100912 *
913 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
914 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200915 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
916 * MBEDTLS_RSA_C
917 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100918 *
919 * This enables the following ciphersuites (if other requisites are
920 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
922 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
923 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
924 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
925 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
926 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
927 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
928 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
929 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
930 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100931 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100933
934/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200935 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
936 *
937 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
938 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200939 * \warning This is currently experimental. EC J-PAKE support is based on the
940 * Thread v1.0.0 specification; incompatible changes to the specification
941 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200942 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200943 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100944 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200945 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
946 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100947 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800948 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100949 * MBEDTLS_USE_PSA_CRYPTO is disabled).
950 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200951 * This enables the following ciphersuites (if other requisites are
952 * enabled as well):
953 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
954 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200955//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200956
957/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100959 *
960 * Enhance support for reading EC keys using variants of SEC1 not allowed by
961 * RFC 5915 and RFC 5480.
962 *
963 * Currently this means parsing the SpecifiedECDomain choice of EC
964 * parameters (only known groups are supported, not arbitrary domains, to
965 * avoid validation issues).
966 *
967 * Disable if you only need to support RFC 5915 + 5480 key formats.
968 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100970
971/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200972 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
973 *
974 * Enable the support for parsing public keys of type Short Weierstrass
975 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200976 * compressed point format. This parsing is done through ECP module's functions.
977 *
978 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
979 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
980 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200981 */
982#define MBEDTLS_PK_PARSE_EC_COMPRESSED
983
984/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100986 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987 * Enable a dummy error function to make use of mbedtls_strerror() in
988 * third party libraries easier when MBEDTLS_ERROR_C is disabled
989 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200990 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
992 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100993 *
994 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200995 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100998
999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001001 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001002 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001003 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001005 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001007
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001008/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001010 *
1011 * Enable functions that use the filesystem.
1012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001014
1015/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001017 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001018 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001019 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001020 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001021 * application.
1022 *
1023 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001025//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001026
1027/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001029 *
1030 * Do not use built-in platform entropy functions.
1031 * This is useful if your platform does not support
1032 * standards like the /dev/urandom or Windows CryptoAPI.
1033 *
1034 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001035 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001036//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001037
1038/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001040 *
1041 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1042 * default SHA-512 based one (if both are available).
1043 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001045 *
1046 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1047 * if you have performance concerns.
1048 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049 * This option is only useful if both MBEDTLS_SHA256_C and
1050 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001051 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001053
1054/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001055 * \def MBEDTLS_ENTROPY_NV_SEED
1056 *
1057 * Enable the non-volatile (NV) seed file-based entropy source.
1058 * (Also enables the NV seed read/write functions in the platform layer)
1059 *
1060 * This is crucial (if not required) on systems that do not have a
1061 * cryptographic entropy source (in hardware or kernel) available.
1062 *
1063 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1064 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001065 * \note The read/write functions that are used by the entropy source are
1066 * determined in the platform layer, and can be modified at runtime and/or
1067 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1068 *
1069 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001070 * with regular fopen(), please make sure you make a seedfile with the
1071 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1072 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001073 * and written to or you will get an entropy source error! The default
1074 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1075 * bytes from the file.
1076 *
1077 * \note The entropy collector will write to the seed file before entropy is
1078 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001079 */
1080//#define MBEDTLS_ENTROPY_NV_SEED
1081
Ronald Cron71016a92020-08-28 19:01:50 +02001082/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001083 *
Ronald Cron71016a92020-08-28 19:01:50 +02001084 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001085 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001086 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1087 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001088 *
1089 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001090 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001091 */
Ronald Cron71016a92020-08-28 19:01:50 +02001092//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001093
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001094/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001096 *
1097 * Enable debugging of buffer allocator memory issues. Automatically prints
1098 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1099 * function for 'debug output' of allocated memory.
1100 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001102 *
1103 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001106
1107/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001109 *
1110 * Include backtrace information with each allocated block.
1111 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001113 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001114 *
1115 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001118
1119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001121 *
1122 * Support external private RSA keys (eg from a HSM) in the PK layer.
1123 *
1124 * Comment this macro to disable support for external private RSA keys.
1125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001127
1128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001130 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001131 * Enable support for PKCS#1 v1.5 encoding.
1132 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001133 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001134 *
Paul Bakker48377d92013-08-30 12:06:24 +02001135 * This enables support for PKCS#1 v1.5 operations.
1136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001138
1139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001141 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001142 * Enable support for PKCS#1 v2.1 encoding.
1143 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001144 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001145 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001146 * \warning If using a hash that is only provided by PSA drivers, you must
1147 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001148 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001149 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001152
Steven Cooreman6801f082021-02-19 17:21:22 +01001153/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1154 *
1155 * Enable support for platform built-in keys. If you enable this feature,
1156 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1157 * See the documentation of that function for more information.
1158 *
1159 * Built-in keys are typically derived from a hardware unique key or
1160 * stored in a secure element.
1161 *
1162 * Requires: MBEDTLS_PSA_CRYPTO_C.
1163 *
1164 * \warning This interface is experimental and may change or be removed
1165 * without notice.
1166 */
1167//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1168
Ronald Cron3768ac12021-01-26 16:58:00 +01001169/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1170 *
1171 * Enable support for PSA crypto client.
1172 *
1173 * \note This option allows to include the code necessary for a PSA
1174 * crypto client when the PSA crypto implementation is not included in
1175 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1176 * code to set and get PSA key attributes.
1177 * The development of PSA drivers partially relying on the library to
1178 * fulfill the hardware gaps is another possible usage of this option.
1179 *
1180 * \warning This interface is experimental and may change or be removed
1181 * without notice.
1182 */
1183//#define MBEDTLS_PSA_CRYPTO_CLIENT
1184
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001185/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1186 *
1187 * Make the PSA Crypto module use an external random generator provided
1188 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1189 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001190 * \note This random generator must deliver random numbers with cryptographic
1191 * quality and high performance. It must supply unpredictable numbers
1192 * with a uniform distribution. The implementation of this function
1193 * is responsible for ensuring that the random generator is seeded
1194 * with sufficient entropy. If you have a hardware TRNG which is slow
1195 * or delivers non-uniform output, declare it as an entropy source
1196 * with mbedtls_entropy_add_source() instead of enabling this option.
1197 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001198 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001199 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1200 * and define a function called mbedtls_psa_external_get_random()
1201 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001202 * ```
1203 * psa_status_t mbedtls_psa_external_get_random(
1204 * mbedtls_psa_external_random_context_t *context,
1205 * uint8_t *output, size_t output_size, size_t *output_length);
1206 * );
1207 * ```
1208 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001209 * The function must fill the \c output buffer with \c output_size bytes
1210 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001211 *
1212 * Requires: MBEDTLS_PSA_CRYPTO_C
1213 *
1214 * \warning If you enable this option, code that uses the PSA cryptography
1215 * interface will not use any of the entropy sources set up for
1216 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1217 * enables.
1218 *
1219 * \note This option is experimental and may be removed without notice.
1220 */
1221//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1222
Paul Bakker9dcc3222011-03-08 14:16:06 +00001223/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001224 * \def MBEDTLS_PSA_CRYPTO_SPM
1225 *
1226 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1227 * Partition Manager) integration which separates the code into two parts: a
1228 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1229 * Environment).
1230 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001231 * If you enable this option, your build environment must include a header
1232 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1233 * header files, or in another directory on the compiler's include search
1234 * path). Alternatively, your platform may customize the header
1235 * `psa/crypto_platform.h`, in which case it can skip or replace the
1236 * inclusion of `"crypto_spe.h"`.
1237 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001238 * Module: library/psa_crypto.c
1239 * Requires: MBEDTLS_PSA_CRYPTO_C
1240 *
1241 */
1242//#define MBEDTLS_PSA_CRYPTO_SPM
1243
1244/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001245 * Uncomment to enable p256-m. This is an alternative implementation of
1246 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1247 * Compared to the default implementation:
1248 *
1249 * - p256-m has a much smaller code size and RAM footprint.
1250 * - p256-m is only available via the PSA API. This includes the pk module
1251 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1252 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1253 * over the core arithmetic, or deterministic derivation of keys.
1254 *
1255 * We recommend enabling this option if your application uses the PSA API
1256 * and the only elliptic curve support it needs is ECDH and ECDSA over
1257 * SECP256R1.
1258 *
1259 * If you enable this option, you do not need to enable any ECC-related
1260 * MBEDTLS_xxx option. You do need to separately request support for the
1261 * cryptographic mechanisms through the PSA API:
1262 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1263 * configuration;
1264 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1265 * - #PSA_WANT_ECC_SECP_R1_256;
1266 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1267 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1268 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1269 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1270 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001271 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001272 * \note To benefit from the smaller code size of p256-m, make sure that you
1273 * do not enable any ECC-related option not supported by p256-m: this
1274 * would cause the built-in ECC implementation to be built as well, in
1275 * order to provide the required option.
1276 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001277 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1278 * SECP256R1 are disabled as they are not supported by this driver.
1279 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1280 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001281 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001282 */
1283//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1284
1285/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001286 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001287 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001288 * Enable support for entropy injection at first boot. This feature is
1289 * required on systems that do not have a built-in entropy source (TRNG).
1290 * This feature is currently not supported on systems that have a built-in
1291 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001292 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001293 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001294 *
1295 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001296//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001297
1298/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001299 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001300 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001301 * Assume all buffers passed to PSA functions are owned exclusively by the
1302 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001303 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001304 * This option may be enabled if all buffers passed to any PSA function reside
1305 * in memory that is accessible only to the PSA function during its execution.
1306 *
1307 * This option MUST be disabled whenever buffer arguments are in memory shared
1308 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001309 * across a trust boundary.
1310 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001311 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001312 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001313 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001314 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001315 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001316//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001317
1318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001320 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001321 * Do not use the Chinese Remainder Theorem
1322 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001323 *
1324 * Uncomment this macro to disable the use of CRT in RSA.
1325 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001326 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001328
1329/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001331 *
1332 * Enable the checkup functions (*_self_test).
1333 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001334#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001335
1336/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001337 * \def MBEDTLS_SHA256_SMALLER
1338 *
1339 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1340 * lower performance.
1341 *
Adam Wolf039080f2019-09-10 09:53:08 -05001342 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001343 * performance and size. This version optimizes more aggressively for size at
1344 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1345 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1346 * 30%.
1347 *
1348 * Uncomment to enable the smaller implementation of SHA256.
1349 */
1350//#define MBEDTLS_SHA256_SMALLER
1351
1352/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001353 * \def MBEDTLS_SHA512_SMALLER
1354 *
1355 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1356 * lower performance.
1357 *
1358 * Uncomment to enable the smaller implementation of SHA512.
1359 */
1360//#define MBEDTLS_SHA512_SMALLER
1361
1362/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001363 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001364 *
1365 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001366 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001367 * with other servers, only debugging of failures is harder.
1368 *
1369 * The advantage of not sending alert messages, is that no information is given
1370 * about reasons for failures thus preventing adversaries of gaining intel.
1371 *
1372 * Enable sending of all alert messages
1373 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001374#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001375
1376/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001377 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1378 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001379 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001380 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001381 * in the underlying transport. The CID functionality is described
1382 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001383 *
1384 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001385 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1386 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1387 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001388 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001389 * The maximum lengths of outgoing and incoming CIDs can be configured
1390 * through the options
1391 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1392 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1393 *
1394 * Requires: MBEDTLS_SSL_PROTO_DTLS
1395 *
1396 * Uncomment to enable the Connection ID extension.
1397 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001398#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1399
1400
1401/**
1402 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1403 *
1404 * Defines whether RFC 9146 (default) or the legacy version
1405 * (version draft-ietf-tls-dtls-connection-id-05,
1406 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1407 * is used.
1408 *
1409 * Set the value to 0 for the standard version, and
1410 * 1 for the legacy draft version.
1411 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001412 * \deprecated Support for the legacy version of the DTLS
1413 * Connection ID feature is deprecated. Please
1414 * switch to the standardized version defined
1415 * in RFC 9146 enabled by utilizing
1416 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1417 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1418 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001419 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1420 */
1421#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001422
1423/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001424 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1425 *
1426 * Enable asynchronous external private key operations in SSL. This allows
1427 * you to configure an SSL connection to call an external cryptographic
1428 * module to perform private key operations instead of performing the
1429 * operation inside the library.
1430 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001431 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001432 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001433//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001434
1435/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001436 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1437 *
1438 * Enable serialization of the TLS context structures, through use of the
1439 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1440 *
1441 * This pair of functions allows one side of a connection to serialize the
1442 * context associated with the connection, then free or re-use that context
1443 * while the serialized state is persisted elsewhere, and finally deserialize
1444 * that state to a live context for resuming read/write operations on the
1445 * connection. From a protocol perspective, the state of the connection is
1446 * unaffected, in particular this is entirely transparent to the peer.
1447 *
1448 * Note: this is distinct from TLS session resumption, which is part of the
1449 * protocol and fully visible by the peer. TLS session resumption enables
1450 * establishing new connections associated to a saved session with shorter,
1451 * lighter handshakes, while context serialization is a local optimization in
1452 * handling a single, potentially long-lived connection.
1453 *
1454 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1455 * saved after the handshake to allow for more efficient serialization, so if
1456 * you don't need this feature you'll save RAM by disabling it.
1457 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001458 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1459 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001460 * Comment to disable the context serialization APIs.
1461 */
1462#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1463
1464/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001465 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001466 *
1467 * Enable the debug messages in SSL module for all issues.
1468 * Debug messages have been disabled in some places to prevent timing
1469 * attacks due to (unbalanced) debugging function calls.
1470 *
1471 * If you need all error reporting you should enable this during debugging,
1472 * but remove this for production servers that should log as well.
1473 *
1474 * Uncomment this macro to report all debug messages on errors introducing
1475 * a timing side-channel.
1476 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001478//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001479
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001480/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001481 *
1482 * Enable support for Encrypt-then-MAC, RFC 7366.
1483 *
1484 * This allows peers that both support it to use a more robust protection for
1485 * ciphersuites using CBC, providing deep resistance against timing attacks
1486 * on the padding or underlying cipher.
1487 *
1488 * This only affects CBC ciphersuites, and is useless if none is defined.
1489 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001490 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001491 *
1492 * Comment this macro to disable support for Encrypt-then-MAC
1493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001494#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001495
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001496/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001497 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001498 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1499 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001500 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001501 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001502 * attacks, but it is recommended to always use it (even if you disable
1503 * renegotiation), since it actually fixes a more fundamental issue in the
1504 * original SSL/TLS design, and has implications beyond Triple Handshake.
1505 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001506 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001507 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001508 * Comment this macro to disable support for Extended Master Secret.
1509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001511
Paul Bakkerd66f0702013-01-31 16:57:45 +01001512/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001513 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1514 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001515 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001516 * giving access to the peer's certificate after completion of the handshake.
1517 *
1518 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1519 * recommended to disable this option for reduced RAM usage.
1520 *
1521 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1522 * defined, but always returns \c NULL.
1523 *
1524 * \note This option has no influence on the protection against the
1525 * triple handshake attack. Even if it is disabled, Mbed TLS will
1526 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001527 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001528 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001529 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001530 *
1531 * Comment this macro to disable storing the peer's certificate
1532 * after the handshake.
1533 */
1534#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1535
1536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001537 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001538 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001539 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001540 *
1541 * The two main uses of renegotiation are (1) refresh keys on long-lived
1542 * connections and (2) client authentication after the initial handshake.
1543 * If you don't need renegotiation, it's probably better to disable it, since
1544 * it has been associated with security issues in the past and is easy to
1545 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001546 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001547 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1548 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001549 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001550 *
1551 * \note Even if this option is disabled, both client and server are aware
1552 * of the Renegotiation Indication Extension (RFC 5746) used to
1553 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1554 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1555 * configuration of this extension).
1556 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001557 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001559
1560/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001561 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001562 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001563 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001564 *
1565 * Comment this macro to disable support for the max_fragment_length extension
1566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001568
1569/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001570 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1571 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001572 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001573 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001574 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1575 *
1576 * Uncomment this macro to enable support for the record_size_limit extension
1577 */
1578//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1579
1580/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001582 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001583 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001584 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001585 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001586 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1587 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001588 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001589 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001590 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001591 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1592 * are only provided by PSA drivers, you must call psa_crypto_init() before
1593 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001594 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001595 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001596 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001597#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001598
1599/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001600 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001601 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001602 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001603 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001604 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001605 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001606 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001607 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001608 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001609 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001610 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1611 * directly performed by TLS 1.3 code. As a consequence, you must
1612 * call psa_crypto_init() before the first TLS 1.3 handshake.
1613 *
1614 * \note Cryptographic operations performed indirectly via another module
1615 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1616 * running handshake hash) only use PSA crypto if
1617 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001618 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001619 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001620 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001621#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001622
1623/**
Ronald Cronab65c522021-11-24 10:47:20 +01001624 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1625 *
1626 * Enable TLS 1.3 middlebox compatibility mode.
1627 *
1628 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1629 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1630 * expecting TLS 1.2 traffic.
1631 *
1632 * Turning on the compatibility mode comes at the cost of a few added bytes
1633 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1634 * that don't use it. Therefore, unless transmission bandwidth is critical and
1635 * you know that middlebox compatibility issues won't occur, it is therefore
1636 * recommended to set this option.
1637 *
1638 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001639 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1640 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001641 *
1642 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001643#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001644
1645/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001646 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1647 *
1648 * Enable TLS 1.3 PSK key exchange mode.
1649 *
1650 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1651 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1652 * effect on the build.
1653 *
1654 */
1655#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1656
1657/**
1658 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1659 *
1660 * Enable TLS 1.3 ephemeral key exchange mode.
1661 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001662 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001663 * MBEDTLS_X509_CRT_PARSE_C
1664 * and at least one of:
1665 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1666 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001667 *
1668 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1669 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1670 * effect on the build.
1671 *
1672 */
1673#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1674
1675/**
1676 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1677 *
1678 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1679 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001680 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001681 *
1682 * Comment to disable support for the PSK ephemeral key exchange mode in
1683 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1684 * have any effect on the build.
1685 *
1686 */
1687#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1688
1689/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 * \def MBEDTLS_SSL_EARLY_DATA
1691 *
1692 * Enable support for RFC 8446 TLS 1.3 early data.
1693 *
1694 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1695 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1696 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1697 *
1698 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1699 * is not enabled, this option does not have any effect on the build.
1700 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001701 * \note The maximum amount of early data can be set with
1702 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1703 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001705//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001706
1707/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001709 *
1710 * Enable support for DTLS (all available versions).
1711 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001712 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001713 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001714 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001715 *
1716 * Comment this macro to disable support for DTLS
1717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001719
1720/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001722 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001723 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001724 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001725 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001728
1729/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001731 *
1732 * Enable support for the anti-replay mechanism in DTLS.
1733 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734 * Requires: MBEDTLS_SSL_TLS_C
1735 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001736 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001737 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001738 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001739 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001740 * Comment this to disable anti-replay in DTLS.
1741 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001743
1744/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001746 *
1747 * Enable support for HelloVerifyRequest on DTLS servers.
1748 *
1749 * This feature is highly recommended to prevent DTLS servers being used as
1750 * amplifiers in DoS attacks against other hosts. It should always be enabled
1751 * unless you know for sure amplification cannot be a problem in the
1752 * environment in which your server operates.
1753 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001754 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001755 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001756 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001757 *
1758 * Comment this to disable support for HelloVerifyRequest.
1759 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001761
1762/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001763 * \def MBEDTLS_SSL_DTLS_SRTP
1764 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001765 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001766 * through the use_srtp extension.
1767 *
1768 * \note This feature provides the minimum functionality required
1769 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1770 * the associated SRTP packet protection key material.
1771 * In particular, the SRTP packet protection itself, as well as the
1772 * demultiplexing of RTP and DTLS packets at the datagram layer
1773 * (see Section 5 of RFC 5764), are not handled by this feature.
1774 * Instead, after successful completion of a handshake negotiating
1775 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001776 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001777 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1778 * (this is implemented in the SSL example programs).
1779 * The resulting key should then be passed to an SRTP stack.
1780 *
1781 * Setting this option enables the runtime API
1782 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1783 * through which the supported DTLS-SRTP protection
1784 * profiles can be configured. You must call this API at
1785 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001786 *
1787 * Requires: MBEDTLS_SSL_PROTO_DTLS
1788 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001789 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001790 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001791//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001792
1793/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001794 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1795 *
1796 * Enable server-side support for clients that reconnect from the same port.
1797 *
1798 * Some clients unexpectedly close the connection and try to reconnect using the
1799 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001800 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001801 * flag enables that support.
1802 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001803 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001804 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001805 * Comment this to disable support for clients reusing the source port.
1806 */
1807#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1808
1809/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001811 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001812 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001813 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001814 * session store remains the responsibility of the application, though).
1815 * Server-side, you also need to provide callbacks for writing and parsing
1816 * tickets, including authenticated encryption and key management. Example
1817 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001818 *
1819 * Comment this macro to disable support for SSL session tickets
1820 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001822
1823/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001825 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001826 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001827 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001828 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001829 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001830 * Comment this macro to disable support for server name indication in SSL
1831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001832#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001833
1834/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001835 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1836 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001837 * When this option is enabled, the SSL buffer will be resized automatically
1838 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001839 *
1840 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001841 */
1842//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1843
1844/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001845 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1846 *
1847 * Enable testing of the constant-flow nature of some sensitive functions with
1848 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001849 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001850 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001851 * This setting requires compiling with clang -fsanitize=memory. The test
1852 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001853 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001854 * \warning This macro is only used for extended testing; it is not considered
1855 * part of the library's API, so it may change or disappear at any time.
1856 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001857 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001858 */
1859//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1860
1861/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001862 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1863 *
1864 * Enable testing of the constant-flow nature of some sensitive functions with
1865 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001866 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001867 *
1868 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001869 * testing if the tests suites are run with valgrind's memcheck. This can be
1870 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1871 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001872 *
1873 * \warning This macro is only used for extended testing; it is not considered
1874 * part of the library's API, so it may change or disappear at any time.
1875 *
1876 * Uncomment to enable testing of the constant-flow nature of selected code.
1877 */
1878//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1879
1880/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001881 * \def MBEDTLS_TEST_HOOKS
1882 *
1883 * Enable features for invasive testing such as introspection functions and
1884 * hooks for fault injection. This enables additional unit tests.
1885 *
1886 * Merely enabling this feature should not change the behavior of the product.
1887 * It only adds new code, and new branching points where the default behavior
1888 * is the same as when this feature is disabled.
1889 * However, this feature increases the attack surface: there is an added
1890 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1891 * Therefore this feature must never be enabled in production.
1892 *
1893 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1894 * information.
1895 *
1896 * Uncomment to enable invasive tests.
1897 */
1898//#define MBEDTLS_TEST_HOOKS
1899
1900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001902 *
1903 * Provide your own alternate threading implementation.
1904 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001906 *
1907 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001908 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001910
1911/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001913 *
1914 * Enable the pthread wrapper layer for the threading layer.
1915 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001917 *
1918 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001919 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001921
1922/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001923 * \def MBEDTLS_USE_PSA_CRYPTO
1924 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001925 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1926 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001927 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001928 * \note Development of this option is currently in progress, and parts of Mbed
1929 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001930 * will still continue to work as usual, so enabling this option should not
1931 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001932 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001933 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001934 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1935 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001936 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001937 * \note An important and desirable effect of this option is that it allows
1938 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1939 * this option is what allows use of drivers for ECDSA, ECDH and EC J-PAKE in
Manuel Pégourié-Gonnard9463e782023-03-30 09:37:39 +02001940 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001941 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1942 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001943 *
1944 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001945 *
1946 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001947 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001948 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001949 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001950//#define MBEDTLS_USE_PSA_CRYPTO
1951
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001952/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001953 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1954 *
John Durkop185764f2020-10-12 21:32:12 -07001955 * This setting allows support for cryptographic mechanisms through the PSA
1956 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001957 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001958 * When this option is disabled, the PSA API exposes the cryptographic
1959 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1960 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001961 *
1962 * When this option is enabled, the PSA API exposes the cryptographic
1963 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1964 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1965 * automatically enabled if required (i.e. if no PSA driver provides the
1966 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1967 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001968 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001969 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001970 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001971 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001972 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1973 * symbols is not completely finalized yet, and the configuration
1974 * tooling is not ideally adapted to having two separate configuration
1975 * files.
1976 * Future minor releases of Mbed TLS may make minor changes to those
1977 * symbols, but we will endeavor to provide a transition path.
1978 * Nonetheless, this option is considered mature enough to use in
1979 * production, as long as you accept that you may need to make
1980 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001981 */
1982//#define MBEDTLS_PSA_CRYPTO_CONFIG
1983
1984/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001985 * \def MBEDTLS_VERSION_FEATURES
1986 *
1987 * Allow run-time checking of compile-time enabled features. Thus allowing users
1988 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001989 * support via mbedtls_version_check_feature().
1990 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001991 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00001992 *
1993 * Comment this to disable run-time checking and save ROM space
1994 */
1995#define MBEDTLS_VERSION_FEATURES
1996
1997/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001998 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1999 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002000 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002001 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2002 * the set of trusted certificates through a callback instead of a linked
2003 * list.
2004 *
2005 * This is useful for example in environments where a large number of trusted
2006 * certificates is present and storing them in a linked list isn't efficient
2007 * enough, or when the set of trusted certificates changes frequently.
2008 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002009 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002010 * `mbedtls_ssl_conf_ca_cb()` for more information.
2011 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002012 * Requires: MBEDTLS_X509_CRT_PARSE_C
2013 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002014 * Uncomment to enable trusted certificate callbacks.
2015 */
2016//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2017
2018/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002019 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002020 *
Chris Jones2c745862020-12-16 11:41:06 +00002021 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002022 *
Chris Jones2c745862020-12-16 11:41:06 +00002023 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002024 * and other functions/constants only used by these functions, thus reducing
2025 * the code footprint by several KB.
2026 */
Chris Jones2c745862020-12-16 11:41:06 +00002027//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002028
2029/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002030 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002031 *
2032 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2033 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2034 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002035 * Requires: MBEDTLS_PKCS1_V21
2036 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002037 * Comment this macro to disallow using RSASSA-PSS in certificates.
2038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002040/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002041
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002042/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002043 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002044 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002045 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002046 * \{
2047 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002048
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002049/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002051 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002052 * Enable AES-NI support on x86-64 or x86-32.
2053 *
2054 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002055 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002056 * - GCC, x86-64, target not explicitly supporting AESNI:
2057 * requires MBEDTLS_HAVE_ASM.
2058 * - GCC, x86-32, target not explicitly supporting AESNI:
2059 * not supported.
2060 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2061 * For this assembly-less implementation, you must currently compile
2062 * `library/aesni.c` and `library/aes.c` with machine options to enable
2063 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2064 * `clang -maes -mpclmul`.
2065 * - Non-x86 targets: this option is silently ignored.
2066 * - Other compilers: this option is silently ignored.
2067 *
2068 * \note
2069 * Above, "GCC" includes compatible compilers such as Clang.
2070 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002071 *
2072 * Module: library/aesni.c
2073 * Caller: library/aes.c
2074 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002075 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002076 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002077 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002078 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002080
2081/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002082 * \def MBEDTLS_AESCE_C
2083 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002084 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002085 *
2086 * Module: library/aesce.c
2087 * Caller: library/aes.c
2088 *
Jerry Yuf015a932023-04-25 10:38:03 +08002089 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002090 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002091 * \warning Runtime detection only works on Linux. For non-Linux operating
2092 * system, Armv8-A Cryptographic Extensions must be supported by
2093 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002094 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002095 * \note Minimum compiler versions for this feature when targeting aarch64
2096 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2097 * Minimum compiler versions for this feature when targeting 32-bit
2098 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002099 *
2100 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2101 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002102 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002103 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002104 */
2105#define MBEDTLS_AESCE_C
2106
2107/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002108 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002109 *
2110 * Enable the AES block cipher.
2111 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002112 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002113 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002114 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002115 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002116 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002117 * This module enables the following ciphersuites (if other requisites are
2118 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2120 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2121 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2122 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2123 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2124 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2125 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2126 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2127 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2128 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2129 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2130 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2131 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2132 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2133 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2134 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2135 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2136 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2137 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2138 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2139 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2140 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2141 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2142 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2143 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2144 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2145 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2146 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2147 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2148 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2149 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2150 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2151 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2152 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2153 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2154 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2155 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2156 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2157 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2158 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2159 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2160 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2161 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2162 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2163 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2164 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2165 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2166 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2167 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2168 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2169 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2170 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2171 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2172 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2173 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2174 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2175 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2176 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002177 *
Paul Bakkercff68422013-09-15 20:43:33 +02002178 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002179 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002180#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002181
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002182/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002184 *
2185 * Enable the generic ASN1 parser.
2186 *
2187 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002188 * Caller: library/x509.c
2189 * library/dhm.c
2190 * library/pkcs12.c
2191 * library/pkcs5.c
2192 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002193 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002195
2196/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002198 *
2199 * Enable the generic ASN1 writer.
2200 *
2201 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002202 * Caller: library/ecdsa.c
2203 * library/pkwrite.c
2204 * library/x509_create.c
2205 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002206 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002209
2210/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002212 *
2213 * Enable the Base64 module.
2214 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002215 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002216 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002217 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002218 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002219 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002220#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002221
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002222/**
Yanray Wange367e472023-10-31 17:23:04 +08002223 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2224 *
2225 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2226 *
2227 * \note This feature is incompatible with insecure block cipher,
2228 * MBEDTLS_DES_C, and cipher modes which always require decryption
2229 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002230 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2231 * this feature is incompatible with following supported PSA equivalence,
2232 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2233 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002234 *
2235 * Module: library/aes.c
2236 * library/aesce.c
2237 * library/aesni.c
2238 * library/aria.c
2239 * library/camellia.c
2240 * library/cipher.c
2241 */
2242//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2243
2244/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002246 *
Paul Bakker9a736322012-11-14 12:39:52 +00002247 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002248 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002249 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002250 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002251 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002252 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002253 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002254 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002255 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002256 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002257 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002258 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002259 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002260 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002261 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002262#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002263
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002264/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002265 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002266 *
2267 * Enable the Camellia block cipher.
2268 *
Paul Bakker38119b12009-01-10 23:31:23 +00002269 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002270 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002271 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002272 * This module enables the following ciphersuites (if other requisites are
2273 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002274 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2275 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2276 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2277 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2278 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2279 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2280 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2281 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2282 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2283 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2284 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2285 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2286 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2287 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2288 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2289 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2290 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2291 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2292 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2293 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2294 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2295 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2296 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2297 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2298 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2299 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2300 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2301 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2302 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2303 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2304 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2305 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2306 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2307 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2308 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2309 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2310 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2311 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2312 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2313 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2314 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2315 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002316 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002317#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002318
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002319/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002320 * \def MBEDTLS_ARIA_C
2321 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002322 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002323 *
2324 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002325 * Caller: library/cipher.c
2326 *
2327 * This module enables the following ciphersuites (if other requisites are
2328 * enabled as well):
2329 *
2330 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2331 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2332 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2333 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2334 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2335 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2336 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2337 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2338 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2339 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2340 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2341 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2342 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2343 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2344 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2345 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2346 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2347 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2348 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2349 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2350 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2351 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2352 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2353 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2354 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2355 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2356 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2357 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2358 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2359 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2360 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2361 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2362 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2363 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2364 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2365 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2366 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2367 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002368 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002369#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002370
2371/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002372 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002373 *
2374 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2375 *
2376 * Module: library/ccm.c
2377 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002378 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2379 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002380 *
2381 * This module enables the AES-CCM ciphersuites, if other requisites are
2382 * enabled as well.
2383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002384#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002385
2386/**
Daniel King34b822c2016-05-15 17:28:08 -03002387 * \def MBEDTLS_CHACHA20_C
2388 *
2389 * Enable the ChaCha20 stream cipher.
2390 *
2391 * Module: library/chacha20.c
2392 */
2393#define MBEDTLS_CHACHA20_C
2394
2395/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002396 * \def MBEDTLS_CHACHAPOLY_C
2397 *
2398 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2399 *
2400 * Module: library/chachapoly.c
2401 *
2402 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2403 */
2404#define MBEDTLS_CHACHAPOLY_C
2405
2406/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002407 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002408 *
2409 * Enable the generic cipher layer.
2410 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002411 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002412 * Caller: library/ccm.c
2413 * library/cmac.c
2414 * library/gcm.c
2415 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002416 * library/pkcs12.c
2417 * library/pkcs5.c
2418 * library/psa_crypto_aead.c
2419 * library/psa_crypto_mac.c
2420 * library/ssl_ciphersuites.c
2421 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002422 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002423 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2424 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002425 *
2426 * Uncomment to enable generic cipher wrappers.
2427 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002428#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002429
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002430/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002431 * \def MBEDTLS_CMAC_C
2432 *
Simon Butcher327398a2016-10-05 14:09:11 +01002433 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2434 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002435 *
2436 * Module: library/cmac.c
2437 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002438 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002439 *
2440 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002441#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002442
2443/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002445 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002446 * Enable the CTR_DRBG AES-based random generator.
2447 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002448 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002449 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002450 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002451 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2452 * is used.
2453 *
2454 * \warning When using PSA, the user should call `psa_crypto_init()` before
2455 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2456 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002457 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2458 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002459 * \note To achieve a 256-bit security strength with CTR_DRBG,
2460 * you must use AES-256 *and* use sufficient entropy.
2461 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002462 *
2463 * Module: library/ctr_drbg.c
2464 * Caller:
2465 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002466 * Requires: MBEDTLS_AES_C or
2467 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2468 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002469 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002470 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002471 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002472#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002473
2474/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002475 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002476 *
2477 * Enable the debug functions.
2478 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002479 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002480 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002481 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002482 * library/ssl_tls12_*.c
2483 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002484 *
2485 * This module provides debugging functions.
2486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002487#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002488
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002489/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002490 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002491 *
2492 * Enable the DES block cipher.
2493 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002494 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002495 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002496 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002497 *
Paul Bakkercff68422013-09-15 20:43:33 +02002498 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002499 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002500 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002501 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002502 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002504
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002507 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002508 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002509 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002510 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002511 * Caller: library/ssl_tls.c
2512 * library/ssl*_client.c
2513 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002514 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002515 * This module is used by the following key exchanges:
2516 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002517 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002518 * \warning Using DHE constitutes a security risk as it
2519 * is not possible to validate custom DH parameters.
2520 * If possible, it is recommended users should consider
2521 * preferring other methods of key exchange.
2522 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002523 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002524 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002525#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002526
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002527/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002528 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002529 *
2530 * Enable the elliptic curve Diffie-Hellman library.
2531 *
2532 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002533 * Caller: library/psa_crypto.c
2534 * library/ssl_tls.c
2535 * library/ssl*_client.c
2536 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002537 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002538 * This module is used by the following key exchanges:
2539 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002540 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002542 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002544
2545/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002547 *
2548 * Enable the elliptic curve DSA library.
2549 *
2550 * Module: library/ecdsa.c
2551 * Caller:
2552 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002553 * This module is used by the following key exchanges:
2554 * ECDHE-ECDSA
2555 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002556 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2557 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2558 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002561
2562/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002563 * \def MBEDTLS_ECJPAKE_C
2564 *
2565 * Enable the elliptic curve J-PAKE library.
2566 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002567 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2568 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002569 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002570 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002571 * Module: library/ecjpake.c
2572 * Caller:
2573 *
2574 * This module is used by the following key exchanges:
2575 * ECJPAKE
2576 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002577 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002578 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002579 * \warning If using a hash that is only provided by PSA drivers, you must
2580 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002581 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002582#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002583
2584/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002586 *
2587 * Enable the elliptic curve over GF(p) library.
2588 *
2589 * Module: library/ecp.c
2590 * Caller: library/ecdh.c
2591 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002592 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002593 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002594 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002597
2598/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002600 *
2601 * Enable the platform-specific entropy code.
2602 *
2603 * Module: library/entropy.c
2604 * Caller:
2605 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002606 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002607 *
2608 * This module provides a generic entropy pool
2609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002610#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002611
2612/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002614 *
2615 * Enable error code to error string conversion.
2616 *
2617 * Module: library/error.c
2618 * Caller:
2619 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002621 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002623
2624/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002625 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002626 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002627 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002628 *
2629 * Module: library/gcm.c
2630 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002631 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2632 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002633 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002634 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2635 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002636 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002638
2639/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002640 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002641 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002642 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002643 * Can significantly increase throughput on systems without GCM hardware
2644 * acceleration (e.g., AESNI, AESCE).
2645 *
Matthias Schulz78266782024-02-08 13:54:48 +01002646 * The mbedtls_gcm_context size will increase by 3840 bytes.
2647 * The code size will increase by roughly 344 bytes.
2648 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002649 * Module: library/gcm.c
2650 *
2651 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002652 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002653//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002654
2655/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002656 * \def MBEDTLS_HKDF_C
2657 *
2658 * Enable the HKDF algorithm (RFC 5869).
2659 *
2660 * Module: library/hkdf.c
2661 * Caller:
2662 *
2663 * Requires: MBEDTLS_MD_C
2664 *
2665 * This module adds support for the Hashed Message Authentication Code
2666 * (HMAC)-based key derivation function (HKDF).
2667 */
2668#define MBEDTLS_HKDF_C
2669
2670/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002672 *
2673 * Enable the HMAC_DRBG random generator.
2674 *
2675 * Module: library/hmac_drbg.c
2676 * Caller:
2677 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002678 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002679 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002680 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002681 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002683
2684/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002685 * \def MBEDTLS_LMS_C
2686 *
2687 * Enable the LMS stateful-hash asymmetric signature algorithm.
2688 *
2689 * Module: library/lms.c
2690 * Caller:
2691 *
Raef Colesab4f8742022-09-01 12:24:31 +01002692 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002693 *
Raef Colesab4f8742022-09-01 12:24:31 +01002694 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002695 */
2696#define MBEDTLS_LMS_C
2697
2698/**
Raef Colesab4f8742022-09-01 12:24:31 +01002699 * \def MBEDTLS_LMS_PRIVATE
2700 *
2701 * Enable LMS private-key operations and signing code. Functions enabled by this
2702 * option are experimental, and should not be used in production.
2703 *
2704 * Requires: MBEDTLS_LMS_C
2705 *
2706 * Uncomment to enable the LMS signature algorithm and private key operations.
2707 */
Raef Coles5127e852022-10-07 10:35:56 +01002708//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002709
2710/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002711 * \def MBEDTLS_NIST_KW_C
2712 *
2713 * Enable the Key Wrapping mode for 128-bit block ciphers,
2714 * as defined in NIST SP 800-38F. Only KW and KWP modes
2715 * are supported. At the moment, only AES is approved by NIST.
2716 *
2717 * Module: library/nist_kw.c
2718 *
2719 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2720 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002721#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002722
2723/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002725 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002726 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002727 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002728 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2729 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002730 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002731 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002732 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002733 * Caller: library/constant_time.c
2734 * library/ecdsa.c
2735 * library/ecjpake.c
2736 * library/hkdf.c
2737 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002738 * library/pk.c
2739 * library/pkcs5.c
2740 * library/pkcs12.c
2741 * library/psa_crypto_ecp.c
2742 * library/psa_crypto_rsa.c
2743 * library/rsa.c
2744 * library/ssl_cookie.c
2745 * library/ssl_msg.c
2746 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002747 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002748 * library/x509_crt.c
2749 * library/x509write_crt.c
2750 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002751 *
2752 * Uncomment to enable generic message digest wrappers.
2753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002754#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002755
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002756/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002758 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002759 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002760 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002761 * Module: library/md5.c
2762 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002763 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002764 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002765 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002766 * This module is required for TLS 1.2 depending on the handshake parameters.
2767 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2768 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002769 *
2770 * \warning MD5 is considered a weak message digest and its use constitutes a
2771 * security risk. If possible, we recommend avoiding dependencies on
2772 * it, and considering stronger message digests instead.
2773 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002774 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002776
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002777/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002778 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002779 *
2780 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002781 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002782 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002783 *
2784 * Module: library/memory_buffer_alloc.c
2785 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002787 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002788 *
2789 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002790 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002792
2793/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002795 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002796 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2797 *
Simon Butcherd567a232016-03-09 20:19:21 +00002798 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2799 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002800 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002801 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002802 * \note See also our Knowledge Base article about porting to a new
2803 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002804 * 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 +00002805 *
Andres AG788aa4a2016-09-14 14:32:09 +01002806 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002807 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002808 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002811
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002812/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002814 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002815 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002816 *
2817 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002818 * Caller: library/asn1write.c
2819 * library/pkcs5.c
2820 * library/pkparse.c
2821 * library/pkwrite.c
2822 * library/rsa.c
2823 * library/x509.c
2824 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002825 * library/x509_crl.c
2826 * library/x509_crt.c
2827 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002828 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002829 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002830 *
2831 * This modules translates between OIDs and internal values.
2832 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002834
2835/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002836 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002837 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002838 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002839 *
2840 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002841 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002842 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002843 * library/x509_crl.c
2844 * library/x509_crt.c
2845 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002846 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002847 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002848 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2849 *
2850 * \warning When parsing password-protected files, if MD5 is provided only by
2851 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002852 *
Paul Bakkercff68422013-09-15 20:43:33 +02002853 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002854 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002856
2857/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002859 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002860 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002861 *
2862 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002863 * Caller: library/pkwrite.c
2864 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002865 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002866 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002868 *
2869 * This modules adds support for encoding / writing PEM files.
2870 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002872
2873/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002875 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002876 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002877 *
2878 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002879 * Caller: library/psa_crypto_rsa.c
2880 * library/ssl_tls.c
2881 * library/ssl*_client.c
2882 * library/ssl*_server.c
2883 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002884 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002885 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002886 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002887 * Uncomment to enable generic public key wrappers.
2888 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002890
2891/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002892 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002893 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002894 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002895 *
2896 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002897 * Caller: library/x509_crt.c
2898 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002899 *
Yanray Wang072a0682023-12-05 10:53:04 +08002900 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002901 *
2902 * Uncomment to enable generic public key parse functions.
2903 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002905
2906/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002908 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002909 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002910 *
2911 * Module: library/pkwrite.c
2912 * Caller: library/x509write.c
2913 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002914 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002915 *
2916 * Uncomment to enable generic public key write functions.
2917 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002919
2920/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002921 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002922 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002923 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002924 *
2925 * Module: library/pkcs5.c
2926 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002927 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002928 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002929 * \warning If using a hash that is only provided by PSA drivers, you must
2930 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002931 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002932 * This module adds support for the PKCS#5 functions.
2933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002935
2936/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002937 * \def MBEDTLS_PKCS7_C
2938 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002939 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002940 * RFC Link - https://tools.ietf.org/html/rfc2315
2941 *
2942 * Module: library/pkcs7.c
2943 *
2944 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002945 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2946 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002947 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002948 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002949 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002950#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002951
2952/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002954 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002955 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002956 * Adds algorithms for parsing PKCS#8 encrypted private keys
2957 *
2958 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002959 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002960 *
Valerio Settie98ad592023-12-28 10:42:12 +01002961 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2962 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002963 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002964 * \warning If using a hash that is only provided by PSA drivers, you must
2965 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002966 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002967 * This module enables PKCS#12 functions.
2968 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002970
2971/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002972 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002973 *
2974 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002975 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002976 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002977 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2978 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002979 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002980 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002981 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002982 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002983 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002984 * Module: library/platform.c
2985 * Caller: Most other .c files
2986 *
2987 * This module enables abstraction of common (libc) functions.
2988 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002989#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002990
2991/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002992 * \def MBEDTLS_POLY1305_C
2993 *
2994 * Enable the Poly1305 MAC algorithm.
2995 *
2996 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002997 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002998 */
2999#define MBEDTLS_POLY1305_C
3000
3001/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003002 * \def MBEDTLS_PSA_CRYPTO_C
3003 *
3004 * Enable the Platform Security Architecture cryptography API.
3005 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003006 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003007 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003008 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003009 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003010 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3011 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3012 * is enabled in PSA (unless it's fully accelerated, see
3013 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003014 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003015#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003016
3017/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003018 * \def MBEDTLS_PSA_CRYPTO_SE_C
3019 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003020 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003021 * cryptography API.
3022 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003023 * \deprecated This feature is deprecated. Please switch to the PSA driver
3024 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003025 *
Ryan Everett32a64582024-03-05 18:16:18 +00003026 * \warning This feature is not thread-safe, and should not be used in a
3027 * multi-threaded environment.
3028 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003029 * Module: library/psa_crypto_se.c
3030 *
3031 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3032 *
3033 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003034//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003035
3036/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003037 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3038 *
3039 * Enable the Platform Security Architecture persistent key storage.
3040 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003041 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003042 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003043 * Requires: MBEDTLS_PSA_CRYPTO_C,
3044 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3045 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003046 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003047#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003048
3049/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003050 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003051 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003052 * Enable the emulation of the Platform Security Architecture
3053 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003054 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003055 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003056 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003057 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003058 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003059#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003060
3061/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003063 *
3064 * Enable the RIPEMD-160 hash algorithm.
3065 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003066 * Module: library/ripemd160.c
3067 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003068 *
3069 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003070#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003071
3072/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003074 *
3075 * Enable the RSA public-key cryptosystem.
3076 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003077 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003078 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003079 * Caller: library/pk.c
3080 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003081 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003082 * library/ssl*_client.c
3083 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003084 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003085 * This module is used by the following key exchanges:
3086 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003087 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003091
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003092/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003094 *
3095 * Enable the SHA1 cryptographic hash algorithm.
3096 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003097 * Module: library/sha1.c
3098 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003099 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003100 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003101 * This module is required for TLS 1.2 depending on the handshake parameters,
3102 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003103 *
3104 * \warning SHA-1 is considered a weak message digest and its use constitutes
3105 * a security risk. If possible, we recommend avoiding dependencies
3106 * on it, and considering stronger message digests instead.
3107 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003109#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003110
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003111/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003112 * \def MBEDTLS_SHA224_C
3113 *
3114 * Enable the SHA-224 cryptographic hash algorithm.
3115 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003116 * Module: library/sha256.c
3117 * Caller: library/md.c
3118 * library/ssl_cookie.c
3119 *
3120 * This module adds support for SHA-224.
3121 */
3122#define MBEDTLS_SHA224_C
3123
3124/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003125 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003126 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003127 * Enable the SHA-256 cryptographic hash algorithm.
3128 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003129 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003130 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003131 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003132 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003133 * library/ssl*_client.c
3134 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003135 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003136 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003137 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003140
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003141/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003142 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003143 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003144 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3145 * with the ARMv8 cryptographic extensions if they are available at runtime.
3146 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003147 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003148 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003149 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003150 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003151 * \note Minimum compiler versions for this feature are Clang 4.0,
3152 * armclang 6.6 or GCC 6.0.
3153 *
3154 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3155 * armclang <= 6.9
3156 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003157 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3158 * That name is deprecated, but may still be used as an alternative form for this
3159 * option.
3160 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003161 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3162 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003163 *
3164 * Requires: MBEDTLS_SHA256_C.
3165 *
3166 * Module: library/sha256.c
3167 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003168 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003169 * and use them if available.
3170 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003171//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003172
Dave Rodgmand85277c2023-10-13 09:22:54 +01003173/**
3174 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3175 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003176 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003177 * This name is now deprecated, but may still be used as an alternative form for
3178 * this option.
3179 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003180//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3181
3182/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003183 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003184 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003185 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3186 * with the ARMv8 cryptographic extensions, which must be available at runtime
3187 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003188 *
3189 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003190 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003191 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003192 * \note Minimum compiler versions for this feature are Clang 4.0,
3193 * armclang 6.6 or GCC 6.0.
3194 *
3195 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3196 * armclang <= 6.9
3197 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003198 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003199 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003200 * option.
3201 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003202 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3203 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003204 *
3205 * Requires: MBEDTLS_SHA256_C.
3206 *
3207 * Module: library/sha256.c
3208 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003209 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003210 * unconditionally.
3211 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003212//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003213
Dave Rodgmand85277c2023-10-13 09:22:54 +01003214/**
3215 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3216 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003217 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003218 * This name is now deprecated, but may still be used as an alternative form for
3219 * this option.
3220 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003221//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3222
3223/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003224 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003225 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003226 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003227 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003228 * Module: library/sha512.c
3229 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003230 * library/psa_crypto_hash.c
3231 * library/ssl_tls.c
3232 * library/ssl*_client.c
3233 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003234 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003235 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003236 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003237#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003238
3239/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003240 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003241 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003242 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003243 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003244 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003245 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003246 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003247 * library/ssl_tls.c
3248 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003249 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003250 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003251 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003252#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003253
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003254/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003255 * \def MBEDTLS_SHA3_C
3256 *
3257 * Enable the SHA3 cryptographic hash algorithm.
3258 *
3259 * Module: library/sha3.c
3260 *
3261 * This module adds support for SHA3.
3262 */
3263#define MBEDTLS_SHA3_C
3264
3265/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003266 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3267 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003268 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3269 * with the ARMv8 cryptographic extensions if they are available at runtime.
3270 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003271 *
3272 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3273 * for a non-Aarch64 build it will be silently ignored.
3274 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003275 * \note Minimum compiler versions for this feature are Clang 7.0,
3276 * armclang 6.9 or GCC 8.0.
3277 *
3278 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3279 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003280 *
3281 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3282 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3283 *
3284 * Requires: MBEDTLS_SHA512_C.
3285 *
3286 * Module: library/sha512.c
3287 *
3288 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3289 * and use them if available.
3290 */
3291//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3292
3293/**
3294 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3295 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003296 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3297 * with the ARMv8 cryptographic extensions, which must be available at runtime
3298 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003299 *
3300 * \note This allows builds with a smaller code size than with
3301 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3302 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003303 * \note Minimum compiler versions for this feature are Clang 7.0,
3304 * armclang 6.9 or GCC 8.0.
3305 *
3306 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3307 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003308 *
3309 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3310 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3311 *
3312 * Requires: MBEDTLS_SHA512_C.
3313 *
3314 * Module: library/sha512.c
3315 *
3316 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3317 * unconditionally.
3318 */
3319//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3320
3321/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003323 *
3324 * Enable simple SSL cache implementation.
3325 *
3326 * Module: library/ssl_cache.c
3327 * Caller:
3328 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003330 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003331#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003332
3333/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003334 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003335 *
3336 * Enable basic implementation of DTLS cookies for hello verification.
3337 *
3338 * Module: library/ssl_cookie.c
3339 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003340 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003341#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003342
3343/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003344 * \def MBEDTLS_SSL_TICKET_C
3345 *
3346 * Enable an implementation of TLS server-side callbacks for session tickets.
3347 *
3348 * Module: library/ssl_ticket.c
3349 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003350 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003351 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3352 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003353 */
3354#define MBEDTLS_SSL_TICKET_C
3355
3356/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003357 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003358 *
3359 * Enable the SSL/TLS client code.
3360 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003361 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003362 * Caller:
3363 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003364 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003365 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003366 * This module is required for SSL/TLS client support.
3367 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003369
Paul Bakker9a736322012-11-14 12:39:52 +00003370/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003372 *
3373 * Enable the SSL/TLS server code.
3374 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003375 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003376 * Caller:
3377 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003379 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003380 * This module is required for SSL/TLS server support.
3381 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003383
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003384/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003385 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003386 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003387 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003388 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003389 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003390 * Caller: library/ssl*_client.c
3391 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003392 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3394 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003395 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003396 * This module is required for SSL/TLS.
3397 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003399
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003400/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003401 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003402 *
3403 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003404 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003405 * contexts are not shared between threads. If you do intend to use contexts
3406 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003407 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003408 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003409 *
3410 * Module: library/threading.c
3411 *
3412 * This allows different threading implementations (self-implemented or
3413 * provided).
3414 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415 * You will have to enable either MBEDTLS_THREADING_ALT or
3416 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003417 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003418 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003419 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003421
3422/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003424 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003425 * Enable the semi-portable timing interface.
3426 *
Simon Butcherd567a232016-03-09 20:19:21 +00003427 * \note The provided implementation only works on POSIX/Unix (including Linux,
3428 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003429 * module and provide your own implementations of the callbacks needed by
3430 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3431 * your own implementation of the whole module by setting
3432 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003433 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003434 * \note The timing module will include time.h on suitable platforms
3435 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3436 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3437 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003438 * \note See also our Knowledge Base article about porting to a new
3439 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003440 * 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 +00003441 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003442 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003445
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003446/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003447 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003448 *
3449 * Enable run-time version information.
3450 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003451 * Module: library/version.c
3452 *
3453 * This module provides run-time version information.
3454 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003456
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003457/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003458 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003459 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003460 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003461 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003462 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003463 * Caller: library/x509_crl.c
3464 * library/x509_crt.c
3465 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003466 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003467 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003468 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3469 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003470 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3471 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003472 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003473 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003476
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003479 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003480 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003481 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003482 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003483 * Caller: library/ssl_tls.c
3484 * library/ssl*_client.c
3485 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003486 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003488 *
3489 * This module is required for X.509 certificate parsing.
3490 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003491#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003492
3493/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003495 *
3496 * Enable X.509 CRL parsing.
3497 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003498 * Module: library/x509_crl.c
3499 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003500 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003501 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003502 *
3503 * This module is required for X.509 CRL parsing.
3504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003506
3507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003509 *
3510 * Enable X.509 Certificate Signing Request (CSR) parsing.
3511 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003512 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003513 * Caller: library/x509_crt_write.c
3514 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003515 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003516 *
3517 * This module is used for reading X.509 certificate request.
3518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003520
3521/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003523 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003524 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003525 *
3526 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003527 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003528 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003529 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3530 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003531 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3532 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003533 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003534 * This module is the basis for creating X.509 certificates and CSRs.
3535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003537
3538/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003539 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003540 *
3541 * Enable creating X.509 certificates.
3542 *
3543 * Module: library/x509_crt_write.c
3544 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003545 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003546 *
3547 * This module is required for X.509 certificate creation.
3548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003550
3551/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003553 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003554 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003555 *
3556 * Module: library/x509_csr_write.c
3557 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003559 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003560 * This module is required for X.509 certificate request writing.
3561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003562#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003563
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003564/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003565
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003566/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003567 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003568 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003569 * This section contains Mbed TLS build settings that are not associated
3570 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003571 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003572 * \{
3573 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003574
Gilles Peskinea02c1242022-03-16 17:03:19 +01003575/**
3576 * \def MBEDTLS_CONFIG_FILE
3577 *
3578 * If defined, this is a header which will be included instead of
3579 * `"mbedtls/mbedtls_config.h"`.
3580 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003581 * Unlike other configuration options, this one must be defined on the
3582 * compiler command line: a definition in `mbedtls_config.h` would have
3583 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003584 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003585 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003586 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003587 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003588 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003589 * The value of this symbol is typically a path in double quotes, either
3590 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003591 */
3592//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3593
3594/**
3595 * \def MBEDTLS_USER_CONFIG_FILE
3596 *
3597 * If defined, this is a header which will be included after
3598 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003599 * This allows you to modify the default configuration, including the ability
3600 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003601 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003602 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003603 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003604 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003605 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003606 * The value of this symbol is typically a path in double quotes, either
3607 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003608 */
3609//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3610
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003611/**
3612 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3613 *
3614 * If defined, this is a header which will be included instead of
3615 * `"psa/crypto_config.h"`.
3616 * This header file specifies which cryptographic mechanisms are available
3617 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3618 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3619 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003620 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003621 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003622 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003623 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003624 * The value of this symbol is typically a path in double quotes, either
3625 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003626 */
3627//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3628
3629/**
3630 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3631 *
3632 * If defined, this is a header which will be included after
3633 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003634 * This allows you to modify the default configuration, including the ability
3635 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003636 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003637 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003638 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003639 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003640 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003641 * The value of this symbol is typically a path in double quotes, either
3642 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003643 */
3644//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3645
Gilles Peskineb1176f22023-02-22 22:07:28 +01003646/**
3647 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3648 *
3649 * If defined, this is a header which will be included instead of
3650 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3651 * as the one in Mbed TLS, but with definitions adapted to the platform on
3652 * which the library code will run.
3653 *
3654 * \note The required content of this header can vary from one version of
3655 * Mbed TLS to the next. Integrators who provide an alternative file
3656 * should review the changes in the original file whenever they
3657 * upgrade Mbed TLS.
3658 *
3659 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3660 * non-standard feature of the C language, so this feature is only available
3661 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3662 *
3663 * The value of this symbol is typically a path in double quotes, either
3664 * absolute or relative to a directory on the include search path.
3665 */
3666//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3667
3668/**
3669 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3670 *
3671 * If defined, this is a header which will be included instead of
3672 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3673 * as the one in Mbed TLS, but with definitions adapted to the environment
3674 * in which the library code will run. The typical use for this feature
3675 * is to provide alternative type definitions on the client side in
3676 * client-server integrations of PSA crypto, where operation structures
3677 * contain handles instead of cryptographic data.
3678 *
3679 * \note The required content of this header can vary from one version of
3680 * Mbed TLS to the next. Integrators who provide an alternative file
3681 * should review the changes in the original file whenever they
3682 * upgrade Mbed TLS.
3683 *
3684 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3685 * non-standard feature of the C language, so this feature is only available
3686 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3687 *
3688 * The value of this symbol is typically a path in double quotes, either
3689 * absolute or relative to a directory on the include search path.
3690 */
3691//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3692
Gilles Peskineba4162a2022-04-11 17:04:38 +02003693/** \} name SECTION: General configuration options */
3694
3695/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003696 * \name SECTION: Module configuration options
3697 *
3698 * This section allows for the setting of module specific sizes and
3699 * configuration options. The default values are already present in the
3700 * relevant header files and should suffice for the regular use cases.
3701 *
3702 * Our advice is to enable options and change their values here
3703 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003704 * \{
3705 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003706/* The Doxygen documentation here is used when a user comments out a
3707 * setting and runs doxygen themselves. On the other hand, when we typeset
3708 * the full documentation including disabled settings, the documentation
3709 * in specific modules' header files is used if present. When editing this
3710 * file, make sure that each option is documented in exactly one place,
3711 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3712 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003713
Paul Bakker088c5c52014-04-25 11:11:10 +02003714/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003715//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003716//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003717
Paul Bakker088c5c52014-04-25 11:11:10 +02003718/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003719//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3720//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3721//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3722//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3723//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003724
Paul Bakker088c5c52014-04-25 11:11:10 +02003725/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003726//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3727//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3728//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3729//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003730
Paul Bakker088c5c52014-04-25 11:11:10 +02003731/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003732//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003733//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003734
Paul Bakker088c5c52014-04-25 11:11:10 +02003735/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003736//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3737//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003738//#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 +01003739
Paul Bakker088c5c52014-04-25 11:11:10 +02003740/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003741//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003742
Paul Bakker088c5c52014-04-25 11:11:10 +02003743/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003744//#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 -04003745
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003746/** \def MBEDTLS_PLATFORM_STD_CALLOC
3747 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003748 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003749 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003750 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003751 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003752 * 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 -04003753 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3754 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003755 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003756 */
3757//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003758
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003759/** \def MBEDTLS_PLATFORM_STD_FREE
3760 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003761 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003762 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003763 * 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 -04003764 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3765 * 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 -04003766 */
3767//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003768//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003769//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003770//#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 +02003771//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3772//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003773/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003774//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003775//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3776//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003777//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3778//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3779//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003780
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003781/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003782/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003783//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3784//#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 +02003785//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003786//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003787//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3788//#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 +02003789//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3790//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003791/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003792//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003793//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003794//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3795//#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 +08003796//#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 +08003797//#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 +02003798
Gilles Peskine3f106f72021-09-23 17:42:39 +02003799/** \def MBEDTLS_CHECK_RETURN
3800 *
3801 * This macro is used at the beginning of the declaration of a function
3802 * to indicate that its return value should be checked. It should
3803 * instruct the compiler to emit a warning or an error if the function
3804 * is called without checking its return value.
3805 *
3806 * There is a default implementation for popular compilers in platform_util.h.
3807 * You can override the default implementation by defining your own here.
3808 *
3809 * If the implementation here is empty, this will effectively disable the
3810 * checking of functions' return values.
3811 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003812//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003813
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003814/** \def MBEDTLS_IGNORE_RETURN
3815 *
3816 * This macro requires one argument, which should be a C function call.
3817 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3818 * warning is suppressed.
3819 */
3820//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3821
Gilles Peskineed038902020-11-13 21:33:21 +01003822/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003823/**
Gilles Peskineed038902020-11-13 21:33:21 +01003824 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3825 * PSA crypto subsystem.
3826 *
3827 * If this option is unset:
3828 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003829 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003830 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3831 * on unspecified heuristics.
3832 */
3833//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3834
Steven Cooreman863470a2021-02-15 14:03:19 +01003835/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003836 * Restrict the PSA library to supporting a maximum amount of simultaneously
3837 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3838 * volatile key, or a persistent key which is loaded temporarily by the
3839 * library as part of a crypto operation in flight.
3840 *
3841 * If this option is unset, the library will fall back to a default value of
3842 * 32 keys.
3843 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003844//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003845
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003846/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003847//#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 +00003848
Paul Bakker088c5c52014-04-25 11:11:10 +02003849/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003850//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3851//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003852
Paul Bakker088c5c52014-04-25 11:11:10 +02003853/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003854
Angus Grattond8213d02016-05-25 20:56:48 +10003855/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3856 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003857 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003858 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003859 * This determines the size of the incoming TLS I/O buffer in such a way
3860 * that it is capable of holding the specified amount of plaintext data,
3861 * regardless of the protection mechanism used.
3862 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003863 * \note When using a value less than the default of 16KB on the client, it is
3864 * recommended to use the Maximum Fragment Length (MFL) extension to
3865 * inform the server about this limitation. On the server, there
3866 * is no supported, standardized way of informing the client about
3867 * restriction on the maximum size of incoming messages, and unless
3868 * the limitation has been communicated by other means, it is recommended
3869 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3870 * while keeping the default value of 16KB for the incoming buffer.
3871 *
David Horstmann95d516f2021-05-04 18:36:56 +01003872 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003873 */
3874//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3875
Gilles Peskined3d02902020-03-04 21:35:27 +01003876/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3877 *
3878 * The maximum length of CIDs used for incoming DTLS messages.
3879 *
3880 */
3881//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3882
3883/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3884 *
3885 * The maximum length of CIDs used for outgoing DTLS messages.
3886 *
3887 */
3888//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3889
TRodziewicze8dd7092021-05-12 14:19:11 +02003890/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003891 *
3892 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003893 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003894 *
3895 * The padding will always be chosen so that the length of the
3896 * padded plaintext is a multiple of the value of this option.
3897 *
3898 * Note: A value of \c 1 means that no padding will be used
3899 * for outgoing records.
3900 *
3901 * Note: On systems lacking division instructions,
3902 * a power of two should be preferred.
3903 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003904//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003905
Angus Grattond8213d02016-05-25 20:56:48 +10003906/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3907 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003908 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003909 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003910 * This determines the size of the outgoing TLS I/O buffer in such a way
3911 * that it is capable of holding the specified amount of plaintext data,
3912 * regardless of the protection mechanism used.
3913 *
Angus Grattond8213d02016-05-25 20:56:48 +10003914 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3915 * the default inward 16384 byte buffer to conform to the TLS specification.
3916 *
3917 * The minimum required outward buffer size is determined by the handshake
3918 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3919 * The specific size requirement depends on the configured ciphers and any
3920 * certificate data which is sent during the handshake.
3921 *
David Horstmann95d516f2021-05-04 18:36:56 +01003922 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003923 */
3924//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3925
Hanno Beckere0b150f2018-08-21 15:51:03 +01003926/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3927 *
3928 * Maximum number of heap-allocated bytes for the purpose of
3929 * DTLS handshake message reassembly and future message buffering.
3930 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003931 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003932 * to account for a reassembled handshake message of maximum size,
3933 * together with its reassembly bitmap.
3934 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003935 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003936 * should be sufficient for all practical situations as it allows
3937 * to reassembly a large handshake message (such as a certificate)
3938 * while buffering multiple smaller handshake messages.
3939 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003940 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003941//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003942
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003943//#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 +02003944//#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 +02003945
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003946/**
3947 * Complete list of ciphersuites to use, in order of preference.
3948 *
3949 * \warning No dependency checking is done on that field! This option can only
3950 * be used to restrict the set of available ciphersuites. It is your
3951 * responsibility to make sure the needed modules are active.
3952 *
3953 * Use this to save a few hundred bytes of ROM (default ordering of all
3954 * available ciphersuites) and a few to a few hundred bytes of RAM.
3955 *
3956 * The value below is only an example, not the default.
3957 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003958//#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 +02003959
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003960/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003961 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3962 *
3963 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003964 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003965 *
3966 * It must be positive and smaller than UINT32_MAX.
3967 *
3968 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3969 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003970 */
3971//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3972
3973/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003974 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3975 *
Jerry Yucf913512023-11-14 11:06:52 +08003976 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003977 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003978 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003979 * - The client ticket age is the time difference between the time when the
3980 * client proposes to the server to use the ticket and the time the client
3981 * received the ticket from the server.
3982 * - The server ticket age is the time difference between the time when the
3983 * server receives a proposition from the client to use the ticket and the
3984 * time when the ticket was created by the server.
3985 *
Jerry Yucf913512023-11-14 11:06:52 +08003986 * The ages might be different due to the client and server clocks not running
3987 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3988 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3989 * 6s, thus in the worst case clients and servers must sync up their system time
3990 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003991 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003992 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003993 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003994//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003995
3996/**
3997 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3998 *
3999 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4000 *
4001 * This must be less than 256.
4002 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004003//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004004
4005/**
4006 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4007 *
4008 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4009 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4010 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4011 *
4012 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004013//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004014
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004015/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004016//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004017//#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 +01004018
Gilles Peskine611179c2022-04-13 23:04:48 +02004019/** \} name SECTION: Module configuration options */