blob: b2441113bcc6bc008b522e4be5d2f7d0b1729b90 [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_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200354
355/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200356 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200357 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200358 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200359 * hardware entropy collector.
360 *
361 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000362 * prototype as declared in library/entropy_poll.h, and accept NULL as first
363 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200364 *
365 * Uncomment to use your own hardware entropy collector.
366 */
367//#define MBEDTLS_ENTROPY_HARDWARE_ALT
368
369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200370 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000371 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100372 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000373 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100374 * Uncomment this macro to use precomputed AES tables stored in ROM.
375 * Comment this macro to generate AES tables in RAM at runtime.
376 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100377 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
378 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100379 * initialization time before the first AES operation can be performed.
380 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
381 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
382 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100383 *
384 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000387
388/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100389 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200390 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100391 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200392 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100393 * Uncommenting this macro omits 75% of the AES tables from
394 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
395 * by computing their values on the fly during operations
396 * (the tables are entry-wise rotations of one another).
397 *
398 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100399 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100400 * runtime. Specifically, one has to compare 4 accesses within
401 * different tables to 4 accesses with additional arithmetic
402 * operations within the same table. The performance gain/loss
403 * depends on the system and memory details.
404 *
405 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200406 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100407//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200408
409/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800410 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
411 *
412 * Use only 128-bit keys in AES operations to save ROM.
413 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800414 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800415 * or 256-bit keys.
416 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800417 * Uncommenting this macro reduces the size of AES code by ~300 bytes
418 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800419 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800420 * Module: library/aes.c
421 *
422 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800423 */
424//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
425
Gilles Peskinea8861e02023-09-05 20:20:51 +0200426/*
427 * Disable plain C implementation for AES.
428 *
429 * When the plain C implementation is enabled, and an implementation using a
430 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
431 * detection will be used to select between them.
432 *
433 * If only one implementation is present, runtime detection will not be used.
434 * This configuration will crash at runtime if running on a CPU without the
435 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
436 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
437 */
438//#define MBEDTLS_AES_USE_HARDWARE_ONLY
439
Arto Kinnunen732ca322023-04-14 14:26:10 +0800440/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200441 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200442 *
443 * Use less ROM for the Camellia implementation (saves about 768 bytes).
444 *
445 * Uncomment this macro to use less memory for Camellia.
446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200447//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200448
449/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200450 * \def MBEDTLS_CHECK_RETURN_WARNING
451 *
452 * If this macro is defined, emit a compile-time warning if application code
453 * calls a function without checking its return value, but the return value
454 * should generally be checked in portable applications.
455 *
456 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
457 * implemented. Otherwise this option has no effect.
458 *
459 * Uncomment to get warnings on using fallible functions without checking
460 * their return value.
461 *
462 * \note This feature is a work in progress.
463 * Warnings will be added to more functions in the future.
464 *
465 * \note A few functions are considered critical, and ignoring the return
466 * value of these functions will trigger a warning even if this
467 * macro is not defined. To completely disable return value check
468 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
469 */
470//#define MBEDTLS_CHECK_RETURN_WARNING
471
472/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200473 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200474 *
475 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200477#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200478
479/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200480 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000481 *
482 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000485
486/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200487 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000488 *
489 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
490 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200491#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000492
493/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100494 * \def MBEDTLS_CIPHER_MODE_OFB
495 *
496 * Enable Output Feedback mode (OFB) for symmetric ciphers.
497 */
498#define MBEDTLS_CIPHER_MODE_OFB
499
500/**
501 * \def MBEDTLS_CIPHER_MODE_XTS
502 *
503 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
504 */
505#define MBEDTLS_CIPHER_MODE_XTS
506
507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200508 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000509 *
510 * Enable NULL cipher.
511 * Warning: Only do so when you know what you are doing. This allows for
512 * encryption or channels without any security!
513 *
Ronald Croncee42702021-04-26 11:34:44 +0200514 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200515 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
516 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
517 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
518 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
519 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
520 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
521 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
522 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
523 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
524 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
525 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
526 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
527 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
528 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
529 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
530 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
531 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
532 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
533 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000534 *
535 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200537//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000538
539/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100540 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200541 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100542 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
543 * specific padding modes in the cipher layer with cipher modes that support
544 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200545 *
546 * If you disable all padding modes, only full blocks can be used with CBC.
547 *
548 * Enable padding modes in the cipher layer.
549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550#define MBEDTLS_CIPHER_PADDING_PKCS7
551#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
552#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
553#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200554
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200555/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
556 *
557 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800558 * Without this, CTR_DRBG uses a 256-bit key
559 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200560 */
561//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
562
Paul Bakker48e93c82013-08-14 12:21:18 +0200563/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200564 * Enable the verified implementations of ECDH primitives from Project Everest
565 * (currently only Curve25519). This feature changes the layout of ECDH
566 * contexts and therefore is a compatibility break for applications that access
567 * fields of a mbedtls_ecdh_context structure directly. See also
568 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000569 *
570 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
571 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200572 */
573//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
574
575/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100576 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200577 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100578 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
579 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200580 *
581 * Comment macros to disable the curve and functions for it
582 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200583/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200584#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
585#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
586#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
587#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
588#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
589#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
590#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
591#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
592#define MBEDTLS_ECP_DP_BP256R1_ENABLED
593#define MBEDTLS_ECP_DP_BP384R1_ENABLED
594#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200595/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200596#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000597#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200598
599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200601 *
602 * Enable specific 'modulo p' routines for each NIST prime.
603 * Depending on the prime and architecture, makes operations 4 to 8 times
604 * faster on the corresponding curve.
605 *
606 * Comment this macro to disable NIST curves optimisation.
607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200608#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200609
610/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200611 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100612 *
613 * Enable "non-blocking" ECC operations that can return early and be resumed.
614 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200615 * This allows various functions to pause by returning
616 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
617 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
618 * order to further progress and eventually complete their operation. This is
619 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
620 * number of ECC operations a function may perform before pausing; see
621 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100622 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200623 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200624 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100625 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100626 * This option:
627 * - Adds xxx_restartable() variants of existing operations in the
628 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100629 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
630 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100631 * - ECDSA: signature generation & verification;
632 * - PK: signature generation & verification;
633 * - X509: certificate chain verification.
634 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
635 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
636 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
637 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000638 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100639 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100640 * - verification of the server's key exchange signature;
641 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100642 * - generation of the client's signature if client authentication is used,
643 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100644 *
645 * \note In the cases above, the usual SSL/TLS functions, such as
646 * mbedtls_ssl_handshake(), can now return
647 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200648 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100649 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
650 * restartable operations in PK, X.509 and TLS (see above) are not
651 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100652 * PSA, and are not restartable. These are temporary limitations that
653 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200654 *
Ron Eldor19779c42018-11-05 16:58:13 +0200655 * \note This option only works with the default software implementation of
656 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100657 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100658 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100659 * Requires: MBEDTLS_ECP_C
660 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100661 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100662 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200663//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100664
665/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200666 * Uncomment to enable using new bignum code in the ECC modules.
667 *
668 * \warning This is currently experimental, incomplete and therefore should not
669 * be used in production.
670 */
671//#define MBEDTLS_ECP_WITH_MPI_UINT
672
673/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200674 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100675 *
676 * Enable deterministic ECDSA (RFC 6979).
677 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
678 * may result in a compromise of the long-term signing key. This is avoided by
679 * the deterministic variant.
680 *
John Durkop36a82e52020-10-26 09:39:05 -0700681 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100682 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100683 * Comment this macro to disable deterministic ECDSA.
684 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200685#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100686
687/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200689 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200690 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200691 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200692 * This enables the following ciphersuites (if other requisites are
693 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200694 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
695 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
696 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
697 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
698 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
699 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
700 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
701 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
702 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
703 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200704 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200705#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200706
707/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200708 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200709 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200710 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200711 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200713 *
714 * This enables the following ciphersuites (if other requisites are
715 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200716 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
717 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
718 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
719 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
720 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
721 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
722 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
723 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
724 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
725 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100726 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100727 * \warning Using DHE constitutes a security risk as it
728 * is not possible to validate custom DH parameters.
729 * If possible, it is recommended users should consider
730 * preferring other methods of key exchange.
731 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100732 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200733 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200734#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200735
736/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200737 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200738 *
739 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
740 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200741 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200742 *
743 * This enables the following ciphersuites (if other requisites are
744 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
746 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
747 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
748 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
749 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
750 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200751 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200752#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200753
754/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200755 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200756 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200757 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200758 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200759 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
760 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200761 *
762 * This enables the following ciphersuites (if other requisites are
763 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
765 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
766 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
767 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
768 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
769 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
770 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
771 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
772 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
773 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200774 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200776
777/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200778 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200779 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200780 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200781 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
783 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200784 *
785 * This enables the following ciphersuites (if other requisites are
786 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
788 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
789 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
790 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
791 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
792 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
793 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
794 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
795 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
796 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
797 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
798 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200801
802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200804 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200805 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200806 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
808 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200809 *
810 * This enables the following ciphersuites (if other requisites are
811 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200812 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
813 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
814 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
815 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
816 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
817 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
818 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
819 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
820 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
821 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
822 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
823 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100824 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100825 * \warning Using DHE constitutes a security risk as it
826 * is not possible to validate custom DH parameters.
827 * If possible, it is recommended users should consider
828 * preferring other methods of key exchange.
829 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100830 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200832#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200833
834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200837 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200839 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
840 * MBEDTLS_RSA_C
841 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200843 *
844 * This enables the following ciphersuites (if other requisites are
845 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
847 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
848 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
849 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
850 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
851 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
852 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
853 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
854 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
855 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200857#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200858
859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200861 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200862 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200863 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200864 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
865 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
866 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200867 *
868 * This enables the following ciphersuites (if other requisites are
869 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
871 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
872 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
873 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
874 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
875 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
876 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
877 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
878 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
879 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200880 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200882
883/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200884 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100885 *
886 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
887 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200888 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
889 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
890 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100891 *
892 * This enables the following ciphersuites (if other requisites are
893 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
895 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
896 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
897 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
898 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
899 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
900 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
901 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
902 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
903 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100906
907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100909 *
910 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
911 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200912 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
913 * MBEDTLS_RSA_C
914 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100915 *
916 * This enables the following ciphersuites (if other requisites are
917 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
919 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
920 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
921 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
922 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
923 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
924 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
925 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
926 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
927 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100928 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200929#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100930
931/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200932 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
933 *
934 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
935 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200936 * \warning This is currently experimental. EC J-PAKE support is based on the
937 * Thread v1.0.0 specification; incompatible changes to the specification
938 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200939 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200940 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100941 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200942 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
943 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100944 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800945 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100946 * MBEDTLS_USE_PSA_CRYPTO is disabled).
947 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200948 * This enables the following ciphersuites (if other requisites are
949 * enabled as well):
950 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
951 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200952//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200953
954/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100956 *
957 * Enhance support for reading EC keys using variants of SEC1 not allowed by
958 * RFC 5915 and RFC 5480.
959 *
960 * Currently this means parsing the SpecifiedECDomain choice of EC
961 * parameters (only known groups are supported, not arbitrary domains, to
962 * avoid validation issues).
963 *
964 * Disable if you only need to support RFC 5915 + 5480 key formats.
965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200966#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100967
968/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200969 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
970 *
971 * Enable the support for parsing public keys of type Short Weierstrass
972 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200973 * compressed point format. This parsing is done through ECP module's functions.
974 *
975 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
976 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
977 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200978 */
979#define MBEDTLS_PK_PARSE_EC_COMPRESSED
980
981/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100983 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984 * Enable a dummy error function to make use of mbedtls_strerror() in
985 * third party libraries easier when MBEDTLS_ERROR_C is disabled
986 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200987 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
989 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100990 *
991 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100993 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100995
996/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000998 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +0200999 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001000 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001002 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001004
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001005/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001007 *
1008 * Enable functions that use the filesystem.
1009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001010#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001011
1012/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001014 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001015 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001016 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001017 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001018 * application.
1019 *
1020 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001022//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001023
1024/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001025 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001026 *
1027 * Do not use built-in platform entropy functions.
1028 * This is useful if your platform does not support
1029 * standards like the /dev/urandom or Windows CryptoAPI.
1030 *
1031 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001032 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001033//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001034
1035/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001036 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001037 *
1038 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1039 * default SHA-512 based one (if both are available).
1040 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001042 *
1043 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1044 * if you have performance concerns.
1045 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001046 * This option is only useful if both MBEDTLS_SHA256_C and
1047 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001048 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001050
1051/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001052 * \def MBEDTLS_ENTROPY_NV_SEED
1053 *
1054 * Enable the non-volatile (NV) seed file-based entropy source.
1055 * (Also enables the NV seed read/write functions in the platform layer)
1056 *
1057 * This is crucial (if not required) on systems that do not have a
1058 * cryptographic entropy source (in hardware or kernel) available.
1059 *
1060 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1061 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001062 * \note The read/write functions that are used by the entropy source are
1063 * determined in the platform layer, and can be modified at runtime and/or
1064 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1065 *
1066 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001067 * with regular fopen(), please make sure you make a seedfile with the
1068 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1069 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001070 * and written to or you will get an entropy source error! The default
1071 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1072 * bytes from the file.
1073 *
1074 * \note The entropy collector will write to the seed file before entropy is
1075 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001076 */
1077//#define MBEDTLS_ENTROPY_NV_SEED
1078
Ronald Cron71016a92020-08-28 19:01:50 +02001079/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001080 *
Ronald Cron71016a92020-08-28 19:01:50 +02001081 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001082 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001083 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1084 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001085 *
1086 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001087 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001088 */
Ronald Cron71016a92020-08-28 19:01:50 +02001089//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001090
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001091/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001093 *
1094 * Enable debugging of buffer allocator memory issues. Automatically prints
1095 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1096 * function for 'debug output' of allocated memory.
1097 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001099 *
1100 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001101 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001103
1104/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001106 *
1107 * Include backtrace information with each allocated block.
1108 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001110 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001111 *
1112 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001113 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001115
1116/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001118 *
1119 * Support external private RSA keys (eg from a HSM) in the PK layer.
1120 *
1121 * Comment this macro to disable support for external private RSA keys.
1122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001123#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001124
1125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001127 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001128 * Enable support for PKCS#1 v1.5 encoding.
1129 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001130 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001131 *
Paul Bakker48377d92013-08-30 12:06:24 +02001132 * This enables support for PKCS#1 v1.5 operations.
1133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001135
1136/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001138 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001139 * Enable support for PKCS#1 v2.1 encoding.
1140 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001141 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001142 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001143 * \warning If using a hash that is only provided by PSA drivers, you must
1144 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001145 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001146 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001148#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001149
Steven Cooreman6801f082021-02-19 17:21:22 +01001150/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1151 *
1152 * Enable support for platform built-in keys. If you enable this feature,
1153 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1154 * See the documentation of that function for more information.
1155 *
1156 * Built-in keys are typically derived from a hardware unique key or
1157 * stored in a secure element.
1158 *
1159 * Requires: MBEDTLS_PSA_CRYPTO_C.
1160 *
1161 * \warning This interface is experimental and may change or be removed
1162 * without notice.
1163 */
1164//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1165
Ronald Cron3768ac12021-01-26 16:58:00 +01001166/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1167 *
1168 * Enable support for PSA crypto client.
1169 *
1170 * \note This option allows to include the code necessary for a PSA
1171 * crypto client when the PSA crypto implementation is not included in
1172 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1173 * code to set and get PSA key attributes.
1174 * The development of PSA drivers partially relying on the library to
1175 * fulfill the hardware gaps is another possible usage of this option.
1176 *
1177 * \warning This interface is experimental and may change or be removed
1178 * without notice.
1179 */
1180//#define MBEDTLS_PSA_CRYPTO_CLIENT
1181
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001182/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1183 *
1184 * Make the PSA Crypto module use an external random generator provided
1185 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1186 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001187 * \note This random generator must deliver random numbers with cryptographic
1188 * quality and high performance. It must supply unpredictable numbers
1189 * with a uniform distribution. The implementation of this function
1190 * is responsible for ensuring that the random generator is seeded
1191 * with sufficient entropy. If you have a hardware TRNG which is slow
1192 * or delivers non-uniform output, declare it as an entropy source
1193 * with mbedtls_entropy_add_source() instead of enabling this option.
1194 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001195 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001196 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1197 * and define a function called mbedtls_psa_external_get_random()
1198 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001199 * ```
1200 * psa_status_t mbedtls_psa_external_get_random(
1201 * mbedtls_psa_external_random_context_t *context,
1202 * uint8_t *output, size_t output_size, size_t *output_length);
1203 * );
1204 * ```
1205 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001206 * The function must fill the \c output buffer with \c output_size bytes
1207 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001208 *
1209 * Requires: MBEDTLS_PSA_CRYPTO_C
1210 *
1211 * \warning If you enable this option, code that uses the PSA cryptography
1212 * interface will not use any of the entropy sources set up for
1213 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1214 * enables.
1215 *
1216 * \note This option is experimental and may be removed without notice.
1217 */
1218//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1219
Paul Bakker9dcc3222011-03-08 14:16:06 +00001220/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001221 * \def MBEDTLS_PSA_CRYPTO_SPM
1222 *
1223 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1224 * Partition Manager) integration which separates the code into two parts: a
1225 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1226 * Environment).
1227 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001228 * If you enable this option, your build environment must include a header
1229 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1230 * header files, or in another directory on the compiler's include search
1231 * path). Alternatively, your platform may customize the header
1232 * `psa/crypto_platform.h`, in which case it can skip or replace the
1233 * inclusion of `"crypto_spe.h"`.
1234 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001235 * Module: library/psa_crypto.c
1236 * Requires: MBEDTLS_PSA_CRYPTO_C
1237 *
1238 */
1239//#define MBEDTLS_PSA_CRYPTO_SPM
1240
1241/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001242 * Uncomment to enable p256-m. This is an alternative implementation of
1243 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1244 * Compared to the default implementation:
1245 *
1246 * - p256-m has a much smaller code size and RAM footprint.
1247 * - p256-m is only available via the PSA API. This includes the pk module
1248 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1249 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1250 * over the core arithmetic, or deterministic derivation of keys.
1251 *
1252 * We recommend enabling this option if your application uses the PSA API
1253 * and the only elliptic curve support it needs is ECDH and ECDSA over
1254 * SECP256R1.
1255 *
1256 * If you enable this option, you do not need to enable any ECC-related
1257 * MBEDTLS_xxx option. You do need to separately request support for the
1258 * cryptographic mechanisms through the PSA API:
1259 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1260 * configuration;
1261 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1262 * - #PSA_WANT_ECC_SECP_R1_256;
1263 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1264 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1265 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1266 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1267 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001268 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001269 * \note To benefit from the smaller code size of p256-m, make sure that you
1270 * do not enable any ECC-related option not supported by p256-m: this
1271 * would cause the built-in ECC implementation to be built as well, in
1272 * order to provide the required option.
1273 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001274 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1275 * SECP256R1 are disabled as they are not supported by this driver.
1276 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1277 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001278 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001279 */
1280//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1281
1282/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001283 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001284 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001285 * Enable support for entropy injection at first boot. This feature is
1286 * required on systems that do not have a built-in entropy source (TRNG).
1287 * This feature is currently not supported on systems that have a built-in
1288 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001289 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001290 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001291 *
1292 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001293//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001294
1295/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001296 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001297 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001298 * Assume all buffers passed to PSA functions are owned exclusively by the
1299 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001300 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001301 * This option may be enabled if all buffers passed to any PSA function reside
1302 * in memory that is accessible only to the PSA function during its execution.
1303 *
1304 * This option MUST be disabled whenever buffer arguments are in memory shared
1305 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001306 * across a trust boundary.
1307 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001308 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001309 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001310 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001311 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001312 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001313//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001314
1315/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001316 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001317 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001318 * Do not use the Chinese Remainder Theorem
1319 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001320 *
1321 * Uncomment this macro to disable the use of CRT in RSA.
1322 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001323 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001324//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001325
1326/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001328 *
1329 * Enable the checkup functions (*_self_test).
1330 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001331#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001332
1333/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001334 * \def MBEDTLS_SHA256_SMALLER
1335 *
1336 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1337 * lower performance.
1338 *
Adam Wolf039080f2019-09-10 09:53:08 -05001339 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001340 * performance and size. This version optimizes more aggressively for size at
1341 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1342 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1343 * 30%.
1344 *
1345 * Uncomment to enable the smaller implementation of SHA256.
1346 */
1347//#define MBEDTLS_SHA256_SMALLER
1348
1349/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001350 * \def MBEDTLS_SHA512_SMALLER
1351 *
1352 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1353 * lower performance.
1354 *
1355 * Uncomment to enable the smaller implementation of SHA512.
1356 */
1357//#define MBEDTLS_SHA512_SMALLER
1358
1359/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001361 *
1362 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001363 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001364 * with other servers, only debugging of failures is harder.
1365 *
1366 * The advantage of not sending alert messages, is that no information is given
1367 * about reasons for failures thus preventing adversaries of gaining intel.
1368 *
1369 * Enable sending of all alert messages
1370 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001371#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001372
1373/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001374 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1375 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001376 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001377 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001378 * in the underlying transport. The CID functionality is described
1379 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001380 *
1381 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001382 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1383 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1384 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001385 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001386 * The maximum lengths of outgoing and incoming CIDs can be configured
1387 * through the options
1388 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1389 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1390 *
1391 * Requires: MBEDTLS_SSL_PROTO_DTLS
1392 *
1393 * Uncomment to enable the Connection ID extension.
1394 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001395#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1396
1397
1398/**
1399 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1400 *
1401 * Defines whether RFC 9146 (default) or the legacy version
1402 * (version draft-ietf-tls-dtls-connection-id-05,
1403 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1404 * is used.
1405 *
1406 * Set the value to 0 for the standard version, and
1407 * 1 for the legacy draft version.
1408 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001409 * \deprecated Support for the legacy version of the DTLS
1410 * Connection ID feature is deprecated. Please
1411 * switch to the standardized version defined
1412 * in RFC 9146 enabled by utilizing
1413 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1414 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1415 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001416 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1417 */
1418#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001419
1420/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001421 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1422 *
1423 * Enable asynchronous external private key operations in SSL. This allows
1424 * you to configure an SSL connection to call an external cryptographic
1425 * module to perform private key operations instead of performing the
1426 * operation inside the library.
1427 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001428 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001429 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001430//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001431
1432/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001433 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1434 *
1435 * Enable serialization of the TLS context structures, through use of the
1436 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1437 *
1438 * This pair of functions allows one side of a connection to serialize the
1439 * context associated with the connection, then free or re-use that context
1440 * while the serialized state is persisted elsewhere, and finally deserialize
1441 * that state to a live context for resuming read/write operations on the
1442 * connection. From a protocol perspective, the state of the connection is
1443 * unaffected, in particular this is entirely transparent to the peer.
1444 *
1445 * Note: this is distinct from TLS session resumption, which is part of the
1446 * protocol and fully visible by the peer. TLS session resumption enables
1447 * establishing new connections associated to a saved session with shorter,
1448 * lighter handshakes, while context serialization is a local optimization in
1449 * handling a single, potentially long-lived connection.
1450 *
1451 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1452 * saved after the handshake to allow for more efficient serialization, so if
1453 * you don't need this feature you'll save RAM by disabling it.
1454 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001455 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1456 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001457 * Comment to disable the context serialization APIs.
1458 */
1459#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1460
1461/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001462 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001463 *
1464 * Enable the debug messages in SSL module for all issues.
1465 * Debug messages have been disabled in some places to prevent timing
1466 * attacks due to (unbalanced) debugging function calls.
1467 *
1468 * If you need all error reporting you should enable this during debugging,
1469 * but remove this for production servers that should log as well.
1470 *
1471 * Uncomment this macro to report all debug messages on errors introducing
1472 * a timing side-channel.
1473 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001475//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001476
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001477/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001478 *
1479 * Enable support for Encrypt-then-MAC, RFC 7366.
1480 *
1481 * This allows peers that both support it to use a more robust protection for
1482 * ciphersuites using CBC, providing deep resistance against timing attacks
1483 * on the padding or underlying cipher.
1484 *
1485 * This only affects CBC ciphersuites, and is useless if none is defined.
1486 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001487 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001488 *
1489 * Comment this macro to disable support for Encrypt-then-MAC
1490 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001491#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001492
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001493/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001494 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001495 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1496 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001497 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001498 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001499 * attacks, but it is recommended to always use it (even if you disable
1500 * renegotiation), since it actually fixes a more fundamental issue in the
1501 * original SSL/TLS design, and has implications beyond Triple Handshake.
1502 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001503 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001504 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001505 * Comment this macro to disable support for Extended Master Secret.
1506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001507#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001508
Paul Bakkerd66f0702013-01-31 16:57:45 +01001509/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001510 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1511 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001512 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001513 * giving access to the peer's certificate after completion of the handshake.
1514 *
1515 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1516 * recommended to disable this option for reduced RAM usage.
1517 *
1518 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1519 * defined, but always returns \c NULL.
1520 *
1521 * \note This option has no influence on the protection against the
1522 * triple handshake attack. Even if it is disabled, Mbed TLS will
1523 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001524 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001525 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001526 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001527 *
1528 * Comment this macro to disable storing the peer's certificate
1529 * after the handshake.
1530 */
1531#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1532
1533/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001534 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001535 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001536 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001537 *
1538 * The two main uses of renegotiation are (1) refresh keys on long-lived
1539 * connections and (2) client authentication after the initial handshake.
1540 * If you don't need renegotiation, it's probably better to disable it, since
1541 * it has been associated with security issues in the past and is easy to
1542 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001543 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001544 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1545 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001546 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001547 *
1548 * \note Even if this option is disabled, both client and server are aware
1549 * of the Renegotiation Indication Extension (RFC 5746) used to
1550 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1551 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1552 * configuration of this extension).
1553 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001556
1557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001559 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001560 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001561 *
1562 * Comment this macro to disable support for the max_fragment_length extension
1563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001565
1566/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001567 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1568 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001569 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001570 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001571 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1572 *
1573 * Uncomment this macro to enable support for the record_size_limit extension
1574 */
1575//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1576
1577/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001578 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001579 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001580 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001581 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001582 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001583 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1584 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001585 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001586 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001587 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001588 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1589 * are only provided by PSA drivers, you must call psa_crypto_init() before
1590 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001591 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001592 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001594#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001595
1596/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001597 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001598 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001599 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001600 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001601 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001602 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001603 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001604 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001605 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001606 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001607 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1608 * directly performed by TLS 1.3 code. As a consequence, you must
1609 * call psa_crypto_init() before the first TLS 1.3 handshake.
1610 *
1611 * \note Cryptographic operations performed indirectly via another module
1612 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1613 * running handshake hash) only use PSA crypto if
1614 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001615 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001616 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001617 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001618#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001619
1620/**
Ronald Cronab65c522021-11-24 10:47:20 +01001621 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1622 *
1623 * Enable TLS 1.3 middlebox compatibility mode.
1624 *
1625 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1626 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1627 * expecting TLS 1.2 traffic.
1628 *
1629 * Turning on the compatibility mode comes at the cost of a few added bytes
1630 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1631 * that don't use it. Therefore, unless transmission bandwidth is critical and
1632 * you know that middlebox compatibility issues won't occur, it is therefore
1633 * recommended to set this option.
1634 *
1635 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001636 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1637 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001638 *
1639 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001640#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001641
1642/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001643 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1644 *
1645 * Enable TLS 1.3 PSK key exchange mode.
1646 *
1647 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1648 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1649 * effect on the build.
1650 *
1651 */
1652#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1653
1654/**
1655 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1656 *
1657 * Enable TLS 1.3 ephemeral key exchange mode.
1658 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001659 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001660 * MBEDTLS_X509_CRT_PARSE_C
1661 * and at least one of:
1662 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1663 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001664 *
1665 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1666 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1667 * effect on the build.
1668 *
1669 */
1670#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1671
1672/**
1673 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1674 *
1675 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1676 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001677 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001678 *
1679 * Comment to disable support for the PSK ephemeral key exchange mode in
1680 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1681 * have any effect on the build.
1682 *
1683 */
1684#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1685
1686/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001687 * \def MBEDTLS_SSL_EARLY_DATA
1688 *
1689 * Enable support for RFC 8446 TLS 1.3 early data.
1690 *
1691 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1692 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1693 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1694 *
1695 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1696 * is not enabled, this option does not have any effect on the build.
1697 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001698 * \note The maximum amount of early data can be set with
1699 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1700 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001702//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001703
1704/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001706 *
1707 * Enable support for DTLS (all available versions).
1708 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001709 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001710 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001711 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001712 *
1713 * Comment this macro to disable support for DTLS
1714 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001716
1717/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001719 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001720 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001721 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001722 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001723 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001724#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001725
1726/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001728 *
1729 * Enable support for the anti-replay mechanism in DTLS.
1730 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731 * Requires: MBEDTLS_SSL_TLS_C
1732 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001733 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001734 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001735 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001736 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001737 * Comment this to disable anti-replay in DTLS.
1738 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001739#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001740
1741/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001743 *
1744 * Enable support for HelloVerifyRequest on DTLS servers.
1745 *
1746 * This feature is highly recommended to prevent DTLS servers being used as
1747 * amplifiers in DoS attacks against other hosts. It should always be enabled
1748 * unless you know for sure amplification cannot be a problem in the
1749 * environment in which your server operates.
1750 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001751 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001752 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001753 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001754 *
1755 * Comment this to disable support for HelloVerifyRequest.
1756 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001758
1759/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001760 * \def MBEDTLS_SSL_DTLS_SRTP
1761 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001762 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001763 * through the use_srtp extension.
1764 *
1765 * \note This feature provides the minimum functionality required
1766 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1767 * the associated SRTP packet protection key material.
1768 * In particular, the SRTP packet protection itself, as well as the
1769 * demultiplexing of RTP and DTLS packets at the datagram layer
1770 * (see Section 5 of RFC 5764), are not handled by this feature.
1771 * Instead, after successful completion of a handshake negotiating
1772 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001773 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001774 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1775 * (this is implemented in the SSL example programs).
1776 * The resulting key should then be passed to an SRTP stack.
1777 *
1778 * Setting this option enables the runtime API
1779 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1780 * through which the supported DTLS-SRTP protection
1781 * profiles can be configured. You must call this API at
1782 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001783 *
1784 * Requires: MBEDTLS_SSL_PROTO_DTLS
1785 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001786 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001787 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001788//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001789
1790/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001791 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1792 *
1793 * Enable server-side support for clients that reconnect from the same port.
1794 *
1795 * Some clients unexpectedly close the connection and try to reconnect using the
1796 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001797 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001798 * flag enables that support.
1799 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001800 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001801 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001802 * Comment this to disable support for clients reusing the source port.
1803 */
1804#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1805
1806/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001808 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001809 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001810 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001811 * session store remains the responsibility of the application, though).
1812 * Server-side, you also need to provide callbacks for writing and parsing
1813 * tickets, including authenticated encryption and key management. Example
1814 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001815 *
1816 * Comment this macro to disable support for SSL session tickets
1817 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001819
1820/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001822 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001823 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001824 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001826 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001827 * Comment this macro to disable support for server name indication in SSL
1828 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001829#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001830
1831/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001832 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1833 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001834 * When this option is enabled, the SSL buffer will be resized automatically
1835 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001836 *
1837 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001838 */
1839//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1840
1841/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001842 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1843 *
1844 * Enable testing of the constant-flow nature of some sensitive functions with
1845 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001846 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001847 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001848 * This setting requires compiling with clang -fsanitize=memory. The test
1849 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001850 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001851 * \warning This macro is only used for extended testing; it is not considered
1852 * part of the library's API, so it may change or disappear at any time.
1853 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001854 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001855 */
1856//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1857
1858/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001859 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1860 *
1861 * Enable testing of the constant-flow nature of some sensitive functions with
1862 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001863 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001864 *
1865 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001866 * testing if the tests suites are run with valgrind's memcheck. This can be
1867 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1868 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001869 *
1870 * \warning This macro is only used for extended testing; it is not considered
1871 * part of the library's API, so it may change or disappear at any time.
1872 *
1873 * Uncomment to enable testing of the constant-flow nature of selected code.
1874 */
1875//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1876
1877/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001878 * \def MBEDTLS_TEST_HOOKS
1879 *
1880 * Enable features for invasive testing such as introspection functions and
1881 * hooks for fault injection. This enables additional unit tests.
1882 *
1883 * Merely enabling this feature should not change the behavior of the product.
1884 * It only adds new code, and new branching points where the default behavior
1885 * is the same as when this feature is disabled.
1886 * However, this feature increases the attack surface: there is an added
1887 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1888 * Therefore this feature must never be enabled in production.
1889 *
1890 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1891 * information.
1892 *
1893 * Uncomment to enable invasive tests.
1894 */
1895//#define MBEDTLS_TEST_HOOKS
1896
1897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001899 *
1900 * Provide your own alternate threading implementation.
1901 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001903 *
1904 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001905 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001907
1908/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001910 *
1911 * Enable the pthread wrapper layer for the threading layer.
1912 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001914 *
1915 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001916 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001917//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001918
1919/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001920 * \def MBEDTLS_USE_PSA_CRYPTO
1921 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001922 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1923 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001924 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001925 * \note Development of this option is currently in progress, and parts of Mbed
1926 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001927 * will still continue to work as usual, so enabling this option should not
1928 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001929 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001930 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001931 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1932 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001933 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001934 * \note An important and desirable effect of this option is that it allows
1935 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1936 * 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 +02001937 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001938 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1939 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001940 *
1941 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001942 *
1943 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001944 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001945 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001946 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001947//#define MBEDTLS_USE_PSA_CRYPTO
1948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001949/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001950 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1951 *
John Durkop185764f2020-10-12 21:32:12 -07001952 * This setting allows support for cryptographic mechanisms through the PSA
1953 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001954 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001955 * When this option is disabled, the PSA API exposes the cryptographic
1956 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1957 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001958 *
1959 * When this option is enabled, the PSA API exposes the cryptographic
1960 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1961 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1962 * automatically enabled if required (i.e. if no PSA driver provides the
1963 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1964 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001965 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001966 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001967 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001968 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001969 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1970 * symbols is not completely finalized yet, and the configuration
1971 * tooling is not ideally adapted to having two separate configuration
1972 * files.
1973 * Future minor releases of Mbed TLS may make minor changes to those
1974 * symbols, but we will endeavor to provide a transition path.
1975 * Nonetheless, this option is considered mature enough to use in
1976 * production, as long as you accept that you may need to make
1977 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001978 */
1979//#define MBEDTLS_PSA_CRYPTO_CONFIG
1980
1981/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001982 * \def MBEDTLS_VERSION_FEATURES
1983 *
1984 * Allow run-time checking of compile-time enabled features. Thus allowing users
1985 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001986 * support via mbedtls_version_check_feature().
1987 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001988 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00001989 *
1990 * Comment this to disable run-time checking and save ROM space
1991 */
1992#define MBEDTLS_VERSION_FEATURES
1993
1994/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001995 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1996 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001997 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001998 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1999 * the set of trusted certificates through a callback instead of a linked
2000 * list.
2001 *
2002 * This is useful for example in environments where a large number of trusted
2003 * certificates is present and storing them in a linked list isn't efficient
2004 * enough, or when the set of trusted certificates changes frequently.
2005 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002006 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002007 * `mbedtls_ssl_conf_ca_cb()` for more information.
2008 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002009 * Requires: MBEDTLS_X509_CRT_PARSE_C
2010 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002011 * Uncomment to enable trusted certificate callbacks.
2012 */
2013//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2014
2015/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002016 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002017 *
Chris Jones2c745862020-12-16 11:41:06 +00002018 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002019 *
Chris Jones2c745862020-12-16 11:41:06 +00002020 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002021 * and other functions/constants only used by these functions, thus reducing
2022 * the code footprint by several KB.
2023 */
Chris Jones2c745862020-12-16 11:41:06 +00002024//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002025
2026/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002027 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002028 *
2029 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2030 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2031 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002032 * Requires: MBEDTLS_PKCS1_V21
2033 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002034 * Comment this macro to disallow using RSASSA-PSS in certificates.
2035 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002036#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002037/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002038
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002039/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002040 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002041 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002042 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002043 * \{
2044 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002045
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002047 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002048 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002049 * Enable AES-NI support on x86-64 or x86-32.
2050 *
2051 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002052 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002053 * - GCC, x86-64, target not explicitly supporting AESNI:
2054 * requires MBEDTLS_HAVE_ASM.
2055 * - GCC, x86-32, target not explicitly supporting AESNI:
2056 * not supported.
2057 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2058 * For this assembly-less implementation, you must currently compile
2059 * `library/aesni.c` and `library/aes.c` with machine options to enable
2060 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2061 * `clang -maes -mpclmul`.
2062 * - Non-x86 targets: this option is silently ignored.
2063 * - Other compilers: this option is silently ignored.
2064 *
2065 * \note
2066 * Above, "GCC" includes compatible compilers such as Clang.
2067 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002068 *
2069 * Module: library/aesni.c
2070 * Caller: library/aes.c
2071 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002072 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002073 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002074 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002075 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002077
2078/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002079 * \def MBEDTLS_AESCE_C
2080 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002081 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002082 *
2083 * Module: library/aesce.c
2084 * Caller: library/aes.c
2085 *
Jerry Yuf015a932023-04-25 10:38:03 +08002086 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002087 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002088 * \warning Runtime detection only works on Linux. For non-Linux operating
2089 * system, Armv8-A Cryptographic Extensions must be supported by
2090 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002091 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002092 * \note Minimum compiler versions for this feature when targeting aarch64
2093 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2094 * Minimum compiler versions for this feature when targeting 32-bit
2095 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002096 *
2097 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2098 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002099 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002100 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002101 */
2102#define MBEDTLS_AESCE_C
2103
2104/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002105 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002106 *
2107 * Enable the AES block cipher.
2108 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002109 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002110 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002111 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002112 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002113 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002114 * This module enables the following ciphersuites (if other requisites are
2115 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002116 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2117 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2118 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2119 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2120 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2121 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2122 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2123 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2124 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2125 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2126 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2127 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2128 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2129 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2130 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2131 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2132 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2133 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2134 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2135 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2136 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2137 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2138 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2139 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2140 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2141 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2142 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2143 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2144 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2145 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2146 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2147 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2148 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2149 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2150 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2151 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2152 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2153 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2154 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2155 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2156 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2157 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2158 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2159 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2160 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2161 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2162 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2163 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2164 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2165 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2166 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2167 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2168 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2169 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2170 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2171 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2172 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2173 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002174 *
Paul Bakkercff68422013-09-15 20:43:33 +02002175 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002176 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002177#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002178
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002179/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002180 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002181 *
2182 * Enable the generic ASN1 parser.
2183 *
2184 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002185 * Caller: library/x509.c
2186 * library/dhm.c
2187 * library/pkcs12.c
2188 * library/pkcs5.c
2189 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002192
2193/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002195 *
2196 * Enable the generic ASN1 writer.
2197 *
2198 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002199 * Caller: library/ecdsa.c
2200 * library/pkwrite.c
2201 * library/x509_create.c
2202 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002203 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002205#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002206
2207/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002209 *
2210 * Enable the Base64 module.
2211 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002212 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002213 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002214 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002215 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002216 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002217#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002218
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002219/**
Yanray Wange367e472023-10-31 17:23:04 +08002220 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2221 *
2222 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2223 *
2224 * \note This feature is incompatible with insecure block cipher,
2225 * MBEDTLS_DES_C, and cipher modes which always require decryption
2226 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002227 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2228 * this feature is incompatible with following supported PSA equivalence,
2229 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2230 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002231 *
2232 * Module: library/aes.c
2233 * library/aesce.c
2234 * library/aesni.c
2235 * library/aria.c
2236 * library/camellia.c
2237 * library/cipher.c
2238 */
2239//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2240
2241/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002242 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002243 *
Paul Bakker9a736322012-11-14 12:39:52 +00002244 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002245 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002246 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002247 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002248 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002249 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002250 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002251 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002252 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002253 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002254 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002255 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002256 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002257 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002259#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002260
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002261/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002262 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002263 *
2264 * Enable the Camellia block cipher.
2265 *
Paul Bakker38119b12009-01-10 23:31:23 +00002266 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002267 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002268 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002269 * This module enables the following ciphersuites (if other requisites are
2270 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002271 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2272 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2273 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2274 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2275 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2276 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2277 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2278 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2279 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2280 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2281 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2282 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2283 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2284 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2285 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2286 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2287 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2288 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2289 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2290 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2291 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2292 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2293 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2294 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2295 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2296 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2297 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2298 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2299 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2300 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2301 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2302 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2303 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2304 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2305 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2306 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2307 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2308 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2309 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2310 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2311 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2312 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002315
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002316/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002317 * \def MBEDTLS_ARIA_C
2318 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002319 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002320 *
2321 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002322 * Caller: library/cipher.c
2323 *
2324 * This module enables the following ciphersuites (if other requisites are
2325 * enabled as well):
2326 *
2327 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2328 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2329 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2330 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2331 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2332 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2333 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2334 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2335 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2336 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2337 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2338 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2339 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2340 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2341 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2342 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2343 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2344 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2345 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2346 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2347 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2348 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2349 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2350 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2351 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2352 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2353 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2354 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2355 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2356 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2357 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2358 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2359 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2360 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2361 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2362 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2363 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2364 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002365 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002366#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002367
2368/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002369 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002370 *
2371 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2372 *
2373 * Module: library/ccm.c
2374 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002375 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2376 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002377 *
2378 * This module enables the AES-CCM ciphersuites, if other requisites are
2379 * enabled as well.
2380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002381#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002382
2383/**
Daniel King34b822c2016-05-15 17:28:08 -03002384 * \def MBEDTLS_CHACHA20_C
2385 *
2386 * Enable the ChaCha20 stream cipher.
2387 *
2388 * Module: library/chacha20.c
2389 */
2390#define MBEDTLS_CHACHA20_C
2391
2392/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002393 * \def MBEDTLS_CHACHAPOLY_C
2394 *
2395 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2396 *
2397 * Module: library/chachapoly.c
2398 *
2399 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2400 */
2401#define MBEDTLS_CHACHAPOLY_C
2402
2403/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002404 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002405 *
2406 * Enable the generic cipher layer.
2407 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002408 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002409 * Caller: library/ccm.c
2410 * library/cmac.c
2411 * library/gcm.c
2412 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002413 * library/pkcs12.c
2414 * library/pkcs5.c
2415 * library/psa_crypto_aead.c
2416 * library/psa_crypto_mac.c
2417 * library/ssl_ciphersuites.c
2418 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002419 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002420 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2421 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002422 *
2423 * Uncomment to enable generic cipher wrappers.
2424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002425#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002426
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002427/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002428 * \def MBEDTLS_CMAC_C
2429 *
Simon Butcher327398a2016-10-05 14:09:11 +01002430 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2431 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002432 *
2433 * Module: library/cmac.c
2434 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002435 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002436 *
2437 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002438#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002439
2440/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002441 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002442 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002443 * Enable the CTR_DRBG AES-based random generator.
2444 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002445 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002446 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002447 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002448 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2449 * is used.
2450 *
2451 * \warning When using PSA, the user should call `psa_crypto_init()` before
2452 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2453 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002454 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2455 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002456 * \note To achieve a 256-bit security strength with CTR_DRBG,
2457 * you must use AES-256 *and* use sufficient entropy.
2458 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002459 *
2460 * Module: library/ctr_drbg.c
2461 * Caller:
2462 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002463 * Requires: MBEDTLS_AES_C or
2464 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2465 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002466 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002467 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002468 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002469#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002470
2471/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002472 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002473 *
2474 * Enable the debug functions.
2475 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002476 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002477 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002478 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002479 * library/ssl_tls12_*.c
2480 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002481 *
2482 * This module provides debugging functions.
2483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002484#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002485
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002486/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002487 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002488 *
2489 * Enable the DES block cipher.
2490 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002491 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002492 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002493 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002494 *
Paul Bakkercff68422013-09-15 20:43:33 +02002495 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002496 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002497 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002498 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002499 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002500#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002501
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002502/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002504 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002505 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002506 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002507 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002508 * Caller: library/ssl_tls.c
2509 * library/ssl*_client.c
2510 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002511 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002512 * This module is used by the following key exchanges:
2513 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002514 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002515 * \warning Using DHE constitutes a security risk as it
2516 * is not possible to validate custom DH parameters.
2517 * If possible, it is recommended users should consider
2518 * preferring other methods of key exchange.
2519 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002520 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002521 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002522#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002523
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002525 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002526 *
2527 * Enable the elliptic curve Diffie-Hellman library.
2528 *
2529 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002530 * Caller: library/psa_crypto.c
2531 * library/ssl_tls.c
2532 * library/ssl*_client.c
2533 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002534 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002535 * This module is used by the following key exchanges:
2536 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002537 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002541
2542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002544 *
2545 * Enable the elliptic curve DSA library.
2546 *
2547 * Module: library/ecdsa.c
2548 * Caller:
2549 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002550 * This module is used by the following key exchanges:
2551 * ECDHE-ECDSA
2552 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002553 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2554 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2555 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002557#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002558
2559/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002560 * \def MBEDTLS_ECJPAKE_C
2561 *
2562 * Enable the elliptic curve J-PAKE library.
2563 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002564 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2565 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002566 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002567 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002568 * Module: library/ecjpake.c
2569 * Caller:
2570 *
2571 * This module is used by the following key exchanges:
2572 * ECJPAKE
2573 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002574 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002575 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002576 * \warning If using a hash that is only provided by PSA drivers, you must
2577 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002578 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002579#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002580
2581/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002582 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002583 *
2584 * Enable the elliptic curve over GF(p) library.
2585 *
2586 * Module: library/ecp.c
2587 * Caller: library/ecdh.c
2588 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002589 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002590 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002591 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002592 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002594
2595/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002597 *
2598 * Enable the platform-specific entropy code.
2599 *
2600 * Module: library/entropy.c
2601 * Caller:
2602 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002604 *
2605 * This module provides a generic entropy pool
2606 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002608
2609/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002610 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002611 *
2612 * Enable error code to error string conversion.
2613 *
2614 * Module: library/error.c
2615 * Caller:
2616 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002618 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002619#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002620
2621/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002623 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002624 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002625 *
2626 * Module: library/gcm.c
2627 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002628 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2629 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002630 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002631 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2632 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002633 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002634#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002635
2636/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002637 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002638 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002639 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002640 * Can significantly increase throughput on systems without GCM hardware
2641 * acceleration (e.g., AESNI, AESCE).
2642 *
Matthias Schulz78266782024-02-08 13:54:48 +01002643 * The mbedtls_gcm_context size will increase by 3840 bytes.
2644 * The code size will increase by roughly 344 bytes.
2645 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002646 * Module: library/gcm.c
2647 *
2648 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002649 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002650//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002651
2652/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002653 * \def MBEDTLS_HKDF_C
2654 *
2655 * Enable the HKDF algorithm (RFC 5869).
2656 *
2657 * Module: library/hkdf.c
2658 * Caller:
2659 *
2660 * Requires: MBEDTLS_MD_C
2661 *
2662 * This module adds support for the Hashed Message Authentication Code
2663 * (HMAC)-based key derivation function (HKDF).
2664 */
2665#define MBEDTLS_HKDF_C
2666
2667/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002669 *
2670 * Enable the HMAC_DRBG random generator.
2671 *
2672 * Module: library/hmac_drbg.c
2673 * Caller:
2674 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002676 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002677 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002680
2681/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002682 * \def MBEDTLS_LMS_C
2683 *
2684 * Enable the LMS stateful-hash asymmetric signature algorithm.
2685 *
2686 * Module: library/lms.c
2687 * Caller:
2688 *
Raef Colesab4f8742022-09-01 12:24:31 +01002689 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002690 *
Raef Colesab4f8742022-09-01 12:24:31 +01002691 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002692 */
2693#define MBEDTLS_LMS_C
2694
2695/**
Raef Colesab4f8742022-09-01 12:24:31 +01002696 * \def MBEDTLS_LMS_PRIVATE
2697 *
2698 * Enable LMS private-key operations and signing code. Functions enabled by this
2699 * option are experimental, and should not be used in production.
2700 *
2701 * Requires: MBEDTLS_LMS_C
2702 *
2703 * Uncomment to enable the LMS signature algorithm and private key operations.
2704 */
Raef Coles5127e852022-10-07 10:35:56 +01002705//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002706
2707/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002708 * \def MBEDTLS_NIST_KW_C
2709 *
2710 * Enable the Key Wrapping mode for 128-bit block ciphers,
2711 * as defined in NIST SP 800-38F. Only KW and KWP modes
2712 * are supported. At the moment, only AES is approved by NIST.
2713 *
2714 * Module: library/nist_kw.c
2715 *
2716 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2717 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002718#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002719
2720/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002721 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002722 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002723 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002724 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002725 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2726 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002727 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002728 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002729 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002730 * Caller: library/constant_time.c
2731 * library/ecdsa.c
2732 * library/ecjpake.c
2733 * library/hkdf.c
2734 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002735 * library/pk.c
2736 * library/pkcs5.c
2737 * library/pkcs12.c
2738 * library/psa_crypto_ecp.c
2739 * library/psa_crypto_rsa.c
2740 * library/rsa.c
2741 * library/ssl_cookie.c
2742 * library/ssl_msg.c
2743 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002744 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002745 * library/x509_crt.c
2746 * library/x509write_crt.c
2747 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002748 *
2749 * Uncomment to enable generic message digest wrappers.
2750 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002751#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002752
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002753/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002754 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002755 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002756 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002757 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002758 * Module: library/md5.c
2759 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002760 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002761 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002762 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002763 * This module is required for TLS 1.2 depending on the handshake parameters.
2764 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2765 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002766 *
2767 * \warning MD5 is considered a weak message digest and its use constitutes a
2768 * security risk. If possible, we recommend avoiding dependencies on
2769 * it, and considering stronger message digests instead.
2770 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002773
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002774/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002776 *
2777 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002778 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002779 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002780 *
2781 * Module: library/memory_buffer_alloc.c
2782 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002783 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002784 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002785 *
2786 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002787 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002788//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002789
2790/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002792 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002793 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2794 *
Simon Butcherd567a232016-03-09 20:19:21 +00002795 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2796 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002797 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002798 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002799 * \note See also our Knowledge Base article about porting to a new
2800 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002801 * 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 +00002802 *
Andres AG788aa4a2016-09-14 14:32:09 +01002803 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002804 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002805 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002806 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002807#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002808
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002809/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002811 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002812 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002813 *
2814 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002815 * Caller: library/asn1write.c
2816 * library/pkcs5.c
2817 * library/pkparse.c
2818 * library/pkwrite.c
2819 * library/rsa.c
2820 * library/x509.c
2821 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002822 * library/x509_crl.c
2823 * library/x509_crt.c
2824 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002825 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002826 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002827 *
2828 * This modules translates between OIDs and internal values.
2829 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002831
2832/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002834 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002835 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002836 *
2837 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002838 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002839 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002840 * library/x509_crl.c
2841 * library/x509_crt.c
2842 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002843 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002845 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2846 *
2847 * \warning When parsing password-protected files, if MD5 is provided only by
2848 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002849 *
Paul Bakkercff68422013-09-15 20:43:33 +02002850 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002853
2854/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002856 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002857 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002858 *
2859 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002860 * Caller: library/pkwrite.c
2861 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002862 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002863 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002864 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002865 *
2866 * This modules adds support for encoding / writing PEM files.
2867 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002868#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002869
2870/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002872 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002873 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002874 *
2875 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002876 * Caller: library/psa_crypto_rsa.c
2877 * library/ssl_tls.c
2878 * library/ssl*_client.c
2879 * library/ssl*_server.c
2880 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002881 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002882 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002883 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002884 * Uncomment to enable generic public key wrappers.
2885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002887
2888/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002890 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002891 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002892 *
2893 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002894 * Caller: library/x509_crt.c
2895 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002896 *
Yanray Wang072a0682023-12-05 10:53:04 +08002897 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002898 *
2899 * Uncomment to enable generic public key parse functions.
2900 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002901#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002902
2903/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002905 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002906 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002907 *
2908 * Module: library/pkwrite.c
2909 * Caller: library/x509write.c
2910 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002911 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002912 *
2913 * Uncomment to enable generic public key write functions.
2914 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002916
2917/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002919 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002920 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002921 *
2922 * Module: library/pkcs5.c
2923 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002924 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002925 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002926 * \warning If using a hash that is only provided by PSA drivers, you must
2927 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002928 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002929 * This module adds support for the PKCS#5 functions.
2930 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002932
2933/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002934 * \def MBEDTLS_PKCS7_C
2935 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002936 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002937 * RFC Link - https://tools.ietf.org/html/rfc2315
2938 *
2939 * Module: library/pkcs7.c
2940 *
2941 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002942 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2943 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002944 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002945 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002946 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002947#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002948
2949/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002950 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002951 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002952 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002953 * Adds algorithms for parsing PKCS#8 encrypted private keys
2954 *
2955 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002956 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002957 *
Valerio Settie98ad592023-12-28 10:42:12 +01002958 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2959 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002960 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002961 * \warning If using a hash that is only provided by PSA drivers, you must
2962 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002963 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002964 * This module enables PKCS#12 functions.
2965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002967
2968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002970 *
2971 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002972 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002973 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2975 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002976 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002977 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002978 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002979 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002980 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002981 * Module: library/platform.c
2982 * Caller: Most other .c files
2983 *
2984 * This module enables abstraction of common (libc) functions.
2985 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002986#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002987
2988/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002989 * \def MBEDTLS_POLY1305_C
2990 *
2991 * Enable the Poly1305 MAC algorithm.
2992 *
2993 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002994 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002995 */
2996#define MBEDTLS_POLY1305_C
2997
2998/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002999 * \def MBEDTLS_PSA_CRYPTO_C
3000 *
3001 * Enable the Platform Security Architecture cryptography API.
3002 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003003 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003004 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003005 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003006 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003007 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3008 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3009 * is enabled in PSA (unless it's fully accelerated, see
3010 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003011 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003012#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003013
3014/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003015 * \def MBEDTLS_PSA_CRYPTO_SE_C
3016 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003017 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003018 * cryptography API.
3019 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003020 * \deprecated This feature is deprecated. Please switch to the PSA driver
3021 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003022 *
Ryan Everett32a64582024-03-05 18:16:18 +00003023 * \warning This feature is not thread-safe, and should not be used in a
3024 * multi-threaded environment.
3025 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003026 * Module: library/psa_crypto_se.c
3027 *
3028 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3029 *
3030 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003031//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003032
3033/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003034 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3035 *
3036 * Enable the Platform Security Architecture persistent key storage.
3037 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003038 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003039 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003040 * Requires: MBEDTLS_PSA_CRYPTO_C,
3041 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3042 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003043 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003044#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003045
3046/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003047 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003048 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003049 * Enable the emulation of the Platform Security Architecture
3050 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003051 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003052 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003053 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003054 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003055 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003056#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003057
3058/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003060 *
3061 * Enable the RIPEMD-160 hash algorithm.
3062 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003063 * Module: library/ripemd160.c
3064 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003065 *
3066 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003068
3069/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003070 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003071 *
3072 * Enable the RSA public-key cryptosystem.
3073 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003074 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003075 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003076 * Caller: library/pk.c
3077 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003078 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003079 * library/ssl*_client.c
3080 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003081 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003082 * This module is used by the following key exchanges:
3083 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003084 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003086 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003087#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003088
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003089/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003091 *
3092 * Enable the SHA1 cryptographic hash algorithm.
3093 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003094 * Module: library/sha1.c
3095 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003096 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003097 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003098 * This module is required for TLS 1.2 depending on the handshake parameters,
3099 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003100 *
3101 * \warning SHA-1 is considered a weak message digest and its use constitutes
3102 * a security risk. If possible, we recommend avoiding dependencies
3103 * on it, and considering stronger message digests instead.
3104 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003105 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003106#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003107
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003108/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003109 * \def MBEDTLS_SHA224_C
3110 *
3111 * Enable the SHA-224 cryptographic hash algorithm.
3112 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003113 * Module: library/sha256.c
3114 * Caller: library/md.c
3115 * library/ssl_cookie.c
3116 *
3117 * This module adds support for SHA-224.
3118 */
3119#define MBEDTLS_SHA224_C
3120
3121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003122 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003123 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003124 * Enable the SHA-256 cryptographic hash algorithm.
3125 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003126 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003127 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003128 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003129 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003130 * library/ssl*_client.c
3131 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003132 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003133 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003134 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003137
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003138/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003139 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003140 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003141 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3142 * with the ARMv8 cryptographic extensions if they are available at runtime.
3143 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003144 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003145 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003146 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003147 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003148 * \note Minimum compiler versions for this feature are Clang 4.0,
3149 * armclang 6.6 or GCC 6.0.
3150 *
3151 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3152 * armclang <= 6.9
3153 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003154 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3155 * That name is deprecated, but may still be used as an alternative form for this
3156 * option.
3157 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003158 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3159 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003160 *
3161 * Requires: MBEDTLS_SHA256_C.
3162 *
3163 * Module: library/sha256.c
3164 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003165 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003166 * and use them if available.
3167 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003168//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003169
Dave Rodgmand85277c2023-10-13 09:22:54 +01003170/**
3171 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3172 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003173 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003174 * This name is now deprecated, but may still be used as an alternative form for
3175 * this option.
3176 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003177//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3178
3179/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003180 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003181 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003182 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3183 * with the ARMv8 cryptographic extensions, which must be available at runtime
3184 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003185 *
3186 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003187 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003188 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003189 * \note Minimum compiler versions for this feature are Clang 4.0,
3190 * armclang 6.6 or GCC 6.0.
3191 *
3192 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3193 * armclang <= 6.9
3194 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003195 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003196 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003197 * option.
3198 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003199 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3200 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003201 *
3202 * Requires: MBEDTLS_SHA256_C.
3203 *
3204 * Module: library/sha256.c
3205 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003206 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003207 * unconditionally.
3208 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003209//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003210
Dave Rodgmand85277c2023-10-13 09:22:54 +01003211/**
3212 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3213 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003214 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003215 * This name is now deprecated, but may still be used as an alternative form for
3216 * this option.
3217 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003218//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3219
3220/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003221 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003222 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003223 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003224 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003225 * Module: library/sha512.c
3226 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003227 * library/psa_crypto_hash.c
3228 * library/ssl_tls.c
3229 * library/ssl*_client.c
3230 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003231 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003232 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003233 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003234#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003235
3236/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003237 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003238 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003239 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003240 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003241 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003242 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003243 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003244 * library/ssl_tls.c
3245 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003246 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003247 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003249#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003250
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003251/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003252 * \def MBEDTLS_SHA3_C
3253 *
3254 * Enable the SHA3 cryptographic hash algorithm.
3255 *
3256 * Module: library/sha3.c
3257 *
3258 * This module adds support for SHA3.
3259 */
3260#define MBEDTLS_SHA3_C
3261
3262/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003263 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3264 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003265 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3266 * with the ARMv8 cryptographic extensions if they are available at runtime.
3267 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003268 *
3269 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3270 * for a non-Aarch64 build it will be silently ignored.
3271 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003272 * \note Minimum compiler versions for this feature are Clang 7.0,
3273 * armclang 6.9 or GCC 8.0.
3274 *
3275 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3276 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003277 *
3278 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3279 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3280 *
3281 * Requires: MBEDTLS_SHA512_C.
3282 *
3283 * Module: library/sha512.c
3284 *
3285 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3286 * and use them if available.
3287 */
3288//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3289
3290/**
3291 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3292 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003293 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3294 * with the ARMv8 cryptographic extensions, which must be available at runtime
3295 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003296 *
3297 * \note This allows builds with a smaller code size than with
3298 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3299 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003300 * \note Minimum compiler versions for this feature are Clang 7.0,
3301 * armclang 6.9 or GCC 8.0.
3302 *
3303 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3304 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003305 *
3306 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3307 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3308 *
3309 * Requires: MBEDTLS_SHA512_C.
3310 *
3311 * Module: library/sha512.c
3312 *
3313 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3314 * unconditionally.
3315 */
3316//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3317
3318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003319 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003320 *
3321 * Enable simple SSL cache implementation.
3322 *
3323 * Module: library/ssl_cache.c
3324 * Caller:
3325 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003328#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003329
3330/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003331 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003332 *
3333 * Enable basic implementation of DTLS cookies for hello verification.
3334 *
3335 * Module: library/ssl_cookie.c
3336 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003337 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003339
3340/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003341 * \def MBEDTLS_SSL_TICKET_C
3342 *
3343 * Enable an implementation of TLS server-side callbacks for session tickets.
3344 *
3345 * Module: library/ssl_ticket.c
3346 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003347 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003348 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3349 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003350 */
3351#define MBEDTLS_SSL_TICKET_C
3352
3353/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003354 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003355 *
3356 * Enable the SSL/TLS client code.
3357 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003358 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003359 * Caller:
3360 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003362 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003363 * This module is required for SSL/TLS client support.
3364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003365#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003366
Paul Bakker9a736322012-11-14 12:39:52 +00003367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003369 *
3370 * Enable the SSL/TLS server code.
3371 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003372 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003373 * Caller:
3374 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003376 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003377 * This module is required for SSL/TLS server support.
3378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003380
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003381/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003383 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003384 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003385 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003386 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003387 * Caller: library/ssl*_client.c
3388 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003389 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3391 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003392 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003393 * This module is required for SSL/TLS.
3394 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003396
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003397/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003399 *
3400 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003401 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003402 * contexts are not shared between threads. If you do intend to use contexts
3403 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003404 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003405 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003406 *
3407 * Module: library/threading.c
3408 *
3409 * This allows different threading implementations (self-implemented or
3410 * provided).
3411 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003412 * You will have to enable either MBEDTLS_THREADING_ALT or
3413 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003414 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003415 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003416 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003418
3419/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003421 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003422 * Enable the semi-portable timing interface.
3423 *
Simon Butcherd567a232016-03-09 20:19:21 +00003424 * \note The provided implementation only works on POSIX/Unix (including Linux,
3425 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003426 * module and provide your own implementations of the callbacks needed by
3427 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3428 * your own implementation of the whole module by setting
3429 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003430 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003431 * \note The timing module will include time.h on suitable platforms
3432 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3433 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3434 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003435 * \note See also our Knowledge Base article about porting to a new
3436 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003437 * 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 +00003438 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003439 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003442
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003443/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003445 *
3446 * Enable run-time version information.
3447 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003448 * Module: library/version.c
3449 *
3450 * This module provides run-time version information.
3451 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003452#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003453
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003454/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003456 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003457 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003458 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003459 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003460 * Caller: library/x509_crl.c
3461 * library/x509_crt.c
3462 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003463 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003464 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003465 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3466 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003467 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3468 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003469 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003470 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003471 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003472#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003473
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003474/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003476 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003477 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003478 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003479 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003480 * Caller: library/ssl_tls.c
3481 * library/ssl*_client.c
3482 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003483 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003484 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003485 *
3486 * This module is required for X.509 certificate parsing.
3487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003488#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003489
3490/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003491 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003492 *
3493 * Enable X.509 CRL parsing.
3494 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003495 * Module: library/x509_crl.c
3496 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003497 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003499 *
3500 * This module is required for X.509 CRL parsing.
3501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003502#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003503
3504/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003506 *
3507 * Enable X.509 Certificate Signing Request (CSR) parsing.
3508 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003509 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003510 * Caller: library/x509_crt_write.c
3511 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003513 *
3514 * This module is used for reading X.509 certificate request.
3515 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003516#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003517
3518/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003520 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003521 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003522 *
3523 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003524 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003525 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003526 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3527 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003528 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3529 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003530 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003531 * This module is the basis for creating X.509 certificates and CSRs.
3532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003533#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003534
3535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003537 *
3538 * Enable creating X.509 certificates.
3539 *
3540 * Module: library/x509_crt_write.c
3541 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003543 *
3544 * This module is required for X.509 certificate creation.
3545 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003546#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003547
3548/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003550 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003551 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003552 *
3553 * Module: library/x509_csr_write.c
3554 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003556 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003557 * This module is required for X.509 certificate request writing.
3558 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003559#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003560
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003561/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003562
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003563/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003564 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003565 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003566 * This section contains Mbed TLS build settings that are not associated
3567 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003568 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003569 * \{
3570 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003571
Gilles Peskinea02c1242022-03-16 17:03:19 +01003572/**
3573 * \def MBEDTLS_CONFIG_FILE
3574 *
3575 * If defined, this is a header which will be included instead of
3576 * `"mbedtls/mbedtls_config.h"`.
3577 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003578 * Unlike other configuration options, this one must be defined on the
3579 * compiler command line: a definition in `mbedtls_config.h` would have
3580 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003581 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003582 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003583 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003584 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003585 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003586 * The value of this symbol is typically a path in double quotes, either
3587 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003588 */
3589//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3590
3591/**
3592 * \def MBEDTLS_USER_CONFIG_FILE
3593 *
3594 * If defined, this is a header which will be included after
3595 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003596 * This allows you to modify the default configuration, including the ability
3597 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003598 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003599 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003600 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003601 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003602 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003603 * The value of this symbol is typically a path in double quotes, either
3604 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003605 */
3606//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3607
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003608/**
3609 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3610 *
3611 * If defined, this is a header which will be included instead of
3612 * `"psa/crypto_config.h"`.
3613 * This header file specifies which cryptographic mechanisms are available
3614 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3615 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3616 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003617 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003618 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003619 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003620 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003621 * The value of this symbol is typically a path in double quotes, either
3622 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003623 */
3624//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3625
3626/**
3627 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3628 *
3629 * If defined, this is a header which will be included after
3630 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003631 * This allows you to modify the default configuration, including the ability
3632 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003633 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003634 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003635 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003636 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003637 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003638 * The value of this symbol is typically a path in double quotes, either
3639 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003640 */
3641//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3642
Gilles Peskineb1176f22023-02-22 22:07:28 +01003643/**
3644 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3645 *
3646 * If defined, this is a header which will be included instead of
3647 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3648 * as the one in Mbed TLS, but with definitions adapted to the platform on
3649 * which the library code will run.
3650 *
3651 * \note The required content of this header can vary from one version of
3652 * Mbed TLS to the next. Integrators who provide an alternative file
3653 * should review the changes in the original file whenever they
3654 * upgrade Mbed TLS.
3655 *
3656 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3657 * non-standard feature of the C language, so this feature is only available
3658 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3659 *
3660 * The value of this symbol is typically a path in double quotes, either
3661 * absolute or relative to a directory on the include search path.
3662 */
3663//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3664
3665/**
3666 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3667 *
3668 * If defined, this is a header which will be included instead of
3669 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3670 * as the one in Mbed TLS, but with definitions adapted to the environment
3671 * in which the library code will run. The typical use for this feature
3672 * is to provide alternative type definitions on the client side in
3673 * client-server integrations of PSA crypto, where operation structures
3674 * contain handles instead of cryptographic data.
3675 *
3676 * \note The required content of this header can vary from one version of
3677 * Mbed TLS to the next. Integrators who provide an alternative file
3678 * should review the changes in the original file whenever they
3679 * upgrade Mbed TLS.
3680 *
3681 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3682 * non-standard feature of the C language, so this feature is only available
3683 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3684 *
3685 * The value of this symbol is typically a path in double quotes, either
3686 * absolute or relative to a directory on the include search path.
3687 */
3688//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3689
Gilles Peskineba4162a2022-04-11 17:04:38 +02003690/** \} name SECTION: General configuration options */
3691
3692/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003693 * \name SECTION: Module configuration options
3694 *
3695 * This section allows for the setting of module specific sizes and
3696 * configuration options. The default values are already present in the
3697 * relevant header files and should suffice for the regular use cases.
3698 *
3699 * Our advice is to enable options and change their values here
3700 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003701 * \{
3702 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003703/* The Doxygen documentation here is used when a user comments out a
3704 * setting and runs doxygen themselves. On the other hand, when we typeset
3705 * the full documentation including disabled settings, the documentation
3706 * in specific modules' header files is used if present. When editing this
3707 * file, make sure that each option is documented in exactly one place,
3708 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3709 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003710
Paul Bakker088c5c52014-04-25 11:11:10 +02003711/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003712//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003713//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003714
Paul Bakker088c5c52014-04-25 11:11:10 +02003715/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003716//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3717//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3718//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3719//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3720//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003721
Paul Bakker088c5c52014-04-25 11:11:10 +02003722/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003723//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3724//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3725//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3726//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003727
Paul Bakker088c5c52014-04-25 11:11:10 +02003728/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003729//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003730//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003731
Paul Bakker088c5c52014-04-25 11:11:10 +02003732/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003733//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3734//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003735//#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 +01003736
Paul Bakker088c5c52014-04-25 11:11:10 +02003737/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003738//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003739
Paul Bakker088c5c52014-04-25 11:11:10 +02003740/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003741//#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 -04003742
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003743/** \def MBEDTLS_PLATFORM_STD_CALLOC
3744 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003745 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003746 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003747 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003748 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003749 * 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 -04003750 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3751 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003752 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003753 */
3754//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003755
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003756/** \def MBEDTLS_PLATFORM_STD_FREE
3757 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003758 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003759 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003760 * 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 -04003761 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3762 * 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 -04003763 */
3764//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003765//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003766//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003767//#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 +02003768//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3769//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003770/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003771//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003772//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3773//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003774//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3775//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3776//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003777
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003778/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003779/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003780//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3781//#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 +02003782//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003783//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003784//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3785//#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 +02003786//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3787//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003788/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003789//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003790//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003791//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3792//#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 +08003793//#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 +08003794//#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 +02003795
Gilles Peskine3f106f72021-09-23 17:42:39 +02003796/** \def MBEDTLS_CHECK_RETURN
3797 *
3798 * This macro is used at the beginning of the declaration of a function
3799 * to indicate that its return value should be checked. It should
3800 * instruct the compiler to emit a warning or an error if the function
3801 * is called without checking its return value.
3802 *
3803 * There is a default implementation for popular compilers in platform_util.h.
3804 * You can override the default implementation by defining your own here.
3805 *
3806 * If the implementation here is empty, this will effectively disable the
3807 * checking of functions' return values.
3808 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003809//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003810
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003811/** \def MBEDTLS_IGNORE_RETURN
3812 *
3813 * This macro requires one argument, which should be a C function call.
3814 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3815 * warning is suppressed.
3816 */
3817//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3818
Gilles Peskineed038902020-11-13 21:33:21 +01003819/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003820/**
Gilles Peskineed038902020-11-13 21:33:21 +01003821 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3822 * PSA crypto subsystem.
3823 *
3824 * If this option is unset:
3825 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003826 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003827 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3828 * on unspecified heuristics.
3829 */
3830//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3831
Steven Cooreman863470a2021-02-15 14:03:19 +01003832/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003833 * Restrict the PSA library to supporting a maximum amount of simultaneously
3834 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3835 * volatile key, or a persistent key which is loaded temporarily by the
3836 * library as part of a crypto operation in flight.
3837 *
3838 * If this option is unset, the library will fall back to a default value of
3839 * 32 keys.
3840 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003841//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003842
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003843/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003844//#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 +00003845
Paul Bakker088c5c52014-04-25 11:11:10 +02003846/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003847//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3848//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003849
Paul Bakker088c5c52014-04-25 11:11:10 +02003850/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003851
Angus Grattond8213d02016-05-25 20:56:48 +10003852/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3853 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003854 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003855 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003856 * This determines the size of the incoming TLS I/O buffer in such a way
3857 * that it is capable of holding the specified amount of plaintext data,
3858 * regardless of the protection mechanism used.
3859 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003860 * \note When using a value less than the default of 16KB on the client, it is
3861 * recommended to use the Maximum Fragment Length (MFL) extension to
3862 * inform the server about this limitation. On the server, there
3863 * is no supported, standardized way of informing the client about
3864 * restriction on the maximum size of incoming messages, and unless
3865 * the limitation has been communicated by other means, it is recommended
3866 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3867 * while keeping the default value of 16KB for the incoming buffer.
3868 *
David Horstmann95d516f2021-05-04 18:36:56 +01003869 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003870 */
3871//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3872
Gilles Peskined3d02902020-03-04 21:35:27 +01003873/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3874 *
3875 * The maximum length of CIDs used for incoming DTLS messages.
3876 *
3877 */
3878//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3879
3880/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3881 *
3882 * The maximum length of CIDs used for outgoing DTLS messages.
3883 *
3884 */
3885//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3886
TRodziewicze8dd7092021-05-12 14:19:11 +02003887/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003888 *
3889 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003890 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003891 *
3892 * The padding will always be chosen so that the length of the
3893 * padded plaintext is a multiple of the value of this option.
3894 *
3895 * Note: A value of \c 1 means that no padding will be used
3896 * for outgoing records.
3897 *
3898 * Note: On systems lacking division instructions,
3899 * a power of two should be preferred.
3900 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003901//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003902
Angus Grattond8213d02016-05-25 20:56:48 +10003903/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3904 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003905 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003906 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003907 * This determines the size of the outgoing TLS I/O buffer in such a way
3908 * that it is capable of holding the specified amount of plaintext data,
3909 * regardless of the protection mechanism used.
3910 *
Angus Grattond8213d02016-05-25 20:56:48 +10003911 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3912 * the default inward 16384 byte buffer to conform to the TLS specification.
3913 *
3914 * The minimum required outward buffer size is determined by the handshake
3915 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3916 * The specific size requirement depends on the configured ciphers and any
3917 * certificate data which is sent during the handshake.
3918 *
David Horstmann95d516f2021-05-04 18:36:56 +01003919 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003920 */
3921//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3922
Hanno Beckere0b150f2018-08-21 15:51:03 +01003923/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3924 *
3925 * Maximum number of heap-allocated bytes for the purpose of
3926 * DTLS handshake message reassembly and future message buffering.
3927 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003928 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003929 * to account for a reassembled handshake message of maximum size,
3930 * together with its reassembly bitmap.
3931 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003932 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003933 * should be sufficient for all practical situations as it allows
3934 * to reassembly a large handshake message (such as a certificate)
3935 * while buffering multiple smaller handshake messages.
3936 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003937 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003938//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003939
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003940//#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 +02003941//#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 +02003942
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003943/**
3944 * Complete list of ciphersuites to use, in order of preference.
3945 *
3946 * \warning No dependency checking is done on that field! This option can only
3947 * be used to restrict the set of available ciphersuites. It is your
3948 * responsibility to make sure the needed modules are active.
3949 *
3950 * Use this to save a few hundred bytes of ROM (default ordering of all
3951 * available ciphersuites) and a few to a few hundred bytes of RAM.
3952 *
3953 * The value below is only an example, not the default.
3954 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003955//#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 +02003956
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003957/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003958 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3959 *
3960 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003961 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003962 *
3963 * It must be positive and smaller than UINT32_MAX.
3964 *
3965 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3966 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003967 */
3968//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3969
3970/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003971 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3972 *
Jerry Yucf913512023-11-14 11:06:52 +08003973 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003974 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003975 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003976 * - The client ticket age is the time difference between the time when the
3977 * client proposes to the server to use the ticket and the time the client
3978 * received the ticket from the server.
3979 * - The server ticket age is the time difference between the time when the
3980 * server receives a proposition from the client to use the ticket and the
3981 * time when the ticket was created by the server.
3982 *
Jerry Yucf913512023-11-14 11:06:52 +08003983 * The ages might be different due to the client and server clocks not running
3984 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3985 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3986 * 6s, thus in the worst case clients and servers must sync up their system time
3987 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003988 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003989 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003990 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003991//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003992
3993/**
3994 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3995 *
3996 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3997 *
3998 * This must be less than 256.
3999 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004000//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004001
4002/**
4003 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4004 *
4005 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4006 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4007 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4008 *
4009 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004010//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004011
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004012/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004013//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004014//#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 +01004015
Gilles Peskine611179c2022-04-13 23:04:48 +02004016/** \} name SECTION: Module configuration options */