blob: dd047e98d673fd3425ea29e70175c6d733e8b218 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020034 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000035 *
36 * Requires support for asm() in compiler.
37 *
38 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000039 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010040 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000041 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000042 * library/constant_time.c
Paul Bakker68041ec2009-04-19 21:17:55 +000043 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010044 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000045 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010046 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020048 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000051
Paul Bakkerf3b86c12011-01-27 15:24:17 +000052/**
Gilles Peskineed942f82017-06-08 15:19:20 +020053 * \def MBEDTLS_NO_UDBL_DIVISION
54 *
55 * The platform lacks support for double-width integer division (64-bit
56 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
57 *
58 * Used in:
59 * include/mbedtls/bignum.h
60 * library/bignum.c
61 *
62 * The bignum code uses double-width division to speed up some operations.
63 * Double-width division is often implemented in software that needs to
64 * be linked with the program. The presence of a double-width integer
65 * type is usually detected automatically through preprocessor macros,
66 * but the automatic detection cannot know whether the code needs to
67 * and can be linked with an implementation of division for that type.
68 * By default division is assumed to be usable if the type is present.
69 * Uncomment this option to prevent the use of double-width division.
70 *
71 * Note that division for the native integer type is always required.
72 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010073 * platform, but it need not support multiplication or division. In some
74 * cases it is also desirable to disable some double-width operations. For
75 * example, if double-width division is implemented in software, disabling
76 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020077 */
78//#define MBEDTLS_NO_UDBL_DIVISION
79
80/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020081 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
82 *
83 * The platform lacks support for 32x32 -> 64-bit multiplication.
84 *
85 * Used in:
86 * library/poly1305.c
87 *
88 * Some parts of the library may use multiplication of two unsigned 32-bit
89 * operands with a 64-bit result in order to speed up computations. On some
90 * platforms, this is not available in hardware and has to be implemented in
91 * software, usually in a library provided by the toolchain.
92 *
93 * Sometimes it is not desirable to have to link to that library. This option
94 * removes the dependency of that library on platforms that lack a hardware
95 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
96 *
97 * Note that depending on the compiler, this may decrease performance compared
98 * to using the library function provided by the toolchain.
99 */
100//#define MBEDTLS_NO_64BIT_MULTIPLICATION
101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000104 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000105 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200113 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200114 * System has time.h and time().
115 * The time does not need to be correct, only time differences are used,
116 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200117 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100118 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
119 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
120 * MBEDTLS_PLATFORM_STD_TIME.
121 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400122 * Comment if your system does not support time functions.
123 *
124 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
125 * interface - timing.c will include time.h on suitable platforms
126 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
127 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100130
131/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200132 * \def MBEDTLS_HAVE_TIME_DATE
133 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100134 * System has time.h, time(), and an implementation for
135 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100136 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200137 * the date should be correct). This is used to verify the validity period of
138 * X.509 certificates.
139 *
140 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100141 *
Hanno Becker6a739782018-09-05 15:06:19 +0100142 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100143 * behaves similarly to the gmtime_r() function from the C standard. Refer to
144 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100145 *
146 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100147 * mbedtls_platform_gmtime_r() at compile-time by using the macro
148 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200149 */
150#define MBEDTLS_HAVE_TIME_DATE
151
152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100154 *
155 * Enable the memory allocation layer.
156 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200157 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 * This allows different allocators (self-implemented or provided) to be
159 * provided to the platform abstraction layer.
160 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400161 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200162 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
163 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000164 * free() function pointer at runtime.
165 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400166 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100169 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400170 * An overview of how the value of mbedtls_calloc is determined:
171 *
172 * - if !MBEDTLS_PLATFORM_MEMORY
173 * - mbedtls_calloc = calloc
174 * - if MBEDTLS_PLATFORM_MEMORY
175 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
176 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
177 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
179 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
180 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
182 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
183 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
184 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
185 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
186 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
187 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
188 *
189 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
190 * - if !MBEDTLS_PLATFORM_STD_CALLOC
191 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
192 *
193 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
194 *
195 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
196 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
197 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
198 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
199 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
200 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100203 *
204 * Enable this layer to allow use of alternative memory allocators.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100207
208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200211 * Do not assign standard functions in the platform layer (e.g. calloc() to
212 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200213 *
214 * This makes sure there are no linking errors on platforms that do not support
215 * these functions. You will HAVE to provide alternatives, either at runtime
216 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
218 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
222 * Uncomment to prevent default assignment of standard functions in the
223 * platform layer.
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200226
227/**
Janos Follathc351d182016-03-21 08:43:59 +0000228 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200230 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100231 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200233 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 * alternative printf function pointer.
236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200239 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
240 * it will be enabled automatically by check_config.h
241 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200242 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000244 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100245 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
246 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 * Uncomment a macro to enable alternate implementation of specific base
248 * platform function
249 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200250//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100252//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_FPRINTF_ALT
254//#define MBEDTLS_PLATFORM_PRINTF_ALT
255//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200256//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100257//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100258//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800259//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260
261/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200262 * Uncomment the macro to let Mbed TLS use your alternate implementation of
263 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
264 * platform_util.c.
265 *
266 * gmtime() is not a thread-safe function as defined in the C standard. The
267 * library will try to use safer implementations of this function, such as
268 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
269 * system, the implementation of mbedtls_platform_gmtime_r() will default to
270 * using the standard gmtime(). In this case, calls from the library to
271 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
272 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
273 * library are also guarded with this mutex to avoid race conditions. However,
274 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
275 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
276 * supplied at compile time.
277 */
278//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
279
280/**
Gilles Peskine86733832023-09-07 15:02:39 +0200281 * Uncomment the macro to let Mbed TLS use your alternate implementation of
282 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
283 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200284 *
Gilles Peskine86733832023-09-07 15:02:39 +0200285 * By default, the library uses a system function such as memset_s()
286 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
287 * SecureZeroMemory (Windows). If no such function is detected, the library
288 * falls back to a plain C implementation. Compilers are technically
289 * permitted to optimize this implementation out, meaning that the memory is
290 * not actually wiped. The library tries to prevent that, but the C language
291 * makes it impossible to guarantee that the memory will always be wiped.
292 *
293 * If your platform provides a guaranteed method to wipe memory which
294 * `platform_util.c` does not detect, define this macro to the name of
295 * a function that takes two arguments, a `void *` pointer and a length,
296 * and wipes that many bytes starting at the specified address. For example,
297 * if your platform has explicit_bzero() but `platform_util.c` does not
298 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
299 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200300 */
301//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
302
303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Mark deprecated functions and features so that they generate a warning if
307 * used. Functionality deprecated in one version will usually be removed in the
308 * next version. You can enable this to help you prepare the transition to a
309 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100310 *
311 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100313 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000314 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317
318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100320 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000321 * Remove deprecated functions and features so that they generate an error if
322 * used. Functionality deprecated in one version will usually be removed in the
323 * next version. You can enable this to help you prepare the transition to a
324 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100325 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000326 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100330/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000331
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000332/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200333 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000334 *
335 * This section sets support for features that are or are not needed
336 * within the modules that are enabled.
337 * \{
338 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
TRodziewiczd8540832021-06-10 15:16:50 +0200343 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200344 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
348 * You will need to provide a header "timing_alt.h" and an implementation at
349 * compile time.
350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100352
Ron Eldor314adb62017-10-10 18:28:25 +0300353//#define MBEDTLS_ECDSA_SIGN_ALT
354//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200355
356/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200357 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200358 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200359 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200360 * hardware entropy collector.
361 *
362 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000363 * prototype as declared in library/entropy_poll.h, and accept NULL as first
364 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200365 *
366 * Uncomment to use your own hardware entropy collector.
367 */
368//#define MBEDTLS_ENTROPY_HARDWARE_ALT
369
370/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200371 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000372 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100373 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000374 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100375 * Uncomment this macro to use precomputed AES tables stored in ROM.
376 * Comment this macro to generate AES tables in RAM at runtime.
377 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100378 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
379 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100380 * initialization time before the first AES operation can be performed.
381 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
382 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
383 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100384 *
385 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000386 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200387//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000388
389/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100390 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200391 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100392 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200393 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100394 * Uncommenting this macro omits 75% of the AES tables from
395 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
396 * by computing their values on the fly during operations
397 * (the tables are entry-wise rotations of one another).
398 *
399 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100400 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100401 * runtime. Specifically, one has to compare 4 accesses within
402 * different tables to 4 accesses with additional arithmetic
403 * operations within the same table. The performance gain/loss
404 * depends on the system and memory details.
405 *
406 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200407 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100408//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200409
410/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800411 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
412 *
413 * Use only 128-bit keys in AES operations to save ROM.
414 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800415 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800416 * or 256-bit keys.
417 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800418 * Uncommenting this macro reduces the size of AES code by ~300 bytes
419 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800420 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800421 * Module: library/aes.c
422 *
423 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800424 */
425//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
426
Gilles Peskinea8861e02023-09-05 20:20:51 +0200427/*
428 * Disable plain C implementation for AES.
429 *
430 * When the plain C implementation is enabled, and an implementation using a
431 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
432 * detection will be used to select between them.
433 *
434 * If only one implementation is present, runtime detection will not be used.
435 * This configuration will crash at runtime if running on a CPU without the
436 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
437 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
438 */
439//#define MBEDTLS_AES_USE_HARDWARE_ONLY
440
Arto Kinnunen732ca322023-04-14 14:26:10 +0800441/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200442 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200443 *
444 * Use less ROM for the Camellia implementation (saves about 768 bytes).
445 *
446 * Uncomment this macro to use less memory for Camellia.
447 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200448//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200449
450/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200451 * \def MBEDTLS_CHECK_RETURN_WARNING
452 *
453 * If this macro is defined, emit a compile-time warning if application code
454 * calls a function without checking its return value, but the return value
455 * should generally be checked in portable applications.
456 *
457 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
458 * implemented. Otherwise this option has no effect.
459 *
460 * Uncomment to get warnings on using fallible functions without checking
461 * their return value.
462 *
463 * \note This feature is a work in progress.
464 * Warnings will be added to more functions in the future.
465 *
466 * \note A few functions are considered critical, and ignoring the return
467 * value of these functions will trigger a warning even if this
468 * macro is not defined. To completely disable return value check
469 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
470 */
471//#define MBEDTLS_CHECK_RETURN_WARNING
472
473/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200474 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200475 *
476 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200479
480/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200481 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000482 *
483 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200485#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000486
487/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200488 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000489 *
490 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
491 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200492#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000493
494/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100495 * \def MBEDTLS_CIPHER_MODE_OFB
496 *
497 * Enable Output Feedback mode (OFB) for symmetric ciphers.
498 */
499#define MBEDTLS_CIPHER_MODE_OFB
500
501/**
502 * \def MBEDTLS_CIPHER_MODE_XTS
503 *
504 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
505 */
506#define MBEDTLS_CIPHER_MODE_XTS
507
508/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200509 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000510 *
511 * Enable NULL cipher.
512 * Warning: Only do so when you know what you are doing. This allows for
513 * encryption or channels without any security!
514 *
Ronald Croncee42702021-04-26 11:34:44 +0200515 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200516 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
517 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
518 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
519 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
520 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
521 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
522 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
523 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
524 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
525 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
526 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
527 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
528 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
529 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
530 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
531 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
532 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
533 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
534 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000535 *
536 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200538//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000539
540/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100541 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200542 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100543 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
544 * specific padding modes in the cipher layer with cipher modes that support
545 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200546 *
547 * If you disable all padding modes, only full blocks can be used with CBC.
548 *
549 * Enable padding modes in the cipher layer.
550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551#define MBEDTLS_CIPHER_PADDING_PKCS7
552#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
553#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
554#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200555
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200556/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
557 *
558 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800559 * Without this, CTR_DRBG uses a 256-bit key
560 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200561 */
562//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
563
Paul Bakker48e93c82013-08-14 12:21:18 +0200564/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200565 * Enable the verified implementations of ECDH primitives from Project Everest
566 * (currently only Curve25519). This feature changes the layout of ECDH
567 * contexts and therefore is a compatibility break for applications that access
568 * fields of a mbedtls_ecdh_context structure directly. See also
569 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000570 *
571 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
572 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200573 */
574//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
575
576/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100577 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200578 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100579 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
580 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200581 *
582 * Comment macros to disable the curve and functions for it
583 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200584/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200585#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
586#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
587#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
588#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
589#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
590#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
591#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
592#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
593#define MBEDTLS_ECP_DP_BP256R1_ENABLED
594#define MBEDTLS_ECP_DP_BP384R1_ENABLED
595#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200596/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200597#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000598#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200599
600/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200601 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200602 *
603 * Enable specific 'modulo p' routines for each NIST prime.
604 * Depending on the prime and architecture, makes operations 4 to 8 times
605 * faster on the corresponding curve.
606 *
607 * Comment this macro to disable NIST curves optimisation.
608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200609#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200610
611/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200612 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100613 *
614 * Enable "non-blocking" ECC operations that can return early and be resumed.
615 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200616 * This allows various functions to pause by returning
617 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
618 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
619 * order to further progress and eventually complete their operation. This is
620 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
621 * number of ECC operations a function may perform before pausing; see
622 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100623 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200624 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200625 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100626 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100627 * This option:
628 * - Adds xxx_restartable() variants of existing operations in the
629 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100630 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
631 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100632 * - ECDSA: signature generation & verification;
633 * - PK: signature generation & verification;
634 * - X509: certificate chain verification.
635 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
636 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
637 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
638 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000639 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100640 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100641 * - verification of the server's key exchange signature;
642 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100643 * - generation of the client's signature if client authentication is used,
644 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100645 *
646 * \note In the cases above, the usual SSL/TLS functions, such as
647 * mbedtls_ssl_handshake(), can now return
648 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200649 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100650 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
651 * restartable operations in PK, X.509 and TLS (see above) are not
652 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100653 * PSA, and are not restartable. These are temporary limitations that
654 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200655 *
Ron Eldor19779c42018-11-05 16:58:13 +0200656 * \note This option only works with the default software implementation of
657 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100658 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100659 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100660 * Requires: MBEDTLS_ECP_C
661 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100662 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100663 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200664//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100665
666/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200667 * Uncomment to enable using new bignum code in the ECC modules.
668 *
669 * \warning This is currently experimental, incomplete and therefore should not
670 * be used in production.
671 */
672//#define MBEDTLS_ECP_WITH_MPI_UINT
673
674/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100676 *
677 * Enable deterministic ECDSA (RFC 6979).
678 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
679 * may result in a compromise of the long-term signing key. This is avoided by
680 * the deterministic variant.
681 *
John Durkop36a82e52020-10-26 09:39:05 -0700682 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100683 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100684 * Comment this macro to disable deterministic ECDSA.
685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100687
688/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200689 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200690 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200691 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200692 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200693 * This enables the following ciphersuites (if other requisites are
694 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
696 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
697 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
698 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
699 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
700 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
701 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
702 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
703 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
704 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200705 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200707
708/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200709 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200710 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200711 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200712 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200713 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200714 *
715 * This enables the following ciphersuites (if other requisites are
716 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200717 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
718 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
719 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
720 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
721 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
722 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
723 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
724 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
725 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
726 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100727 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100728 * \warning Using DHE constitutes a security risk as it
729 * is not possible to validate custom DH parameters.
730 * If possible, it is recommended users should consider
731 * preferring other methods of key exchange.
732 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100733 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200735#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200736
737/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200739 *
740 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
741 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200742 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200743 *
744 * This enables the following ciphersuites (if other requisites are
745 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
747 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
748 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
749 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
750 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
751 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200752 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200753#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200754
755/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200756 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200757 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200758 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200759 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200760 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
761 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200762 *
763 * This enables the following ciphersuites (if other requisites are
764 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
766 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
767 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
768 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
769 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
770 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
771 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
772 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
773 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
774 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200775 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200776#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200777
778/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200779 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200780 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200781 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200782 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
784 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200785 *
786 * This enables the following ciphersuites (if other requisites are
787 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200788 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
789 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
790 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
791 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
792 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
793 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
794 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
795 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
796 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
797 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
798 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
799 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200800 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200801#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200802
803/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200804 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200805 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200806 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200807 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200808 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
809 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200810 *
811 * This enables the following ciphersuites (if other requisites are
812 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
814 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
815 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
816 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
817 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
818 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
819 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
820 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
821 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
822 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
823 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
824 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100825 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100826 * \warning Using DHE constitutes a security risk as it
827 * is not possible to validate custom DH parameters.
828 * If possible, it is recommended users should consider
829 * preferring other methods of key exchange.
830 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100831 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200832 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200833#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200834
835/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200836 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200837 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200838 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200839 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200840 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
841 * MBEDTLS_RSA_C
842 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200843 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200844 *
845 * This enables the following ciphersuites (if other requisites are
846 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200847 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
848 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
849 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
850 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
851 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
852 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
853 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
854 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
855 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
856 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200857 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200859
860/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200861 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200862 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200863 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200864 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200865 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
866 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
867 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200868 *
869 * This enables the following ciphersuites (if other requisites are
870 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
872 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
873 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
874 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
875 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
876 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
877 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
878 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
879 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
880 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200881 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200883
884/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100886 *
887 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
888 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200889 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
890 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
891 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100892 *
893 * This enables the following ciphersuites (if other requisites are
894 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
896 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
897 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
898 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
899 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
900 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
901 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
902 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
903 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
904 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100905 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100907
908/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100910 *
911 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
912 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200913 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
914 * MBEDTLS_RSA_C
915 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100916 *
917 * This enables the following ciphersuites (if other requisites are
918 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200919 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
920 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
921 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
922 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
923 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
924 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
925 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
926 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
927 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
928 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100931
932/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200933 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
934 *
935 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
936 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200937 * \warning This is currently experimental. EC J-PAKE support is based on the
938 * Thread v1.0.0 specification; incompatible changes to the specification
939 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200940 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200941 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100942 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200943 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
944 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100945 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800946 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100947 * MBEDTLS_USE_PSA_CRYPTO is disabled).
948 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200949 * This enables the following ciphersuites (if other requisites are
950 * enabled as well):
951 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
952 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200953//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200954
955/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200956 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100957 *
958 * Enhance support for reading EC keys using variants of SEC1 not allowed by
959 * RFC 5915 and RFC 5480.
960 *
961 * Currently this means parsing the SpecifiedECDomain choice of EC
962 * parameters (only known groups are supported, not arbitrary domains, to
963 * avoid validation issues).
964 *
965 * Disable if you only need to support RFC 5915 + 5480 key formats.
966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100968
969/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200970 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
971 *
972 * Enable the support for parsing public keys of type Short Weierstrass
973 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200974 * compressed point format. This parsing is done through ECP module's functions.
975 *
976 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
977 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
978 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200979 */
980#define MBEDTLS_PK_PARSE_EC_COMPRESSED
981
982/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200983 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100984 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985 * Enable a dummy error function to make use of mbedtls_strerror() in
986 * third party libraries easier when MBEDTLS_ERROR_C is disabled
987 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200988 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
990 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100991 *
992 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100994 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200995#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100996
997/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000999 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001000 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001001 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001002 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001003 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001005
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001008 *
1009 * Enable functions that use the filesystem.
1010 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001012
1013/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001014 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001015 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001016 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001017 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001018 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001019 * application.
1020 *
1021 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001024
1025/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001027 *
1028 * Do not use built-in platform entropy functions.
1029 * This is useful if your platform does not support
1030 * standards like the /dev/urandom or Windows CryptoAPI.
1031 *
1032 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001033 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001035
1036/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001038 *
1039 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1040 * default SHA-512 based one (if both are available).
1041 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001043 *
1044 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1045 * if you have performance concerns.
1046 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * This option is only useful if both MBEDTLS_SHA256_C and
1048 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001051
1052/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001053 * \def MBEDTLS_ENTROPY_NV_SEED
1054 *
1055 * Enable the non-volatile (NV) seed file-based entropy source.
1056 * (Also enables the NV seed read/write functions in the platform layer)
1057 *
1058 * This is crucial (if not required) on systems that do not have a
1059 * cryptographic entropy source (in hardware or kernel) available.
1060 *
1061 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1062 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001063 * \note The read/write functions that are used by the entropy source are
1064 * determined in the platform layer, and can be modified at runtime and/or
1065 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1066 *
1067 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001068 * with regular fopen(), please make sure you make a seedfile with the
1069 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1070 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001071 * and written to or you will get an entropy source error! The default
1072 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1073 * bytes from the file.
1074 *
1075 * \note The entropy collector will write to the seed file before entropy is
1076 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001077 */
1078//#define MBEDTLS_ENTROPY_NV_SEED
1079
Ronald Cron71016a92020-08-28 19:01:50 +02001080/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001081 *
Ronald Cron71016a92020-08-28 19:01:50 +02001082 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001083 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001084 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1085 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001086 *
1087 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001088 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001089 */
Ronald Cron71016a92020-08-28 19:01:50 +02001090//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001091
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001092/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001093 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001094 *
1095 * Enable debugging of buffer allocator memory issues. Automatically prints
1096 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1097 * function for 'debug output' of allocated memory.
1098 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001099 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001100 *
1101 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001102 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001104
1105/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001107 *
1108 * Include backtrace information with each allocated block.
1109 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001110 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001111 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001112 *
1113 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001114 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001116
1117/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001118 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001119 *
1120 * Support external private RSA keys (eg from a HSM) in the PK layer.
1121 *
1122 * Comment this macro to disable support for external private RSA keys.
1123 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001124#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001125
1126/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001128 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001129 * Enable support for PKCS#1 v1.5 encoding.
1130 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001131 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001132 *
Paul Bakker48377d92013-08-30 12:06:24 +02001133 * This enables support for PKCS#1 v1.5 operations.
1134 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001135#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001136
1137/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001138 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001139 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001140 * Enable support for PKCS#1 v2.1 encoding.
1141 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001142 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001143 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001144 * \warning If using a hash that is only provided by PSA drivers, you must
1145 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001146 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001147 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1148 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001150
Steven Cooreman6801f082021-02-19 17:21:22 +01001151/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1152 *
1153 * Enable support for platform built-in keys. If you enable this feature,
1154 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1155 * See the documentation of that function for more information.
1156 *
1157 * Built-in keys are typically derived from a hardware unique key or
1158 * stored in a secure element.
1159 *
1160 * Requires: MBEDTLS_PSA_CRYPTO_C.
1161 *
1162 * \warning This interface is experimental and may change or be removed
1163 * without notice.
1164 */
1165//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1166
Ronald Cron3768ac12021-01-26 16:58:00 +01001167/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1168 *
1169 * Enable support for PSA crypto client.
1170 *
1171 * \note This option allows to include the code necessary for a PSA
1172 * crypto client when the PSA crypto implementation is not included in
1173 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1174 * code to set and get PSA key attributes.
1175 * The development of PSA drivers partially relying on the library to
1176 * fulfill the hardware gaps is another possible usage of this option.
1177 *
1178 * \warning This interface is experimental and may change or be removed
1179 * without notice.
1180 */
1181//#define MBEDTLS_PSA_CRYPTO_CLIENT
1182
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001183/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1184 *
1185 * Make the PSA Crypto module use an external random generator provided
1186 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1187 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001188 * \note This random generator must deliver random numbers with cryptographic
1189 * quality and high performance. It must supply unpredictable numbers
1190 * with a uniform distribution. The implementation of this function
1191 * is responsible for ensuring that the random generator is seeded
1192 * with sufficient entropy. If you have a hardware TRNG which is slow
1193 * or delivers non-uniform output, declare it as an entropy source
1194 * with mbedtls_entropy_add_source() instead of enabling this option.
1195 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001196 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001197 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1198 * and define a function called mbedtls_psa_external_get_random()
1199 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001200 * ```
1201 * psa_status_t mbedtls_psa_external_get_random(
1202 * mbedtls_psa_external_random_context_t *context,
1203 * uint8_t *output, size_t output_size, size_t *output_length);
1204 * );
1205 * ```
1206 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001207 * The function must fill the \c output buffer with \c output_size bytes
1208 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001209 *
1210 * Requires: MBEDTLS_PSA_CRYPTO_C
1211 *
1212 * \warning If you enable this option, code that uses the PSA cryptography
1213 * interface will not use any of the entropy sources set up for
1214 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1215 * enables.
1216 *
1217 * \note This option is experimental and may be removed without notice.
1218 */
1219//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1220
Paul Bakker9dcc3222011-03-08 14:16:06 +00001221/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001222 * \def MBEDTLS_PSA_CRYPTO_SPM
1223 *
1224 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1225 * Partition Manager) integration which separates the code into two parts: a
1226 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1227 * Environment).
1228 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001229 * If you enable this option, your build environment must include a header
1230 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1231 * header files, or in another directory on the compiler's include search
1232 * path). Alternatively, your platform may customize the header
1233 * `psa/crypto_platform.h`, in which case it can skip or replace the
1234 * inclusion of `"crypto_spe.h"`.
1235 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001236 * Module: library/psa_crypto.c
1237 * Requires: MBEDTLS_PSA_CRYPTO_C
1238 *
1239 */
1240//#define MBEDTLS_PSA_CRYPTO_SPM
1241
1242/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001243 * Uncomment to enable p256-m. This is an alternative implementation of
1244 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1245 * Compared to the default implementation:
1246 *
1247 * - p256-m has a much smaller code size and RAM footprint.
1248 * - p256-m is only available via the PSA API. This includes the pk module
1249 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1250 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1251 * over the core arithmetic, or deterministic derivation of keys.
1252 *
1253 * We recommend enabling this option if your application uses the PSA API
1254 * and the only elliptic curve support it needs is ECDH and ECDSA over
1255 * SECP256R1.
1256 *
1257 * If you enable this option, you do not need to enable any ECC-related
1258 * MBEDTLS_xxx option. You do need to separately request support for the
1259 * cryptographic mechanisms through the PSA API:
1260 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1261 * configuration;
1262 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1263 * - #PSA_WANT_ECC_SECP_R1_256;
1264 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1265 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1266 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1267 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1268 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001269 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001270 * \note To benefit from the smaller code size of p256-m, make sure that you
1271 * do not enable any ECC-related option not supported by p256-m: this
1272 * would cause the built-in ECC implementation to be built as well, in
1273 * order to provide the required option.
1274 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001275 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1276 * SECP256R1 are disabled as they are not supported by this driver.
1277 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1278 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001279 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001280 */
1281//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1282
1283/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001284 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001285 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001286 * Enable support for entropy injection at first boot. This feature is
1287 * required on systems that do not have a built-in entropy source (TRNG).
1288 * This feature is currently not supported on systems that have a built-in
1289 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001290 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001291 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001292 *
1293 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001294//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001295
1296/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001297 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001298 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001299 * Assume all buffers passed to PSA functions are owned exclusively by the
1300 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001301 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001302 * This option may be enabled if all buffers passed to any PSA function reside
1303 * in memory that is accessible only to the PSA function during its execution.
1304 *
1305 * This option MUST be disabled whenever buffer arguments are in memory shared
1306 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001307 * across a trust boundary.
1308 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001309 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001310 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001311 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001312 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001313 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001314//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001315
1316/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001317 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001318 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001319 * Do not use the Chinese Remainder Theorem
1320 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001321 *
1322 * Uncomment this macro to disable the use of CRT in RSA.
1323 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001324 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001325//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001326
1327/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001328 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001329 *
1330 * Enable the checkup functions (*_self_test).
1331 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001332#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001333
1334/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001335 * \def MBEDTLS_SHA256_SMALLER
1336 *
1337 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1338 * lower performance.
1339 *
Adam Wolf039080f2019-09-10 09:53:08 -05001340 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001341 * performance and size. This version optimizes more aggressively for size at
1342 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1343 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1344 * 30%.
1345 *
1346 * Uncomment to enable the smaller implementation of SHA256.
1347 */
1348//#define MBEDTLS_SHA256_SMALLER
1349
1350/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001351 * \def MBEDTLS_SHA512_SMALLER
1352 *
1353 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1354 * lower performance.
1355 *
1356 * Uncomment to enable the smaller implementation of SHA512.
1357 */
1358//#define MBEDTLS_SHA512_SMALLER
1359
1360/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001362 *
1363 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001364 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001365 * with other servers, only debugging of failures is harder.
1366 *
1367 * The advantage of not sending alert messages, is that no information is given
1368 * about reasons for failures thus preventing adversaries of gaining intel.
1369 *
1370 * Enable sending of all alert messages
1371 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001372#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001373
1374/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001375 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1376 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001377 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001378 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001379 * in the underlying transport. The CID functionality is described
1380 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001381 *
1382 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001383 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1384 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1385 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001386 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001387 * The maximum lengths of outgoing and incoming CIDs can be configured
1388 * through the options
1389 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1390 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1391 *
1392 * Requires: MBEDTLS_SSL_PROTO_DTLS
1393 *
1394 * Uncomment to enable the Connection ID extension.
1395 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001396#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1397
1398
1399/**
1400 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1401 *
1402 * Defines whether RFC 9146 (default) or the legacy version
1403 * (version draft-ietf-tls-dtls-connection-id-05,
1404 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1405 * is used.
1406 *
1407 * Set the value to 0 for the standard version, and
1408 * 1 for the legacy draft version.
1409 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001410 * \deprecated Support for the legacy version of the DTLS
1411 * Connection ID feature is deprecated. Please
1412 * switch to the standardized version defined
1413 * in RFC 9146 enabled by utilizing
1414 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1415 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1416 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001417 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1418 */
1419#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001420
1421/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001422 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1423 *
1424 * Enable asynchronous external private key operations in SSL. This allows
1425 * you to configure an SSL connection to call an external cryptographic
1426 * module to perform private key operations instead of performing the
1427 * operation inside the library.
1428 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001429 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001430 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001431//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001432
1433/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001434 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1435 *
1436 * Enable serialization of the TLS context structures, through use of the
1437 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1438 *
1439 * This pair of functions allows one side of a connection to serialize the
1440 * context associated with the connection, then free or re-use that context
1441 * while the serialized state is persisted elsewhere, and finally deserialize
1442 * that state to a live context for resuming read/write operations on the
1443 * connection. From a protocol perspective, the state of the connection is
1444 * unaffected, in particular this is entirely transparent to the peer.
1445 *
1446 * Note: this is distinct from TLS session resumption, which is part of the
1447 * protocol and fully visible by the peer. TLS session resumption enables
1448 * establishing new connections associated to a saved session with shorter,
1449 * lighter handshakes, while context serialization is a local optimization in
1450 * handling a single, potentially long-lived connection.
1451 *
1452 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1453 * saved after the handshake to allow for more efficient serialization, so if
1454 * you don't need this feature you'll save RAM by disabling it.
1455 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001456 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1457 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001458 * Comment to disable the context serialization APIs.
1459 */
1460#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1461
1462/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001463 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001464 *
1465 * Enable the debug messages in SSL module for all issues.
1466 * Debug messages have been disabled in some places to prevent timing
1467 * attacks due to (unbalanced) debugging function calls.
1468 *
1469 * If you need all error reporting you should enable this during debugging,
1470 * but remove this for production servers that should log as well.
1471 *
1472 * Uncomment this macro to report all debug messages on errors introducing
1473 * a timing side-channel.
1474 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001475 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001476//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001477
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001478/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001479 *
1480 * Enable support for Encrypt-then-MAC, RFC 7366.
1481 *
1482 * This allows peers that both support it to use a more robust protection for
1483 * ciphersuites using CBC, providing deep resistance against timing attacks
1484 * on the padding or underlying cipher.
1485 *
1486 * This only affects CBC ciphersuites, and is useless if none is defined.
1487 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001488 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001489 *
1490 * Comment this macro to disable support for Encrypt-then-MAC
1491 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001492#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001494/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001495 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001496 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1497 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001498 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001499 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001500 * attacks, but it is recommended to always use it (even if you disable
1501 * renegotiation), since it actually fixes a more fundamental issue in the
1502 * original SSL/TLS design, and has implications beyond Triple Handshake.
1503 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001504 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001505 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001506 * Comment this macro to disable support for Extended Master Secret.
1507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001508#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001509
Paul Bakkerd66f0702013-01-31 16:57:45 +01001510/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001511 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1512 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001513 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001514 * giving access to the peer's certificate after completion of the handshake.
1515 *
1516 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1517 * recommended to disable this option for reduced RAM usage.
1518 *
1519 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1520 * defined, but always returns \c NULL.
1521 *
1522 * \note This option has no influence on the protection against the
1523 * triple handshake attack. Even if it is disabled, Mbed TLS will
1524 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001525 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001526 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001527 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001528 *
1529 * Comment this macro to disable storing the peer's certificate
1530 * after the handshake.
1531 */
1532#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1533
1534/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001536 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001537 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001538 *
1539 * The two main uses of renegotiation are (1) refresh keys on long-lived
1540 * connections and (2) client authentication after the initial handshake.
1541 * If you don't need renegotiation, it's probably better to disable it, since
1542 * it has been associated with security issues in the past and is easy to
1543 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001544 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001545 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1546 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001547 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001548 *
1549 * \note Even if this option is disabled, both client and server are aware
1550 * of the Renegotiation Indication Extension (RFC 5746) used to
1551 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1552 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1553 * configuration of this extension).
1554 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001557
1558/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001560 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001561 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001562 *
1563 * Comment this macro to disable support for the max_fragment_length extension
1564 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001565#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001566
1567/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001568 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1569 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001570 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001571 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001572 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1573 *
1574 * Uncomment this macro to enable support for the record_size_limit extension
1575 */
1576//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1577
1578/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001579 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001580 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001581 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001582 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001583 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001584 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1585 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001586 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001587 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001588 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001589 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1590 * are only provided by PSA drivers, you must call psa_crypto_init() before
1591 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001592 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001593 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001594 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001595#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001596
1597/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001598 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001599 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001600 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001601 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001602 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001603 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001604 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001605 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001606 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001607 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001608 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1609 * directly performed by TLS 1.3 code. As a consequence, you must
1610 * call psa_crypto_init() before the first TLS 1.3 handshake.
1611 *
1612 * \note Cryptographic operations performed indirectly via another module
1613 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1614 * running handshake hash) only use PSA crypto if
1615 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001616 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001617 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001618 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001619#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001620
1621/**
Ronald Cronab65c522021-11-24 10:47:20 +01001622 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1623 *
1624 * Enable TLS 1.3 middlebox compatibility mode.
1625 *
1626 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1627 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1628 * expecting TLS 1.2 traffic.
1629 *
1630 * Turning on the compatibility mode comes at the cost of a few added bytes
1631 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1632 * that don't use it. Therefore, unless transmission bandwidth is critical and
1633 * you know that middlebox compatibility issues won't occur, it is therefore
1634 * recommended to set this option.
1635 *
1636 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001637 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1638 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001639 *
1640 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001641#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001642
1643/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001644 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1645 *
1646 * Enable TLS 1.3 PSK key exchange mode.
1647 *
1648 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1649 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1650 * effect on the build.
1651 *
1652 */
1653#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1654
1655/**
1656 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1657 *
1658 * Enable TLS 1.3 ephemeral key exchange mode.
1659 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001660 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001661 * MBEDTLS_X509_CRT_PARSE_C
1662 * and at least one of:
1663 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1664 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001665 *
1666 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1667 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1668 * effect on the build.
1669 *
1670 */
1671#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1672
1673/**
1674 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1675 *
1676 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1677 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001678 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001679 *
1680 * Comment to disable support for the PSK ephemeral key exchange mode in
1681 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1682 * have any effect on the build.
1683 *
1684 */
1685#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1686
1687/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 * \def MBEDTLS_SSL_EARLY_DATA
1689 *
1690 * Enable support for RFC 8446 TLS 1.3 early data.
1691 *
1692 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1693 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1694 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1695 *
1696 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1697 * is not enabled, this option does not have any effect on the build.
1698 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001699 * \note The maximum amount of early data can be set with
1700 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1701 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001703//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001704
1705/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001707 *
1708 * Enable support for DTLS (all available versions).
1709 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001710 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001711 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001712 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001713 *
1714 * Comment this macro to disable support for DTLS
1715 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001717
1718/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001720 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001721 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001722 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001723 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001724 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001726
1727/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001729 *
1730 * Enable support for the anti-replay mechanism in DTLS.
1731 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 * Requires: MBEDTLS_SSL_TLS_C
1733 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001734 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001735 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001736 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001737 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001738 * Comment this to disable anti-replay in DTLS.
1739 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001740#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001741
1742/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001744 *
1745 * Enable support for HelloVerifyRequest on DTLS servers.
1746 *
1747 * This feature is highly recommended to prevent DTLS servers being used as
1748 * amplifiers in DoS attacks against other hosts. It should always be enabled
1749 * unless you know for sure amplification cannot be a problem in the
1750 * environment in which your server operates.
1751 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001752 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001753 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001754 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001755 *
1756 * Comment this to disable support for HelloVerifyRequest.
1757 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001759
1760/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001761 * \def MBEDTLS_SSL_DTLS_SRTP
1762 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001763 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001764 * through the use_srtp extension.
1765 *
1766 * \note This feature provides the minimum functionality required
1767 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1768 * the associated SRTP packet protection key material.
1769 * In particular, the SRTP packet protection itself, as well as the
1770 * demultiplexing of RTP and DTLS packets at the datagram layer
1771 * (see Section 5 of RFC 5764), are not handled by this feature.
1772 * Instead, after successful completion of a handshake negotiating
1773 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001774 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001775 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1776 * (this is implemented in the SSL example programs).
1777 * The resulting key should then be passed to an SRTP stack.
1778 *
1779 * Setting this option enables the runtime API
1780 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1781 * through which the supported DTLS-SRTP protection
1782 * profiles can be configured. You must call this API at
1783 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001784 *
1785 * Requires: MBEDTLS_SSL_PROTO_DTLS
1786 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001787 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001788 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001789//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001790
1791/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001792 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1793 *
1794 * Enable server-side support for clients that reconnect from the same port.
1795 *
1796 * Some clients unexpectedly close the connection and try to reconnect using the
1797 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001798 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001799 * flag enables that support.
1800 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001801 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001802 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001803 * Comment this to disable support for clients reusing the source port.
1804 */
1805#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1806
1807/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001808 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001809 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001810 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001811 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001812 * session store remains the responsibility of the application, though).
1813 * Server-side, you also need to provide callbacks for writing and parsing
1814 * tickets, including authenticated encryption and key management. Example
1815 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001816 *
1817 * Comment this macro to disable support for SSL session tickets
1818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001820
1821/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001823 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001824 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001825 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001827 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001828 * Comment this macro to disable support for server name indication in SSL
1829 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001831
1832/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001833 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1834 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001835 * When this option is enabled, the SSL buffer will be resized automatically
1836 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001837 *
1838 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001839 */
1840//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1841
1842/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001843 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1844 *
1845 * Enable testing of the constant-flow nature of some sensitive functions with
1846 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001847 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001848 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001849 * This setting requires compiling with clang -fsanitize=memory. The test
1850 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001851 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001852 * \warning This macro is only used for extended testing; it is not considered
1853 * part of the library's API, so it may change or disappear at any time.
1854 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001855 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001856 */
1857//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1858
1859/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001860 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1861 *
1862 * Enable testing of the constant-flow nature of some sensitive functions with
1863 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001864 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001865 *
1866 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001867 * testing if the tests suites are run with valgrind's memcheck. This can be
1868 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1869 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001870 *
1871 * \warning This macro is only used for extended testing; it is not considered
1872 * part of the library's API, so it may change or disappear at any time.
1873 *
1874 * Uncomment to enable testing of the constant-flow nature of selected code.
1875 */
1876//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1877
1878/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001879 * \def MBEDTLS_TEST_HOOKS
1880 *
1881 * Enable features for invasive testing such as introspection functions and
1882 * hooks for fault injection. This enables additional unit tests.
1883 *
1884 * Merely enabling this feature should not change the behavior of the product.
1885 * It only adds new code, and new branching points where the default behavior
1886 * is the same as when this feature is disabled.
1887 * However, this feature increases the attack surface: there is an added
1888 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1889 * Therefore this feature must never be enabled in production.
1890 *
1891 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1892 * information.
1893 *
1894 * Uncomment to enable invasive tests.
1895 */
1896//#define MBEDTLS_TEST_HOOKS
1897
1898/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001899 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001900 *
1901 * Provide your own alternate threading implementation.
1902 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001904 *
1905 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001908
1909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001911 *
1912 * Enable the pthread wrapper layer for the threading layer.
1913 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001915 *
1916 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001917 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001918//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001919
1920/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001921 * \def MBEDTLS_USE_PSA_CRYPTO
1922 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001923 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1924 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001925 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001926 * \note Development of this option is currently in progress, and parts of Mbed
1927 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001928 * will still continue to work as usual, so enabling this option should not
1929 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001930 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001931 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001932 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1933 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001934 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001935 * \note An important and desirable effect of this option is that it allows
1936 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1937 * 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 +02001938 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001939 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1940 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001941 *
1942 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001943 *
1944 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001945 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001946 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001948//#define MBEDTLS_USE_PSA_CRYPTO
1949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001951 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1952 *
John Durkop185764f2020-10-12 21:32:12 -07001953 * This setting allows support for cryptographic mechanisms through the PSA
1954 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001955 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001956 * When this option is disabled, the PSA API exposes the cryptographic
1957 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1958 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001959 *
1960 * When this option is enabled, the PSA API exposes the cryptographic
1961 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1962 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1963 * automatically enabled if required (i.e. if no PSA driver provides the
1964 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1965 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001966 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001967 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001968 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001969 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001970 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1971 * symbols is not completely finalized yet, and the configuration
1972 * tooling is not ideally adapted to having two separate configuration
1973 * files.
1974 * Future minor releases of Mbed TLS may make minor changes to those
1975 * symbols, but we will endeavor to provide a transition path.
1976 * Nonetheless, this option is considered mature enough to use in
1977 * production, as long as you accept that you may need to make
1978 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001979 */
1980//#define MBEDTLS_PSA_CRYPTO_CONFIG
1981
1982/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001983 * \def MBEDTLS_VERSION_FEATURES
1984 *
1985 * Allow run-time checking of compile-time enabled features. Thus allowing users
1986 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001987 * support via mbedtls_version_check_feature().
1988 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001989 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00001990 *
1991 * Comment this to disable run-time checking and save ROM space
1992 */
1993#define MBEDTLS_VERSION_FEATURES
1994
1995/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001996 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1997 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001998 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001999 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2000 * the set of trusted certificates through a callback instead of a linked
2001 * list.
2002 *
2003 * This is useful for example in environments where a large number of trusted
2004 * certificates is present and storing them in a linked list isn't efficient
2005 * enough, or when the set of trusted certificates changes frequently.
2006 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002007 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002008 * `mbedtls_ssl_conf_ca_cb()` for more information.
2009 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002010 * Requires: MBEDTLS_X509_CRT_PARSE_C
2011 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002012 * Uncomment to enable trusted certificate callbacks.
2013 */
2014//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2015
2016/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002017 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002018 *
Chris Jones2c745862020-12-16 11:41:06 +00002019 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002020 *
Chris Jones2c745862020-12-16 11:41:06 +00002021 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002022 * and other functions/constants only used by these functions, thus reducing
2023 * the code footprint by several KB.
2024 */
Chris Jones2c745862020-12-16 11:41:06 +00002025//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002026
2027/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002028 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002029 *
2030 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2031 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2032 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002033 * Requires: MBEDTLS_PKCS1_V21
2034 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002035 * Comment this macro to disallow using RSASSA-PSS in certificates.
2036 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002038/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002039
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002040/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002041 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002042 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002043 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002044 * \{
2045 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002046
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002047/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002048 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002049 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002050 * Enable AES-NI support on x86-64 or x86-32.
2051 *
2052 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002053 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002054 * - GCC, x86-64, target not explicitly supporting AESNI:
2055 * requires MBEDTLS_HAVE_ASM.
2056 * - GCC, x86-32, target not explicitly supporting AESNI:
2057 * not supported.
2058 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2059 * For this assembly-less implementation, you must currently compile
2060 * `library/aesni.c` and `library/aes.c` with machine options to enable
2061 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2062 * `clang -maes -mpclmul`.
2063 * - Non-x86 targets: this option is silently ignored.
2064 * - Other compilers: this option is silently ignored.
2065 *
2066 * \note
2067 * Above, "GCC" includes compatible compilers such as Clang.
2068 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002069 *
2070 * Module: library/aesni.c
2071 * Caller: library/aes.c
2072 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002073 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002074 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002075 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002077#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002078
2079/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002080 * \def MBEDTLS_AESCE_C
2081 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002082 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002083 *
2084 * Module: library/aesce.c
2085 * Caller: library/aes.c
2086 *
Jerry Yuf015a932023-04-25 10:38:03 +08002087 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002088 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002089 * \warning Runtime detection only works on Linux. For non-Linux operating
2090 * system, Armv8-A Cryptographic Extensions must be supported by
2091 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002092 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002093 * \note Minimum compiler versions for this feature when targeting aarch64
2094 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2095 * Minimum compiler versions for this feature when targeting 32-bit
2096 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002097 *
2098 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2099 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002100 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002101 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002102 */
2103#define MBEDTLS_AESCE_C
2104
2105/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002106 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002107 *
2108 * Enable the AES block cipher.
2109 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002110 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002111 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002112 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002113 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002114 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002115 * This module enables the following ciphersuites (if other requisites are
2116 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002117 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2118 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2119 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2120 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2121 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2122 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2123 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2124 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2125 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2126 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2127 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2128 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2129 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2130 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2131 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2132 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2133 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2134 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2135 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2136 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2137 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2138 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2139 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2140 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2141 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2142 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2143 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2144 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2145 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2146 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2147 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2148 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2149 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2150 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2151 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2152 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2153 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2154 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2155 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2156 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2157 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2158 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2159 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2160 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2161 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2162 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2163 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2164 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2165 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2166 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2167 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2168 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2169 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2170 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2171 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2172 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2173 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2174 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002175 *
Paul Bakkercff68422013-09-15 20:43:33 +02002176 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002179
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002182 *
2183 * Enable the generic ASN1 parser.
2184 *
2185 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002186 * Caller: library/x509.c
2187 * library/dhm.c
2188 * library/pkcs12.c
2189 * library/pkcs5.c
2190 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002191 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002192#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002193
2194/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002195 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002196 *
2197 * Enable the generic ASN1 writer.
2198 *
2199 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002200 * Caller: library/ecdsa.c
2201 * library/pkwrite.c
2202 * library/x509_create.c
2203 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002204 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002206#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002207
2208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002209 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002210 *
2211 * Enable the Base64 module.
2212 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002213 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002214 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002215 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002216 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002217 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002218#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002219
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002220/**
Yanray Wange367e472023-10-31 17:23:04 +08002221 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2222 *
2223 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2224 *
2225 * \note This feature is incompatible with insecure block cipher,
2226 * MBEDTLS_DES_C, and cipher modes which always require decryption
2227 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002228 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2229 * this feature is incompatible with following supported PSA equivalence,
2230 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2231 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002232 *
2233 * Module: library/aes.c
2234 * library/aesce.c
2235 * library/aesni.c
2236 * library/aria.c
2237 * library/camellia.c
2238 * library/cipher.c
2239 */
2240//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2241
2242/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002243 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002244 *
Paul Bakker9a736322012-11-14 12:39:52 +00002245 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002246 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002247 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002248 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002249 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002250 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002251 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002252 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002253 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002254 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002255 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002256 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002257 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002258 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002259 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002261
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002262/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002263 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002264 *
2265 * Enable the Camellia block cipher.
2266 *
Paul Bakker38119b12009-01-10 23:31:23 +00002267 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002268 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002269 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002270 * This module enables the following ciphersuites (if other requisites are
2271 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2273 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2274 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2275 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2276 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2277 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2278 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2279 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2280 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2281 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2282 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2283 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2284 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2285 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2286 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2287 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2288 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2289 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2290 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2291 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2292 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2293 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2294 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2295 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2296 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2297 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2298 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2299 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2300 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2301 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2302 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2303 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2304 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2305 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2306 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2307 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2308 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2309 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2310 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2311 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2312 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2313 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002315#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002316
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002317/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002318 * \def MBEDTLS_ARIA_C
2319 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002320 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002321 *
2322 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002323 * Caller: library/cipher.c
2324 *
2325 * This module enables the following ciphersuites (if other requisites are
2326 * enabled as well):
2327 *
2328 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2329 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2330 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2331 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2332 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2333 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2334 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2335 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2336 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2337 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2338 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2339 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2340 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2341 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2342 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2343 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2344 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2345 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2346 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2347 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2348 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2349 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2350 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2351 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2352 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2353 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2354 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2355 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2356 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2357 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2358 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2359 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2360 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2361 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2362 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2363 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2364 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2365 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002366 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002367#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002368
2369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002371 *
2372 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2373 *
2374 * Module: library/ccm.c
2375 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002376 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2377 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002378 *
2379 * This module enables the AES-CCM ciphersuites, if other requisites are
2380 * enabled as well.
2381 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002382#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002383
2384/**
Daniel King34b822c2016-05-15 17:28:08 -03002385 * \def MBEDTLS_CHACHA20_C
2386 *
2387 * Enable the ChaCha20 stream cipher.
2388 *
2389 * Module: library/chacha20.c
2390 */
2391#define MBEDTLS_CHACHA20_C
2392
2393/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002394 * \def MBEDTLS_CHACHAPOLY_C
2395 *
2396 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2397 *
2398 * Module: library/chachapoly.c
2399 *
2400 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2401 */
2402#define MBEDTLS_CHACHAPOLY_C
2403
2404/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002405 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002406 *
2407 * Enable the generic cipher layer.
2408 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002409 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002410 * Caller: library/ccm.c
2411 * library/cmac.c
2412 * library/gcm.c
2413 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002414 * library/pkcs12.c
2415 * library/pkcs5.c
2416 * library/psa_crypto_aead.c
2417 * library/psa_crypto_mac.c
2418 * library/ssl_ciphersuites.c
2419 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002420 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002421 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2422 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002423 *
2424 * Uncomment to enable generic cipher wrappers.
2425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002427
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002428/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002429 * \def MBEDTLS_CMAC_C
2430 *
Simon Butcher327398a2016-10-05 14:09:11 +01002431 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2432 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002433 *
2434 * Module: library/cmac.c
2435 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002436 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002437 *
2438 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002439#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002440
2441/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002443 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002444 * Enable the CTR_DRBG AES-based random generator.
2445 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002446 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002447 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002448 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002449 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2450 * is used.
2451 *
2452 * \warning When using PSA, the user should call `psa_crypto_init()` before
2453 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2454 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002455 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2456 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002457 * \note To achieve a 256-bit security strength with CTR_DRBG,
2458 * you must use AES-256 *and* use sufficient entropy.
2459 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002460 *
2461 * Module: library/ctr_drbg.c
2462 * Caller:
2463 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002464 * Requires: MBEDTLS_AES_C or
2465 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2466 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002467 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002468 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002469 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002470#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002471
2472/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002474 *
2475 * Enable the debug functions.
2476 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002477 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002478 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002479 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002480 * library/ssl_tls12_*.c
2481 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002482 *
2483 * This module provides debugging functions.
2484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002486
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002487/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002489 *
2490 * Enable the DES block cipher.
2491 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002492 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002493 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002494 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002495 *
Paul Bakkercff68422013-09-15 20:43:33 +02002496 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002497 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002498 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002499 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002501#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002502
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002503/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002504 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002505 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002506 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002507 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002508 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002509 * Caller: library/ssl_tls.c
2510 * library/ssl*_client.c
2511 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002512 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002513 * This module is used by the following key exchanges:
2514 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002515 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002516 * \warning Using DHE constitutes a security risk as it
2517 * is not possible to validate custom DH parameters.
2518 * If possible, it is recommended users should consider
2519 * preferring other methods of key exchange.
2520 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002521 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002524
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002525/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002527 *
2528 * Enable the elliptic curve Diffie-Hellman library.
2529 *
2530 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002531 * Caller: library/psa_crypto.c
2532 * library/ssl_tls.c
2533 * library/ssl*_client.c
2534 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002535 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002536 * This module is used by the following key exchanges:
2537 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002538 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002542
2543/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002544 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002545 *
2546 * Enable the elliptic curve DSA library.
2547 *
2548 * Module: library/ecdsa.c
2549 * Caller:
2550 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002551 * This module is used by the following key exchanges:
2552 * ECDHE-ECDSA
2553 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002554 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2555 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2556 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002557 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002558#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002559
2560/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002561 * \def MBEDTLS_ECJPAKE_C
2562 *
2563 * Enable the elliptic curve J-PAKE library.
2564 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002565 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2566 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002567 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002568 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002569 * Module: library/ecjpake.c
2570 * Caller:
2571 *
2572 * This module is used by the following key exchanges:
2573 * ECJPAKE
2574 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002575 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002576 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002577 * \warning If using a hash that is only provided by PSA drivers, you must
2578 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002579 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002580#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002581
2582/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002584 *
2585 * Enable the elliptic curve over GF(p) library.
2586 *
2587 * Module: library/ecp.c
2588 * Caller: library/ecdh.c
2589 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002590 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002591 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002594#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002595
2596/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002597 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002598 *
2599 * Enable the platform-specific entropy code.
2600 *
2601 * Module: library/entropy.c
2602 * Caller:
2603 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002605 *
2606 * This module provides a generic entropy pool
2607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002609
2610/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002612 *
2613 * Enable error code to error string conversion.
2614 *
2615 * Module: library/error.c
2616 * Caller:
2617 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002621
2622/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002624 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002625 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002626 *
2627 * Module: library/gcm.c
2628 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002629 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2630 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002631 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002632 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2633 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002634 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002635#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002636
2637/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002638 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002639 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002640 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002641 * Can significantly increase throughput on systems without GCM hardware
2642 * acceleration (e.g., AESNI, AESCE).
2643 *
Matthias Schulz78266782024-02-08 13:54:48 +01002644 * The mbedtls_gcm_context size will increase by 3840 bytes.
2645 * The code size will increase by roughly 344 bytes.
2646 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002647 * Module: library/gcm.c
2648 *
2649 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002650 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002651//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002652
2653/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002654 * \def MBEDTLS_HKDF_C
2655 *
2656 * Enable the HKDF algorithm (RFC 5869).
2657 *
2658 * Module: library/hkdf.c
2659 * Caller:
2660 *
2661 * Requires: MBEDTLS_MD_C
2662 *
2663 * This module adds support for the Hashed Message Authentication Code
2664 * (HMAC)-based key derivation function (HKDF).
2665 */
2666#define MBEDTLS_HKDF_C
2667
2668/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002670 *
2671 * Enable the HMAC_DRBG random generator.
2672 *
2673 * Module: library/hmac_drbg.c
2674 * Caller:
2675 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002677 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002678 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002679 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002681
2682/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002683 * \def MBEDTLS_LMS_C
2684 *
2685 * Enable the LMS stateful-hash asymmetric signature algorithm.
2686 *
2687 * Module: library/lms.c
2688 * Caller:
2689 *
Raef Colesab4f8742022-09-01 12:24:31 +01002690 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002691 *
Raef Colesab4f8742022-09-01 12:24:31 +01002692 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002693 */
2694#define MBEDTLS_LMS_C
2695
2696/**
Raef Colesab4f8742022-09-01 12:24:31 +01002697 * \def MBEDTLS_LMS_PRIVATE
2698 *
2699 * Enable LMS private-key operations and signing code. Functions enabled by this
2700 * option are experimental, and should not be used in production.
2701 *
2702 * Requires: MBEDTLS_LMS_C
2703 *
2704 * Uncomment to enable the LMS signature algorithm and private key operations.
2705 */
Raef Coles5127e852022-10-07 10:35:56 +01002706//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002707
2708/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002709 * \def MBEDTLS_NIST_KW_C
2710 *
2711 * Enable the Key Wrapping mode for 128-bit block ciphers,
2712 * as defined in NIST SP 800-38F. Only KW and KWP modes
2713 * are supported. At the moment, only AES is approved by NIST.
2714 *
2715 * Module: library/nist_kw.c
2716 *
2717 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2718 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002719#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002720
2721/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002722 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002723 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002724 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002725 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002726 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2727 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002728 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002729 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002730 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002731 * Caller: library/constant_time.c
2732 * library/ecdsa.c
2733 * library/ecjpake.c
2734 * library/hkdf.c
2735 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002736 * library/pk.c
2737 * library/pkcs5.c
2738 * library/pkcs12.c
2739 * library/psa_crypto_ecp.c
2740 * library/psa_crypto_rsa.c
2741 * library/rsa.c
2742 * library/ssl_cookie.c
2743 * library/ssl_msg.c
2744 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002745 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002746 * library/x509_crt.c
2747 * library/x509write_crt.c
2748 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002749 *
2750 * Uncomment to enable generic message digest wrappers.
2751 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002752#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002753
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002754/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002755 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002756 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002757 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002758 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002759 * Module: library/md5.c
2760 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002761 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002762 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002763 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002764 * This module is required for TLS 1.2 depending on the handshake parameters.
2765 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2766 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002767 *
2768 * \warning MD5 is considered a weak message digest and its use constitutes a
2769 * security risk. If possible, we recommend avoiding dependencies on
2770 * it, and considering stronger message digests instead.
2771 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002772 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002774
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002775/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002776 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002777 *
2778 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002779 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002780 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002781 *
2782 * Module: library/memory_buffer_alloc.c
2783 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002784 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002785 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002786 *
2787 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002788 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002789//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002790
2791/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002792 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002793 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002794 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2795 *
Simon Butcherd567a232016-03-09 20:19:21 +00002796 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2797 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002798 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002799 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002800 * \note See also our Knowledge Base article about porting to a new
2801 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002802 * 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 +00002803 *
Andres AG788aa4a2016-09-14 14:32:09 +01002804 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002805 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002806 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002807 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002809
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002810/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002812 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002813 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002814 *
2815 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002816 * Caller: library/asn1write.c
2817 * library/pkcs5.c
2818 * library/pkparse.c
2819 * library/pkwrite.c
2820 * library/rsa.c
2821 * library/x509.c
2822 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002823 * library/x509_crl.c
2824 * library/x509_crt.c
2825 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002826 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002827 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002828 *
2829 * This modules translates between OIDs and internal values.
2830 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002831#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002832
2833/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002835 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002836 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002837 *
2838 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002839 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002840 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002841 * library/x509_crl.c
2842 * library/x509_crt.c
2843 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002844 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002846 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2847 *
2848 * \warning When parsing password-protected files, if MD5 is provided only by
2849 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002850 *
Paul Bakkercff68422013-09-15 20:43:33 +02002851 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002852 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002854
2855/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002857 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002858 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002859 *
2860 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002861 * Caller: library/pkwrite.c
2862 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002863 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002864 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002866 *
2867 * This modules adds support for encoding / writing PEM files.
2868 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002870
2871/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002873 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002874 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002875 *
2876 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002877 * Caller: library/psa_crypto_rsa.c
2878 * library/ssl_tls.c
2879 * library/ssl*_client.c
2880 * library/ssl*_server.c
2881 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002882 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002883 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002884 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002885 * Uncomment to enable generic public key wrappers.
2886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002888
2889/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002891 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002892 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002893 *
2894 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002895 * Caller: library/x509_crt.c
2896 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002897 *
Yanray Wang072a0682023-12-05 10:53:04 +08002898 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002899 *
2900 * Uncomment to enable generic public key parse functions.
2901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002903
2904/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002905 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002906 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002907 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002908 *
2909 * Module: library/pkwrite.c
2910 * Caller: library/x509write.c
2911 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002912 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002913 *
2914 * Uncomment to enable generic public key write functions.
2915 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002917
2918/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002920 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002921 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002922 *
2923 * Module: library/pkcs5.c
2924 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002925 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002926 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002927 * \warning If using a hash that is only provided by PSA drivers, you must
2928 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002929 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002930 * This module adds support for the PKCS#5 functions.
2931 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002933
2934/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002935 * \def MBEDTLS_PKCS7_C
2936 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002937 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002938 * RFC Link - https://tools.ietf.org/html/rfc2315
2939 *
2940 * Module: library/pkcs7.c
2941 *
2942 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002943 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2944 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002945 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002946 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002947 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002948#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002949
2950/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002952 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002953 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002954 * Adds algorithms for parsing PKCS#8 encrypted private keys
2955 *
2956 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002957 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002958 *
Valerio Settie98ad592023-12-28 10:42:12 +01002959 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2960 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002961 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002962 * \warning If using a hash that is only provided by PSA drivers, you must
2963 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002964 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002965 * This module enables PKCS#12 functions.
2966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002968
2969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002971 *
2972 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002973 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002974 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2976 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002977 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002978 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002979 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002980 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002981 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002982 * Module: library/platform.c
2983 * Caller: Most other .c files
2984 *
2985 * This module enables abstraction of common (libc) functions.
2986 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002987#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002988
2989/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002990 * \def MBEDTLS_POLY1305_C
2991 *
2992 * Enable the Poly1305 MAC algorithm.
2993 *
2994 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002995 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002996 */
2997#define MBEDTLS_POLY1305_C
2998
2999/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003000 * \def MBEDTLS_PSA_CRYPTO_C
3001 *
3002 * Enable the Platform Security Architecture cryptography API.
3003 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003004 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003005 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003006 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003007 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003008 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3009 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3010 * is enabled in PSA (unless it's fully accelerated, see
3011 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003012 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003013#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003014
3015/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003016 * \def MBEDTLS_PSA_CRYPTO_SE_C
3017 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003018 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003019 * cryptography API.
3020 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003021 * \deprecated This feature is deprecated. Please switch to the PSA driver
3022 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003023 *
Ryan Everett32a64582024-03-05 18:16:18 +00003024 * \warning This feature is not thread-safe, and should not be used in a
3025 * multi-threaded environment.
3026 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003027 * Module: library/psa_crypto_se.c
3028 *
3029 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3030 *
3031 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003032//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003033
3034/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003035 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3036 *
3037 * Enable the Platform Security Architecture persistent key storage.
3038 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003039 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003040 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003041 * Requires: MBEDTLS_PSA_CRYPTO_C,
3042 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3043 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003044 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003045#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003046
3047/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003048 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003049 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003050 * Enable the emulation of the Platform Security Architecture
3051 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003052 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003053 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003054 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003055 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003056 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003057#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003058
3059/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003060 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003061 *
3062 * Enable the RIPEMD-160 hash algorithm.
3063 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003064 * Module: library/ripemd160.c
3065 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003066 *
3067 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003069
3070/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003072 *
3073 * Enable the RSA public-key cryptosystem.
3074 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003075 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003076 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003077 * Caller: library/pk.c
3078 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003079 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003080 * library/ssl*_client.c
3081 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003082 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003083 * This module is used by the following key exchanges:
3084 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003085 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003086 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003089
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003090/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003092 *
3093 * Enable the SHA1 cryptographic hash algorithm.
3094 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003095 * Module: library/sha1.c
3096 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003097 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003098 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003099 * This module is required for TLS 1.2 depending on the handshake parameters,
3100 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003101 *
3102 * \warning SHA-1 is considered a weak message digest and its use constitutes
3103 * a security risk. If possible, we recommend avoiding dependencies
3104 * on it, and considering stronger message digests instead.
3105 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003108
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003109/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003110 * \def MBEDTLS_SHA224_C
3111 *
3112 * Enable the SHA-224 cryptographic hash algorithm.
3113 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003114 * Module: library/sha256.c
3115 * Caller: library/md.c
3116 * library/ssl_cookie.c
3117 *
3118 * This module adds support for SHA-224.
3119 */
3120#define MBEDTLS_SHA224_C
3121
3122/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003124 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003125 * Enable the SHA-256 cryptographic hash algorithm.
3126 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003127 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003128 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003129 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003130 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003131 * library/ssl*_client.c
3132 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003133 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003134 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003135 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003138
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003139/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003140 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003141 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003142 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3143 * with the ARMv8 cryptographic extensions if they are available at runtime.
3144 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003145 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003146 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003147 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003148 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003149 * \note Minimum compiler versions for this feature are Clang 4.0,
3150 * armclang 6.6 or GCC 6.0.
3151 *
3152 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3153 * armclang <= 6.9
3154 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003155 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3156 * That name is deprecated, but may still be used as an alternative form for this
3157 * option.
3158 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003159 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3160 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003161 *
3162 * Requires: MBEDTLS_SHA256_C.
3163 *
3164 * Module: library/sha256.c
3165 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003166 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003167 * and use them if available.
3168 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003169//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003170
Dave Rodgmand85277c2023-10-13 09:22:54 +01003171/**
3172 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3173 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003174 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003175 * This name is now deprecated, but may still be used as an alternative form for
3176 * this option.
3177 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003178//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3179
3180/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003181 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003182 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003183 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3184 * with the ARMv8 cryptographic extensions, which must be available at runtime
3185 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003186 *
3187 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003188 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003189 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003190 * \note Minimum compiler versions for this feature are Clang 4.0,
3191 * armclang 6.6 or GCC 6.0.
3192 *
3193 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3194 * armclang <= 6.9
3195 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003196 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003197 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003198 * option.
3199 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003200 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3201 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003202 *
3203 * Requires: MBEDTLS_SHA256_C.
3204 *
3205 * Module: library/sha256.c
3206 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003207 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003208 * unconditionally.
3209 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003210//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003211
Dave Rodgmand85277c2023-10-13 09:22:54 +01003212/**
3213 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3214 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003215 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003216 * This name is now deprecated, but may still be used as an alternative form for
3217 * this option.
3218 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003219//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3220
3221/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003222 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003223 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003224 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003225 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003226 * Module: library/sha512.c
3227 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003228 * library/psa_crypto_hash.c
3229 * library/ssl_tls.c
3230 * library/ssl*_client.c
3231 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003232 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003233 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003234 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003235#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003236
3237/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003238 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003239 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003240 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003241 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003242 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003243 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003244 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003245 * library/ssl_tls.c
3246 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003247 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003248 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003249 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003251
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003252/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003253 * \def MBEDTLS_SHA3_C
3254 *
3255 * Enable the SHA3 cryptographic hash algorithm.
3256 *
3257 * Module: library/sha3.c
3258 *
3259 * This module adds support for SHA3.
3260 */
3261#define MBEDTLS_SHA3_C
3262
3263/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003264 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3265 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003266 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3267 * with the ARMv8 cryptographic extensions if they are available at runtime.
3268 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003269 *
3270 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3271 * for a non-Aarch64 build it will be silently ignored.
3272 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003273 * \note Minimum compiler versions for this feature are Clang 7.0,
3274 * armclang 6.9 or GCC 8.0.
3275 *
3276 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3277 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003278 *
3279 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3280 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3281 *
3282 * Requires: MBEDTLS_SHA512_C.
3283 *
3284 * Module: library/sha512.c
3285 *
3286 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3287 * and use them if available.
3288 */
3289//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3290
3291/**
3292 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3293 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003294 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3295 * with the ARMv8 cryptographic extensions, which must be available at runtime
3296 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003297 *
3298 * \note This allows builds with a smaller code size than with
3299 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3300 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003301 * \note Minimum compiler versions for this feature are Clang 7.0,
3302 * armclang 6.9 or GCC 8.0.
3303 *
3304 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3305 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003306 *
3307 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3308 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3309 *
3310 * Requires: MBEDTLS_SHA512_C.
3311 *
3312 * Module: library/sha512.c
3313 *
3314 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3315 * unconditionally.
3316 */
3317//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3318
3319/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003320 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003321 *
3322 * Enable simple SSL cache implementation.
3323 *
3324 * Module: library/ssl_cache.c
3325 * Caller:
3326 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003327 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003328 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003330
3331/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003333 *
3334 * Enable basic implementation of DTLS cookies for hello verification.
3335 *
3336 * Module: library/ssl_cookie.c
3337 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003339#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003340
3341/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003342 * \def MBEDTLS_SSL_TICKET_C
3343 *
3344 * Enable an implementation of TLS server-side callbacks for session tickets.
3345 *
3346 * Module: library/ssl_ticket.c
3347 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003348 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003349 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3350 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003351 */
3352#define MBEDTLS_SSL_TICKET_C
3353
3354/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003355 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003356 *
3357 * Enable the SSL/TLS client code.
3358 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003359 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003360 * Caller:
3361 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003363 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003364 * This module is required for SSL/TLS client support.
3365 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003367
Paul Bakker9a736322012-11-14 12:39:52 +00003368/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003370 *
3371 * Enable the SSL/TLS server code.
3372 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003373 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003374 * Caller:
3375 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003376 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003377 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003378 * This module is required for SSL/TLS server support.
3379 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003381
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003382/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003383 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003384 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003385 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003386 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003387 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003388 * Caller: library/ssl*_client.c
3389 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003390 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3392 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003393 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003394 * This module is required for SSL/TLS.
3395 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003397
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003398/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003399 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003400 *
3401 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003402 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003403 * contexts are not shared between threads. If you do intend to use contexts
3404 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003405 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003406 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003407 *
3408 * Module: library/threading.c
3409 *
3410 * This allows different threading implementations (self-implemented or
3411 * provided).
3412 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413 * You will have to enable either MBEDTLS_THREADING_ALT or
3414 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003415 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003416 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003417 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003419
3420/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003421 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003422 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003423 * Enable the semi-portable timing interface.
3424 *
Simon Butcherd567a232016-03-09 20:19:21 +00003425 * \note The provided implementation only works on POSIX/Unix (including Linux,
3426 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003427 * module and provide your own implementations of the callbacks needed by
3428 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3429 * your own implementation of the whole module by setting
3430 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003431 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003432 * \note The timing module will include time.h on suitable platforms
3433 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3434 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3435 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003436 * \note See also our Knowledge Base article about porting to a new
3437 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003438 * 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 +00003439 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003440 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003441 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003442#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003443
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003444/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003445 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003446 *
3447 * Enable run-time version information.
3448 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003449 * Module: library/version.c
3450 *
3451 * This module provides run-time version information.
3452 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003454
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003455/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003456 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003457 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003458 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003459 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003460 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003461 * Caller: library/x509_crl.c
3462 * library/x509_crt.c
3463 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003464 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003465 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003466 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3467 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003468 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3469 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003470 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003471 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003474
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003475/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003476 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003477 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003478 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003479 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003480 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003481 * Caller: library/ssl_tls.c
3482 * library/ssl*_client.c
3483 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003484 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003485 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003486 *
3487 * This module is required for X.509 certificate parsing.
3488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003489#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003490
3491/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003492 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003493 *
3494 * Enable X.509 CRL parsing.
3495 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003496 * Module: library/x509_crl.c
3497 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003498 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003499 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003500 *
3501 * This module is required for X.509 CRL parsing.
3502 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003503#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003504
3505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003506 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003507 *
3508 * Enable X.509 Certificate Signing Request (CSR) parsing.
3509 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003510 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003511 * Caller: library/x509_crt_write.c
3512 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003513 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003514 *
3515 * This module is used for reading X.509 certificate request.
3516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003518
3519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003521 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003522 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003523 *
3524 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003525 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003526 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003527 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3528 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003529 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3530 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003531 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003532 * This module is the basis for creating X.509 certificates and CSRs.
3533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003535
3536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003538 *
3539 * Enable creating X.509 certificates.
3540 *
3541 * Module: library/x509_crt_write.c
3542 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003544 *
3545 * This module is required for X.509 certificate creation.
3546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003547#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003548
3549/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003551 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003552 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003553 *
3554 * Module: library/x509_csr_write.c
3555 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003556 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003557 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003558 * This module is required for X.509 certificate request writing.
3559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003560#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003561
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003562/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003563
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003564/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003565 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003566 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003567 * This section contains Mbed TLS build settings that are not associated
3568 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003569 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003570 * \{
3571 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003572
Gilles Peskinea02c1242022-03-16 17:03:19 +01003573/**
3574 * \def MBEDTLS_CONFIG_FILE
3575 *
3576 * If defined, this is a header which will be included instead of
3577 * `"mbedtls/mbedtls_config.h"`.
3578 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003579 * Unlike other configuration options, this one must be defined on the
3580 * compiler command line: a definition in `mbedtls_config.h` would have
3581 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003582 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003583 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003584 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003585 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003586 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003587 * The value of this symbol is typically a path in double quotes, either
3588 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003589 */
3590//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3591
3592/**
3593 * \def MBEDTLS_USER_CONFIG_FILE
3594 *
3595 * If defined, this is a header which will be included after
3596 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003597 * This allows you to modify the default configuration, including the ability
3598 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003599 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003600 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003601 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003602 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003603 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003604 * The value of this symbol is typically a path in double quotes, either
3605 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003606 */
3607//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3608
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003609/**
3610 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3611 *
3612 * If defined, this is a header which will be included instead of
3613 * `"psa/crypto_config.h"`.
3614 * This header file specifies which cryptographic mechanisms are available
3615 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3616 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3617 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003618 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003619 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003620 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003621 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003622 * The value of this symbol is typically a path in double quotes, either
3623 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003624 */
3625//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3626
3627/**
3628 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3629 *
3630 * If defined, this is a header which will be included after
3631 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003632 * This allows you to modify the default configuration, including the ability
3633 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003634 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003635 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003636 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003637 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003638 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003639 * The value of this symbol is typically a path in double quotes, either
3640 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003641 */
3642//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3643
Gilles Peskineb1176f22023-02-22 22:07:28 +01003644/**
3645 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3646 *
3647 * If defined, this is a header which will be included instead of
3648 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3649 * as the one in Mbed TLS, but with definitions adapted to the platform on
3650 * which the library code will run.
3651 *
3652 * \note The required content of this header can vary from one version of
3653 * Mbed TLS to the next. Integrators who provide an alternative file
3654 * should review the changes in the original file whenever they
3655 * upgrade Mbed TLS.
3656 *
3657 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3658 * non-standard feature of the C language, so this feature is only available
3659 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3660 *
3661 * The value of this symbol is typically a path in double quotes, either
3662 * absolute or relative to a directory on the include search path.
3663 */
3664//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3665
3666/**
3667 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3668 *
3669 * If defined, this is a header which will be included instead of
3670 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3671 * as the one in Mbed TLS, but with definitions adapted to the environment
3672 * in which the library code will run. The typical use for this feature
3673 * is to provide alternative type definitions on the client side in
3674 * client-server integrations of PSA crypto, where operation structures
3675 * contain handles instead of cryptographic data.
3676 *
3677 * \note The required content of this header can vary from one version of
3678 * Mbed TLS to the next. Integrators who provide an alternative file
3679 * should review the changes in the original file whenever they
3680 * upgrade Mbed TLS.
3681 *
3682 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3683 * non-standard feature of the C language, so this feature is only available
3684 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3685 *
3686 * The value of this symbol is typically a path in double quotes, either
3687 * absolute or relative to a directory on the include search path.
3688 */
3689//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3690
Gilles Peskineba4162a2022-04-11 17:04:38 +02003691/** \} name SECTION: General configuration options */
3692
3693/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003694 * \name SECTION: Module configuration options
3695 *
3696 * This section allows for the setting of module specific sizes and
3697 * configuration options. The default values are already present in the
3698 * relevant header files and should suffice for the regular use cases.
3699 *
3700 * Our advice is to enable options and change their values here
3701 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003702 * \{
3703 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003704/* The Doxygen documentation here is used when a user comments out a
3705 * setting and runs doxygen themselves. On the other hand, when we typeset
3706 * the full documentation including disabled settings, the documentation
3707 * in specific modules' header files is used if present. When editing this
3708 * file, make sure that each option is documented in exactly one place,
3709 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3710 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003711
Paul Bakker088c5c52014-04-25 11:11:10 +02003712/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003713//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003714//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003715
Paul Bakker088c5c52014-04-25 11:11:10 +02003716/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003717//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3718//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3719//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3720//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3721//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003722
Paul Bakker088c5c52014-04-25 11:11:10 +02003723/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003724//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3725//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3726//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3727//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003728
Paul Bakker088c5c52014-04-25 11:11:10 +02003729/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003730//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003731//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003732
Paul Bakker088c5c52014-04-25 11:11:10 +02003733/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003734//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3735//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003736//#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 +01003737
Paul Bakker088c5c52014-04-25 11:11:10 +02003738/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003739//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003740
Paul Bakker088c5c52014-04-25 11:11:10 +02003741/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003742//#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 -04003743
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003744/** \def MBEDTLS_PLATFORM_STD_CALLOC
3745 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003746 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003747 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003748 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003749 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003750 * 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 -04003751 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3752 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003753 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003754 */
3755//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003756
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003757/** \def MBEDTLS_PLATFORM_STD_FREE
3758 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003759 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003760 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003761 * 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 -04003762 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3763 * 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 -04003764 */
3765//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003766//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003767//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003768//#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 +02003769//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3770//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003771/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003772//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003773//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3774//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003775//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3776//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3777//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003778
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003779/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003780/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003781//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3782//#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 +02003783//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003784//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003785//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3786//#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 +02003787//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3788//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003789/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003790//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003791//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003792//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3793//#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 +08003794//#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 +08003795//#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 +02003796
Gilles Peskine3f106f72021-09-23 17:42:39 +02003797/** \def MBEDTLS_CHECK_RETURN
3798 *
3799 * This macro is used at the beginning of the declaration of a function
3800 * to indicate that its return value should be checked. It should
3801 * instruct the compiler to emit a warning or an error if the function
3802 * is called without checking its return value.
3803 *
3804 * There is a default implementation for popular compilers in platform_util.h.
3805 * You can override the default implementation by defining your own here.
3806 *
3807 * If the implementation here is empty, this will effectively disable the
3808 * checking of functions' return values.
3809 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003810//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003811
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003812/** \def MBEDTLS_IGNORE_RETURN
3813 *
3814 * This macro requires one argument, which should be a C function call.
3815 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3816 * warning is suppressed.
3817 */
3818//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3819
Gilles Peskineed038902020-11-13 21:33:21 +01003820/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003821/**
Gilles Peskineed038902020-11-13 21:33:21 +01003822 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3823 * PSA crypto subsystem.
3824 *
3825 * If this option is unset:
3826 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003827 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003828 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3829 * on unspecified heuristics.
3830 */
3831//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3832
Steven Cooreman863470a2021-02-15 14:03:19 +01003833/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003834 * Restrict the PSA library to supporting a maximum amount of simultaneously
3835 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3836 * volatile key, or a persistent key which is loaded temporarily by the
3837 * library as part of a crypto operation in flight.
3838 *
3839 * If this option is unset, the library will fall back to a default value of
3840 * 32 keys.
3841 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003842//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003843
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003844/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003845//#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 +00003846
Paul Bakker088c5c52014-04-25 11:11:10 +02003847/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003848//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3849//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003850
Paul Bakker088c5c52014-04-25 11:11:10 +02003851/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003852
Angus Grattond8213d02016-05-25 20:56:48 +10003853/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3854 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003855 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003856 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003857 * This determines the size of the incoming TLS I/O buffer in such a way
3858 * that it is capable of holding the specified amount of plaintext data,
3859 * regardless of the protection mechanism used.
3860 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003861 * \note When using a value less than the default of 16KB on the client, it is
3862 * recommended to use the Maximum Fragment Length (MFL) extension to
3863 * inform the server about this limitation. On the server, there
3864 * is no supported, standardized way of informing the client about
3865 * restriction on the maximum size of incoming messages, and unless
3866 * the limitation has been communicated by other means, it is recommended
3867 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3868 * while keeping the default value of 16KB for the incoming buffer.
3869 *
David Horstmann95d516f2021-05-04 18:36:56 +01003870 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003871 */
3872//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3873
Gilles Peskined3d02902020-03-04 21:35:27 +01003874/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3875 *
3876 * The maximum length of CIDs used for incoming DTLS messages.
3877 *
3878 */
3879//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3880
3881/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3882 *
3883 * The maximum length of CIDs used for outgoing DTLS messages.
3884 *
3885 */
3886//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3887
TRodziewicze8dd7092021-05-12 14:19:11 +02003888/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003889 *
3890 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003891 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003892 *
3893 * The padding will always be chosen so that the length of the
3894 * padded plaintext is a multiple of the value of this option.
3895 *
3896 * Note: A value of \c 1 means that no padding will be used
3897 * for outgoing records.
3898 *
3899 * Note: On systems lacking division instructions,
3900 * a power of two should be preferred.
3901 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003902//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003903
Angus Grattond8213d02016-05-25 20:56:48 +10003904/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3905 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003906 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003907 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003908 * This determines the size of the outgoing TLS I/O buffer in such a way
3909 * that it is capable of holding the specified amount of plaintext data,
3910 * regardless of the protection mechanism used.
3911 *
Angus Grattond8213d02016-05-25 20:56:48 +10003912 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3913 * the default inward 16384 byte buffer to conform to the TLS specification.
3914 *
3915 * The minimum required outward buffer size is determined by the handshake
3916 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3917 * The specific size requirement depends on the configured ciphers and any
3918 * certificate data which is sent during the handshake.
3919 *
David Horstmann95d516f2021-05-04 18:36:56 +01003920 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003921 */
3922//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3923
Hanno Beckere0b150f2018-08-21 15:51:03 +01003924/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3925 *
3926 * Maximum number of heap-allocated bytes for the purpose of
3927 * DTLS handshake message reassembly and future message buffering.
3928 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003929 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003930 * to account for a reassembled handshake message of maximum size,
3931 * together with its reassembly bitmap.
3932 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003933 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003934 * should be sufficient for all practical situations as it allows
3935 * to reassembly a large handshake message (such as a certificate)
3936 * while buffering multiple smaller handshake messages.
3937 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003938 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003939//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003940
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003941//#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 +02003942//#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 +02003943
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003944/**
3945 * Complete list of ciphersuites to use, in order of preference.
3946 *
3947 * \warning No dependency checking is done on that field! This option can only
3948 * be used to restrict the set of available ciphersuites. It is your
3949 * responsibility to make sure the needed modules are active.
3950 *
3951 * Use this to save a few hundred bytes of ROM (default ordering of all
3952 * available ciphersuites) and a few to a few hundred bytes of RAM.
3953 *
3954 * The value below is only an example, not the default.
3955 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003956//#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 +02003957
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003958/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003959 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3960 *
3961 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003962 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003963 *
3964 * It must be positive and smaller than UINT32_MAX.
3965 *
3966 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3967 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003968 */
3969//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3970
3971/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003972 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3973 *
Jerry Yucf913512023-11-14 11:06:52 +08003974 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003975 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003976 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003977 * - The client ticket age is the time difference between the time when the
3978 * client proposes to the server to use the ticket and the time the client
3979 * received the ticket from the server.
3980 * - The server ticket age is the time difference between the time when the
3981 * server receives a proposition from the client to use the ticket and the
3982 * time when the ticket was created by the server.
3983 *
Jerry Yucf913512023-11-14 11:06:52 +08003984 * The ages might be different due to the client and server clocks not running
3985 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3986 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3987 * 6s, thus in the worst case clients and servers must sync up their system time
3988 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003989 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003990 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003991 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003992//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003993
3994/**
3995 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3996 *
3997 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3998 *
3999 * This must be less than 256.
4000 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004001//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004002
4003/**
4004 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4005 *
4006 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4007 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4008 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4009 *
4010 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004011//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004012
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004013/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004014//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004015//#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 +01004016
Gilles Peskine611179c2022-04-13 23:04:48 +02004017/** \} name SECTION: Module configuration options */