blob: 3881dbb114b754269e0d7efe872db64917263f19 [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
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200353/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200354 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200355 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200356 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200357 * hardware entropy collector.
358 *
359 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000360 * prototype as declared in library/entropy_poll.h, and accept NULL as first
361 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200362 *
363 * Uncomment to use your own hardware entropy collector.
364 */
365//#define MBEDTLS_ENTROPY_HARDWARE_ALT
366
367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000369 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100370 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000371 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100372 * Uncomment this macro to use precomputed AES tables stored in ROM.
373 * Comment this macro to generate AES tables in RAM at runtime.
374 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100375 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
376 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100377 * initialization time before the first AES operation can be performed.
378 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
379 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
380 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100381 *
382 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000385
386/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100387 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200388 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100389 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200390 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100391 * Uncommenting this macro omits 75% of the AES tables from
392 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
393 * by computing their values on the fly during operations
394 * (the tables are entry-wise rotations of one another).
395 *
396 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100397 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100398 * runtime. Specifically, one has to compare 4 accesses within
399 * different tables to 4 accesses with additional arithmetic
400 * operations within the same table. The performance gain/loss
401 * depends on the system and memory details.
402 *
403 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200404 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100405//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200406
407/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800408 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
409 *
410 * Use only 128-bit keys in AES operations to save ROM.
411 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800412 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800413 * or 256-bit keys.
414 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800415 * Uncommenting this macro reduces the size of AES code by ~300 bytes
416 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800417 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800418 * Module: library/aes.c
419 *
420 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800421 */
422//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
423
Gilles Peskinea8861e02023-09-05 20:20:51 +0200424/*
425 * Disable plain C implementation for AES.
426 *
427 * When the plain C implementation is enabled, and an implementation using a
428 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
429 * detection will be used to select between them.
430 *
431 * If only one implementation is present, runtime detection will not be used.
432 * This configuration will crash at runtime if running on a CPU without the
433 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
434 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
435 */
436//#define MBEDTLS_AES_USE_HARDWARE_ONLY
437
Arto Kinnunen732ca322023-04-14 14:26:10 +0800438/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200440 *
441 * Use less ROM for the Camellia implementation (saves about 768 bytes).
442 *
443 * Uncomment this macro to use less memory for Camellia.
444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200446
447/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200448 * \def MBEDTLS_CHECK_RETURN_WARNING
449 *
450 * If this macro is defined, emit a compile-time warning if application code
451 * calls a function without checking its return value, but the return value
452 * should generally be checked in portable applications.
453 *
454 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
455 * implemented. Otherwise this option has no effect.
456 *
457 * Uncomment to get warnings on using fallible functions without checking
458 * their return value.
459 *
460 * \note This feature is a work in progress.
461 * Warnings will be added to more functions in the future.
462 *
463 * \note A few functions are considered critical, and ignoring the return
464 * value of these functions will trigger a warning even if this
465 * macro is not defined. To completely disable return value check
466 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
467 */
468//#define MBEDTLS_CHECK_RETURN_WARNING
469
470/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200471 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200472 *
473 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200475#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200476
477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000479 *
480 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000483
484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200485 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000486 *
487 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200489#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000490
491/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100492 * \def MBEDTLS_CIPHER_MODE_OFB
493 *
494 * Enable Output Feedback mode (OFB) for symmetric ciphers.
495 */
496#define MBEDTLS_CIPHER_MODE_OFB
497
498/**
499 * \def MBEDTLS_CIPHER_MODE_XTS
500 *
501 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
502 */
503#define MBEDTLS_CIPHER_MODE_XTS
504
505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200506 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000507 *
508 * Enable NULL cipher.
509 * Warning: Only do so when you know what you are doing. This allows for
510 * encryption or channels without any security!
511 *
Ronald Croncee42702021-04-26 11:34:44 +0200512 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
514 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
515 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
516 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
517 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
518 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
519 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
520 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
521 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
522 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
523 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
524 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
525 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
526 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
527 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
528 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
529 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
530 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
531 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000532 *
533 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000536
537/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100538 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200539 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100540 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
541 * specific padding modes in the cipher layer with cipher modes that support
542 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200543 *
544 * If you disable all padding modes, only full blocks can be used with CBC.
545 *
546 * Enable padding modes in the cipher layer.
547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548#define MBEDTLS_CIPHER_PADDING_PKCS7
549#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
550#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
551#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200552
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200553/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
554 *
555 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800556 * Without this, CTR_DRBG uses a 256-bit key
557 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200558 */
559//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
560
Paul Bakker48e93c82013-08-14 12:21:18 +0200561/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200562 * Enable the verified implementations of ECDH primitives from Project Everest
563 * (currently only Curve25519). This feature changes the layout of ECDH
564 * contexts and therefore is a compatibility break for applications that access
565 * fields of a mbedtls_ecdh_context structure directly. See also
566 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000567 *
568 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
569 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200570 */
571//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
572
573/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100574 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200575 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100576 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
577 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200578 *
579 * Comment macros to disable the curve and functions for it
580 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200581/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200582#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
583#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
584#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
585#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
586#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
587#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
588#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
589#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
590#define MBEDTLS_ECP_DP_BP256R1_ENABLED
591#define MBEDTLS_ECP_DP_BP384R1_ENABLED
592#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200593/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200594#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000595#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200596
597/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200599 *
600 * Enable specific 'modulo p' routines for each NIST prime.
601 * Depending on the prime and architecture, makes operations 4 to 8 times
602 * faster on the corresponding curve.
603 *
604 * Comment this macro to disable NIST curves optimisation.
605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200607
608/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200609 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100610 *
611 * Enable "non-blocking" ECC operations that can return early and be resumed.
612 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200613 * This allows various functions to pause by returning
614 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
615 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
616 * order to further progress and eventually complete their operation. This is
617 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
618 * number of ECC operations a function may perform before pausing; see
619 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100620 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200621 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200622 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100623 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100624 * This option:
625 * - Adds xxx_restartable() variants of existing operations in the
626 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100627 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
628 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100629 * - ECDSA: signature generation & verification;
630 * - PK: signature generation & verification;
631 * - X509: certificate chain verification.
632 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
633 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
634 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
635 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000636 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100637 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100638 * - verification of the server's key exchange signature;
639 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100640 * - generation of the client's signature if client authentication is used,
641 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100642 *
643 * \note In the cases above, the usual SSL/TLS functions, such as
644 * mbedtls_ssl_handshake(), can now return
645 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200646 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100647 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
648 * restartable operations in PK, X.509 and TLS (see above) are not
649 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100650 * PSA, and are not restartable. These are temporary limitations that
651 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200652 *
Ron Eldor19779c42018-11-05 16:58:13 +0200653 * \note This option only works with the default software implementation of
654 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100655 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100656 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100657 * Requires: MBEDTLS_ECP_C
658 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100659 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100660 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200661//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100662
663/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200664 * Uncomment to enable using new bignum code in the ECC modules.
665 *
666 * \warning This is currently experimental, incomplete and therefore should not
667 * be used in production.
668 */
669//#define MBEDTLS_ECP_WITH_MPI_UINT
670
671/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100673 *
674 * Enable deterministic ECDSA (RFC 6979).
675 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
676 * may result in a compromise of the long-term signing key. This is avoided by
677 * the deterministic variant.
678 *
John Durkop36a82e52020-10-26 09:39:05 -0700679 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100680 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100681 * Comment this macro to disable deterministic ECDSA.
682 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200683#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100684
685/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200687 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200688 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200689 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200690 * This enables the following ciphersuites (if other requisites are
691 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200692 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
693 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
694 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
695 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
696 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
697 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
698 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
699 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
700 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
701 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200702 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200704
705/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200707 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200708 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200709 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200711 *
712 * This enables the following ciphersuites (if other requisites are
713 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
715 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
716 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
717 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
718 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
719 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
720 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
721 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
722 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
723 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100724 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100725 * \warning Using DHE constitutes a security risk as it
726 * is not possible to validate custom DH parameters.
727 * If possible, it is recommended users should consider
728 * preferring other methods of key exchange.
729 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100730 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200731 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200732#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200733
734/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200735 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200736 *
737 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
738 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200739 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200740 *
741 * This enables the following ciphersuites (if other requisites are
742 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200743 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
744 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
745 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
746 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
747 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
748 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200749 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200750#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200751
752/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200753 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200754 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200755 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200756 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
758 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200759 *
760 * This enables the following ciphersuites (if other requisites are
761 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
763 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
764 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
765 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
766 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
767 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
768 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
769 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
770 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
771 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200772 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200773#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200774
775/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200776 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200777 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200778 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200779 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
781 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200782 *
783 * This enables the following ciphersuites (if other requisites are
784 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
786 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
787 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
788 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
789 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
790 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
791 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
792 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
793 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
794 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
795 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
796 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200799
800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200801 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200802 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200803 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200804 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
806 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200807 *
808 * This enables the following ciphersuites (if other requisites are
809 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
811 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
812 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
813 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
814 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
815 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
816 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
817 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
818 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
819 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
820 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
821 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100822 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100823 * \warning Using DHE constitutes a security risk as it
824 * is not possible to validate custom DH parameters.
825 * If possible, it is recommended users should consider
826 * preferring other methods of key exchange.
827 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100828 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200829 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200830#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200831
832/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200833 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200834 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200835 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200837 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
838 * MBEDTLS_RSA_C
839 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200841 *
842 * This enables the following ciphersuites (if other requisites are
843 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
845 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
846 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
847 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
848 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
849 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
850 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
851 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
852 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
853 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200854 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200855#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856
857/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200859 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200860 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200861 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200862 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
863 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
864 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200865 *
866 * This enables the following ciphersuites (if other requisites are
867 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
869 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
870 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
871 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
872 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
873 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
874 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
875 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
876 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
877 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200878 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200880
881/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100883 *
884 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
885 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200886 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
887 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
888 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100889 *
890 * This enables the following ciphersuites (if other requisites are
891 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
893 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
894 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
895 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
896 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
897 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
898 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
899 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
900 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
901 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100902 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200903#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100904
905/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100907 *
908 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
909 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200910 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
911 * MBEDTLS_RSA_C
912 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100913 *
914 * This enables the following ciphersuites (if other requisites are
915 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
917 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
918 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
919 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
920 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
921 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
922 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
923 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
924 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
925 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100926 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100928
929/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200930 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
931 *
932 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
933 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200934 * \warning This is currently experimental. EC J-PAKE support is based on the
935 * Thread v1.0.0 specification; incompatible changes to the specification
936 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200937 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200938 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100939 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200940 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
941 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100942 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800943 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100944 * MBEDTLS_USE_PSA_CRYPTO is disabled).
945 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200946 * This enables the following ciphersuites (if other requisites are
947 * enabled as well):
948 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
949 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200950//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200951
952/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200953 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100954 *
955 * Enhance support for reading EC keys using variants of SEC1 not allowed by
956 * RFC 5915 and RFC 5480.
957 *
958 * Currently this means parsing the SpecifiedECDomain choice of EC
959 * parameters (only known groups are supported, not arbitrary domains, to
960 * avoid validation issues).
961 *
962 * Disable if you only need to support RFC 5915 + 5480 key formats.
963 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100965
966/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200967 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
968 *
969 * Enable the support for parsing public keys of type Short Weierstrass
970 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200971 * compressed point format. This parsing is done through ECP module's functions.
972 *
973 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
974 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
975 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200976 */
977#define MBEDTLS_PK_PARSE_EC_COMPRESSED
978
979/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200980 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100981 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982 * Enable a dummy error function to make use of mbedtls_strerror() in
983 * third party libraries easier when MBEDTLS_ERROR_C is disabled
984 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200985 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
987 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100988 *
989 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100991 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100993
994/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200995 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000996 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +0200997 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200998 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200999 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001000 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001002
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001003/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001005 *
1006 * Enable functions that use the filesystem.
1007 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001009
1010/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001012 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001013 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001014 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001015 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001016 * application.
1017 *
1018 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001019 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001021
1022/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001024 *
1025 * Do not use built-in platform entropy functions.
1026 * This is useful if your platform does not support
1027 * standards like the /dev/urandom or Windows CryptoAPI.
1028 *
1029 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001032
1033/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001035 *
1036 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1037 * default SHA-512 based one (if both are available).
1038 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001040 *
1041 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1042 * if you have performance concerns.
1043 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * This option is only useful if both MBEDTLS_SHA256_C and
1045 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001046 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001048
1049/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001050 * \def MBEDTLS_ENTROPY_NV_SEED
1051 *
1052 * Enable the non-volatile (NV) seed file-based entropy source.
1053 * (Also enables the NV seed read/write functions in the platform layer)
1054 *
1055 * This is crucial (if not required) on systems that do not have a
1056 * cryptographic entropy source (in hardware or kernel) available.
1057 *
1058 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1059 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001060 * \note The read/write functions that are used by the entropy source are
1061 * determined in the platform layer, and can be modified at runtime and/or
1062 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1063 *
1064 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001065 * with regular fopen(), please make sure you make a seedfile with the
1066 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1067 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001068 * and written to or you will get an entropy source error! The default
1069 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1070 * bytes from the file.
1071 *
1072 * \note The entropy collector will write to the seed file before entropy is
1073 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001074 */
1075//#define MBEDTLS_ENTROPY_NV_SEED
1076
Ronald Cron71016a92020-08-28 19:01:50 +02001077/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001078 *
Ronald Cron71016a92020-08-28 19:01:50 +02001079 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001080 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001081 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1082 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001083 *
1084 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001085 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001086 */
Ronald Cron71016a92020-08-28 19:01:50 +02001087//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001088
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001089/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001091 *
1092 * Enable debugging of buffer allocator memory issues. Automatically prints
1093 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1094 * function for 'debug output' of allocated memory.
1095 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001097 *
1098 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001099 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001101
1102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001104 *
1105 * Include backtrace information with each allocated block.
1106 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001108 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001109 *
1110 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001111 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001113
1114/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001116 *
1117 * Support external private RSA keys (eg from a HSM) in the PK layer.
1118 *
1119 * Comment this macro to disable support for external private RSA keys.
1120 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001121#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001122
1123/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001124 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001125 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001126 * Enable support for PKCS#1 v1.5 encoding.
1127 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001128 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001129 *
Paul Bakker48377d92013-08-30 12:06:24 +02001130 * This enables support for PKCS#1 v1.5 operations.
1131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001133
1134/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001135 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001136 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001137 * Enable support for PKCS#1 v2.1 encoding.
1138 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001139 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001140 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001141 * \warning If using a hash that is only provided by PSA drivers, you must
1142 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001143 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001144 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1145 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001146#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001147
Steven Cooreman6801f082021-02-19 17:21:22 +01001148/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1149 *
1150 * Enable support for platform built-in keys. If you enable this feature,
1151 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1152 * See the documentation of that function for more information.
1153 *
1154 * Built-in keys are typically derived from a hardware unique key or
1155 * stored in a secure element.
1156 *
1157 * Requires: MBEDTLS_PSA_CRYPTO_C.
1158 *
1159 * \warning This interface is experimental and may change or be removed
1160 * without notice.
1161 */
1162//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1163
Ronald Cron3768ac12021-01-26 16:58:00 +01001164/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1165 *
1166 * Enable support for PSA crypto client.
1167 *
1168 * \note This option allows to include the code necessary for a PSA
1169 * crypto client when the PSA crypto implementation is not included in
1170 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1171 * code to set and get PSA key attributes.
1172 * The development of PSA drivers partially relying on the library to
1173 * fulfill the hardware gaps is another possible usage of this option.
1174 *
1175 * \warning This interface is experimental and may change or be removed
1176 * without notice.
1177 */
1178//#define MBEDTLS_PSA_CRYPTO_CLIENT
1179
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001180/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1181 *
1182 * Make the PSA Crypto module use an external random generator provided
1183 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1184 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001185 * \note This random generator must deliver random numbers with cryptographic
1186 * quality and high performance. It must supply unpredictable numbers
1187 * with a uniform distribution. The implementation of this function
1188 * is responsible for ensuring that the random generator is seeded
1189 * with sufficient entropy. If you have a hardware TRNG which is slow
1190 * or delivers non-uniform output, declare it as an entropy source
1191 * with mbedtls_entropy_add_source() instead of enabling this option.
1192 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001193 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001194 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1195 * and define a function called mbedtls_psa_external_get_random()
1196 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001197 * ```
1198 * psa_status_t mbedtls_psa_external_get_random(
1199 * mbedtls_psa_external_random_context_t *context,
1200 * uint8_t *output, size_t output_size, size_t *output_length);
1201 * );
1202 * ```
1203 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001204 * The function must fill the \c output buffer with \c output_size bytes
1205 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001206 *
1207 * Requires: MBEDTLS_PSA_CRYPTO_C
1208 *
1209 * \warning If you enable this option, code that uses the PSA cryptography
1210 * interface will not use any of the entropy sources set up for
1211 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1212 * enables.
1213 *
1214 * \note This option is experimental and may be removed without notice.
1215 */
1216//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1217
Paul Bakker9dcc3222011-03-08 14:16:06 +00001218/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001219 * \def MBEDTLS_PSA_CRYPTO_SPM
1220 *
1221 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1222 * Partition Manager) integration which separates the code into two parts: a
1223 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1224 * Environment).
1225 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001226 * If you enable this option, your build environment must include a header
1227 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1228 * header files, or in another directory on the compiler's include search
1229 * path). Alternatively, your platform may customize the header
1230 * `psa/crypto_platform.h`, in which case it can skip or replace the
1231 * inclusion of `"crypto_spe.h"`.
1232 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001233 * Module: library/psa_crypto.c
1234 * Requires: MBEDTLS_PSA_CRYPTO_C
1235 *
1236 */
1237//#define MBEDTLS_PSA_CRYPTO_SPM
1238
1239/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001240 * Uncomment to enable p256-m. This is an alternative implementation of
1241 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1242 * Compared to the default implementation:
1243 *
1244 * - p256-m has a much smaller code size and RAM footprint.
1245 * - p256-m is only available via the PSA API. This includes the pk module
1246 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1247 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1248 * over the core arithmetic, or deterministic derivation of keys.
1249 *
1250 * We recommend enabling this option if your application uses the PSA API
1251 * and the only elliptic curve support it needs is ECDH and ECDSA over
1252 * SECP256R1.
1253 *
1254 * If you enable this option, you do not need to enable any ECC-related
1255 * MBEDTLS_xxx option. You do need to separately request support for the
1256 * cryptographic mechanisms through the PSA API:
1257 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1258 * configuration;
1259 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1260 * - #PSA_WANT_ECC_SECP_R1_256;
1261 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1262 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1263 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1264 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1265 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001266 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001267 * \note To benefit from the smaller code size of p256-m, make sure that you
1268 * do not enable any ECC-related option not supported by p256-m: this
1269 * would cause the built-in ECC implementation to be built as well, in
1270 * order to provide the required option.
1271 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001272 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1273 * SECP256R1 are disabled as they are not supported by this driver.
1274 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1275 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001276 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001277 */
1278//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1279
1280/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001281 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001282 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001283 * Enable support for entropy injection at first boot. This feature is
1284 * required on systems that do not have a built-in entropy source (TRNG).
1285 * This feature is currently not supported on systems that have a built-in
1286 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001287 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001288 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001289 *
1290 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001291//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001292
1293/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001294 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001295 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001296 * Assume all buffers passed to PSA functions are owned exclusively by the
1297 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001298 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001299 * This option may be enabled if all buffers passed to any PSA function reside
1300 * in memory that is accessible only to the PSA function during its execution.
1301 *
1302 * This option MUST be disabled whenever buffer arguments are in memory shared
1303 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001304 * across a trust boundary.
1305 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001306 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001307 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001308 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001309 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001310 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001311//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001312
1313/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001315 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001316 * Do not use the Chinese Remainder Theorem
1317 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001318 *
1319 * Uncomment this macro to disable the use of CRT in RSA.
1320 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001321 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001323
1324/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001325 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001326 *
1327 * Enable the checkup functions (*_self_test).
1328 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001329#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001330
1331/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001332 * \def MBEDTLS_SHA256_SMALLER
1333 *
1334 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1335 * lower performance.
1336 *
Adam Wolf039080f2019-09-10 09:53:08 -05001337 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001338 * performance and size. This version optimizes more aggressively for size at
1339 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1340 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1341 * 30%.
1342 *
1343 * Uncomment to enable the smaller implementation of SHA256.
1344 */
1345//#define MBEDTLS_SHA256_SMALLER
1346
1347/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001348 * \def MBEDTLS_SHA512_SMALLER
1349 *
1350 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1351 * lower performance.
1352 *
1353 * Uncomment to enable the smaller implementation of SHA512.
1354 */
1355//#define MBEDTLS_SHA512_SMALLER
1356
1357/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001358 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001359 *
1360 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001361 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001362 * with other servers, only debugging of failures is harder.
1363 *
1364 * The advantage of not sending alert messages, is that no information is given
1365 * about reasons for failures thus preventing adversaries of gaining intel.
1366 *
1367 * Enable sending of all alert messages
1368 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001369#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001370
1371/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001372 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1373 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001374 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001375 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001376 * in the underlying transport. The CID functionality is described
1377 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001378 *
1379 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001380 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1381 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1382 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001383 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001384 * The maximum lengths of outgoing and incoming CIDs can be configured
1385 * through the options
1386 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1387 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1388 *
1389 * Requires: MBEDTLS_SSL_PROTO_DTLS
1390 *
1391 * Uncomment to enable the Connection ID extension.
1392 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001393#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1394
1395
1396/**
1397 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1398 *
1399 * Defines whether RFC 9146 (default) or the legacy version
1400 * (version draft-ietf-tls-dtls-connection-id-05,
1401 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1402 * is used.
1403 *
1404 * Set the value to 0 for the standard version, and
1405 * 1 for the legacy draft version.
1406 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001407 * \deprecated Support for the legacy version of the DTLS
1408 * Connection ID feature is deprecated. Please
1409 * switch to the standardized version defined
1410 * in RFC 9146 enabled by utilizing
1411 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1412 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1413 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001414 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1415 */
1416#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001417
1418/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001419 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1420 *
1421 * Enable asynchronous external private key operations in SSL. This allows
1422 * you to configure an SSL connection to call an external cryptographic
1423 * module to perform private key operations instead of performing the
1424 * operation inside the library.
1425 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001426 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001427 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001428//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001429
1430/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001431 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1432 *
1433 * Enable serialization of the TLS context structures, through use of the
1434 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1435 *
1436 * This pair of functions allows one side of a connection to serialize the
1437 * context associated with the connection, then free or re-use that context
1438 * while the serialized state is persisted elsewhere, and finally deserialize
1439 * that state to a live context for resuming read/write operations on the
1440 * connection. From a protocol perspective, the state of the connection is
1441 * unaffected, in particular this is entirely transparent to the peer.
1442 *
1443 * Note: this is distinct from TLS session resumption, which is part of the
1444 * protocol and fully visible by the peer. TLS session resumption enables
1445 * establishing new connections associated to a saved session with shorter,
1446 * lighter handshakes, while context serialization is a local optimization in
1447 * handling a single, potentially long-lived connection.
1448 *
1449 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1450 * saved after the handshake to allow for more efficient serialization, so if
1451 * you don't need this feature you'll save RAM by disabling it.
1452 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001453 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1454 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001455 * Comment to disable the context serialization APIs.
1456 */
1457#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1458
1459/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001460 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001461 *
1462 * Enable the debug messages in SSL module for all issues.
1463 * Debug messages have been disabled in some places to prevent timing
1464 * attacks due to (unbalanced) debugging function calls.
1465 *
1466 * If you need all error reporting you should enable this during debugging,
1467 * but remove this for production servers that should log as well.
1468 *
1469 * Uncomment this macro to report all debug messages on errors introducing
1470 * a timing side-channel.
1471 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001473//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001474
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001475/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001476 *
1477 * Enable support for Encrypt-then-MAC, RFC 7366.
1478 *
1479 * This allows peers that both support it to use a more robust protection for
1480 * ciphersuites using CBC, providing deep resistance against timing attacks
1481 * on the padding or underlying cipher.
1482 *
1483 * This only affects CBC ciphersuites, and is useless if none is defined.
1484 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001485 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001486 *
1487 * Comment this macro to disable support for Encrypt-then-MAC
1488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001489#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001490
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001491/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001492 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001493 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1494 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001495 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001496 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001497 * attacks, but it is recommended to always use it (even if you disable
1498 * renegotiation), since it actually fixes a more fundamental issue in the
1499 * original SSL/TLS design, and has implications beyond Triple Handshake.
1500 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001501 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001502 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001503 * Comment this macro to disable support for Extended Master Secret.
1504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001505#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001506
Paul Bakkerd66f0702013-01-31 16:57:45 +01001507/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001508 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1509 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001510 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001511 * giving access to the peer's certificate after completion of the handshake.
1512 *
1513 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1514 * recommended to disable this option for reduced RAM usage.
1515 *
1516 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1517 * defined, but always returns \c NULL.
1518 *
1519 * \note This option has no influence on the protection against the
1520 * triple handshake attack. Even if it is disabled, Mbed TLS will
1521 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001522 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001523 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001524 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001525 *
1526 * Comment this macro to disable storing the peer's certificate
1527 * after the handshake.
1528 */
1529#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1530
1531/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001532 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001533 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001534 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001535 *
1536 * The two main uses of renegotiation are (1) refresh keys on long-lived
1537 * connections and (2) client authentication after the initial handshake.
1538 * If you don't need renegotiation, it's probably better to disable it, since
1539 * it has been associated with security issues in the past and is easy to
1540 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001541 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001542 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1543 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001544 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001545 *
1546 * \note Even if this option is disabled, both client and server are aware
1547 * of the Renegotiation Indication Extension (RFC 5746) used to
1548 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1549 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1550 * configuration of this extension).
1551 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001553#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001554
1555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001557 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001558 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001559 *
1560 * Comment this macro to disable support for the max_fragment_length extension
1561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001563
1564/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001565 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1566 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001567 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001568 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001569 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1570 *
1571 * Uncomment this macro to enable support for the record_size_limit extension
1572 */
1573//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1574
1575/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001577 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001578 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001579 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001580 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001581 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1582 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001583 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001584 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001585 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001586 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1587 * are only provided by PSA drivers, you must call psa_crypto_init() before
1588 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001589 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001590 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001591 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001592#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001593
1594/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001595 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001596 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001597 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001598 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001599 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001600 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001601 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001602 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001603 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001604 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001605 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1606 * directly performed by TLS 1.3 code. As a consequence, you must
1607 * call psa_crypto_init() before the first TLS 1.3 handshake.
1608 *
1609 * \note Cryptographic operations performed indirectly via another module
1610 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1611 * running handshake hash) only use PSA crypto if
1612 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001613 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001614 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001615 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001616#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001617
1618/**
Ronald Cronab65c522021-11-24 10:47:20 +01001619 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1620 *
1621 * Enable TLS 1.3 middlebox compatibility mode.
1622 *
1623 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1624 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1625 * expecting TLS 1.2 traffic.
1626 *
1627 * Turning on the compatibility mode comes at the cost of a few added bytes
1628 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1629 * that don't use it. Therefore, unless transmission bandwidth is critical and
1630 * you know that middlebox compatibility issues won't occur, it is therefore
1631 * recommended to set this option.
1632 *
1633 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001634 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1635 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001636 *
1637 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001638#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001639
1640/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001641 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1642 *
1643 * Enable TLS 1.3 PSK key exchange mode.
1644 *
1645 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1646 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1647 * effect on the build.
1648 *
1649 */
1650#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1651
1652/**
1653 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1654 *
1655 * Enable TLS 1.3 ephemeral key exchange mode.
1656 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001657 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001658 * MBEDTLS_X509_CRT_PARSE_C
1659 * and at least one of:
1660 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1661 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001662 *
1663 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1664 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1665 * effect on the build.
1666 *
1667 */
1668#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1669
1670/**
1671 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1672 *
1673 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1674 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001675 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001676 *
1677 * Comment to disable support for the PSK ephemeral key exchange mode in
1678 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1679 * have any effect on the build.
1680 *
1681 */
1682#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1683
1684/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001685 * \def MBEDTLS_SSL_EARLY_DATA
1686 *
1687 * Enable support for RFC 8446 TLS 1.3 early data.
1688 *
1689 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1690 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1691 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1692 *
1693 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1694 * is not enabled, this option does not have any effect on the build.
1695 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001696 * \note The maximum amount of early data can be set with
1697 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1698 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001700//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001701
1702/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001703 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001704 *
1705 * Enable support for DTLS (all available versions).
1706 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001707 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001708 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001709 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001710 *
1711 * Comment this macro to disable support for DTLS
1712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001713#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001714
1715/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001717 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001718 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001719 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001720 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001721 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001723
1724/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001726 *
1727 * Enable support for the anti-replay mechanism in DTLS.
1728 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729 * Requires: MBEDTLS_SSL_TLS_C
1730 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001731 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001732 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001733 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001734 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001735 * Comment this to disable anti-replay in DTLS.
1736 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001737#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001738
1739/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001740 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001741 *
1742 * Enable support for HelloVerifyRequest on DTLS servers.
1743 *
1744 * This feature is highly recommended to prevent DTLS servers being used as
1745 * amplifiers in DoS attacks against other hosts. It should always be enabled
1746 * unless you know for sure amplification cannot be a problem in the
1747 * environment in which your server operates.
1748 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001749 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001750 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001751 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001752 *
1753 * Comment this to disable support for HelloVerifyRequest.
1754 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001755#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001756
1757/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001758 * \def MBEDTLS_SSL_DTLS_SRTP
1759 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001760 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001761 * through the use_srtp extension.
1762 *
1763 * \note This feature provides the minimum functionality required
1764 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1765 * the associated SRTP packet protection key material.
1766 * In particular, the SRTP packet protection itself, as well as the
1767 * demultiplexing of RTP and DTLS packets at the datagram layer
1768 * (see Section 5 of RFC 5764), are not handled by this feature.
1769 * Instead, after successful completion of a handshake negotiating
1770 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001771 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001772 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1773 * (this is implemented in the SSL example programs).
1774 * The resulting key should then be passed to an SRTP stack.
1775 *
1776 * Setting this option enables the runtime API
1777 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1778 * through which the supported DTLS-SRTP protection
1779 * profiles can be configured. You must call this API at
1780 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001781 *
1782 * Requires: MBEDTLS_SSL_PROTO_DTLS
1783 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001784 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001785 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001786//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001787
1788/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001789 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1790 *
1791 * Enable server-side support for clients that reconnect from the same port.
1792 *
1793 * Some clients unexpectedly close the connection and try to reconnect using the
1794 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001795 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001796 * flag enables that support.
1797 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001798 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001799 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001800 * Comment this to disable support for clients reusing the source port.
1801 */
1802#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1803
1804/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001806 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001807 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001808 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001809 * session store remains the responsibility of the application, though).
1810 * Server-side, you also need to provide callbacks for writing and parsing
1811 * tickets, including authenticated encryption and key management. Example
1812 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001813 *
1814 * Comment this macro to disable support for SSL session tickets
1815 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001817
1818/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001820 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001821 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001822 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001824 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001825 * Comment this macro to disable support for server name indication in SSL
1826 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001828
1829/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001830 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1831 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001832 * When this option is enabled, the SSL buffer will be resized automatically
1833 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001834 *
1835 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001836 */
1837//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1838
1839/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001840 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1841 *
1842 * Enable testing of the constant-flow nature of some sensitive functions with
1843 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001844 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001845 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001846 * This setting requires compiling with clang -fsanitize=memory. The test
1847 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001848 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001849 * \warning This macro is only used for extended testing; it is not considered
1850 * part of the library's API, so it may change or disappear at any time.
1851 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001852 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001853 */
1854//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1855
1856/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001857 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1858 *
1859 * Enable testing of the constant-flow nature of some sensitive functions with
1860 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001861 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001862 *
1863 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001864 * testing if the tests suites are run with valgrind's memcheck. This can be
1865 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1866 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001867 *
1868 * \warning This macro is only used for extended testing; it is not considered
1869 * part of the library's API, so it may change or disappear at any time.
1870 *
1871 * Uncomment to enable testing of the constant-flow nature of selected code.
1872 */
1873//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1874
1875/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001876 * \def MBEDTLS_TEST_HOOKS
1877 *
1878 * Enable features for invasive testing such as introspection functions and
1879 * hooks for fault injection. This enables additional unit tests.
1880 *
1881 * Merely enabling this feature should not change the behavior of the product.
1882 * It only adds new code, and new branching points where the default behavior
1883 * is the same as when this feature is disabled.
1884 * However, this feature increases the attack surface: there is an added
1885 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1886 * Therefore this feature must never be enabled in production.
1887 *
1888 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1889 * information.
1890 *
1891 * Uncomment to enable invasive tests.
1892 */
1893//#define MBEDTLS_TEST_HOOKS
1894
1895/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001897 *
1898 * Provide your own alternate threading implementation.
1899 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001900 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001901 *
1902 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001903 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001904//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001905
1906/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001908 *
1909 * Enable the pthread wrapper layer for the threading layer.
1910 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001912 *
1913 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001914 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001915//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001916
1917/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001918 * \def MBEDTLS_USE_PSA_CRYPTO
1919 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001920 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1921 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001922 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001923 * \note Development of this option is currently in progress, and parts of Mbed
1924 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001925 * will still continue to work as usual, so enabling this option should not
1926 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001927 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001928 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001929 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1930 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001931 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001932 * \note An important and desirable effect of this option is that it allows
1933 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1934 * 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 +02001935 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001936 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1937 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001938 *
1939 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001940 *
1941 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001942 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001943 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001944 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001945//#define MBEDTLS_USE_PSA_CRYPTO
1946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001948 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1949 *
John Durkop185764f2020-10-12 21:32:12 -07001950 * This setting allows support for cryptographic mechanisms through the PSA
1951 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001952 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001953 * When this option is disabled, the PSA API exposes the cryptographic
1954 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1955 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001956 *
1957 * When this option is enabled, the PSA API exposes the cryptographic
1958 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1959 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1960 * automatically enabled if required (i.e. if no PSA driver provides the
1961 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1962 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001963 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001964 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001965 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001966 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001967 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1968 * symbols is not completely finalized yet, and the configuration
1969 * tooling is not ideally adapted to having two separate configuration
1970 * files.
1971 * Future minor releases of Mbed TLS may make minor changes to those
1972 * symbols, but we will endeavor to provide a transition path.
1973 * Nonetheless, this option is considered mature enough to use in
1974 * production, as long as you accept that you may need to make
1975 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001976 */
1977//#define MBEDTLS_PSA_CRYPTO_CONFIG
1978
1979/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001980 * \def MBEDTLS_VERSION_FEATURES
1981 *
1982 * Allow run-time checking of compile-time enabled features. Thus allowing users
1983 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001984 * support via mbedtls_version_check_feature().
1985 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001986 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00001987 *
1988 * Comment this to disable run-time checking and save ROM space
1989 */
1990#define MBEDTLS_VERSION_FEATURES
1991
1992/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001993 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1994 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001995 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001996 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1997 * the set of trusted certificates through a callback instead of a linked
1998 * list.
1999 *
2000 * This is useful for example in environments where a large number of trusted
2001 * certificates is present and storing them in a linked list isn't efficient
2002 * enough, or when the set of trusted certificates changes frequently.
2003 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002004 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002005 * `mbedtls_ssl_conf_ca_cb()` for more information.
2006 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002007 * Requires: MBEDTLS_X509_CRT_PARSE_C
2008 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002009 * Uncomment to enable trusted certificate callbacks.
2010 */
2011//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2012
2013/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002014 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002015 *
Chris Jones2c745862020-12-16 11:41:06 +00002016 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002017 *
Chris Jones2c745862020-12-16 11:41:06 +00002018 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002019 * and other functions/constants only used by these functions, thus reducing
2020 * the code footprint by several KB.
2021 */
Chris Jones2c745862020-12-16 11:41:06 +00002022//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002023
2024/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002026 *
2027 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2028 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2029 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002030 * Requires: MBEDTLS_PKCS1_V21
2031 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002032 * Comment this macro to disallow using RSASSA-PSS in certificates.
2033 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002035/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002036
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002037/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002038 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002039 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002040 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002041 * \{
2042 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002043
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002044/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002045 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002046 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002047 * Enable AES-NI support on x86-64 or x86-32.
2048 *
2049 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002050 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002051 * - GCC, x86-64, target not explicitly supporting AESNI:
2052 * requires MBEDTLS_HAVE_ASM.
2053 * - GCC, x86-32, target not explicitly supporting AESNI:
2054 * not supported.
2055 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2056 * For this assembly-less implementation, you must currently compile
2057 * `library/aesni.c` and `library/aes.c` with machine options to enable
2058 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2059 * `clang -maes -mpclmul`.
2060 * - Non-x86 targets: this option is silently ignored.
2061 * - Other compilers: this option is silently ignored.
2062 *
2063 * \note
2064 * Above, "GCC" includes compatible compilers such as Clang.
2065 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002066 *
2067 * Module: library/aesni.c
2068 * Caller: library/aes.c
2069 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002070 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002071 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002072 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002073 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002075
2076/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002077 * \def MBEDTLS_AESCE_C
2078 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002079 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002080 *
2081 * Module: library/aesce.c
2082 * Caller: library/aes.c
2083 *
Jerry Yuf015a932023-04-25 10:38:03 +08002084 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002085 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002086 * \warning Runtime detection only works on Linux. For non-Linux operating
2087 * system, Armv8-A Cryptographic Extensions must be supported by
2088 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002089 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002090 * \note Minimum compiler versions for this feature when targeting aarch64
2091 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2092 * Minimum compiler versions for this feature when targeting 32-bit
2093 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002094 *
2095 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2096 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002097 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002098 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002099 */
2100#define MBEDTLS_AESCE_C
2101
2102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002104 *
2105 * Enable the AES block cipher.
2106 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002107 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002108 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002109 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002110 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002111 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002112 * This module enables the following ciphersuites (if other requisites are
2113 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002114 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2115 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2116 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2117 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2118 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2119 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2120 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2121 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2122 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2123 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2124 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2125 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2126 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2127 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2128 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2129 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2130 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2131 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2132 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2133 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2134 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2135 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2136 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2137 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2138 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2139 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2140 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2141 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2142 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2143 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2144 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2145 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2146 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2147 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2148 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2149 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2150 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2151 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2152 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2153 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2154 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2155 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2156 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2157 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2158 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2159 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2160 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2161 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2162 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2163 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2164 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2165 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2166 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2167 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2168 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2169 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2170 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2171 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002172 *
Paul Bakkercff68422013-09-15 20:43:33 +02002173 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002176
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002177/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002179 *
2180 * Enable the generic ASN1 parser.
2181 *
2182 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002183 * Caller: library/x509.c
2184 * library/dhm.c
2185 * library/pkcs12.c
2186 * library/pkcs5.c
2187 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002188 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002190
2191/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002192 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002193 *
2194 * Enable the generic ASN1 writer.
2195 *
2196 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002197 * Caller: library/ecdsa.c
2198 * library/pkwrite.c
2199 * library/x509_create.c
2200 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002201 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002204
2205/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002206 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002207 *
2208 * Enable the Base64 module.
2209 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002210 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002211 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002212 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002213 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002215#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002216
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002217/**
Yanray Wange367e472023-10-31 17:23:04 +08002218 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2219 *
2220 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2221 *
2222 * \note This feature is incompatible with insecure block cipher,
2223 * MBEDTLS_DES_C, and cipher modes which always require decryption
2224 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002225 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2226 * this feature is incompatible with following supported PSA equivalence,
2227 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2228 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002229 *
2230 * Module: library/aes.c
2231 * library/aesce.c
2232 * library/aesni.c
2233 * library/aria.c
2234 * library/camellia.c
2235 * library/cipher.c
2236 */
2237//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2238
2239/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002240 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002241 *
Paul Bakker9a736322012-11-14 12:39:52 +00002242 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002243 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002244 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002245 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002246 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002247 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002248 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002249 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002250 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002251 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002252 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002253 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002254 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002255 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002257#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002258
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002259/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002261 *
2262 * Enable the Camellia block cipher.
2263 *
Paul Bakker38119b12009-01-10 23:31:23 +00002264 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002265 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002266 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002267 * This module enables the following ciphersuites (if other requisites are
2268 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2270 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2271 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2272 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2273 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2274 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2275 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2276 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2277 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2278 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2279 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2280 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2281 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2282 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2283 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2284 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2285 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2286 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2287 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2288 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2289 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2290 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2291 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2292 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2293 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2294 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2295 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2296 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2297 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2298 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2299 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2300 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2301 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2302 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2303 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2304 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2305 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2306 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2307 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2308 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2309 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2310 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002313
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002314/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002315 * \def MBEDTLS_ARIA_C
2316 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002317 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002318 *
2319 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002320 * Caller: library/cipher.c
2321 *
2322 * This module enables the following ciphersuites (if other requisites are
2323 * enabled as well):
2324 *
2325 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2326 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2327 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2328 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2329 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2330 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2331 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2332 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2333 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2334 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2335 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2336 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2337 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2338 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2339 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2340 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2341 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2342 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2343 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2344 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2345 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2346 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2347 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2348 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2349 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2350 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2351 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2352 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2353 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2354 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2355 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2356 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2357 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2358 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2359 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2360 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2361 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2362 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002363 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002364#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002365
2366/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002367 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002368 *
2369 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2370 *
2371 * Module: library/ccm.c
2372 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002373 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2374 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002375 *
2376 * This module enables the AES-CCM ciphersuites, if other requisites are
2377 * enabled as well.
2378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002380
2381/**
Daniel King34b822c2016-05-15 17:28:08 -03002382 * \def MBEDTLS_CHACHA20_C
2383 *
2384 * Enable the ChaCha20 stream cipher.
2385 *
2386 * Module: library/chacha20.c
2387 */
2388#define MBEDTLS_CHACHA20_C
2389
2390/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002391 * \def MBEDTLS_CHACHAPOLY_C
2392 *
2393 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2394 *
2395 * Module: library/chachapoly.c
2396 *
2397 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2398 */
2399#define MBEDTLS_CHACHAPOLY_C
2400
2401/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002402 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002403 *
2404 * Enable the generic cipher layer.
2405 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002406 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002407 * Caller: library/ccm.c
2408 * library/cmac.c
2409 * library/gcm.c
2410 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002411 * library/pkcs12.c
2412 * library/pkcs5.c
2413 * library/psa_crypto_aead.c
2414 * library/psa_crypto_mac.c
2415 * library/ssl_ciphersuites.c
2416 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002417 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002418 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2419 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002420 *
2421 * Uncomment to enable generic cipher wrappers.
2422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002424
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002425/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002426 * \def MBEDTLS_CMAC_C
2427 *
Simon Butcher327398a2016-10-05 14:09:11 +01002428 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2429 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002430 *
2431 * Module: library/cmac.c
2432 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002433 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002434 *
2435 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002436#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002437
2438/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002439 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002440 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002441 * Enable the CTR_DRBG AES-based random generator.
2442 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002443 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002444 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002445 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002446 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2447 * is used.
2448 *
2449 * \warning When using PSA, the user should call `psa_crypto_init()` before
2450 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2451 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002452 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2453 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002454 * \note To achieve a 256-bit security strength with CTR_DRBG,
2455 * you must use AES-256 *and* use sufficient entropy.
2456 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002457 *
2458 * Module: library/ctr_drbg.c
2459 * Caller:
2460 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002461 * Requires: MBEDTLS_AES_C or
2462 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2463 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002464 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002465 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002466 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002467#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002468
2469/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002470 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002471 *
2472 * Enable the debug functions.
2473 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002474 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002475 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002476 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002477 * library/ssl_tls12_*.c
2478 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002479 *
2480 * This module provides debugging functions.
2481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002482#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002483
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002486 *
2487 * Enable the DES block cipher.
2488 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002489 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002490 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002491 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002492 *
Paul Bakkercff68422013-09-15 20:43:33 +02002493 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002494 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002495 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002496 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002499
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002500/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002501 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002502 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002503 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002504 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002505 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002506 * Caller: library/ssl_tls.c
2507 * library/ssl*_client.c
2508 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002509 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002510 * This module is used by the following key exchanges:
2511 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002512 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002513 * \warning Using DHE constitutes a security risk as it
2514 * is not possible to validate custom DH parameters.
2515 * If possible, it is recommended users should consider
2516 * preferring other methods of key exchange.
2517 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002518 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002520#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002521
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002522/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002524 *
2525 * Enable the elliptic curve Diffie-Hellman library.
2526 *
2527 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002528 * Caller: library/psa_crypto.c
2529 * library/ssl_tls.c
2530 * library/ssl*_client.c
2531 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002532 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002533 * This module is used by the following key exchanges:
2534 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002535 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002536 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002539
2540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002542 *
2543 * Enable the elliptic curve DSA library.
2544 *
2545 * Module: library/ecdsa.c
2546 * Caller:
2547 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002548 * This module is used by the following key exchanges:
2549 * ECDHE-ECDSA
2550 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002551 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2552 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2553 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002556
2557/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002558 * \def MBEDTLS_ECJPAKE_C
2559 *
2560 * Enable the elliptic curve J-PAKE library.
2561 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002562 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2563 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002564 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002565 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002566 * Module: library/ecjpake.c
2567 * Caller:
2568 *
2569 * This module is used by the following key exchanges:
2570 * ECJPAKE
2571 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002572 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002573 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002574 * \warning If using a hash that is only provided by PSA drivers, you must
2575 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002576 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002577#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002578
2579/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002581 *
2582 * Enable the elliptic curve over GF(p) library.
2583 *
2584 * Module: library/ecp.c
2585 * Caller: library/ecdh.c
2586 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002587 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002588 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002590 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002591#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002592
2593/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002594 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002595 *
2596 * Enable the platform-specific entropy code.
2597 *
2598 * Module: library/entropy.c
2599 * Caller:
2600 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002602 *
2603 * This module provides a generic entropy pool
2604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002605#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002606
2607/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002609 *
2610 * Enable error code to error string conversion.
2611 *
2612 * Module: library/error.c
2613 * Caller:
2614 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002618
2619/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002621 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002622 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002623 *
2624 * Module: library/gcm.c
2625 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002626 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2627 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002628 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002629 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2630 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002631 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002632#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002633
2634/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002635 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002636 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002637 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002638 * Can significantly increase throughput on systems without GCM hardware
2639 * acceleration (e.g., AESNI, AESCE).
2640 *
Matthias Schulz78266782024-02-08 13:54:48 +01002641 * The mbedtls_gcm_context size will increase by 3840 bytes.
2642 * The code size will increase by roughly 344 bytes.
2643 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002644 * Module: library/gcm.c
2645 *
2646 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002647 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002648//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002649
2650/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002651 * \def MBEDTLS_HKDF_C
2652 *
2653 * Enable the HKDF algorithm (RFC 5869).
2654 *
2655 * Module: library/hkdf.c
2656 * Caller:
2657 *
2658 * Requires: MBEDTLS_MD_C
2659 *
2660 * This module adds support for the Hashed Message Authentication Code
2661 * (HMAC)-based key derivation function (HKDF).
2662 */
2663#define MBEDTLS_HKDF_C
2664
2665/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002667 *
2668 * Enable the HMAC_DRBG random generator.
2669 *
2670 * Module: library/hmac_drbg.c
2671 * Caller:
2672 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002674 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002675 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002676 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002678
2679/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002680 * \def MBEDTLS_LMS_C
2681 *
2682 * Enable the LMS stateful-hash asymmetric signature algorithm.
2683 *
2684 * Module: library/lms.c
2685 * Caller:
2686 *
Raef Colesab4f8742022-09-01 12:24:31 +01002687 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002688 *
Raef Colesab4f8742022-09-01 12:24:31 +01002689 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002690 */
2691#define MBEDTLS_LMS_C
2692
2693/**
Raef Colesab4f8742022-09-01 12:24:31 +01002694 * \def MBEDTLS_LMS_PRIVATE
2695 *
2696 * Enable LMS private-key operations and signing code. Functions enabled by this
2697 * option are experimental, and should not be used in production.
2698 *
2699 * Requires: MBEDTLS_LMS_C
2700 *
2701 * Uncomment to enable the LMS signature algorithm and private key operations.
2702 */
Raef Coles5127e852022-10-07 10:35:56 +01002703//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002704
2705/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002706 * \def MBEDTLS_NIST_KW_C
2707 *
2708 * Enable the Key Wrapping mode for 128-bit block ciphers,
2709 * as defined in NIST SP 800-38F. Only KW and KWP modes
2710 * are supported. At the moment, only AES is approved by NIST.
2711 *
2712 * Module: library/nist_kw.c
2713 *
2714 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2715 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002716#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002717
2718/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002720 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002721 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002722 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002723 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2724 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002725 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002726 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002727 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002728 * Caller: library/constant_time.c
2729 * library/ecdsa.c
2730 * library/ecjpake.c
2731 * library/hkdf.c
2732 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002733 * library/pk.c
2734 * library/pkcs5.c
2735 * library/pkcs12.c
2736 * library/psa_crypto_ecp.c
2737 * library/psa_crypto_rsa.c
2738 * library/rsa.c
2739 * library/ssl_cookie.c
2740 * library/ssl_msg.c
2741 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002742 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002743 * library/x509_crt.c
2744 * library/x509write_crt.c
2745 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002746 *
2747 * Uncomment to enable generic message digest wrappers.
2748 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002750
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002751/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002752 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002753 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002754 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002755 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002756 * Module: library/md5.c
2757 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002758 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002759 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002760 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002761 * This module is required for TLS 1.2 depending on the handshake parameters.
2762 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2763 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002764 *
2765 * \warning MD5 is considered a weak message digest and its use constitutes a
2766 * security risk. If possible, we recommend avoiding dependencies on
2767 * it, and considering stronger message digests instead.
2768 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002769 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002770#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002771
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002772/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002774 *
2775 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002776 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002777 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002778 *
2779 * Module: library/memory_buffer_alloc.c
2780 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002782 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002783 *
2784 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002787
2788/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002789 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002790 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002791 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2792 *
Simon Butcherd567a232016-03-09 20:19:21 +00002793 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2794 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002795 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002796 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002797 * \note See also our Knowledge Base article about porting to a new
2798 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002799 * 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 +00002800 *
Andres AG788aa4a2016-09-14 14:32:09 +01002801 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002802 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002803 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002804 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002806
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002807/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002809 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002810 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002811 *
2812 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002813 * Caller: library/asn1write.c
2814 * library/pkcs5.c
2815 * library/pkparse.c
2816 * library/pkwrite.c
2817 * library/rsa.c
2818 * library/x509.c
2819 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002820 * library/x509_crl.c
2821 * library/x509_crt.c
2822 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002823 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002824 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002825 *
2826 * This modules translates between OIDs and internal values.
2827 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002828#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002829
2830/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002831 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002832 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002833 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002834 *
2835 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002836 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002837 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002838 * library/x509_crl.c
2839 * library/x509_crt.c
2840 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002841 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002843 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2844 *
2845 * \warning When parsing password-protected files, if MD5 is provided only by
2846 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002847 *
Paul Bakkercff68422013-09-15 20:43:33 +02002848 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002851
2852/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002854 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002855 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002856 *
2857 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002858 * Caller: library/pkwrite.c
2859 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002860 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002861 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002863 *
2864 * This modules adds support for encoding / writing PEM files.
2865 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002866#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002867
2868/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002870 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002871 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002872 *
2873 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002874 * Caller: library/psa_crypto_rsa.c
2875 * library/ssl_tls.c
2876 * library/ssl*_client.c
2877 * library/ssl*_server.c
2878 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002879 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002880 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002881 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002882 * Uncomment to enable generic public key wrappers.
2883 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002884#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002885
2886/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002888 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002889 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002890 *
2891 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002892 * Caller: library/x509_crt.c
2893 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002894 *
Yanray Wang072a0682023-12-05 10:53:04 +08002895 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002896 *
2897 * Uncomment to enable generic public key parse functions.
2898 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002899#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002900
2901/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002903 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002904 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002905 *
2906 * Module: library/pkwrite.c
2907 * Caller: library/x509write.c
2908 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002909 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002910 *
2911 * Uncomment to enable generic public key write functions.
2912 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002913#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002914
2915/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002917 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002918 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002919 *
2920 * Module: library/pkcs5.c
2921 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002922 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002923 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002924 * \warning If using a hash that is only provided by PSA drivers, you must
2925 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002926 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002927 * This module adds support for the PKCS#5 functions.
2928 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002929#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002930
2931/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002932 * \def MBEDTLS_PKCS7_C
2933 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002934 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002935 * RFC Link - https://tools.ietf.org/html/rfc2315
2936 *
2937 * Module: library/pkcs7.c
2938 *
2939 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002940 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2941 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002942 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002943 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002944 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002945#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002946
2947/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002949 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002950 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002951 * Adds algorithms for parsing PKCS#8 encrypted private keys
2952 *
2953 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002954 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002955 *
Valerio Settie98ad592023-12-28 10:42:12 +01002956 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2957 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002958 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002959 * \warning If using a hash that is only provided by PSA drivers, you must
2960 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002961 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002962 * This module enables PKCS#12 functions.
2963 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002965
2966/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002968 *
2969 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002970 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002971 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002972 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2973 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002974 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002975 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002976 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002977 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002978 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002979 * Module: library/platform.c
2980 * Caller: Most other .c files
2981 *
2982 * This module enables abstraction of common (libc) functions.
2983 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002984#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002985
2986/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002987 * \def MBEDTLS_POLY1305_C
2988 *
2989 * Enable the Poly1305 MAC algorithm.
2990 *
2991 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002992 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002993 */
2994#define MBEDTLS_POLY1305_C
2995
2996/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002997 * \def MBEDTLS_PSA_CRYPTO_C
2998 *
2999 * Enable the Platform Security Architecture cryptography API.
3000 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003001 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003002 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003003 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003004 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003005 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3006 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3007 * is enabled in PSA (unless it's fully accelerated, see
3008 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003009 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003010#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003011
3012/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003013 * \def MBEDTLS_PSA_CRYPTO_SE_C
3014 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003015 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003016 * cryptography API.
3017 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003018 * \deprecated This feature is deprecated. Please switch to the PSA driver
3019 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003020 *
Ryan Everett32a64582024-03-05 18:16:18 +00003021 * \warning This feature is not thread-safe, and should not be used in a
3022 * multi-threaded environment.
3023 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003024 * Module: library/psa_crypto_se.c
3025 *
3026 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3027 *
3028 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003029//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003030
3031/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003032 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3033 *
3034 * Enable the Platform Security Architecture persistent key storage.
3035 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003036 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003037 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003038 * Requires: MBEDTLS_PSA_CRYPTO_C,
3039 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3040 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003041 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003042#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003043
3044/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003045 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003046 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003047 * Enable the emulation of the Platform Security Architecture
3048 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003049 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003050 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003051 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003052 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003053 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003054#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003055
3056/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003058 *
3059 * Enable the RIPEMD-160 hash algorithm.
3060 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003061 * Module: library/ripemd160.c
3062 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003063 *
3064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003066
3067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003069 *
3070 * Enable the RSA public-key cryptosystem.
3071 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003072 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003073 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003074 * Caller: library/pk.c
3075 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003076 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003077 * library/ssl*_client.c
3078 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003079 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003080 * This module is used by the following key exchanges:
3081 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003082 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003083 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003084 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003086
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003087/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003089 *
3090 * Enable the SHA1 cryptographic hash algorithm.
3091 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003092 * Module: library/sha1.c
3093 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003094 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003095 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003096 * This module is required for TLS 1.2 depending on the handshake parameters,
3097 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003098 *
3099 * \warning SHA-1 is considered a weak message digest and its use constitutes
3100 * a security risk. If possible, we recommend avoiding dependencies
3101 * on it, and considering stronger message digests instead.
3102 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003105
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003106/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003107 * \def MBEDTLS_SHA224_C
3108 *
3109 * Enable the SHA-224 cryptographic hash algorithm.
3110 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003111 * Module: library/sha256.c
3112 * Caller: library/md.c
3113 * library/ssl_cookie.c
3114 *
3115 * This module adds support for SHA-224.
3116 */
3117#define MBEDTLS_SHA224_C
3118
3119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003121 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003122 * Enable the SHA-256 cryptographic hash algorithm.
3123 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003124 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003125 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003126 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003127 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003128 * library/ssl*_client.c
3129 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003130 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003131 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003132 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003135
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003136/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003137 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003138 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003139 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3140 * with the ARMv8 cryptographic extensions if they are available at runtime.
3141 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003142 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003143 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003144 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003145 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003146 * \note Minimum compiler versions for this feature are Clang 4.0,
3147 * armclang 6.6 or GCC 6.0.
3148 *
3149 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3150 * armclang <= 6.9
3151 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003152 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3153 * That name is deprecated, but may still be used as an alternative form for this
3154 * option.
3155 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003156 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3157 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003158 *
3159 * Requires: MBEDTLS_SHA256_C.
3160 *
3161 * Module: library/sha256.c
3162 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003163 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003164 * and use them if available.
3165 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003166//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003167
Dave Rodgmand85277c2023-10-13 09:22:54 +01003168/**
3169 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3170 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003171 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003172 * This name is now deprecated, but may still be used as an alternative form for
3173 * this option.
3174 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003175//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3176
3177/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003178 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003179 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003180 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3181 * with the ARMv8 cryptographic extensions, which must be available at runtime
3182 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003183 *
3184 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003185 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003186 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003187 * \note Minimum compiler versions for this feature are Clang 4.0,
3188 * armclang 6.6 or GCC 6.0.
3189 *
3190 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3191 * armclang <= 6.9
3192 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003193 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003194 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003195 * option.
3196 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003197 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3198 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003199 *
3200 * Requires: MBEDTLS_SHA256_C.
3201 *
3202 * Module: library/sha256.c
3203 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003204 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003205 * unconditionally.
3206 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003207//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003208
Dave Rodgmand85277c2023-10-13 09:22:54 +01003209/**
3210 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3211 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003212 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003213 * This name is now deprecated, but may still be used as an alternative form for
3214 * this option.
3215 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003216//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3217
3218/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003219 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003220 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003221 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003222 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003223 * Module: library/sha512.c
3224 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003225 * library/psa_crypto_hash.c
3226 * library/ssl_tls.c
3227 * library/ssl*_client.c
3228 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003229 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003230 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003231 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003232#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003233
3234/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003235 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003236 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003237 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003238 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003239 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003240 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003241 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003242 * library/ssl_tls.c
3243 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003244 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003245 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003248
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003249/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003250 * \def MBEDTLS_SHA3_C
3251 *
3252 * Enable the SHA3 cryptographic hash algorithm.
3253 *
3254 * Module: library/sha3.c
3255 *
3256 * This module adds support for SHA3.
3257 */
3258#define MBEDTLS_SHA3_C
3259
3260/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003261 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3262 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003263 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3264 * with the ARMv8 cryptographic extensions if they are available at runtime.
3265 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003266 *
3267 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3268 * for a non-Aarch64 build it will be silently ignored.
3269 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003270 * \note Minimum compiler versions for this feature are Clang 7.0,
3271 * armclang 6.9 or GCC 8.0.
3272 *
3273 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3274 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003275 *
3276 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3277 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3278 *
3279 * Requires: MBEDTLS_SHA512_C.
3280 *
3281 * Module: library/sha512.c
3282 *
3283 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3284 * and use them if available.
3285 */
3286//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3287
3288/**
3289 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3290 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003291 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3292 * with the ARMv8 cryptographic extensions, which must be available at runtime
3293 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003294 *
3295 * \note This allows builds with a smaller code size than with
3296 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3297 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003298 * \note Minimum compiler versions for this feature are Clang 7.0,
3299 * armclang 6.9 or GCC 8.0.
3300 *
3301 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3302 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003303 *
3304 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3305 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3306 *
3307 * Requires: MBEDTLS_SHA512_C.
3308 *
3309 * Module: library/sha512.c
3310 *
3311 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3312 * unconditionally.
3313 */
3314//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3315
3316/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003318 *
3319 * Enable simple SSL cache implementation.
3320 *
3321 * Module: library/ssl_cache.c
3322 * Caller:
3323 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003325 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003327
3328/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003330 *
3331 * Enable basic implementation of DTLS cookies for hello verification.
3332 *
3333 * Module: library/ssl_cookie.c
3334 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003335 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003336#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003337
3338/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003339 * \def MBEDTLS_SSL_TICKET_C
3340 *
3341 * Enable an implementation of TLS server-side callbacks for session tickets.
3342 *
3343 * Module: library/ssl_ticket.c
3344 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003345 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003346 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3347 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003348 */
3349#define MBEDTLS_SSL_TICKET_C
3350
3351/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003352 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003353 *
3354 * Enable the SSL/TLS client code.
3355 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003356 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003357 * Caller:
3358 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003360 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003361 * This module is required for SSL/TLS client support.
3362 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003363#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003364
Paul Bakker9a736322012-11-14 12:39:52 +00003365/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003367 *
3368 * Enable the SSL/TLS server code.
3369 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003370 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003371 * Caller:
3372 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003374 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003375 * This module is required for SSL/TLS server support.
3376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003377#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003378
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003379/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003381 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003382 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003383 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003384 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003385 * Caller: library/ssl*_client.c
3386 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003387 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003388 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3389 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003390 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003391 * This module is required for SSL/TLS.
3392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003394
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003395/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003397 *
3398 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003399 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003400 * contexts are not shared between threads. If you do intend to use contexts
3401 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003402 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003403 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003404 *
3405 * Module: library/threading.c
3406 *
3407 * This allows different threading implementations (self-implemented or
3408 * provided).
3409 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410 * You will have to enable either MBEDTLS_THREADING_ALT or
3411 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003412 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003413 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003414 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003416
3417/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003419 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003420 * Enable the semi-portable timing interface.
3421 *
Simon Butcherd567a232016-03-09 20:19:21 +00003422 * \note The provided implementation only works on POSIX/Unix (including Linux,
3423 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003424 * module and provide your own implementations of the callbacks needed by
3425 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3426 * your own implementation of the whole module by setting
3427 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003428 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003429 * \note The timing module will include time.h on suitable platforms
3430 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3431 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3432 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003433 * \note See also our Knowledge Base article about porting to a new
3434 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003435 * 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 +00003436 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003437 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003438 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003439#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003440
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003441/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003442 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003443 *
3444 * Enable run-time version information.
3445 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003446 * Module: library/version.c
3447 *
3448 * This module provides run-time version information.
3449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003451
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003452/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003454 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003455 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003456 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003457 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003458 * Caller: library/x509_crl.c
3459 * library/x509_crt.c
3460 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003461 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003462 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003463 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3464 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003465 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3466 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003467 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003468 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003469 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003470#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003471
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003472/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003474 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003475 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003476 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003477 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003478 * Caller: library/ssl_tls.c
3479 * library/ssl*_client.c
3480 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003481 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003483 *
3484 * This module is required for X.509 certificate parsing.
3485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003486#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003487
3488/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003489 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003490 *
3491 * Enable X.509 CRL parsing.
3492 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003493 * Module: library/x509_crl.c
3494 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003495 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003496 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003497 *
3498 * This module is required for X.509 CRL parsing.
3499 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003500#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003501
3502/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003503 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003504 *
3505 * Enable X.509 Certificate Signing Request (CSR) parsing.
3506 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003507 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003508 * Caller: library/x509_crt_write.c
3509 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003510 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003511 *
3512 * This module is used for reading X.509 certificate request.
3513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003514#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003515
3516/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003518 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003519 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003520 *
3521 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003522 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003523 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003524 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3525 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003526 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3527 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003528 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003529 * This module is the basis for creating X.509 certificates and CSRs.
3530 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003531#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003532
3533/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003535 *
3536 * Enable creating X.509 certificates.
3537 *
3538 * Module: library/x509_crt_write.c
3539 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003541 *
3542 * This module is required for X.509 certificate creation.
3543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003545
3546/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003547 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003548 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003549 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003550 *
3551 * Module: library/x509_csr_write.c
3552 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003553 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003554 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003555 * This module is required for X.509 certificate request writing.
3556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003557#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003558
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003559/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003560
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003561/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003562 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003563 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003564 * This section contains Mbed TLS build settings that are not associated
3565 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003566 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003567 * \{
3568 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003569
Gilles Peskinea02c1242022-03-16 17:03:19 +01003570/**
3571 * \def MBEDTLS_CONFIG_FILE
3572 *
3573 * If defined, this is a header which will be included instead of
3574 * `"mbedtls/mbedtls_config.h"`.
3575 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003576 * Unlike other configuration options, this one must be defined on the
3577 * compiler command line: a definition in `mbedtls_config.h` would have
3578 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003579 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003580 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003581 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003582 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003583 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003584 * The value of this symbol is typically a path in double quotes, either
3585 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003586 */
3587//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3588
3589/**
3590 * \def MBEDTLS_USER_CONFIG_FILE
3591 *
3592 * If defined, this is a header which will be included after
3593 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003594 * This allows you to modify the default configuration, including the ability
3595 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003596 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003597 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003598 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003599 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003600 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003601 * The value of this symbol is typically a path in double quotes, either
3602 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003603 */
3604//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3605
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003606/**
3607 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3608 *
3609 * If defined, this is a header which will be included instead of
3610 * `"psa/crypto_config.h"`.
3611 * This header file specifies which cryptographic mechanisms are available
3612 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3613 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3614 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003615 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003616 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003617 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003618 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003619 * The value of this symbol is typically a path in double quotes, either
3620 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003621 */
3622//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3623
3624/**
3625 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3626 *
3627 * If defined, this is a header which will be included after
3628 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003629 * This allows you to modify the default configuration, including the ability
3630 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003631 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003632 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003633 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003634 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003635 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003636 * The value of this symbol is typically a path in double quotes, either
3637 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003638 */
3639//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3640
Gilles Peskineb1176f22023-02-22 22:07:28 +01003641/**
3642 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3643 *
3644 * If defined, this is a header which will be included instead of
3645 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3646 * as the one in Mbed TLS, but with definitions adapted to the platform on
3647 * which the library code will run.
3648 *
3649 * \note The required content of this header can vary from one version of
3650 * Mbed TLS to the next. Integrators who provide an alternative file
3651 * should review the changes in the original file whenever they
3652 * upgrade Mbed TLS.
3653 *
3654 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3655 * non-standard feature of the C language, so this feature is only available
3656 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3657 *
3658 * The value of this symbol is typically a path in double quotes, either
3659 * absolute or relative to a directory on the include search path.
3660 */
3661//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3662
3663/**
3664 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3665 *
3666 * If defined, this is a header which will be included instead of
3667 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3668 * as the one in Mbed TLS, but with definitions adapted to the environment
3669 * in which the library code will run. The typical use for this feature
3670 * is to provide alternative type definitions on the client side in
3671 * client-server integrations of PSA crypto, where operation structures
3672 * contain handles instead of cryptographic data.
3673 *
3674 * \note The required content of this header can vary from one version of
3675 * Mbed TLS to the next. Integrators who provide an alternative file
3676 * should review the changes in the original file whenever they
3677 * upgrade Mbed TLS.
3678 *
3679 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3680 * non-standard feature of the C language, so this feature is only available
3681 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3682 *
3683 * The value of this symbol is typically a path in double quotes, either
3684 * absolute or relative to a directory on the include search path.
3685 */
3686//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3687
Gilles Peskineba4162a2022-04-11 17:04:38 +02003688/** \} name SECTION: General configuration options */
3689
3690/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003691 * \name SECTION: Module configuration options
3692 *
3693 * This section allows for the setting of module specific sizes and
3694 * configuration options. The default values are already present in the
3695 * relevant header files and should suffice for the regular use cases.
3696 *
3697 * Our advice is to enable options and change their values here
3698 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003699 * \{
3700 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003701/* The Doxygen documentation here is used when a user comments out a
3702 * setting and runs doxygen themselves. On the other hand, when we typeset
3703 * the full documentation including disabled settings, the documentation
3704 * in specific modules' header files is used if present. When editing this
3705 * file, make sure that each option is documented in exactly one place,
3706 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3707 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003708
Paul Bakker088c5c52014-04-25 11:11:10 +02003709/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003710//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003711//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003712
Paul Bakker088c5c52014-04-25 11:11:10 +02003713/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003714//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3715//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3716//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3717//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3718//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003719
Paul Bakker088c5c52014-04-25 11:11:10 +02003720/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003721//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3722//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3723//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3724//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003725
Paul Bakker088c5c52014-04-25 11:11:10 +02003726/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003727//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003728//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003729
Paul Bakker088c5c52014-04-25 11:11:10 +02003730/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003731//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3732//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003733//#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 +01003734
Paul Bakker088c5c52014-04-25 11:11:10 +02003735/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003736//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003737
Paul Bakker088c5c52014-04-25 11:11:10 +02003738/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003739//#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 -04003740
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003741/** \def MBEDTLS_PLATFORM_STD_CALLOC
3742 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003743 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003744 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003745 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003746 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003747 * 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 -04003748 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3749 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003750 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003751 */
3752//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003753
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003754/** \def MBEDTLS_PLATFORM_STD_FREE
3755 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003756 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003757 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003758 * 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 -04003759 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3760 * 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 -04003761 */
3762//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003763//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003764//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003765//#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 +02003766//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3767//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003768/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003769//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003770//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3771//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003772//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3773//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3774//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003775
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003776/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003777/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003778//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3779//#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 +02003780//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003781//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003782//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3783//#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 +02003784//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3785//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003786/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003787//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003788//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003789//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3790//#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 +08003791//#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 +08003792//#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 +02003793
Gilles Peskine3f106f72021-09-23 17:42:39 +02003794/** \def MBEDTLS_CHECK_RETURN
3795 *
3796 * This macro is used at the beginning of the declaration of a function
3797 * to indicate that its return value should be checked. It should
3798 * instruct the compiler to emit a warning or an error if the function
3799 * is called without checking its return value.
3800 *
3801 * There is a default implementation for popular compilers in platform_util.h.
3802 * You can override the default implementation by defining your own here.
3803 *
3804 * If the implementation here is empty, this will effectively disable the
3805 * checking of functions' return values.
3806 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003807//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003808
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003809/** \def MBEDTLS_IGNORE_RETURN
3810 *
3811 * This macro requires one argument, which should be a C function call.
3812 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3813 * warning is suppressed.
3814 */
3815//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3816
Gilles Peskineed038902020-11-13 21:33:21 +01003817/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003818/**
Gilles Peskineed038902020-11-13 21:33:21 +01003819 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3820 * PSA crypto subsystem.
3821 *
3822 * If this option is unset:
3823 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003824 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003825 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3826 * on unspecified heuristics.
3827 */
3828//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3829
Steven Cooreman863470a2021-02-15 14:03:19 +01003830/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003831 * Restrict the PSA library to supporting a maximum amount of simultaneously
3832 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3833 * volatile key, or a persistent key which is loaded temporarily by the
3834 * library as part of a crypto operation in flight.
3835 *
3836 * If this option is unset, the library will fall back to a default value of
3837 * 32 keys.
3838 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003839//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003840
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003841/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003842//#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 +00003843
Paul Bakker088c5c52014-04-25 11:11:10 +02003844/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003845//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3846//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003847
Paul Bakker088c5c52014-04-25 11:11:10 +02003848/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003849
Angus Grattond8213d02016-05-25 20:56:48 +10003850/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3851 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003852 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003853 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003854 * This determines the size of the incoming TLS I/O buffer in such a way
3855 * that it is capable of holding the specified amount of plaintext data,
3856 * regardless of the protection mechanism used.
3857 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003858 * \note When using a value less than the default of 16KB on the client, it is
3859 * recommended to use the Maximum Fragment Length (MFL) extension to
3860 * inform the server about this limitation. On the server, there
3861 * is no supported, standardized way of informing the client about
3862 * restriction on the maximum size of incoming messages, and unless
3863 * the limitation has been communicated by other means, it is recommended
3864 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3865 * while keeping the default value of 16KB for the incoming buffer.
3866 *
David Horstmann95d516f2021-05-04 18:36:56 +01003867 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003868 */
3869//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3870
Gilles Peskined3d02902020-03-04 21:35:27 +01003871/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3872 *
3873 * The maximum length of CIDs used for incoming DTLS messages.
3874 *
3875 */
3876//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3877
3878/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3879 *
3880 * The maximum length of CIDs used for outgoing DTLS messages.
3881 *
3882 */
3883//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3884
TRodziewicze8dd7092021-05-12 14:19:11 +02003885/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003886 *
3887 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003888 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003889 *
3890 * The padding will always be chosen so that the length of the
3891 * padded plaintext is a multiple of the value of this option.
3892 *
3893 * Note: A value of \c 1 means that no padding will be used
3894 * for outgoing records.
3895 *
3896 * Note: On systems lacking division instructions,
3897 * a power of two should be preferred.
3898 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003899//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003900
Angus Grattond8213d02016-05-25 20:56:48 +10003901/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3902 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003903 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003904 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003905 * This determines the size of the outgoing TLS I/O buffer in such a way
3906 * that it is capable of holding the specified amount of plaintext data,
3907 * regardless of the protection mechanism used.
3908 *
Angus Grattond8213d02016-05-25 20:56:48 +10003909 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3910 * the default inward 16384 byte buffer to conform to the TLS specification.
3911 *
3912 * The minimum required outward buffer size is determined by the handshake
3913 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3914 * The specific size requirement depends on the configured ciphers and any
3915 * certificate data which is sent during the handshake.
3916 *
David Horstmann95d516f2021-05-04 18:36:56 +01003917 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003918 */
3919//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3920
Hanno Beckere0b150f2018-08-21 15:51:03 +01003921/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3922 *
3923 * Maximum number of heap-allocated bytes for the purpose of
3924 * DTLS handshake message reassembly and future message buffering.
3925 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003926 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003927 * to account for a reassembled handshake message of maximum size,
3928 * together with its reassembly bitmap.
3929 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003930 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003931 * should be sufficient for all practical situations as it allows
3932 * to reassembly a large handshake message (such as a certificate)
3933 * while buffering multiple smaller handshake messages.
3934 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003935 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003936//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003937
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003938//#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 +02003939//#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 +02003940
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003941/**
3942 * Complete list of ciphersuites to use, in order of preference.
3943 *
3944 * \warning No dependency checking is done on that field! This option can only
3945 * be used to restrict the set of available ciphersuites. It is your
3946 * responsibility to make sure the needed modules are active.
3947 *
3948 * Use this to save a few hundred bytes of ROM (default ordering of all
3949 * available ciphersuites) and a few to a few hundred bytes of RAM.
3950 *
3951 * The value below is only an example, not the default.
3952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003953//#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 +02003954
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003955/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003956 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3957 *
3958 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003959 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003960 *
3961 * It must be positive and smaller than UINT32_MAX.
3962 *
3963 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3964 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003965 */
3966//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3967
3968/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003969 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3970 *
Jerry Yucf913512023-11-14 11:06:52 +08003971 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003972 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003973 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003974 * - The client ticket age is the time difference between the time when the
3975 * client proposes to the server to use the ticket and the time the client
3976 * received the ticket from the server.
3977 * - The server ticket age is the time difference between the time when the
3978 * server receives a proposition from the client to use the ticket and the
3979 * time when the ticket was created by the server.
3980 *
Jerry Yucf913512023-11-14 11:06:52 +08003981 * The ages might be different due to the client and server clocks not running
3982 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3983 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3984 * 6s, thus in the worst case clients and servers must sync up their system time
3985 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003986 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003987 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003988 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003989//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003990
3991/**
3992 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3993 *
3994 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3995 *
3996 * This must be less than 256.
3997 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003998//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003999
4000/**
4001 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4002 *
4003 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4004 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4005 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4006 *
4007 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004008//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004009
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004010/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004011//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004012//#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 +01004013
Gilles Peskine611179c2022-04-13 23:04:48 +02004014/** \} name SECTION: Module configuration options */