blob: e3589eab9ffbca345fa5366aab9b7a835e0e3172 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020034 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000035 *
36 * Requires support for asm() in compiler.
37 *
38 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000039 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010040 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000041 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000042 * library/constant_time.c
Paul Bakker68041ec2009-04-19 21:17:55 +000043 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010044 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000045 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010046 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020048 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000051
Paul Bakkerf3b86c12011-01-27 15:24:17 +000052/**
Gilles Peskineed942f82017-06-08 15:19:20 +020053 * \def MBEDTLS_NO_UDBL_DIVISION
54 *
55 * The platform lacks support for double-width integer division (64-bit
56 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
57 *
58 * Used in:
59 * include/mbedtls/bignum.h
60 * library/bignum.c
61 *
62 * The bignum code uses double-width division to speed up some operations.
63 * Double-width division is often implemented in software that needs to
64 * be linked with the program. The presence of a double-width integer
65 * type is usually detected automatically through preprocessor macros,
66 * but the automatic detection cannot know whether the code needs to
67 * and can be linked with an implementation of division for that type.
68 * By default division is assumed to be usable if the type is present.
69 * Uncomment this option to prevent the use of double-width division.
70 *
71 * Note that division for the native integer type is always required.
72 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010073 * platform, but it need not support multiplication or division. In some
74 * cases it is also desirable to disable some double-width operations. For
75 * example, if double-width division is implemented in software, disabling
76 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020077 */
78//#define MBEDTLS_NO_UDBL_DIVISION
79
80/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020081 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
82 *
83 * The platform lacks support for 32x32 -> 64-bit multiplication.
84 *
85 * Used in:
86 * library/poly1305.c
87 *
88 * Some parts of the library may use multiplication of two unsigned 32-bit
89 * operands with a 64-bit result in order to speed up computations. On some
90 * platforms, this is not available in hardware and has to be implemented in
91 * software, usually in a library provided by the toolchain.
92 *
93 * Sometimes it is not desirable to have to link to that library. This option
94 * removes the dependency of that library on platforms that lack a hardware
95 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
96 *
97 * Note that depending on the compiler, this may decrease performance compared
98 * to using the library function provided by the toolchain.
99 */
100//#define MBEDTLS_NO_64BIT_MULTIPLICATION
101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000104 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000105 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200113 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200114 * System has time.h and time().
115 * The time does not need to be correct, only time differences are used,
116 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200117 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100118 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
119 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
120 * MBEDTLS_PLATFORM_STD_TIME.
121 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400122 * Comment if your system does not support time functions.
123 *
124 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
125 * interface - timing.c will include time.h on suitable platforms
126 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
127 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100130
131/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200132 * \def MBEDTLS_HAVE_TIME_DATE
133 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100134 * System has time.h, time(), and an implementation for
135 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100136 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200137 * the date should be correct). This is used to verify the validity period of
138 * X.509 certificates.
139 *
140 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100141 *
Hanno Becker6a739782018-09-05 15:06:19 +0100142 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100143 * behaves similarly to the gmtime_r() function from the C standard. Refer to
144 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100145 *
146 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100147 * mbedtls_platform_gmtime_r() at compile-time by using the macro
148 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200149 */
150#define MBEDTLS_HAVE_TIME_DATE
151
152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100154 *
155 * Enable the memory allocation layer.
156 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200157 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 * This allows different allocators (self-implemented or provided) to be
159 * provided to the platform abstraction layer.
160 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400161 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200162 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
163 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000164 * free() function pointer at runtime.
165 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400166 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100169 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400170 * An overview of how the value of mbedtls_calloc is determined:
171 *
172 * - if !MBEDTLS_PLATFORM_MEMORY
173 * - mbedtls_calloc = calloc
174 * - if MBEDTLS_PLATFORM_MEMORY
175 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
176 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
177 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
179 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
180 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
182 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
183 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
184 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
185 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
186 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
187 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
188 *
189 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
190 * - if !MBEDTLS_PLATFORM_STD_CALLOC
191 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
192 *
193 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
194 *
195 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
196 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
197 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
198 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
199 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
200 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100203 *
204 * Enable this layer to allow use of alternative memory allocators.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100207
208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200211 * Do not assign standard functions in the platform layer (e.g. calloc() to
212 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200213 *
214 * This makes sure there are no linking errors on platforms that do not support
215 * these functions. You will HAVE to provide alternatives, either at runtime
216 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
218 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
222 * Uncomment to prevent default assignment of standard functions in the
223 * platform layer.
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200226
227/**
Janos Follathc351d182016-03-21 08:43:59 +0000228 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200230 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100231 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200233 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 * alternative printf function pointer.
236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200239 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
240 * it will be enabled automatically by check_config.h
241 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200242 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000244 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100245 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
246 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 * Uncomment a macro to enable alternate implementation of specific base
248 * platform function
249 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200250//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100252//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_FPRINTF_ALT
254//#define MBEDTLS_PLATFORM_PRINTF_ALT
255//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200256//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100257//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100258//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800259//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260
261/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200262 * Uncomment the macro to let Mbed TLS use your alternate implementation of
263 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
264 * platform_util.c.
265 *
266 * gmtime() is not a thread-safe function as defined in the C standard. The
267 * library will try to use safer implementations of this function, such as
268 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
269 * system, the implementation of mbedtls_platform_gmtime_r() will default to
270 * using the standard gmtime(). In this case, calls from the library to
271 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
272 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
273 * library are also guarded with this mutex to avoid race conditions. However,
274 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
275 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
276 * supplied at compile time.
277 */
278//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
279
280/**
Gilles Peskine86733832023-09-07 15:02:39 +0200281 * Uncomment the macro to let Mbed TLS use your alternate implementation of
282 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
283 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200284 *
Gilles Peskine86733832023-09-07 15:02:39 +0200285 * By default, the library uses a system function such as memset_s()
286 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
287 * SecureZeroMemory (Windows). If no such function is detected, the library
288 * falls back to a plain C implementation. Compilers are technically
289 * permitted to optimize this implementation out, meaning that the memory is
290 * not actually wiped. The library tries to prevent that, but the C language
291 * makes it impossible to guarantee that the memory will always be wiped.
292 *
293 * If your platform provides a guaranteed method to wipe memory which
294 * `platform_util.c` does not detect, define this macro to the name of
295 * a function that takes two arguments, a `void *` pointer and a length,
296 * and wipes that many bytes starting at the specified address. For example,
297 * if your platform has explicit_bzero() but `platform_util.c` does not
298 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
299 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200300 */
301//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
302
303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Mark deprecated functions and features so that they generate a warning if
307 * used. Functionality deprecated in one version will usually be removed in the
308 * next version. You can enable this to help you prepare the transition to a
309 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100310 *
311 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100313 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000314 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317
318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100320 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000321 * Remove deprecated functions and features so that they generate an error if
322 * used. Functionality deprecated in one version will usually be removed in the
323 * next version. You can enable this to help you prepare the transition to a
324 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100325 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000326 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100330/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000331
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000332/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200333 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000334 *
335 * This section sets support for features that are or are not needed
336 * within the modules that are enabled.
337 * \{
338 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
TRodziewiczd8540832021-06-10 15:16:50 +0200343 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200344 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
348 * You will need to provide a header "timing_alt.h" and an implementation at
349 * compile time.
350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100352
Paul Bakker90995b52013-06-24 19:20:35 +0200353/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200354 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200355 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200356 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200357 * hardware entropy collector.
358 *
359 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000360 * prototype as declared in library/entropy_poll.h, and accept NULL as first
361 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200362 *
363 * Uncomment to use your own hardware entropy collector.
364 */
365//#define MBEDTLS_ENTROPY_HARDWARE_ALT
366
367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000369 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100370 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000371 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100372 * Uncomment this macro to use precomputed AES tables stored in ROM.
373 * Comment this macro to generate AES tables in RAM at runtime.
374 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100375 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
376 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100377 * initialization time before the first AES operation can be performed.
378 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
379 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
380 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100381 *
382 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000385
386/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100387 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200388 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100389 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200390 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100391 * Uncommenting this macro omits 75% of the AES tables from
392 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
393 * by computing their values on the fly during operations
394 * (the tables are entry-wise rotations of one another).
395 *
396 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100397 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100398 * runtime. Specifically, one has to compare 4 accesses within
399 * different tables to 4 accesses with additional arithmetic
400 * operations within the same table. The performance gain/loss
401 * depends on the system and memory details.
402 *
403 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200404 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100405//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200406
407/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800408 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
409 *
410 * Use only 128-bit keys in AES operations to save ROM.
411 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800412 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800413 * or 256-bit keys.
414 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800415 * Uncommenting this macro reduces the size of AES code by ~300 bytes
416 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800417 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800418 * Module: library/aes.c
419 *
420 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800421 */
422//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
423
Gilles Peskinea8861e02023-09-05 20:20:51 +0200424/*
425 * Disable plain C implementation for AES.
426 *
427 * When the plain C implementation is enabled, and an implementation using a
428 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
429 * detection will be used to select between them.
430 *
431 * If only one implementation is present, runtime detection will not be used.
432 * This configuration will crash at runtime if running on a CPU without the
433 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
434 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
435 */
436//#define MBEDTLS_AES_USE_HARDWARE_ONLY
437
Arto Kinnunen732ca322023-04-14 14:26:10 +0800438/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200440 *
441 * Use less ROM for the Camellia implementation (saves about 768 bytes).
442 *
443 * Uncomment this macro to use less memory for Camellia.
444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200446
447/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200448 * \def MBEDTLS_CHECK_RETURN_WARNING
449 *
450 * If this macro is defined, emit a compile-time warning if application code
451 * calls a function without checking its return value, but the return value
452 * should generally be checked in portable applications.
453 *
454 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
455 * implemented. Otherwise this option has no effect.
456 *
457 * Uncomment to get warnings on using fallible functions without checking
458 * their return value.
459 *
460 * \note This feature is a work in progress.
461 * Warnings will be added to more functions in the future.
462 *
463 * \note A few functions are considered critical, and ignoring the return
464 * value of these functions will trigger a warning even if this
465 * macro is not defined. To completely disable return value check
466 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
467 */
468//#define MBEDTLS_CHECK_RETURN_WARNING
469
470/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200471 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200472 *
473 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200475#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200476
477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000479 *
480 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000483
484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200485 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000486 *
487 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200489#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000490
491/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100492 * \def MBEDTLS_CIPHER_MODE_OFB
493 *
494 * Enable Output Feedback mode (OFB) for symmetric ciphers.
495 */
496#define MBEDTLS_CIPHER_MODE_OFB
497
498/**
499 * \def MBEDTLS_CIPHER_MODE_XTS
500 *
501 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
502 */
503#define MBEDTLS_CIPHER_MODE_XTS
504
505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200506 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000507 *
508 * Enable NULL cipher.
509 * Warning: Only do so when you know what you are doing. This allows for
510 * encryption or channels without any security!
511 *
Ronald Croncee42702021-04-26 11:34:44 +0200512 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
514 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
515 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
516 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
517 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
518 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
519 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
520 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
521 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
522 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
523 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
524 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
525 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
526 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
527 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
528 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
529 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
530 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
531 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000532 *
533 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000536
537/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100538 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200539 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100540 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
541 * specific padding modes in the cipher layer with cipher modes that support
542 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200543 *
544 * If you disable all padding modes, only full blocks can be used with CBC.
545 *
546 * Enable padding modes in the cipher layer.
547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548#define MBEDTLS_CIPHER_PADDING_PKCS7
549#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
550#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
551#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200552
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200553/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
554 *
555 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800556 * Without this, CTR_DRBG uses a 256-bit key
557 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200558 */
559//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
560
Paul Bakker48e93c82013-08-14 12:21:18 +0200561/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200562 * Enable the verified implementations of ECDH primitives from Project Everest
563 * (currently only Curve25519). This feature changes the layout of ECDH
564 * contexts and therefore is a compatibility break for applications that access
565 * fields of a mbedtls_ecdh_context structure directly. See also
566 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000567 *
568 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
569 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200570 */
571//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
572
573/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100574 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200575 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100576 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
577 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200578 *
579 * Comment macros to disable the curve and functions for it
580 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200581/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200582#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
583#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
584#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
585#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
586#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
587#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
588#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
589#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
590#define MBEDTLS_ECP_DP_BP256R1_ENABLED
591#define MBEDTLS_ECP_DP_BP384R1_ENABLED
592#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200593/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200594#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000595#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200596
597/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200599 *
600 * Enable specific 'modulo p' routines for each NIST prime.
601 * Depending on the prime and architecture, makes operations 4 to 8 times
602 * faster on the corresponding curve.
603 *
604 * Comment this macro to disable NIST curves optimisation.
605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200607
608/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200609 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100610 *
611 * Enable "non-blocking" ECC operations that can return early and be resumed.
612 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200613 * This allows various functions to pause by returning
614 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
615 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
616 * order to further progress and eventually complete their operation. This is
617 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
618 * number of ECC operations a function may perform before pausing; see
619 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100620 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200621 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200622 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100623 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100624 * This option:
625 * - Adds xxx_restartable() variants of existing operations in the
626 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100627 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
628 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100629 * - ECDSA: signature generation & verification;
630 * - PK: signature generation & verification;
631 * - X509: certificate chain verification.
632 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
633 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
634 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
635 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000636 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100637 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100638 * - verification of the server's key exchange signature;
639 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100640 * - generation of the client's signature if client authentication is used,
641 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100642 *
643 * \note In the cases above, the usual SSL/TLS functions, such as
644 * mbedtls_ssl_handshake(), can now return
645 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200646 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100647 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
648 * restartable operations in PK, X.509 and TLS (see above) are not
649 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100650 * PSA, and are not restartable. These are temporary limitations that
651 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200652 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100653 * Requires: MBEDTLS_ECP_C
654 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100655 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100656 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200657//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100658
659/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200660 * Uncomment to enable using new bignum code in the ECC modules.
661 *
662 * \warning This is currently experimental, incomplete and therefore should not
663 * be used in production.
664 */
665//#define MBEDTLS_ECP_WITH_MPI_UINT
666
667/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200668 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100669 *
670 * Enable deterministic ECDSA (RFC 6979).
671 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
672 * may result in a compromise of the long-term signing key. This is avoided by
673 * the deterministic variant.
674 *
John Durkop36a82e52020-10-26 09:39:05 -0700675 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100676 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100677 * Comment this macro to disable deterministic ECDSA.
678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100680
681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200683 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200684 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200685 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200686 * This enables the following ciphersuites (if other requisites are
687 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
689 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
690 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
691 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
692 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
693 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
694 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
695 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
696 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
697 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200698 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200699#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200700
701/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200703 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200704 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200705 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200707 *
708 * This enables the following ciphersuites (if other requisites are
709 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
711 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
712 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
713 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
714 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
715 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
716 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
717 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
718 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
719 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100720 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100721 * \warning Using DHE constitutes a security risk as it
722 * is not possible to validate custom DH parameters.
723 * If possible, it is recommended users should consider
724 * preferring other methods of key exchange.
725 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100726 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200727 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200728#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200729
730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200731 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200732 *
733 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
734 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200735 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200736 *
737 * This enables the following ciphersuites (if other requisites are
738 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200739 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
740 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
741 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
742 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
743 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
744 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200747
748/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200749 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200750 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200751 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200752 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200753 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
754 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200755 *
756 * This enables the following ciphersuites (if other requisites are
757 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
759 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
760 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
761 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
762 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
763 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
764 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
765 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
766 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
767 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200768 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200770
771/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200772 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200773 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200774 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200775 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200776 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
777 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200778 *
779 * This enables the following ciphersuites (if other requisites are
780 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
782 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
783 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
784 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
785 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
786 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
787 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
788 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
789 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
790 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
791 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
792 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200794#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200795
796/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200798 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200799 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200800 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200801 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
802 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200803 *
804 * This enables the following ciphersuites (if other requisites are
805 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
807 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
808 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
809 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
810 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
811 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
812 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
813 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
814 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
815 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
816 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
817 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100818 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100819 * \warning Using DHE constitutes a security risk as it
820 * is not possible to validate custom DH parameters.
821 * If possible, it is recommended users should consider
822 * preferring other methods of key exchange.
823 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100824 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200826#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200827
828/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200829 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200830 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200831 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200832 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200833 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
834 * MBEDTLS_RSA_C
835 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200836 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200837 *
838 * This enables the following ciphersuites (if other requisites are
839 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
841 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
842 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
843 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
844 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
845 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
846 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
847 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
848 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
849 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200850 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200851#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200852
853/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200854 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200855 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200856 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200857 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200858 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
859 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
860 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200861 *
862 * This enables the following ciphersuites (if other requisites are
863 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200864 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
865 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
866 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
867 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
868 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
869 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
870 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
871 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
872 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
873 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200874 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200876
877/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200878 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100879 *
880 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
881 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200882 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
883 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
884 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100885 *
886 * This enables the following ciphersuites (if other requisites are
887 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
889 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
890 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
891 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
892 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
893 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
894 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
895 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
896 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
897 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100898 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200899#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100900
901/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100903 *
904 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
905 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200906 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
907 * MBEDTLS_RSA_C
908 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100909 *
910 * This enables the following ciphersuites (if other requisites are
911 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
913 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
914 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
915 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
916 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
917 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
918 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
919 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
920 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
921 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100922 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200923#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100924
925/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200926 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
927 *
928 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
929 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200930 * \warning This is currently experimental. EC J-PAKE support is based on the
931 * Thread v1.0.0 specification; incompatible changes to the specification
932 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200933 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200934 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100935 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200936 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
937 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100938 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800939 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100940 * MBEDTLS_USE_PSA_CRYPTO is disabled).
941 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200942 * This enables the following ciphersuites (if other requisites are
943 * enabled as well):
944 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
945 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200946//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200947
948/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100950 *
951 * Enhance support for reading EC keys using variants of SEC1 not allowed by
952 * RFC 5915 and RFC 5480.
953 *
954 * Currently this means parsing the SpecifiedECDomain choice of EC
955 * parameters (only known groups are supported, not arbitrary domains, to
956 * avoid validation issues).
957 *
958 * Disable if you only need to support RFC 5915 + 5480 key formats.
959 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200960#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100961
962/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200963 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
964 *
965 * Enable the support for parsing public keys of type Short Weierstrass
966 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200967 * compressed point format. This parsing is done through ECP module's functions.
968 *
969 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
970 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
971 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200972 */
973#define MBEDTLS_PK_PARSE_EC_COMPRESSED
974
975/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200976 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100977 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200978 * Enable a dummy error function to make use of mbedtls_strerror() in
979 * third party libraries easier when MBEDTLS_ERROR_C is disabled
980 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200981 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
983 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100984 *
985 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100987 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100989
990/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000992 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +0200993 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200994 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200995 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +0000998
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001001 *
1002 * Enable functions that use the filesystem.
1003 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001005
1006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001008 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001009 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001010 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001011 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001012 * application.
1013 *
1014 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001015 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001017
1018/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001020 *
1021 * Do not use built-in platform entropy functions.
1022 * This is useful if your platform does not support
1023 * standards like the /dev/urandom or Windows CryptoAPI.
1024 *
1025 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001026 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001028
1029/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001031 *
1032 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1033 * default SHA-512 based one (if both are available).
1034 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001036 *
1037 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1038 * if you have performance concerns.
1039 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040 * This option is only useful if both MBEDTLS_SHA256_C and
1041 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001044
1045/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001046 * \def MBEDTLS_ENTROPY_NV_SEED
1047 *
1048 * Enable the non-volatile (NV) seed file-based entropy source.
1049 * (Also enables the NV seed read/write functions in the platform layer)
1050 *
1051 * This is crucial (if not required) on systems that do not have a
1052 * cryptographic entropy source (in hardware or kernel) available.
1053 *
1054 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1055 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001056 * \note The read/write functions that are used by the entropy source are
1057 * determined in the platform layer, and can be modified at runtime and/or
1058 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1059 *
1060 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001061 * with regular fopen(), please make sure you make a seedfile with the
1062 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1063 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001064 * and written to or you will get an entropy source error! The default
1065 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1066 * bytes from the file.
1067 *
1068 * \note The entropy collector will write to the seed file before entropy is
1069 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001070 */
1071//#define MBEDTLS_ENTROPY_NV_SEED
1072
Ronald Cron71016a92020-08-28 19:01:50 +02001073/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001074 *
Ronald Cron71016a92020-08-28 19:01:50 +02001075 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001076 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001077 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1078 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001079 *
1080 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001081 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001082 */
Ronald Cron71016a92020-08-28 19:01:50 +02001083//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001084
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001085/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001087 *
1088 * Enable debugging of buffer allocator memory issues. Automatically prints
1089 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1090 * function for 'debug output' of allocated memory.
1091 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001093 *
1094 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001095 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001097
1098/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001099 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001100 *
1101 * Include backtrace information with each allocated block.
1102 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001104 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001105 *
1106 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001109
1110/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001111 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001112 *
1113 * Support external private RSA keys (eg from a HSM) in the PK layer.
1114 *
1115 * Comment this macro to disable support for external private RSA keys.
1116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001118
1119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001121 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001122 * Enable support for PKCS#1 v1.5 encoding.
1123 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001124 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001125 *
Paul Bakker48377d92013-08-30 12:06:24 +02001126 * This enables support for PKCS#1 v1.5 operations.
1127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001129
1130/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001131 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001132 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001133 * Enable support for PKCS#1 v2.1 encoding.
1134 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001135 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001136 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001137 * \warning If using a hash that is only provided by PSA drivers, you must
1138 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001139 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001140 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001142#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001143
Steven Cooreman6801f082021-02-19 17:21:22 +01001144/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1145 *
1146 * Enable support for platform built-in keys. If you enable this feature,
1147 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1148 * See the documentation of that function for more information.
1149 *
1150 * Built-in keys are typically derived from a hardware unique key or
1151 * stored in a secure element.
1152 *
1153 * Requires: MBEDTLS_PSA_CRYPTO_C.
1154 *
1155 * \warning This interface is experimental and may change or be removed
1156 * without notice.
1157 */
1158//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1159
Ronald Cron3768ac12021-01-26 16:58:00 +01001160/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1161 *
1162 * Enable support for PSA crypto client.
1163 *
1164 * \note This option allows to include the code necessary for a PSA
1165 * crypto client when the PSA crypto implementation is not included in
1166 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1167 * code to set and get PSA key attributes.
1168 * The development of PSA drivers partially relying on the library to
1169 * fulfill the hardware gaps is another possible usage of this option.
1170 *
1171 * \warning This interface is experimental and may change or be removed
1172 * without notice.
1173 */
1174//#define MBEDTLS_PSA_CRYPTO_CLIENT
1175
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001176/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1177 *
1178 * Make the PSA Crypto module use an external random generator provided
1179 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1180 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001181 * \note This random generator must deliver random numbers with cryptographic
1182 * quality and high performance. It must supply unpredictable numbers
1183 * with a uniform distribution. The implementation of this function
1184 * is responsible for ensuring that the random generator is seeded
1185 * with sufficient entropy. If you have a hardware TRNG which is slow
1186 * or delivers non-uniform output, declare it as an entropy source
1187 * with mbedtls_entropy_add_source() instead of enabling this option.
1188 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001189 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001190 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1191 * and define a function called mbedtls_psa_external_get_random()
1192 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001193 * ```
1194 * psa_status_t mbedtls_psa_external_get_random(
1195 * mbedtls_psa_external_random_context_t *context,
1196 * uint8_t *output, size_t output_size, size_t *output_length);
1197 * );
1198 * ```
1199 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001200 * The function must fill the \c output buffer with \c output_size bytes
1201 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001202 *
1203 * Requires: MBEDTLS_PSA_CRYPTO_C
1204 *
1205 * \warning If you enable this option, code that uses the PSA cryptography
1206 * interface will not use any of the entropy sources set up for
1207 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1208 * enables.
1209 *
1210 * \note This option is experimental and may be removed without notice.
1211 */
1212//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1213
Paul Bakker9dcc3222011-03-08 14:16:06 +00001214/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001215 * \def MBEDTLS_PSA_CRYPTO_SPM
1216 *
1217 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1218 * Partition Manager) integration which separates the code into two parts: a
1219 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1220 * Environment).
1221 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001222 * If you enable this option, your build environment must include a header
1223 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1224 * header files, or in another directory on the compiler's include search
1225 * path). Alternatively, your platform may customize the header
1226 * `psa/crypto_platform.h`, in which case it can skip or replace the
1227 * inclusion of `"crypto_spe.h"`.
1228 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001229 * Module: library/psa_crypto.c
1230 * Requires: MBEDTLS_PSA_CRYPTO_C
1231 *
1232 */
1233//#define MBEDTLS_PSA_CRYPTO_SPM
1234
1235/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001236 * Uncomment to enable p256-m. This is an alternative implementation of
1237 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1238 * Compared to the default implementation:
1239 *
1240 * - p256-m has a much smaller code size and RAM footprint.
1241 * - p256-m is only available via the PSA API. This includes the pk module
1242 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1243 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1244 * over the core arithmetic, or deterministic derivation of keys.
1245 *
1246 * We recommend enabling this option if your application uses the PSA API
1247 * and the only elliptic curve support it needs is ECDH and ECDSA over
1248 * SECP256R1.
1249 *
1250 * If you enable this option, you do not need to enable any ECC-related
1251 * MBEDTLS_xxx option. You do need to separately request support for the
1252 * cryptographic mechanisms through the PSA API:
1253 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1254 * configuration;
1255 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1256 * - #PSA_WANT_ECC_SECP_R1_256;
1257 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1258 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1259 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1260 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1261 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001262 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001263 * \note To benefit from the smaller code size of p256-m, make sure that you
1264 * do not enable any ECC-related option not supported by p256-m: this
1265 * would cause the built-in ECC implementation to be built as well, in
1266 * order to provide the required option.
1267 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001268 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1269 * SECP256R1 are disabled as they are not supported by this driver.
1270 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1271 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001272 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001273 */
1274//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1275
1276/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001277 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001278 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001279 * Enable support for entropy injection at first boot. This feature is
1280 * required on systems that do not have a built-in entropy source (TRNG).
1281 * This feature is currently not supported on systems that have a built-in
1282 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001283 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001284 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001285 *
1286 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001287//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001288
1289/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001290 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001291 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001292 * Assume all buffers passed to PSA functions are owned exclusively by the
1293 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001294 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001295 * This option may be enabled if all buffers passed to any PSA function reside
1296 * in memory that is accessible only to the PSA function during its execution.
1297 *
1298 * This option MUST be disabled whenever buffer arguments are in memory shared
1299 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001300 * across a trust boundary.
1301 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001302 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001303 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001304 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001305 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001306 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001307//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001308
1309/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001311 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001312 * Do not use the Chinese Remainder Theorem
1313 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001314 *
1315 * Uncomment this macro to disable the use of CRT in RSA.
1316 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001319
1320/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001321 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001322 *
1323 * Enable the checkup functions (*_self_test).
1324 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001325#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001326
1327/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001328 * \def MBEDTLS_SHA256_SMALLER
1329 *
1330 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1331 * lower performance.
1332 *
Adam Wolf039080f2019-09-10 09:53:08 -05001333 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001334 * performance and size. This version optimizes more aggressively for size at
1335 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1336 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1337 * 30%.
1338 *
1339 * Uncomment to enable the smaller implementation of SHA256.
1340 */
1341//#define MBEDTLS_SHA256_SMALLER
1342
1343/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001344 * \def MBEDTLS_SHA512_SMALLER
1345 *
1346 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1347 * lower performance.
1348 *
1349 * Uncomment to enable the smaller implementation of SHA512.
1350 */
1351//#define MBEDTLS_SHA512_SMALLER
1352
1353/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001355 *
1356 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001357 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001358 * with other servers, only debugging of failures is harder.
1359 *
1360 * The advantage of not sending alert messages, is that no information is given
1361 * about reasons for failures thus preventing adversaries of gaining intel.
1362 *
1363 * Enable sending of all alert messages
1364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001365#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001366
1367/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001368 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1369 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001370 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001371 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001372 * in the underlying transport. The CID functionality is described
1373 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001374 *
1375 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001376 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1377 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1378 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001379 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001380 * The maximum lengths of outgoing and incoming CIDs can be configured
1381 * through the options
1382 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1383 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1384 *
1385 * Requires: MBEDTLS_SSL_PROTO_DTLS
1386 *
1387 * Uncomment to enable the Connection ID extension.
1388 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001389#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1390
1391
1392/**
1393 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1394 *
1395 * Defines whether RFC 9146 (default) or the legacy version
1396 * (version draft-ietf-tls-dtls-connection-id-05,
1397 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1398 * is used.
1399 *
1400 * Set the value to 0 for the standard version, and
1401 * 1 for the legacy draft version.
1402 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001403 * \deprecated Support for the legacy version of the DTLS
1404 * Connection ID feature is deprecated. Please
1405 * switch to the standardized version defined
1406 * in RFC 9146 enabled by utilizing
1407 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1408 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1409 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001410 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1411 */
1412#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001413
1414/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001415 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1416 *
1417 * Enable asynchronous external private key operations in SSL. This allows
1418 * you to configure an SSL connection to call an external cryptographic
1419 * module to perform private key operations instead of performing the
1420 * operation inside the library.
1421 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001422 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001423 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001424//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001425
1426/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001427 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1428 *
1429 * Enable serialization of the TLS context structures, through use of the
1430 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1431 *
1432 * This pair of functions allows one side of a connection to serialize the
1433 * context associated with the connection, then free or re-use that context
1434 * while the serialized state is persisted elsewhere, and finally deserialize
1435 * that state to a live context for resuming read/write operations on the
1436 * connection. From a protocol perspective, the state of the connection is
1437 * unaffected, in particular this is entirely transparent to the peer.
1438 *
1439 * Note: this is distinct from TLS session resumption, which is part of the
1440 * protocol and fully visible by the peer. TLS session resumption enables
1441 * establishing new connections associated to a saved session with shorter,
1442 * lighter handshakes, while context serialization is a local optimization in
1443 * handling a single, potentially long-lived connection.
1444 *
1445 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1446 * saved after the handshake to allow for more efficient serialization, so if
1447 * you don't need this feature you'll save RAM by disabling it.
1448 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001449 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1450 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001451 * Comment to disable the context serialization APIs.
1452 */
1453#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1454
1455/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001456 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001457 *
1458 * Enable the debug messages in SSL module for all issues.
1459 * Debug messages have been disabled in some places to prevent timing
1460 * attacks due to (unbalanced) debugging function calls.
1461 *
1462 * If you need all error reporting you should enable this during debugging,
1463 * but remove this for production servers that should log as well.
1464 *
1465 * Uncomment this macro to report all debug messages on errors introducing
1466 * a timing side-channel.
1467 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001468 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001471/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001472 *
1473 * Enable support for Encrypt-then-MAC, RFC 7366.
1474 *
1475 * This allows peers that both support it to use a more robust protection for
1476 * ciphersuites using CBC, providing deep resistance against timing attacks
1477 * on the padding or underlying cipher.
1478 *
1479 * This only affects CBC ciphersuites, and is useless if none is defined.
1480 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001481 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001482 *
1483 * Comment this macro to disable support for Encrypt-then-MAC
1484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001485#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001486
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001487/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001488 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001489 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1490 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001491 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001492 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001493 * attacks, but it is recommended to always use it (even if you disable
1494 * renegotiation), since it actually fixes a more fundamental issue in the
1495 * original SSL/TLS design, and has implications beyond Triple Handshake.
1496 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001497 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001498 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001499 * Comment this macro to disable support for Extended Master Secret.
1500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001501#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001502
Paul Bakkerd66f0702013-01-31 16:57:45 +01001503/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001504 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1505 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001506 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001507 * giving access to the peer's certificate after completion of the handshake.
1508 *
1509 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1510 * recommended to disable this option for reduced RAM usage.
1511 *
1512 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1513 * defined, but always returns \c NULL.
1514 *
1515 * \note This option has no influence on the protection against the
1516 * triple handshake attack. Even if it is disabled, Mbed TLS will
1517 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001518 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001519 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001520 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001521 *
1522 * Comment this macro to disable storing the peer's certificate
1523 * after the handshake.
1524 */
1525#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1526
1527/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001529 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001530 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001531 *
1532 * The two main uses of renegotiation are (1) refresh keys on long-lived
1533 * connections and (2) client authentication after the initial handshake.
1534 * If you don't need renegotiation, it's probably better to disable it, since
1535 * it has been associated with security issues in the past and is easy to
1536 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001537 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001538 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1539 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001540 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001541 *
1542 * \note Even if this option is disabled, both client and server are aware
1543 * of the Renegotiation Indication Extension (RFC 5746) used to
1544 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1545 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1546 * configuration of this extension).
1547 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001549#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001550
1551/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001553 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001554 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001555 *
1556 * Comment this macro to disable support for the max_fragment_length extension
1557 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001559
1560/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001561 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1562 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001563 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001564 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001565 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1566 *
1567 * Uncomment this macro to enable support for the record_size_limit extension
1568 */
1569//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1570
1571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001572 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001573 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001574 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001575 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001576 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001577 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1578 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001579 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001580 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001581 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001582 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1583 * are only provided by PSA drivers, you must call psa_crypto_init() before
1584 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001585 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001586 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001587 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001588#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001589
1590/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001591 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001592 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001593 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001594 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001595 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001596 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001597 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001598 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001599 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001600 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001601 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1602 * directly performed by TLS 1.3 code. As a consequence, you must
1603 * call psa_crypto_init() before the first TLS 1.3 handshake.
1604 *
1605 * \note Cryptographic operations performed indirectly via another module
1606 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1607 * running handshake hash) only use PSA crypto if
1608 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001609 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001610 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001611 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001612#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001613
1614/**
Ronald Cronab65c522021-11-24 10:47:20 +01001615 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1616 *
1617 * Enable TLS 1.3 middlebox compatibility mode.
1618 *
1619 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1620 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1621 * expecting TLS 1.2 traffic.
1622 *
1623 * Turning on the compatibility mode comes at the cost of a few added bytes
1624 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1625 * that don't use it. Therefore, unless transmission bandwidth is critical and
1626 * you know that middlebox compatibility issues won't occur, it is therefore
1627 * recommended to set this option.
1628 *
1629 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001630 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1631 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001632 *
1633 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001634#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001635
1636/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001637 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1638 *
1639 * Enable TLS 1.3 PSK key exchange mode.
1640 *
1641 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1642 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1643 * effect on the build.
1644 *
1645 */
1646#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1647
1648/**
1649 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1650 *
1651 * Enable TLS 1.3 ephemeral key exchange mode.
1652 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001653 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001654 * MBEDTLS_X509_CRT_PARSE_C
1655 * and at least one of:
1656 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1657 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001658 *
1659 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1660 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1661 * effect on the build.
1662 *
1663 */
1664#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1665
1666/**
1667 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1668 *
1669 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1670 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001671 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001672 *
1673 * Comment to disable support for the PSK ephemeral key exchange mode in
1674 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1675 * have any effect on the build.
1676 *
1677 */
1678#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1679
1680/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001681 * \def MBEDTLS_SSL_EARLY_DATA
1682 *
1683 * Enable support for RFC 8446 TLS 1.3 early data.
1684 *
1685 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1686 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1687 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1688 *
1689 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1690 * is not enabled, this option does not have any effect on the build.
1691 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001692 * \note The maximum amount of early data can be set with
1693 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1694 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001696//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001697
1698/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001700 *
1701 * Enable support for DTLS (all available versions).
1702 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001703 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001704 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001705 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001706 *
1707 * Comment this macro to disable support for DTLS
1708 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001709#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001710
1711/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001713 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001714 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001715 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001716 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001719
1720/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001722 *
1723 * Enable support for the anti-replay mechanism in DTLS.
1724 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725 * Requires: MBEDTLS_SSL_TLS_C
1726 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001727 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001728 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001729 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001730 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001731 * Comment this to disable anti-replay in DTLS.
1732 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001734
1735/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001737 *
1738 * Enable support for HelloVerifyRequest on DTLS servers.
1739 *
1740 * This feature is highly recommended to prevent DTLS servers being used as
1741 * amplifiers in DoS attacks against other hosts. It should always be enabled
1742 * unless you know for sure amplification cannot be a problem in the
1743 * environment in which your server operates.
1744 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001745 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001746 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001747 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001748 *
1749 * Comment this to disable support for HelloVerifyRequest.
1750 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001751#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001752
1753/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001754 * \def MBEDTLS_SSL_DTLS_SRTP
1755 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001756 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001757 * through the use_srtp extension.
1758 *
1759 * \note This feature provides the minimum functionality required
1760 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1761 * the associated SRTP packet protection key material.
1762 * In particular, the SRTP packet protection itself, as well as the
1763 * demultiplexing of RTP and DTLS packets at the datagram layer
1764 * (see Section 5 of RFC 5764), are not handled by this feature.
1765 * Instead, after successful completion of a handshake negotiating
1766 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001767 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001768 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1769 * (this is implemented in the SSL example programs).
1770 * The resulting key should then be passed to an SRTP stack.
1771 *
1772 * Setting this option enables the runtime API
1773 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1774 * through which the supported DTLS-SRTP protection
1775 * profiles can be configured. You must call this API at
1776 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001777 *
1778 * Requires: MBEDTLS_SSL_PROTO_DTLS
1779 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001780 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001781 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001782//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001783
1784/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001785 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1786 *
1787 * Enable server-side support for clients that reconnect from the same port.
1788 *
1789 * Some clients unexpectedly close the connection and try to reconnect using the
1790 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001791 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001792 * flag enables that support.
1793 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001794 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001795 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001796 * Comment this to disable support for clients reusing the source port.
1797 */
1798#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1799
1800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001802 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001803 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001804 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001805 * session store remains the responsibility of the application, though).
1806 * Server-side, you also need to provide callbacks for writing and parsing
1807 * tickets, including authenticated encryption and key management. Example
1808 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001809 *
1810 * Comment this macro to disable support for SSL session tickets
1811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001813
1814/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001815 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001816 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001817 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001818 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001820 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001821 * Comment this macro to disable support for server name indication in SSL
1822 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001824
1825/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001826 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1827 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001828 * When this option is enabled, the SSL buffer will be resized automatically
1829 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001830 *
1831 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001832 */
1833//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1834
1835/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001836 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1837 *
1838 * Enable testing of the constant-flow nature of some sensitive functions with
1839 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001840 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001841 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001842 * This setting requires compiling with clang -fsanitize=memory. The test
1843 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001844 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001845 * \warning This macro is only used for extended testing; it is not considered
1846 * part of the library's API, so it may change or disappear at any time.
1847 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001848 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001849 */
1850//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1851
1852/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001853 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1854 *
1855 * Enable testing of the constant-flow nature of some sensitive functions with
1856 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001857 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001858 *
1859 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001860 * testing if the tests suites are run with valgrind's memcheck. This can be
1861 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1862 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001863 *
1864 * \warning This macro is only used for extended testing; it is not considered
1865 * part of the library's API, so it may change or disappear at any time.
1866 *
1867 * Uncomment to enable testing of the constant-flow nature of selected code.
1868 */
1869//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1870
1871/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001872 * \def MBEDTLS_TEST_HOOKS
1873 *
1874 * Enable features for invasive testing such as introspection functions and
1875 * hooks for fault injection. This enables additional unit tests.
1876 *
1877 * Merely enabling this feature should not change the behavior of the product.
1878 * It only adds new code, and new branching points where the default behavior
1879 * is the same as when this feature is disabled.
1880 * However, this feature increases the attack surface: there is an added
1881 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1882 * Therefore this feature must never be enabled in production.
1883 *
1884 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1885 * information.
1886 *
1887 * Uncomment to enable invasive tests.
1888 */
1889//#define MBEDTLS_TEST_HOOKS
1890
1891/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001893 *
1894 * Provide your own alternate threading implementation.
1895 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001897 *
1898 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001899 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001900//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001901
1902/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001904 *
1905 * Enable the pthread wrapper layer for the threading layer.
1906 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001908 *
1909 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001912
1913/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001914 * \def MBEDTLS_USE_PSA_CRYPTO
1915 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001916 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1917 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001918 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001919 * \note Development of this option is currently in progress, and parts of Mbed
1920 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001921 * will still continue to work as usual, so enabling this option should not
1922 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001923 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001924 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001925 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1926 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001927 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001928 * \note An important and desirable effect of this option is that it allows
1929 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1930 * 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 +02001931 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001932 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1933 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001934 *
1935 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001936 *
1937 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001938 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001939 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001940 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001941//#define MBEDTLS_USE_PSA_CRYPTO
1942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001943/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001944 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1945 *
John Durkop185764f2020-10-12 21:32:12 -07001946 * This setting allows support for cryptographic mechanisms through the PSA
1947 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001948 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001949 * When this option is disabled, the PSA API exposes the cryptographic
1950 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1951 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001952 *
1953 * When this option is enabled, the PSA API exposes the cryptographic
1954 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1955 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1956 * automatically enabled if required (i.e. if no PSA driver provides the
1957 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1958 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001959 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001960 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001961 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001962 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001963 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1964 * symbols is not completely finalized yet, and the configuration
1965 * tooling is not ideally adapted to having two separate configuration
1966 * files.
1967 * Future minor releases of Mbed TLS may make minor changes to those
1968 * symbols, but we will endeavor to provide a transition path.
1969 * Nonetheless, this option is considered mature enough to use in
1970 * production, as long as you accept that you may need to make
1971 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001972 */
1973//#define MBEDTLS_PSA_CRYPTO_CONFIG
1974
1975/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001976 * \def MBEDTLS_VERSION_FEATURES
1977 *
1978 * Allow run-time checking of compile-time enabled features. Thus allowing users
1979 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001980 * support via mbedtls_version_check_feature().
1981 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001982 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00001983 *
1984 * Comment this to disable run-time checking and save ROM space
1985 */
1986#define MBEDTLS_VERSION_FEATURES
1987
1988/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001989 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1990 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001991 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001992 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1993 * the set of trusted certificates through a callback instead of a linked
1994 * list.
1995 *
1996 * This is useful for example in environments where a large number of trusted
1997 * certificates is present and storing them in a linked list isn't efficient
1998 * enough, or when the set of trusted certificates changes frequently.
1999 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002000 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002001 * `mbedtls_ssl_conf_ca_cb()` for more information.
2002 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002003 * Requires: MBEDTLS_X509_CRT_PARSE_C
2004 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002005 * Uncomment to enable trusted certificate callbacks.
2006 */
2007//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2008
2009/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002010 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002011 *
Chris Jones2c745862020-12-16 11:41:06 +00002012 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002013 *
Chris Jones2c745862020-12-16 11:41:06 +00002014 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002015 * and other functions/constants only used by these functions, thus reducing
2016 * the code footprint by several KB.
2017 */
Chris Jones2c745862020-12-16 11:41:06 +00002018//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002019
2020/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002021 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002022 *
2023 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2024 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2025 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002026 * Requires: MBEDTLS_PKCS1_V21
2027 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002028 * Comment this macro to disallow using RSASSA-PSS in certificates.
2029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002030#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002031/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002032
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002033/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002034 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002035 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002036 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002037 * \{
2038 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002039
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002040/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002041 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002042 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002043 * Enable AES-NI support on x86-64 or x86-32.
2044 *
2045 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002046 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002047 * - GCC, x86-64, target not explicitly supporting AESNI:
2048 * requires MBEDTLS_HAVE_ASM.
2049 * - GCC, x86-32, target not explicitly supporting AESNI:
2050 * not supported.
2051 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2052 * For this assembly-less implementation, you must currently compile
2053 * `library/aesni.c` and `library/aes.c` with machine options to enable
2054 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2055 * `clang -maes -mpclmul`.
2056 * - Non-x86 targets: this option is silently ignored.
2057 * - Other compilers: this option is silently ignored.
2058 *
2059 * \note
2060 * Above, "GCC" includes compatible compilers such as Clang.
2061 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002062 *
2063 * Module: library/aesni.c
2064 * Caller: library/aes.c
2065 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002066 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002067 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002068 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002069 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002071
2072/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002073 * \def MBEDTLS_AESCE_C
2074 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002075 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002076 *
2077 * Module: library/aesce.c
2078 * Caller: library/aes.c
2079 *
Jerry Yuf015a932023-04-25 10:38:03 +08002080 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002081 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002082 * \warning Runtime detection only works on Linux. For non-Linux operating
2083 * system, Armv8-A Cryptographic Extensions must be supported by
2084 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002085 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002086 * \note Minimum compiler versions for this feature when targeting aarch64
2087 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2088 * Minimum compiler versions for this feature when targeting 32-bit
2089 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002090 *
2091 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2092 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002093 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002094 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002095 */
2096#define MBEDTLS_AESCE_C
2097
2098/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002099 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002100 *
2101 * Enable the AES block cipher.
2102 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002103 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002104 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002105 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002106 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002107 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002108 * This module enables the following ciphersuites (if other requisites are
2109 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2111 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2112 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2113 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2114 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2115 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2116 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2117 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2118 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2119 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2120 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2121 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2122 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2123 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2124 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2125 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2126 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2127 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2128 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2129 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2130 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2131 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2132 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2133 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2134 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2135 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2136 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2137 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2138 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2139 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2140 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2141 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2142 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2143 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2144 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2145 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2146 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2147 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2148 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2149 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2150 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2151 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2152 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2153 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2154 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2155 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2156 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2157 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2158 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2159 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2160 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2161 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2162 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2163 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2164 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2165 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2166 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2167 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002168 *
Paul Bakkercff68422013-09-15 20:43:33 +02002169 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002170 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002171#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002172
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002173/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002174 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002175 *
2176 * Enable the generic ASN1 parser.
2177 *
2178 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002179 * Caller: library/x509.c
2180 * library/dhm.c
2181 * library/pkcs12.c
2182 * library/pkcs5.c
2183 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002184 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002186
2187/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002189 *
2190 * Enable the generic ASN1 writer.
2191 *
2192 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002193 * Caller: library/ecdsa.c
2194 * library/pkwrite.c
2195 * library/x509_create.c
2196 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002197 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002200
2201/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002202 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002203 *
2204 * Enable the Base64 module.
2205 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002206 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002207 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002208 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002209 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002210 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002212
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002213/**
Yanray Wange367e472023-10-31 17:23:04 +08002214 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2215 *
2216 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2217 *
2218 * \note This feature is incompatible with insecure block cipher,
2219 * MBEDTLS_DES_C, and cipher modes which always require decryption
2220 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002221 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2222 * this feature is incompatible with following supported PSA equivalence,
2223 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2224 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002225 *
2226 * Module: library/aes.c
2227 * library/aesce.c
2228 * library/aesni.c
2229 * library/aria.c
2230 * library/camellia.c
2231 * library/cipher.c
2232 */
2233//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2234
2235/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002236 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002237 *
Paul Bakker9a736322012-11-14 12:39:52 +00002238 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002239 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002240 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002241 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002242 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002243 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002244 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002245 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002246 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002247 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002248 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002249 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002250 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002251 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002254
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002255/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002256 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002257 *
2258 * Enable the Camellia block cipher.
2259 *
Paul Bakker38119b12009-01-10 23:31:23 +00002260 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002261 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002262 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002263 * This module enables the following ciphersuites (if other requisites are
2264 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002265 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2266 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2267 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2268 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2269 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2270 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2271 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2272 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2273 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2274 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2275 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2276 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2277 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2278 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2279 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2280 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2281 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2282 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2283 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2284 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2285 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2286 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2287 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2288 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2289 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2290 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2291 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2292 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2293 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2294 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2295 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2296 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2297 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2298 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2299 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2300 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2301 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2302 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2303 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2304 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2305 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2306 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002308#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002309
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002310/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002311 * \def MBEDTLS_ARIA_C
2312 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002313 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002314 *
2315 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002316 * Caller: library/cipher.c
2317 *
2318 * This module enables the following ciphersuites (if other requisites are
2319 * enabled as well):
2320 *
2321 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2322 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2323 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2324 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2325 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2326 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2327 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2328 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2329 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2330 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2331 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2332 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2333 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2334 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2335 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2336 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2337 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2338 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2339 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2340 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2341 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2342 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2343 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2344 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2345 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2346 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2347 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2348 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2349 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2350 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2351 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2352 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2353 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2354 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2355 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2356 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2357 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2358 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002359 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002360#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002361
2362/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002363 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002364 *
2365 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2366 *
2367 * Module: library/ccm.c
2368 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002369 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2370 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002371 *
2372 * This module enables the AES-CCM ciphersuites, if other requisites are
2373 * enabled as well.
2374 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002376
2377/**
Daniel King34b822c2016-05-15 17:28:08 -03002378 * \def MBEDTLS_CHACHA20_C
2379 *
2380 * Enable the ChaCha20 stream cipher.
2381 *
2382 * Module: library/chacha20.c
2383 */
2384#define MBEDTLS_CHACHA20_C
2385
2386/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002387 * \def MBEDTLS_CHACHAPOLY_C
2388 *
2389 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2390 *
2391 * Module: library/chachapoly.c
2392 *
2393 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2394 */
2395#define MBEDTLS_CHACHAPOLY_C
2396
2397/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002398 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002399 *
2400 * Enable the generic cipher layer.
2401 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002402 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002403 * Caller: library/ccm.c
2404 * library/cmac.c
2405 * library/gcm.c
2406 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002407 * library/pkcs12.c
2408 * library/pkcs5.c
2409 * library/psa_crypto_aead.c
2410 * library/psa_crypto_mac.c
2411 * library/ssl_ciphersuites.c
2412 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002413 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002414 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2415 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002416 *
2417 * Uncomment to enable generic cipher wrappers.
2418 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002420
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002421/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002422 * \def MBEDTLS_CMAC_C
2423 *
Simon Butcher327398a2016-10-05 14:09:11 +01002424 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2425 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002426 *
2427 * Module: library/cmac.c
2428 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002429 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002430 *
2431 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002432#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002433
2434/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002435 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002436 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002437 * Enable the CTR_DRBG AES-based random generator.
2438 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002439 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002440 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002441 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002442 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2443 * is used.
2444 *
2445 * \warning When using PSA, the user should call `psa_crypto_init()` before
2446 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2447 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002448 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2449 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002450 * \note To achieve a 256-bit security strength with CTR_DRBG,
2451 * you must use AES-256 *and* use sufficient entropy.
2452 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002453 *
2454 * Module: library/ctr_drbg.c
2455 * Caller:
2456 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002457 * Requires: MBEDTLS_AES_C or
2458 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2459 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002460 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002461 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002462 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002463#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002464
2465/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002467 *
2468 * Enable the debug functions.
2469 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002470 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002471 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002472 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002473 * library/ssl_tls12_*.c
2474 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002475 *
2476 * This module provides debugging functions.
2477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002479
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002480/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002482 *
2483 * Enable the DES block cipher.
2484 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002485 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002486 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002487 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002488 *
Paul Bakkercff68422013-09-15 20:43:33 +02002489 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002490 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002491 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002492 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002495
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002498 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002499 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002500 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002501 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002502 * Caller: library/ssl_tls.c
2503 * library/ssl*_client.c
2504 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002505 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002506 * This module is used by the following key exchanges:
2507 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002508 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002509 * \warning Using DHE constitutes a security risk as it
2510 * is not possible to validate custom DH parameters.
2511 * If possible, it is recommended users should consider
2512 * preferring other methods of key exchange.
2513 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002514 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002515 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002516#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002517
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002518/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002520 *
2521 * Enable the elliptic curve Diffie-Hellman library.
2522 *
2523 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002524 * Caller: library/psa_crypto.c
2525 * library/ssl_tls.c
2526 * library/ssl*_client.c
2527 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002528 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002529 * This module is used by the following key exchanges:
2530 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002531 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002535
2536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002538 *
2539 * Enable the elliptic curve DSA library.
2540 *
2541 * Module: library/ecdsa.c
2542 * Caller:
2543 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002544 * This module is used by the following key exchanges:
2545 * ECDHE-ECDSA
2546 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002547 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2548 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2549 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002552
2553/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002554 * \def MBEDTLS_ECJPAKE_C
2555 *
2556 * Enable the elliptic curve J-PAKE library.
2557 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002558 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2559 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002560 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002561 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002562 * Module: library/ecjpake.c
2563 * Caller:
2564 *
2565 * This module is used by the following key exchanges:
2566 * ECJPAKE
2567 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002568 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002569 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002570 * \warning If using a hash that is only provided by PSA drivers, you must
2571 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002572 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002573#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002574
2575/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002577 *
2578 * Enable the elliptic curve over GF(p) library.
2579 *
2580 * Module: library/ecp.c
2581 * Caller: library/ecdh.c
2582 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002583 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002584 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002586 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002588
2589/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002590 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002591 *
2592 * Enable the platform-specific entropy code.
2593 *
2594 * Module: library/entropy.c
2595 * Caller:
2596 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002597 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002598 *
2599 * This module provides a generic entropy pool
2600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002602
2603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002605 *
2606 * Enable error code to error string conversion.
2607 *
2608 * Module: library/error.c
2609 * Caller:
2610 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002614
2615/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002616 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002617 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002618 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002619 *
2620 * Module: library/gcm.c
2621 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002622 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2623 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002624 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002625 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2626 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002628#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002629
2630/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002631 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002632 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002633 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002634 * Can significantly increase throughput on systems without GCM hardware
2635 * acceleration (e.g., AESNI, AESCE).
2636 *
Matthias Schulz78266782024-02-08 13:54:48 +01002637 * The mbedtls_gcm_context size will increase by 3840 bytes.
2638 * The code size will increase by roughly 344 bytes.
2639 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002640 * Module: library/gcm.c
2641 *
2642 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002643 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002644//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002645
2646/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002647 * \def MBEDTLS_HKDF_C
2648 *
2649 * Enable the HKDF algorithm (RFC 5869).
2650 *
2651 * Module: library/hkdf.c
2652 * Caller:
2653 *
2654 * Requires: MBEDTLS_MD_C
2655 *
2656 * This module adds support for the Hashed Message Authentication Code
2657 * (HMAC)-based key derivation function (HKDF).
2658 */
2659#define MBEDTLS_HKDF_C
2660
2661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002662 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002663 *
2664 * Enable the HMAC_DRBG random generator.
2665 *
2666 * Module: library/hmac_drbg.c
2667 * Caller:
2668 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002670 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002671 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002674
2675/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002676 * \def MBEDTLS_LMS_C
2677 *
2678 * Enable the LMS stateful-hash asymmetric signature algorithm.
2679 *
2680 * Module: library/lms.c
2681 * Caller:
2682 *
Raef Colesab4f8742022-09-01 12:24:31 +01002683 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002684 *
Raef Colesab4f8742022-09-01 12:24:31 +01002685 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002686 */
2687#define MBEDTLS_LMS_C
2688
2689/**
Raef Colesab4f8742022-09-01 12:24:31 +01002690 * \def MBEDTLS_LMS_PRIVATE
2691 *
2692 * Enable LMS private-key operations and signing code. Functions enabled by this
2693 * option are experimental, and should not be used in production.
2694 *
2695 * Requires: MBEDTLS_LMS_C
2696 *
2697 * Uncomment to enable the LMS signature algorithm and private key operations.
2698 */
Raef Coles5127e852022-10-07 10:35:56 +01002699//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002700
2701/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002702 * \def MBEDTLS_NIST_KW_C
2703 *
2704 * Enable the Key Wrapping mode for 128-bit block ciphers,
2705 * as defined in NIST SP 800-38F. Only KW and KWP modes
2706 * are supported. At the moment, only AES is approved by NIST.
2707 *
2708 * Module: library/nist_kw.c
2709 *
2710 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2711 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002712#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002713
2714/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002715 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002716 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002717 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002718 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002719 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2720 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002721 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002722 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002723 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002724 * Caller: library/constant_time.c
2725 * library/ecdsa.c
2726 * library/ecjpake.c
2727 * library/hkdf.c
2728 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002729 * library/pk.c
2730 * library/pkcs5.c
2731 * library/pkcs12.c
2732 * library/psa_crypto_ecp.c
2733 * library/psa_crypto_rsa.c
2734 * library/rsa.c
2735 * library/ssl_cookie.c
2736 * library/ssl_msg.c
2737 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002738 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002739 * library/x509_crt.c
2740 * library/x509write_crt.c
2741 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002742 *
2743 * Uncomment to enable generic message digest wrappers.
2744 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002745#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002746
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002747/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002748 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002749 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002750 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002751 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002752 * Module: library/md5.c
2753 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002754 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002755 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002756 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002757 * This module is required for TLS 1.2 depending on the handshake parameters.
2758 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2759 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002760 *
2761 * \warning MD5 is considered a weak message digest and its use constitutes a
2762 * security risk. If possible, we recommend avoiding dependencies on
2763 * it, and considering stronger message digests instead.
2764 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002765 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002766#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002767
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002768/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002770 *
2771 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002772 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002773 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002774 *
2775 * Module: library/memory_buffer_alloc.c
2776 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002778 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002779 *
2780 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002781 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002782//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002783
2784/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002785 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002786 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002787 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2788 *
Simon Butcherd567a232016-03-09 20:19:21 +00002789 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2790 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002791 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002792 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002793 * \note See also our Knowledge Base article about porting to a new
2794 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002795 * 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 +00002796 *
Andres AG788aa4a2016-09-14 14:32:09 +01002797 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002798 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002799 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002800 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002802
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002803/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002805 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002806 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002807 *
2808 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002809 * Caller: library/asn1write.c
2810 * library/pkcs5.c
2811 * library/pkparse.c
2812 * library/pkwrite.c
2813 * library/rsa.c
2814 * library/x509.c
2815 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002816 * library/x509_crl.c
2817 * library/x509_crt.c
2818 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002819 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002820 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002821 *
2822 * This modules translates between OIDs and internal values.
2823 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002825
2826/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002827 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002828 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002829 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002830 *
2831 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002832 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002833 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002834 * library/x509_crl.c
2835 * library/x509_crt.c
2836 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002837 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002838 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002839 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2840 *
2841 * \warning When parsing password-protected files, if MD5 is provided only by
2842 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002843 *
Paul Bakkercff68422013-09-15 20:43:33 +02002844 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002845 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002847
2848/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002850 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002851 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002852 *
2853 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002854 * Caller: library/pkwrite.c
2855 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002856 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002857 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002859 *
2860 * This modules adds support for encoding / writing PEM files.
2861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002863
2864/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002866 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002867 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002868 *
2869 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002870 * Caller: library/psa_crypto_rsa.c
2871 * library/ssl_tls.c
2872 * library/ssl*_client.c
2873 * library/ssl*_server.c
2874 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002875 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002876 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002877 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002878 * Uncomment to enable generic public key wrappers.
2879 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002881
2882/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002884 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002885 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002886 *
2887 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002888 * Caller: library/x509_crt.c
2889 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002890 *
Yanray Wang072a0682023-12-05 10:53:04 +08002891 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002892 *
2893 * Uncomment to enable generic public key parse functions.
2894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002896
2897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002899 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002900 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002901 *
2902 * Module: library/pkwrite.c
2903 * Caller: library/x509write.c
2904 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002905 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002906 *
2907 * Uncomment to enable generic public key write functions.
2908 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002909#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002910
2911/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002913 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002914 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002915 *
2916 * Module: library/pkcs5.c
2917 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002918 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002919 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002920 * \warning If using a hash that is only provided by PSA drivers, you must
2921 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002922 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002923 * This module adds support for the PKCS#5 functions.
2924 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002926
2927/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002928 * \def MBEDTLS_PKCS7_C
2929 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002930 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002931 * RFC Link - https://tools.ietf.org/html/rfc2315
2932 *
2933 * Module: library/pkcs7.c
2934 *
2935 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002936 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2937 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002938 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002939 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002940 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002941#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002942
2943/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002944 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002945 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002946 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002947 * Adds algorithms for parsing PKCS#8 encrypted private keys
2948 *
2949 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002950 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002951 *
Valerio Settie98ad592023-12-28 10:42:12 +01002952 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2953 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002954 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002955 * \warning If using a hash that is only provided by PSA drivers, you must
2956 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002957 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002958 * This module enables PKCS#12 functions.
2959 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002961
2962/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002964 *
2965 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002966 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002967 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2969 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002970 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002971 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002972 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002973 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002974 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002975 * Module: library/platform.c
2976 * Caller: Most other .c files
2977 *
2978 * This module enables abstraction of common (libc) functions.
2979 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002980#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002981
2982/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002983 * \def MBEDTLS_POLY1305_C
2984 *
2985 * Enable the Poly1305 MAC algorithm.
2986 *
2987 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002988 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002989 */
2990#define MBEDTLS_POLY1305_C
2991
2992/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002993 * \def MBEDTLS_PSA_CRYPTO_C
2994 *
2995 * Enable the Platform Security Architecture cryptography API.
2996 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002997 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002998 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002999 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003000 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003001 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3002 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3003 * is enabled in PSA (unless it's fully accelerated, see
3004 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003005 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003006#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003007
3008/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003009 * \def MBEDTLS_PSA_CRYPTO_SE_C
3010 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003011 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003012 * cryptography API.
3013 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003014 * \deprecated This feature is deprecated. Please switch to the PSA driver
3015 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003016 *
Ryan Everett32a64582024-03-05 18:16:18 +00003017 * \warning This feature is not thread-safe, and should not be used in a
3018 * multi-threaded environment.
3019 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003020 * Module: library/psa_crypto_se.c
3021 *
3022 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3023 *
3024 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003025//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003026
3027/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003028 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3029 *
3030 * Enable the Platform Security Architecture persistent key storage.
3031 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003032 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003033 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003034 * Requires: MBEDTLS_PSA_CRYPTO_C,
3035 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3036 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003037 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003038#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003039
3040/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003041 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003042 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003043 * Enable the emulation of the Platform Security Architecture
3044 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003045 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003046 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003047 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003048 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003049 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003050#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003051
3052/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003053 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003054 *
3055 * Enable the RIPEMD-160 hash algorithm.
3056 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003057 * Module: library/ripemd160.c
3058 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003059 *
3060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003062
3063/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003065 *
3066 * Enable the RSA public-key cryptosystem.
3067 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003068 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003069 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003070 * Caller: library/pk.c
3071 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003072 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003073 * library/ssl*_client.c
3074 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003075 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003076 * This module is used by the following key exchanges:
3077 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003078 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003080 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003082
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003083/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003085 *
3086 * Enable the SHA1 cryptographic hash algorithm.
3087 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003088 * Module: library/sha1.c
3089 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003090 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003091 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003092 * This module is required for TLS 1.2 depending on the handshake parameters,
3093 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003094 *
3095 * \warning SHA-1 is considered a weak message digest and its use constitutes
3096 * a security risk. If possible, we recommend avoiding dependencies
3097 * on it, and considering stronger message digests instead.
3098 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003099 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003101
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003102/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003103 * \def MBEDTLS_SHA224_C
3104 *
3105 * Enable the SHA-224 cryptographic hash algorithm.
3106 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003107 * Module: library/sha256.c
3108 * Caller: library/md.c
3109 * library/ssl_cookie.c
3110 *
3111 * This module adds support for SHA-224.
3112 */
3113#define MBEDTLS_SHA224_C
3114
3115/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003117 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003118 * Enable the SHA-256 cryptographic hash algorithm.
3119 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003120 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003121 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003122 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003123 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003124 * library/ssl*_client.c
3125 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003126 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003127 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003128 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003131
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003132/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003133 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003134 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003135 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3136 * with the ARMv8 cryptographic extensions if they are available at runtime.
3137 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003138 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003139 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003140 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003141 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003142 * \note Minimum compiler versions for this feature are Clang 4.0,
3143 * armclang 6.6 or GCC 6.0.
3144 *
3145 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3146 * armclang <= 6.9
3147 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003148 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3149 * That name is deprecated, but may still be used as an alternative form for this
3150 * option.
3151 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003152 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3153 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003154 *
3155 * Requires: MBEDTLS_SHA256_C.
3156 *
3157 * Module: library/sha256.c
3158 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003159 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003160 * and use them if available.
3161 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003162//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003163
Dave Rodgmand85277c2023-10-13 09:22:54 +01003164/**
3165 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3166 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003167 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003168 * This name is now deprecated, but may still be used as an alternative form for
3169 * this option.
3170 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003171//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3172
3173/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003174 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003175 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003176 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3177 * with the ARMv8 cryptographic extensions, which must be available at runtime
3178 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003179 *
3180 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003181 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003182 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003183 * \note Minimum compiler versions for this feature are Clang 4.0,
3184 * armclang 6.6 or GCC 6.0.
3185 *
3186 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3187 * armclang <= 6.9
3188 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003189 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003190 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003191 * option.
3192 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003193 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3194 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003195 *
3196 * Requires: MBEDTLS_SHA256_C.
3197 *
3198 * Module: library/sha256.c
3199 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003200 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003201 * unconditionally.
3202 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003203//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003204
Dave Rodgmand85277c2023-10-13 09:22:54 +01003205/**
3206 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3207 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003208 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003209 * This name is now deprecated, but may still be used as an alternative form for
3210 * this option.
3211 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003212//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3213
3214/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003215 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003216 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003217 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003218 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003219 * Module: library/sha512.c
3220 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003221 * library/psa_crypto_hash.c
3222 * library/ssl_tls.c
3223 * library/ssl*_client.c
3224 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003225 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003226 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003227 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003228#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003229
3230/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003231 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003232 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003233 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003234 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003235 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003236 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003237 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003238 * library/ssl_tls.c
3239 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003240 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003241 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003242 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003244
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003245/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003246 * \def MBEDTLS_SHA3_C
3247 *
3248 * Enable the SHA3 cryptographic hash algorithm.
3249 *
3250 * Module: library/sha3.c
3251 *
3252 * This module adds support for SHA3.
3253 */
3254#define MBEDTLS_SHA3_C
3255
3256/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003257 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3258 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003259 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3260 * with the ARMv8 cryptographic extensions if they are available at runtime.
3261 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003262 *
3263 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3264 * for a non-Aarch64 build it will be silently ignored.
3265 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003266 * \note Minimum compiler versions for this feature are Clang 7.0,
3267 * armclang 6.9 or GCC 8.0.
3268 *
3269 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3270 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003271 *
3272 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3273 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3274 *
3275 * Requires: MBEDTLS_SHA512_C.
3276 *
3277 * Module: library/sha512.c
3278 *
3279 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3280 * and use them if available.
3281 */
3282//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3283
3284/**
3285 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3286 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003287 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3288 * with the ARMv8 cryptographic extensions, which must be available at runtime
3289 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003290 *
3291 * \note This allows builds with a smaller code size than with
3292 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3293 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003294 * \note Minimum compiler versions for this feature are Clang 7.0,
3295 * armclang 6.9 or GCC 8.0.
3296 *
3297 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3298 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003299 *
3300 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3301 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3302 *
3303 * Requires: MBEDTLS_SHA512_C.
3304 *
3305 * Module: library/sha512.c
3306 *
3307 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3308 * unconditionally.
3309 */
3310//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3311
3312/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003313 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003314 *
3315 * Enable simple SSL cache implementation.
3316 *
3317 * Module: library/ssl_cache.c
3318 * Caller:
3319 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003320 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003321 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003323
3324/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003326 *
3327 * Enable basic implementation of DTLS cookies for hello verification.
3328 *
3329 * Module: library/ssl_cookie.c
3330 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003331 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003333
3334/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003335 * \def MBEDTLS_SSL_TICKET_C
3336 *
3337 * Enable an implementation of TLS server-side callbacks for session tickets.
3338 *
3339 * Module: library/ssl_ticket.c
3340 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003341 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003342 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3343 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003344 */
3345#define MBEDTLS_SSL_TICKET_C
3346
3347/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003349 *
3350 * Enable the SSL/TLS client code.
3351 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003352 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003353 * Caller:
3354 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003355 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003356 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003357 * This module is required for SSL/TLS client support.
3358 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003360
Paul Bakker9a736322012-11-14 12:39:52 +00003361/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003363 *
3364 * Enable the SSL/TLS server code.
3365 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003366 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003367 * Caller:
3368 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003370 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003371 * This module is required for SSL/TLS server support.
3372 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003374
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003375/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003376 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003377 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003378 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003379 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003380 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003381 * Caller: library/ssl*_client.c
3382 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003383 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3385 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003386 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003387 * This module is required for SSL/TLS.
3388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003390
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003391/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003393 *
3394 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003395 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003396 * contexts are not shared between threads. If you do intend to use contexts
3397 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003398 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003399 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003400 *
3401 * Module: library/threading.c
3402 *
3403 * This allows different threading implementations (self-implemented or
3404 * provided).
3405 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003406 * You will have to enable either MBEDTLS_THREADING_ALT or
3407 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003408 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003409 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003410 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003411//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003412
3413/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003414 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003415 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003416 * Enable the semi-portable timing interface.
3417 *
Simon Butcherd567a232016-03-09 20:19:21 +00003418 * \note The provided implementation only works on POSIX/Unix (including Linux,
3419 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003420 * module and provide your own implementations of the callbacks needed by
3421 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3422 * your own implementation of the whole module by setting
3423 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003424 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003425 * \note The timing module will include time.h on suitable platforms
3426 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3427 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3428 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003429 * \note See also our Knowledge Base article about porting to a new
3430 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003431 * 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 +00003432 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003433 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003436
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003437/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003438 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003439 *
3440 * Enable run-time version information.
3441 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003442 * Module: library/version.c
3443 *
3444 * This module provides run-time version information.
3445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003447
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003448/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003449 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003450 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003451 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003452 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003453 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003454 * Caller: library/x509_crl.c
3455 * library/x509_crt.c
3456 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003457 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003458 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003459 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3460 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003461 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3462 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003463 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003464 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003465 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003466#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003467
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003468/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003469 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003470 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003471 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003472 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003473 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003474 * Caller: library/ssl_tls.c
3475 * library/ssl*_client.c
3476 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003477 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003479 *
3480 * This module is required for X.509 certificate parsing.
3481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003483
3484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003485 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003486 *
3487 * Enable X.509 CRL parsing.
3488 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003489 * Module: library/x509_crl.c
3490 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003491 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003492 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003493 *
3494 * This module is required for X.509 CRL parsing.
3495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003496#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003497
3498/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003499 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003500 *
3501 * Enable X.509 Certificate Signing Request (CSR) parsing.
3502 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003503 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003504 * Caller: library/x509_crt_write.c
3505 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003506 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003507 *
3508 * This module is used for reading X.509 certificate request.
3509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003510#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003511
3512/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003513 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003514 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003515 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003516 *
3517 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003518 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003519 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003520 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3521 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003522 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3523 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003524 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003525 * This module is the basis for creating X.509 certificates and CSRs.
3526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003527#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003528
3529/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003530 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003531 *
3532 * Enable creating X.509 certificates.
3533 *
3534 * Module: library/x509_crt_write.c
3535 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003537 *
3538 * This module is required for X.509 certificate creation.
3539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003541
3542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003544 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003545 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003546 *
3547 * Module: library/x509_csr_write.c
3548 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003550 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003551 * This module is required for X.509 certificate request writing.
3552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003553#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003554
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003555/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003556
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003557/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003558 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003559 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003560 * This section contains Mbed TLS build settings that are not associated
3561 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003562 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003563 * \{
3564 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003565
Gilles Peskinea02c1242022-03-16 17:03:19 +01003566/**
3567 * \def MBEDTLS_CONFIG_FILE
3568 *
3569 * If defined, this is a header which will be included instead of
3570 * `"mbedtls/mbedtls_config.h"`.
3571 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003572 * Unlike other configuration options, this one must be defined on the
3573 * compiler command line: a definition in `mbedtls_config.h` would have
3574 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003575 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003576 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003577 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003578 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003579 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003580 * The value of this symbol is typically a path in double quotes, either
3581 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003582 */
3583//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3584
3585/**
3586 * \def MBEDTLS_USER_CONFIG_FILE
3587 *
3588 * If defined, this is a header which will be included after
3589 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003590 * This allows you to modify the default configuration, including the ability
3591 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003592 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003593 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003594 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003595 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003596 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003597 * The value of this symbol is typically a path in double quotes, either
3598 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003599 */
3600//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3601
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003602/**
3603 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3604 *
3605 * If defined, this is a header which will be included instead of
3606 * `"psa/crypto_config.h"`.
3607 * This header file specifies which cryptographic mechanisms are available
3608 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3609 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3610 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003611 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003612 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003613 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003614 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003615 * The value of this symbol is typically a path in double quotes, either
3616 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003617 */
3618//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3619
3620/**
3621 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3622 *
3623 * If defined, this is a header which will be included after
3624 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003625 * This allows you to modify the default configuration, including the ability
3626 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003627 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003628 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003629 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003630 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003631 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003632 * The value of this symbol is typically a path in double quotes, either
3633 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003634 */
3635//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3636
Gilles Peskineb1176f22023-02-22 22:07:28 +01003637/**
3638 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3639 *
3640 * If defined, this is a header which will be included instead of
3641 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3642 * as the one in Mbed TLS, but with definitions adapted to the platform on
3643 * which the library code will run.
3644 *
3645 * \note The required content of this header can vary from one version of
3646 * Mbed TLS to the next. Integrators who provide an alternative file
3647 * should review the changes in the original file whenever they
3648 * upgrade Mbed TLS.
3649 *
3650 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3651 * non-standard feature of the C language, so this feature is only available
3652 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3653 *
3654 * The value of this symbol is typically a path in double quotes, either
3655 * absolute or relative to a directory on the include search path.
3656 */
3657//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3658
3659/**
3660 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3661 *
3662 * If defined, this is a header which will be included instead of
3663 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3664 * as the one in Mbed TLS, but with definitions adapted to the environment
3665 * in which the library code will run. The typical use for this feature
3666 * is to provide alternative type definitions on the client side in
3667 * client-server integrations of PSA crypto, where operation structures
3668 * contain handles instead of cryptographic data.
3669 *
3670 * \note The required content of this header can vary from one version of
3671 * Mbed TLS to the next. Integrators who provide an alternative file
3672 * should review the changes in the original file whenever they
3673 * upgrade Mbed TLS.
3674 *
3675 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3676 * non-standard feature of the C language, so this feature is only available
3677 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3678 *
3679 * The value of this symbol is typically a path in double quotes, either
3680 * absolute or relative to a directory on the include search path.
3681 */
3682//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3683
Gilles Peskineba4162a2022-04-11 17:04:38 +02003684/** \} name SECTION: General configuration options */
3685
3686/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003687 * \name SECTION: Module configuration options
3688 *
3689 * This section allows for the setting of module specific sizes and
3690 * configuration options. The default values are already present in the
3691 * relevant header files and should suffice for the regular use cases.
3692 *
3693 * Our advice is to enable options and change their values here
3694 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003695 * \{
3696 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003697/* The Doxygen documentation here is used when a user comments out a
3698 * setting and runs doxygen themselves. On the other hand, when we typeset
3699 * the full documentation including disabled settings, the documentation
3700 * in specific modules' header files is used if present. When editing this
3701 * file, make sure that each option is documented in exactly one place,
3702 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3703 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003704
Paul Bakker088c5c52014-04-25 11:11:10 +02003705/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003706//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003707//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003708
Paul Bakker088c5c52014-04-25 11:11:10 +02003709/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003710//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3711//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3712//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3713//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3714//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003715
Paul Bakker088c5c52014-04-25 11:11:10 +02003716/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003717//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3718//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3719//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3720//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003721
Paul Bakker088c5c52014-04-25 11:11:10 +02003722/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003723//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003724//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003725
Paul Bakker088c5c52014-04-25 11:11:10 +02003726/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003727//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3728//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003729//#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 +01003730
Paul Bakker088c5c52014-04-25 11:11:10 +02003731/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003732//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003733
Paul Bakker088c5c52014-04-25 11:11:10 +02003734/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003735//#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 -04003736
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003737/** \def MBEDTLS_PLATFORM_STD_CALLOC
3738 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003739 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003740 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003741 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003742 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003743 * 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 -04003744 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3745 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003746 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003747 */
3748//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003749
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003750/** \def MBEDTLS_PLATFORM_STD_FREE
3751 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003752 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003753 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003754 * 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 -04003755 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3756 * 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 -04003757 */
3758//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003759//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003760//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003761//#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 +02003762//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3763//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003764/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003765//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003766//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3767//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003768//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3769//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3770//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003771
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003772/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003773/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003774//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3775//#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 +02003776//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003777//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003778//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3779//#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 +02003780//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3781//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003782/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003783//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003784//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003785//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3786//#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 +08003787//#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 +08003788//#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 +02003789
Gilles Peskine3f106f72021-09-23 17:42:39 +02003790/** \def MBEDTLS_CHECK_RETURN
3791 *
3792 * This macro is used at the beginning of the declaration of a function
3793 * to indicate that its return value should be checked. It should
3794 * instruct the compiler to emit a warning or an error if the function
3795 * is called without checking its return value.
3796 *
3797 * There is a default implementation for popular compilers in platform_util.h.
3798 * You can override the default implementation by defining your own here.
3799 *
3800 * If the implementation here is empty, this will effectively disable the
3801 * checking of functions' return values.
3802 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003803//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003804
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003805/** \def MBEDTLS_IGNORE_RETURN
3806 *
3807 * This macro requires one argument, which should be a C function call.
3808 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3809 * warning is suppressed.
3810 */
3811//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3812
Gilles Peskineed038902020-11-13 21:33:21 +01003813/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003814/**
Gilles Peskineed038902020-11-13 21:33:21 +01003815 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3816 * PSA crypto subsystem.
3817 *
3818 * If this option is unset:
3819 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003820 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003821 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3822 * on unspecified heuristics.
3823 */
3824//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3825
Steven Cooreman863470a2021-02-15 14:03:19 +01003826/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003827 *
Gilles Peskine2cb03a52024-07-16 21:29:13 +02003828 * The maximum amount of PSA keys simultaneously in memory. This counts all
3829 * volatile keys, plus loaded persistent keys.
3830 *
3831 * Currently, persistent keys do not need to be loaded all the time while
3832 * a multipart operation is in progress, only while the operation is being
3833 * set up. This may change in future versions of the library.
3834 *
3835 * Currently, the library traverses of the whole table on each access to a
3836 * persistent key. Therefore large values may cause poor performance.
3837 *
3838 * This option has no effect when #MBEDTLS_PSA_CRYPTO_C is disabled.
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003839 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003840//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003841
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003842/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003843//#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 +00003844
Paul Bakker088c5c52014-04-25 11:11:10 +02003845/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003846//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3847//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003848
Paul Bakker088c5c52014-04-25 11:11:10 +02003849/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003850
Angus Grattond8213d02016-05-25 20:56:48 +10003851/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3852 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003853 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003854 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003855 * This determines the size of the incoming TLS I/O buffer in such a way
3856 * that it is capable of holding the specified amount of plaintext data,
3857 * regardless of the protection mechanism used.
3858 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003859 * \note When using a value less than the default of 16KB on the client, it is
3860 * recommended to use the Maximum Fragment Length (MFL) extension to
3861 * inform the server about this limitation. On the server, there
3862 * is no supported, standardized way of informing the client about
3863 * restriction on the maximum size of incoming messages, and unless
3864 * the limitation has been communicated by other means, it is recommended
3865 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3866 * while keeping the default value of 16KB for the incoming buffer.
3867 *
David Horstmann95d516f2021-05-04 18:36:56 +01003868 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003869 */
3870//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3871
Gilles Peskined3d02902020-03-04 21:35:27 +01003872/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3873 *
3874 * The maximum length of CIDs used for incoming DTLS messages.
3875 *
3876 */
3877//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3878
3879/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3880 *
3881 * The maximum length of CIDs used for outgoing DTLS messages.
3882 *
3883 */
3884//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3885
TRodziewicze8dd7092021-05-12 14:19:11 +02003886/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003887 *
3888 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003889 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003890 *
3891 * The padding will always be chosen so that the length of the
3892 * padded plaintext is a multiple of the value of this option.
3893 *
3894 * Note: A value of \c 1 means that no padding will be used
3895 * for outgoing records.
3896 *
3897 * Note: On systems lacking division instructions,
3898 * a power of two should be preferred.
3899 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003900//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003901
Angus Grattond8213d02016-05-25 20:56:48 +10003902/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3903 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003904 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003905 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003906 * This determines the size of the outgoing TLS I/O buffer in such a way
3907 * that it is capable of holding the specified amount of plaintext data,
3908 * regardless of the protection mechanism used.
3909 *
Angus Grattond8213d02016-05-25 20:56:48 +10003910 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3911 * the default inward 16384 byte buffer to conform to the TLS specification.
3912 *
3913 * The minimum required outward buffer size is determined by the handshake
3914 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3915 * The specific size requirement depends on the configured ciphers and any
3916 * certificate data which is sent during the handshake.
3917 *
David Horstmann95d516f2021-05-04 18:36:56 +01003918 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003919 */
3920//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3921
Hanno Beckere0b150f2018-08-21 15:51:03 +01003922/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3923 *
3924 * Maximum number of heap-allocated bytes for the purpose of
3925 * DTLS handshake message reassembly and future message buffering.
3926 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003927 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003928 * to account for a reassembled handshake message of maximum size,
3929 * together with its reassembly bitmap.
3930 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003931 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003932 * should be sufficient for all practical situations as it allows
3933 * to reassembly a large handshake message (such as a certificate)
3934 * while buffering multiple smaller handshake messages.
3935 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003936 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003937//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003938
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003939//#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 +02003940//#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 +02003941
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003942/**
3943 * Complete list of ciphersuites to use, in order of preference.
3944 *
3945 * \warning No dependency checking is done on that field! This option can only
3946 * be used to restrict the set of available ciphersuites. It is your
3947 * responsibility to make sure the needed modules are active.
3948 *
3949 * Use this to save a few hundred bytes of ROM (default ordering of all
3950 * available ciphersuites) and a few to a few hundred bytes of RAM.
3951 *
3952 * The value below is only an example, not the default.
3953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003954//#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 +02003955
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003956/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003957 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3958 *
3959 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003960 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003961 *
3962 * It must be positive and smaller than UINT32_MAX.
3963 *
3964 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3965 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003966 */
3967//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3968
3969/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003970 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3971 *
Jerry Yucf913512023-11-14 11:06:52 +08003972 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003973 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003974 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003975 * - The client ticket age is the time difference between the time when the
3976 * client proposes to the server to use the ticket and the time the client
3977 * received the ticket from the server.
3978 * - The server ticket age is the time difference between the time when the
3979 * server receives a proposition from the client to use the ticket and the
3980 * time when the ticket was created by the server.
3981 *
Jerry Yucf913512023-11-14 11:06:52 +08003982 * The ages might be different due to the client and server clocks not running
3983 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3984 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3985 * 6s, thus in the worst case clients and servers must sync up their system time
3986 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003987 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003988 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003989 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003990//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003991
3992/**
3993 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3994 *
3995 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3996 *
3997 * This must be less than 256.
3998 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003999//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004000
4001/**
4002 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4003 *
4004 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4005 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4006 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4007 *
4008 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004009//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004010
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004011/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004012//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004013//#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 +01004014
Gilles Peskine611179c2022-04-13 23:04:48 +02004015/** \} name SECTION: Module configuration options */