blob: dd390ff221d0fcd4bb5788e8240d1c3cfc536ff9 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020034 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000035 *
36 * Requires support for asm() in compiler.
37 *
38 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000039 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010040 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000041 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000042 * library/constant_time.c
Paul Bakker68041ec2009-04-19 21:17:55 +000043 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010044 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000045 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010046 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020048 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000051
Paul Bakkerf3b86c12011-01-27 15:24:17 +000052/**
Gilles Peskineed942f82017-06-08 15:19:20 +020053 * \def MBEDTLS_NO_UDBL_DIVISION
54 *
55 * The platform lacks support for double-width integer division (64-bit
56 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
57 *
58 * Used in:
59 * include/mbedtls/bignum.h
60 * library/bignum.c
61 *
62 * The bignum code uses double-width division to speed up some operations.
63 * Double-width division is often implemented in software that needs to
64 * be linked with the program. The presence of a double-width integer
65 * type is usually detected automatically through preprocessor macros,
66 * but the automatic detection cannot know whether the code needs to
67 * and can be linked with an implementation of division for that type.
68 * By default division is assumed to be usable if the type is present.
69 * Uncomment this option to prevent the use of double-width division.
70 *
71 * Note that division for the native integer type is always required.
72 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010073 * platform, but it need not support multiplication or division. In some
74 * cases it is also desirable to disable some double-width operations. For
75 * example, if double-width division is implemented in software, disabling
76 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020077 */
78//#define MBEDTLS_NO_UDBL_DIVISION
79
80/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020081 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
82 *
83 * The platform lacks support for 32x32 -> 64-bit multiplication.
84 *
85 * Used in:
86 * library/poly1305.c
87 *
88 * Some parts of the library may use multiplication of two unsigned 32-bit
89 * operands with a 64-bit result in order to speed up computations. On some
90 * platforms, this is not available in hardware and has to be implemented in
91 * software, usually in a library provided by the toolchain.
92 *
93 * Sometimes it is not desirable to have to link to that library. This option
94 * removes the dependency of that library on platforms that lack a hardware
95 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
96 *
97 * Note that depending on the compiler, this may decrease performance compared
98 * to using the library function provided by the toolchain.
99 */
100//#define MBEDTLS_NO_64BIT_MULTIPLICATION
101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000104 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000105 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200113 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200114 * System has time.h and time().
115 * The time does not need to be correct, only time differences are used,
116 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200117 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100118 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
119 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
120 * MBEDTLS_PLATFORM_STD_TIME.
121 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400122 * Comment if your system does not support time functions.
123 *
124 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
125 * interface - timing.c will include time.h on suitable platforms
126 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
127 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100130
131/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200132 * \def MBEDTLS_HAVE_TIME_DATE
133 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100134 * System has time.h, time(), and an implementation for
135 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100136 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200137 * the date should be correct). This is used to verify the validity period of
138 * X.509 certificates.
139 *
140 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100141 *
Hanno Becker6a739782018-09-05 15:06:19 +0100142 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100143 * behaves similarly to the gmtime_r() function from the C standard. Refer to
144 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100145 *
146 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100147 * mbedtls_platform_gmtime_r() at compile-time by using the macro
148 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200149 */
150#define MBEDTLS_HAVE_TIME_DATE
151
152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100154 *
155 * Enable the memory allocation layer.
156 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200157 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 * This allows different allocators (self-implemented or provided) to be
159 * provided to the platform abstraction layer.
160 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400161 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200162 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
163 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000164 * free() function pointer at runtime.
165 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400166 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100169 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400170 * An overview of how the value of mbedtls_calloc is determined:
171 *
172 * - if !MBEDTLS_PLATFORM_MEMORY
173 * - mbedtls_calloc = calloc
174 * - if MBEDTLS_PLATFORM_MEMORY
175 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
176 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
177 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
179 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
180 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
182 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
183 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
184 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
185 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
186 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
187 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
188 *
189 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
190 * - if !MBEDTLS_PLATFORM_STD_CALLOC
191 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
192 *
193 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
194 *
195 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
196 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
197 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
198 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
199 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
200 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100203 *
204 * Enable this layer to allow use of alternative memory allocators.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100207
208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200211 * Do not assign standard functions in the platform layer (e.g. calloc() to
212 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200213 *
214 * This makes sure there are no linking errors on platforms that do not support
215 * these functions. You will HAVE to provide alternatives, either at runtime
216 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
218 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
222 * Uncomment to prevent default assignment of standard functions in the
223 * platform layer.
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200226
227/**
Janos Follathc351d182016-03-21 08:43:59 +0000228 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200230 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100231 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200233 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 * alternative printf function pointer.
236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200239 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
240 * it will be enabled automatically by check_config.h
241 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200242 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000244 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100245 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
246 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 * Uncomment a macro to enable alternate implementation of specific base
248 * platform function
249 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200250//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100252//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_FPRINTF_ALT
254//#define MBEDTLS_PLATFORM_PRINTF_ALT
255//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200256//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100257//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100258//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800259//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260
261/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200262 * Uncomment the macro to let Mbed TLS use your alternate implementation of
263 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
264 * platform_util.c.
265 *
266 * gmtime() is not a thread-safe function as defined in the C standard. The
267 * library will try to use safer implementations of this function, such as
268 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
269 * system, the implementation of mbedtls_platform_gmtime_r() will default to
270 * using the standard gmtime(). In this case, calls from the library to
271 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
272 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
273 * library are also guarded with this mutex to avoid race conditions. However,
274 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
275 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
276 * supplied at compile time.
277 */
278//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
279
280/**
Gilles Peskine86733832023-09-07 15:02:39 +0200281 * Uncomment the macro to let Mbed TLS use your alternate implementation of
282 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
283 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200284 *
Gilles Peskine86733832023-09-07 15:02:39 +0200285 * By default, the library uses a system function such as memset_s()
286 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
287 * SecureZeroMemory (Windows). If no such function is detected, the library
288 * falls back to a plain C implementation. Compilers are technically
289 * permitted to optimize this implementation out, meaning that the memory is
290 * not actually wiped. The library tries to prevent that, but the C language
291 * makes it impossible to guarantee that the memory will always be wiped.
292 *
293 * If your platform provides a guaranteed method to wipe memory which
294 * `platform_util.c` does not detect, define this macro to the name of
295 * a function that takes two arguments, a `void *` pointer and a length,
296 * and wipes that many bytes starting at the specified address. For example,
297 * if your platform has explicit_bzero() but `platform_util.c` does not
298 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
299 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200300 */
301//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
302
303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Mark deprecated functions and features so that they generate a warning if
307 * used. Functionality deprecated in one version will usually be removed in the
308 * next version. You can enable this to help you prepare the transition to a
309 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100310 *
311 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100313 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000314 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317
318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100320 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000321 * Remove deprecated functions and features so that they generate an error if
322 * used. Functionality deprecated in one version will usually be removed in the
323 * next version. You can enable this to help you prepare the transition to a
324 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100325 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000326 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100330/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000331
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000332/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200333 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000334 *
335 * This section sets support for features that are or are not needed
336 * within the modules that are enabled.
337 * \{
338 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
TRodziewiczd8540832021-06-10 15:16:50 +0200343 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200344 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
348 * You will need to provide a header "timing_alt.h" and an implementation at
349 * compile time.
350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100352
Ron Eldora84c1cb2017-10-10 19:04:27 +0300353//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300354//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300355//#define MBEDTLS_ECDSA_VERIFY_ALT
356//#define MBEDTLS_ECDSA_SIGN_ALT
357//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200358
359/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200360 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200361 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200362 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200363 * hardware entropy collector.
364 *
365 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000366 * prototype as declared in library/entropy_poll.h, and accept NULL as first
367 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200368 *
369 * Uncomment to use your own hardware entropy collector.
370 */
371//#define MBEDTLS_ENTROPY_HARDWARE_ALT
372
373/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200374 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000375 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100376 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000377 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100378 * Uncomment this macro to use precomputed AES tables stored in ROM.
379 * Comment this macro to generate AES tables in RAM at runtime.
380 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100381 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
382 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100383 * initialization time before the first AES operation can be performed.
384 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
385 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
386 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100387 *
388 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000389 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000391
392/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100393 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200394 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100395 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200396 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100397 * Uncommenting this macro omits 75% of the AES tables from
398 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
399 * by computing their values on the fly during operations
400 * (the tables are entry-wise rotations of one another).
401 *
402 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100403 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100404 * runtime. Specifically, one has to compare 4 accesses within
405 * different tables to 4 accesses with additional arithmetic
406 * operations within the same table. The performance gain/loss
407 * depends on the system and memory details.
408 *
409 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200410 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100411//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200412
413/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800414 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
415 *
416 * Use only 128-bit keys in AES operations to save ROM.
417 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800418 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800419 * or 256-bit keys.
420 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800421 * Uncommenting this macro reduces the size of AES code by ~300 bytes
422 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800423 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800424 * Module: library/aes.c
425 *
426 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800427 */
428//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
429
Gilles Peskinea8861e02023-09-05 20:20:51 +0200430/*
431 * Disable plain C implementation for AES.
432 *
433 * When the plain C implementation is enabled, and an implementation using a
434 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
435 * detection will be used to select between them.
436 *
437 * If only one implementation is present, runtime detection will not be used.
438 * This configuration will crash at runtime if running on a CPU without the
439 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
440 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
441 */
442//#define MBEDTLS_AES_USE_HARDWARE_ONLY
443
Arto Kinnunen732ca322023-04-14 14:26:10 +0800444/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200446 *
447 * Use less ROM for the Camellia implementation (saves about 768 bytes).
448 *
449 * Uncomment this macro to use less memory for Camellia.
450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200451//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200452
453/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200454 * \def MBEDTLS_CHECK_RETURN_WARNING
455 *
456 * If this macro is defined, emit a compile-time warning if application code
457 * calls a function without checking its return value, but the return value
458 * should generally be checked in portable applications.
459 *
460 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
461 * implemented. Otherwise this option has no effect.
462 *
463 * Uncomment to get warnings on using fallible functions without checking
464 * their return value.
465 *
466 * \note This feature is a work in progress.
467 * Warnings will be added to more functions in the future.
468 *
469 * \note A few functions are considered critical, and ignoring the return
470 * value of these functions will trigger a warning even if this
471 * macro is not defined. To completely disable return value check
472 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
473 */
474//#define MBEDTLS_CHECK_RETURN_WARNING
475
476/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200477 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200478 *
479 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
480 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200481#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200482
483/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000485 *
486 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200488#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000489
490/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200491 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000492 *
493 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200495#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000496
497/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100498 * \def MBEDTLS_CIPHER_MODE_OFB
499 *
500 * Enable Output Feedback mode (OFB) for symmetric ciphers.
501 */
502#define MBEDTLS_CIPHER_MODE_OFB
503
504/**
505 * \def MBEDTLS_CIPHER_MODE_XTS
506 *
507 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
508 */
509#define MBEDTLS_CIPHER_MODE_XTS
510
511/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200512 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000513 *
514 * Enable NULL cipher.
515 * Warning: Only do so when you know what you are doing. This allows for
516 * encryption or channels without any security!
517 *
Ronald Croncee42702021-04-26 11:34:44 +0200518 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200519 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
520 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
521 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
522 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
523 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
524 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
525 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
526 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
527 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
528 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
529 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
530 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
531 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
532 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
533 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
534 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
535 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
536 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
537 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000538 *
539 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200541//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000542
543/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100544 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200545 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100546 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
547 * specific padding modes in the cipher layer with cipher modes that support
548 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200549 *
550 * If you disable all padding modes, only full blocks can be used with CBC.
551 *
552 * Enable padding modes in the cipher layer.
553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554#define MBEDTLS_CIPHER_PADDING_PKCS7
555#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
556#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
557#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200558
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200559/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
560 *
561 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800562 * Without this, CTR_DRBG uses a 256-bit key
563 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200564 */
565//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
566
Paul Bakker48e93c82013-08-14 12:21:18 +0200567/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200568 * Enable the verified implementations of ECDH primitives from Project Everest
569 * (currently only Curve25519). This feature changes the layout of ECDH
570 * contexts and therefore is a compatibility break for applications that access
571 * fields of a mbedtls_ecdh_context structure directly. See also
572 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000573 *
574 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
575 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200576 */
577//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
578
579/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100580 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200581 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100582 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
583 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200584 *
585 * Comment macros to disable the curve and functions for it
586 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200587/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200588#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
589#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
590#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
591#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
592#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
593#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
594#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
595#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
596#define MBEDTLS_ECP_DP_BP256R1_ENABLED
597#define MBEDTLS_ECP_DP_BP384R1_ENABLED
598#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200599/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200600#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000601#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200602
603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200604 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200605 *
606 * Enable specific 'modulo p' routines for each NIST prime.
607 * Depending on the prime and architecture, makes operations 4 to 8 times
608 * faster on the corresponding curve.
609 *
610 * Comment this macro to disable NIST curves optimisation.
611 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200613
614/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200615 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100616 *
617 * Enable "non-blocking" ECC operations that can return early and be resumed.
618 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200619 * This allows various functions to pause by returning
620 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
621 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
622 * order to further progress and eventually complete their operation. This is
623 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
624 * number of ECC operations a function may perform before pausing; see
625 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100626 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200627 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200628 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100629 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100630 * This option:
631 * - Adds xxx_restartable() variants of existing operations in the
632 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100633 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
634 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100635 * - ECDSA: signature generation & verification;
636 * - PK: signature generation & verification;
637 * - X509: certificate chain verification.
638 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
639 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
640 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
641 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000642 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100643 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100644 * - verification of the server's key exchange signature;
645 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100646 * - generation of the client's signature if client authentication is used,
647 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100648 *
649 * \note In the cases above, the usual SSL/TLS functions, such as
650 * mbedtls_ssl_handshake(), can now return
651 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200652 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100653 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
654 * restartable operations in PK, X.509 and TLS (see above) are not
655 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100656 * PSA, and are not restartable. These are temporary limitations that
657 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200658 *
Ron Eldor19779c42018-11-05 16:58:13 +0200659 * \note This option only works with the default software implementation of
660 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100661 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100662 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100663 * Requires: MBEDTLS_ECP_C
664 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100665 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100666 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200667//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100668
669/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200670 * Uncomment to enable using new bignum code in the ECC modules.
671 *
672 * \warning This is currently experimental, incomplete and therefore should not
673 * be used in production.
674 */
675//#define MBEDTLS_ECP_WITH_MPI_UINT
676
677/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200678 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100679 *
680 * Enable deterministic ECDSA (RFC 6979).
681 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
682 * may result in a compromise of the long-term signing key. This is avoided by
683 * the deterministic variant.
684 *
John Durkop36a82e52020-10-26 09:39:05 -0700685 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100686 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100687 * Comment this macro to disable deterministic ECDSA.
688 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200689#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100690
691/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200692 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200693 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200694 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200695 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200696 * This enables the following ciphersuites (if other requisites are
697 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200698 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
699 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
700 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
701 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
702 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
703 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
704 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
705 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
706 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
707 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200708 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200709#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200710
711/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200713 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200714 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200715 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200716 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200717 *
718 * This enables the following ciphersuites (if other requisites are
719 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200720 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
721 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
722 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
723 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
724 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
725 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
726 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
727 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
728 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
729 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100730 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100731 * \warning Using DHE constitutes a security risk as it
732 * is not possible to validate custom DH parameters.
733 * If possible, it is recommended users should consider
734 * preferring other methods of key exchange.
735 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100736 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200739
740/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200741 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200742 *
743 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
744 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200745 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200746 *
747 * This enables the following ciphersuites (if other requisites are
748 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200749 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
750 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
751 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
752 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
753 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
754 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200755 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200756#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200757
758/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200759 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200760 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200761 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200762 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200763 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
764 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200765 *
766 * This enables the following ciphersuites (if other requisites are
767 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
769 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
770 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
771 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
772 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
773 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
774 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
775 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
776 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
777 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200779#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200780
781/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200783 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200784 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200785 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
787 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200788 *
789 * This enables the following ciphersuites (if other requisites are
790 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200791 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
792 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
793 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
794 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
795 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
796 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
797 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
798 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
799 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
800 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
801 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
802 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200803 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200804#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200805
806/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200808 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200809 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200810 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200811 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
812 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200813 *
814 * This enables the following ciphersuites (if other requisites are
815 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200816 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
817 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
818 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
819 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
820 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
821 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
822 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
823 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
824 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
825 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
826 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
827 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100828 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100829 * \warning Using DHE constitutes a security risk as it
830 * is not possible to validate custom DH parameters.
831 * If possible, it is recommended users should consider
832 * preferring other methods of key exchange.
833 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100834 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200835 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200836#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200837
838/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200840 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200841 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200842 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200843 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
844 * MBEDTLS_RSA_C
845 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200847 *
848 * This enables the following ciphersuites (if other requisites are
849 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200850 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
851 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
852 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
853 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
854 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
855 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
856 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
857 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
858 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
859 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200860 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200861#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200862
863/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200864 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200865 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200866 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200867 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200868 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
869 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
870 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200871 *
872 * This enables the following ciphersuites (if other requisites are
873 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200874 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
875 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
876 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
877 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
878 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
879 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
880 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
881 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
882 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
883 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200884 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200886
887/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100889 *
890 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
891 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200892 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
893 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
894 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100895 *
896 * This enables the following ciphersuites (if other requisites are
897 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200898 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
899 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
900 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
901 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
902 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
903 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
904 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
905 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
906 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
907 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100908 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100910
911/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100913 *
914 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
915 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200916 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
917 * MBEDTLS_RSA_C
918 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100919 *
920 * This enables the following ciphersuites (if other requisites are
921 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200922 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
923 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
924 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
925 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
926 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
927 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
928 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
929 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
930 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
931 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100932 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200933#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100934
935/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200936 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
937 *
938 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
939 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200940 * \warning This is currently experimental. EC J-PAKE support is based on the
941 * Thread v1.0.0 specification; incompatible changes to the specification
942 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200943 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200944 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100945 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200946 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
947 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100948 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800949 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100950 * MBEDTLS_USE_PSA_CRYPTO is disabled).
951 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200952 * This enables the following ciphersuites (if other requisites are
953 * enabled as well):
954 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
955 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200956//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200957
958/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100960 *
961 * Enhance support for reading EC keys using variants of SEC1 not allowed by
962 * RFC 5915 and RFC 5480.
963 *
964 * Currently this means parsing the SpecifiedECDomain choice of EC
965 * parameters (only known groups are supported, not arbitrary domains, to
966 * avoid validation issues).
967 *
968 * Disable if you only need to support RFC 5915 + 5480 key formats.
969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100971
972/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200973 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
974 *
975 * Enable the support for parsing public keys of type Short Weierstrass
976 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200977 * compressed point format. This parsing is done through ECP module's functions.
978 *
979 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
980 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
981 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200982 */
983#define MBEDTLS_PK_PARSE_EC_COMPRESSED
984
985/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100987 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * Enable a dummy error function to make use of mbedtls_strerror() in
989 * third party libraries easier when MBEDTLS_ERROR_C is disabled
990 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200991 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
993 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100994 *
995 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100999
1000/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001002 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001003 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001004 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001005 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001006 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001008
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001009/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001010 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001011 *
1012 * Enable functions that use the filesystem.
1013 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001014#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001015
1016/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001018 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001019 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001020 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001021 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001022 * application.
1023 *
1024 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001027
1028/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001029 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001030 *
1031 * Do not use built-in platform entropy functions.
1032 * This is useful if your platform does not support
1033 * standards like the /dev/urandom or Windows CryptoAPI.
1034 *
1035 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001036 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001038
1039/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001041 *
1042 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1043 * default SHA-512 based one (if both are available).
1044 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001046 *
1047 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1048 * if you have performance concerns.
1049 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050 * This option is only useful if both MBEDTLS_SHA256_C and
1051 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001054
1055/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001056 * \def MBEDTLS_ENTROPY_NV_SEED
1057 *
1058 * Enable the non-volatile (NV) seed file-based entropy source.
1059 * (Also enables the NV seed read/write functions in the platform layer)
1060 *
1061 * This is crucial (if not required) on systems that do not have a
1062 * cryptographic entropy source (in hardware or kernel) available.
1063 *
1064 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1065 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001066 * \note The read/write functions that are used by the entropy source are
1067 * determined in the platform layer, and can be modified at runtime and/or
1068 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1069 *
1070 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001071 * with regular fopen(), please make sure you make a seedfile with the
1072 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1073 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001074 * and written to or you will get an entropy source error! The default
1075 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1076 * bytes from the file.
1077 *
1078 * \note The entropy collector will write to the seed file before entropy is
1079 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001080 */
1081//#define MBEDTLS_ENTROPY_NV_SEED
1082
Ronald Cron71016a92020-08-28 19:01:50 +02001083/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001084 *
Ronald Cron71016a92020-08-28 19:01:50 +02001085 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001086 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001087 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1088 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001089 *
1090 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001091 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001092 */
Ronald Cron71016a92020-08-28 19:01:50 +02001093//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001094
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001095/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001097 *
1098 * Enable debugging of buffer allocator memory issues. Automatically prints
1099 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1100 * function for 'debug output' of allocated memory.
1101 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001103 *
1104 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001105 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001107
1108/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001110 *
1111 * Include backtrace information with each allocated block.
1112 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001113 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001114 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001115 *
1116 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001117 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001118//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001119
1120/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001121 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001122 *
1123 * Support external private RSA keys (eg from a HSM) in the PK layer.
1124 *
1125 * Comment this macro to disable support for external private RSA keys.
1126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001128
1129/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001131 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001132 * Enable support for PKCS#1 v1.5 encoding.
1133 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001134 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001135 *
Paul Bakker48377d92013-08-30 12:06:24 +02001136 * This enables support for PKCS#1 v1.5 operations.
1137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001138#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001139
1140/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001141 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001142 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001143 * Enable support for PKCS#1 v2.1 encoding.
1144 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001145 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001146 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001147 * \warning If using a hash that is only provided by PSA drivers, you must
1148 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001149 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001150 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001153
Steven Cooreman6801f082021-02-19 17:21:22 +01001154/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1155 *
1156 * Enable support for platform built-in keys. If you enable this feature,
1157 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1158 * See the documentation of that function for more information.
1159 *
1160 * Built-in keys are typically derived from a hardware unique key or
1161 * stored in a secure element.
1162 *
1163 * Requires: MBEDTLS_PSA_CRYPTO_C.
1164 *
1165 * \warning This interface is experimental and may change or be removed
1166 * without notice.
1167 */
1168//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1169
Ronald Cron3768ac12021-01-26 16:58:00 +01001170/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1171 *
1172 * Enable support for PSA crypto client.
1173 *
1174 * \note This option allows to include the code necessary for a PSA
1175 * crypto client when the PSA crypto implementation is not included in
1176 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1177 * code to set and get PSA key attributes.
1178 * The development of PSA drivers partially relying on the library to
1179 * fulfill the hardware gaps is another possible usage of this option.
1180 *
1181 * \warning This interface is experimental and may change or be removed
1182 * without notice.
1183 */
1184//#define MBEDTLS_PSA_CRYPTO_CLIENT
1185
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001186/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1187 *
1188 * Make the PSA Crypto module use an external random generator provided
1189 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1190 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001191 * \note This random generator must deliver random numbers with cryptographic
1192 * quality and high performance. It must supply unpredictable numbers
1193 * with a uniform distribution. The implementation of this function
1194 * is responsible for ensuring that the random generator is seeded
1195 * with sufficient entropy. If you have a hardware TRNG which is slow
1196 * or delivers non-uniform output, declare it as an entropy source
1197 * with mbedtls_entropy_add_source() instead of enabling this option.
1198 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001199 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001200 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1201 * and define a function called mbedtls_psa_external_get_random()
1202 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001203 * ```
1204 * psa_status_t mbedtls_psa_external_get_random(
1205 * mbedtls_psa_external_random_context_t *context,
1206 * uint8_t *output, size_t output_size, size_t *output_length);
1207 * );
1208 * ```
1209 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001210 * The function must fill the \c output buffer with \c output_size bytes
1211 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001212 *
1213 * Requires: MBEDTLS_PSA_CRYPTO_C
1214 *
1215 * \warning If you enable this option, code that uses the PSA cryptography
1216 * interface will not use any of the entropy sources set up for
1217 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1218 * enables.
1219 *
1220 * \note This option is experimental and may be removed without notice.
1221 */
1222//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1223
Paul Bakker9dcc3222011-03-08 14:16:06 +00001224/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001225 * \def MBEDTLS_PSA_CRYPTO_SPM
1226 *
1227 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1228 * Partition Manager) integration which separates the code into two parts: a
1229 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1230 * Environment).
1231 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001232 * If you enable this option, your build environment must include a header
1233 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1234 * header files, or in another directory on the compiler's include search
1235 * path). Alternatively, your platform may customize the header
1236 * `psa/crypto_platform.h`, in which case it can skip or replace the
1237 * inclusion of `"crypto_spe.h"`.
1238 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001239 * Module: library/psa_crypto.c
1240 * Requires: MBEDTLS_PSA_CRYPTO_C
1241 *
1242 */
1243//#define MBEDTLS_PSA_CRYPTO_SPM
1244
1245/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001246 * Uncomment to enable p256-m. This is an alternative implementation of
1247 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1248 * Compared to the default implementation:
1249 *
1250 * - p256-m has a much smaller code size and RAM footprint.
1251 * - p256-m is only available via the PSA API. This includes the pk module
1252 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1253 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1254 * over the core arithmetic, or deterministic derivation of keys.
1255 *
1256 * We recommend enabling this option if your application uses the PSA API
1257 * and the only elliptic curve support it needs is ECDH and ECDSA over
1258 * SECP256R1.
1259 *
1260 * If you enable this option, you do not need to enable any ECC-related
1261 * MBEDTLS_xxx option. You do need to separately request support for the
1262 * cryptographic mechanisms through the PSA API:
1263 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1264 * configuration;
1265 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1266 * - #PSA_WANT_ECC_SECP_R1_256;
1267 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1268 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1269 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1270 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1271 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001272 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001273 * \note To benefit from the smaller code size of p256-m, make sure that you
1274 * do not enable any ECC-related option not supported by p256-m: this
1275 * would cause the built-in ECC implementation to be built as well, in
1276 * order to provide the required option.
1277 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001278 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1279 * SECP256R1 are disabled as they are not supported by this driver.
1280 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1281 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001282 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001283 */
1284//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1285
1286/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001287 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001288 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001289 * Enable support for entropy injection at first boot. This feature is
1290 * required on systems that do not have a built-in entropy source (TRNG).
1291 * This feature is currently not supported on systems that have a built-in
1292 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001293 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001294 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001295 *
1296 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001297//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001298
1299/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001300 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001301 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001302 * Assume all buffers passed to PSA functions are owned exclusively by the
1303 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001304 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001305 * This option may be enabled if all buffers passed to any PSA function reside
1306 * in memory that is accessible only to the PSA function during its execution.
1307 *
1308 * This option MUST be disabled whenever buffer arguments are in memory shared
1309 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001310 * across a trust boundary.
1311 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001312 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001313 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001314 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001315 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001316 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001317//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001318
1319/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001321 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001322 * Do not use the Chinese Remainder Theorem
1323 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001324 *
1325 * Uncomment this macro to disable the use of CRT in RSA.
1326 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001328//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001329
1330/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001331 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001332 *
1333 * Enable the checkup functions (*_self_test).
1334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001336
1337/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001338 * \def MBEDTLS_SHA256_SMALLER
1339 *
1340 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1341 * lower performance.
1342 *
Adam Wolf039080f2019-09-10 09:53:08 -05001343 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001344 * performance and size. This version optimizes more aggressively for size at
1345 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1346 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1347 * 30%.
1348 *
1349 * Uncomment to enable the smaller implementation of SHA256.
1350 */
1351//#define MBEDTLS_SHA256_SMALLER
1352
1353/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001354 * \def MBEDTLS_SHA512_SMALLER
1355 *
1356 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1357 * lower performance.
1358 *
1359 * Uncomment to enable the smaller implementation of SHA512.
1360 */
1361//#define MBEDTLS_SHA512_SMALLER
1362
1363/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001364 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001365 *
1366 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001367 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001368 * with other servers, only debugging of failures is harder.
1369 *
1370 * The advantage of not sending alert messages, is that no information is given
1371 * about reasons for failures thus preventing adversaries of gaining intel.
1372 *
1373 * Enable sending of all alert messages
1374 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001376
1377/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001378 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1379 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001380 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001381 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001382 * in the underlying transport. The CID functionality is described
1383 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001384 *
1385 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001386 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1387 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1388 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001389 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001390 * The maximum lengths of outgoing and incoming CIDs can be configured
1391 * through the options
1392 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1393 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1394 *
1395 * Requires: MBEDTLS_SSL_PROTO_DTLS
1396 *
1397 * Uncomment to enable the Connection ID extension.
1398 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001399#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1400
1401
1402/**
1403 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1404 *
1405 * Defines whether RFC 9146 (default) or the legacy version
1406 * (version draft-ietf-tls-dtls-connection-id-05,
1407 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1408 * is used.
1409 *
1410 * Set the value to 0 for the standard version, and
1411 * 1 for the legacy draft version.
1412 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001413 * \deprecated Support for the legacy version of the DTLS
1414 * Connection ID feature is deprecated. Please
1415 * switch to the standardized version defined
1416 * in RFC 9146 enabled by utilizing
1417 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1418 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1419 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001420 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1421 */
1422#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001423
1424/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001425 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1426 *
1427 * Enable asynchronous external private key operations in SSL. This allows
1428 * you to configure an SSL connection to call an external cryptographic
1429 * module to perform private key operations instead of performing the
1430 * operation inside the library.
1431 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001432 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001433 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001434//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001435
1436/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001437 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1438 *
1439 * Enable serialization of the TLS context structures, through use of the
1440 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1441 *
1442 * This pair of functions allows one side of a connection to serialize the
1443 * context associated with the connection, then free or re-use that context
1444 * while the serialized state is persisted elsewhere, and finally deserialize
1445 * that state to a live context for resuming read/write operations on the
1446 * connection. From a protocol perspective, the state of the connection is
1447 * unaffected, in particular this is entirely transparent to the peer.
1448 *
1449 * Note: this is distinct from TLS session resumption, which is part of the
1450 * protocol and fully visible by the peer. TLS session resumption enables
1451 * establishing new connections associated to a saved session with shorter,
1452 * lighter handshakes, while context serialization is a local optimization in
1453 * handling a single, potentially long-lived connection.
1454 *
1455 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1456 * saved after the handshake to allow for more efficient serialization, so if
1457 * you don't need this feature you'll save RAM by disabling it.
1458 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001459 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1460 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001461 * Comment to disable the context serialization APIs.
1462 */
1463#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1464
1465/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001467 *
1468 * Enable the debug messages in SSL module for all issues.
1469 * Debug messages have been disabled in some places to prevent timing
1470 * attacks due to (unbalanced) debugging function calls.
1471 *
1472 * If you need all error reporting you should enable this during debugging,
1473 * but remove this for production servers that should log as well.
1474 *
1475 * Uncomment this macro to report all debug messages on errors introducing
1476 * a timing side-channel.
1477 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001479//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001480
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001481/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001482 *
1483 * Enable support for Encrypt-then-MAC, RFC 7366.
1484 *
1485 * This allows peers that both support it to use a more robust protection for
1486 * ciphersuites using CBC, providing deep resistance against timing attacks
1487 * on the padding or underlying cipher.
1488 *
1489 * This only affects CBC ciphersuites, and is useless if none is defined.
1490 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001491 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001492 *
1493 * Comment this macro to disable support for Encrypt-then-MAC
1494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001497/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001498 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001499 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1500 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001501 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001502 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001503 * attacks, but it is recommended to always use it (even if you disable
1504 * renegotiation), since it actually fixes a more fundamental issue in the
1505 * original SSL/TLS design, and has implications beyond Triple Handshake.
1506 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001507 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001508 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001509 * Comment this macro to disable support for Extended Master Secret.
1510 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001511#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001512
Paul Bakkerd66f0702013-01-31 16:57:45 +01001513/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001514 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1515 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001516 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001517 * giving access to the peer's certificate after completion of the handshake.
1518 *
1519 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1520 * recommended to disable this option for reduced RAM usage.
1521 *
1522 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1523 * defined, but always returns \c NULL.
1524 *
1525 * \note This option has no influence on the protection against the
1526 * triple handshake attack. Even if it is disabled, Mbed TLS will
1527 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001528 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001529 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001530 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001531 *
1532 * Comment this macro to disable storing the peer's certificate
1533 * after the handshake.
1534 */
1535#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1536
1537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001538 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001539 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001540 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001541 *
1542 * The two main uses of renegotiation are (1) refresh keys on long-lived
1543 * connections and (2) client authentication after the initial handshake.
1544 * If you don't need renegotiation, it's probably better to disable it, since
1545 * it has been associated with security issues in the past and is easy to
1546 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001547 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001548 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1549 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001550 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001551 *
1552 * \note Even if this option is disabled, both client and server are aware
1553 * of the Renegotiation Indication Extension (RFC 5746) used to
1554 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1555 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1556 * configuration of this extension).
1557 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001558 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001560
1561/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001563 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001564 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001565 *
1566 * Comment this macro to disable support for the max_fragment_length extension
1567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001568#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001569
1570/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001571 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1572 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001573 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001574 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001575 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1576 *
1577 * Uncomment this macro to enable support for the record_size_limit extension
1578 */
1579//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1580
1581/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001583 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001584 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001585 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001586 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001587 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1588 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001589 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001590 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001591 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001592 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1593 * are only provided by PSA drivers, you must call psa_crypto_init() before
1594 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001595 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001596 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001598#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001599
1600/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001601 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001602 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001603 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001604 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001605 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001606 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001607 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001608 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001609 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001610 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001611 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1612 * directly performed by TLS 1.3 code. As a consequence, you must
1613 * call psa_crypto_init() before the first TLS 1.3 handshake.
1614 *
1615 * \note Cryptographic operations performed indirectly via another module
1616 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1617 * running handshake hash) only use PSA crypto if
1618 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001619 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001620 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001621 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001622#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001623
1624/**
Ronald Cronab65c522021-11-24 10:47:20 +01001625 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1626 *
1627 * Enable TLS 1.3 middlebox compatibility mode.
1628 *
1629 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1630 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1631 * expecting TLS 1.2 traffic.
1632 *
1633 * Turning on the compatibility mode comes at the cost of a few added bytes
1634 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1635 * that don't use it. Therefore, unless transmission bandwidth is critical and
1636 * you know that middlebox compatibility issues won't occur, it is therefore
1637 * recommended to set this option.
1638 *
1639 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001640 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1641 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001642 *
1643 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001644#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001645
1646/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001647 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1648 *
1649 * Enable TLS 1.3 PSK key exchange mode.
1650 *
1651 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1652 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1653 * effect on the build.
1654 *
1655 */
1656#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1657
1658/**
1659 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1660 *
1661 * Enable TLS 1.3 ephemeral key exchange mode.
1662 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001663 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001664 * MBEDTLS_X509_CRT_PARSE_C
1665 * and at least one of:
1666 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1667 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001668 *
1669 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1670 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1671 * effect on the build.
1672 *
1673 */
1674#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1675
1676/**
1677 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1678 *
1679 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1680 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001681 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001682 *
1683 * Comment to disable support for the PSK ephemeral key exchange mode in
1684 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1685 * have any effect on the build.
1686 *
1687 */
1688#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1689
1690/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 * \def MBEDTLS_SSL_EARLY_DATA
1692 *
1693 * Enable support for RFC 8446 TLS 1.3 early data.
1694 *
1695 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1696 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1697 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1698 *
1699 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1700 * is not enabled, this option does not have any effect on the build.
1701 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001702 * \note The maximum amount of early data can be set with
1703 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1704 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001706//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001707
1708/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001709 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001710 *
1711 * Enable support for DTLS (all available versions).
1712 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001713 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001714 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001715 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001716 *
1717 * Comment this macro to disable support for DTLS
1718 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001720
1721/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001723 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001724 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001725 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001726 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001727 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001729
1730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001732 *
1733 * Enable support for the anti-replay mechanism in DTLS.
1734 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735 * Requires: MBEDTLS_SSL_TLS_C
1736 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001737 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001738 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001739 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001740 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001741 * Comment this to disable anti-replay in DTLS.
1742 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001744
1745/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001747 *
1748 * Enable support for HelloVerifyRequest on DTLS servers.
1749 *
1750 * This feature is highly recommended to prevent DTLS servers being used as
1751 * amplifiers in DoS attacks against other hosts. It should always be enabled
1752 * unless you know for sure amplification cannot be a problem in the
1753 * environment in which your server operates.
1754 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001755 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001756 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001757 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001758 *
1759 * Comment this to disable support for HelloVerifyRequest.
1760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001762
1763/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001764 * \def MBEDTLS_SSL_DTLS_SRTP
1765 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001766 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001767 * through the use_srtp extension.
1768 *
1769 * \note This feature provides the minimum functionality required
1770 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1771 * the associated SRTP packet protection key material.
1772 * In particular, the SRTP packet protection itself, as well as the
1773 * demultiplexing of RTP and DTLS packets at the datagram layer
1774 * (see Section 5 of RFC 5764), are not handled by this feature.
1775 * Instead, after successful completion of a handshake negotiating
1776 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001777 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001778 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1779 * (this is implemented in the SSL example programs).
1780 * The resulting key should then be passed to an SRTP stack.
1781 *
1782 * Setting this option enables the runtime API
1783 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1784 * through which the supported DTLS-SRTP protection
1785 * profiles can be configured. You must call this API at
1786 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001787 *
1788 * Requires: MBEDTLS_SSL_PROTO_DTLS
1789 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001790 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001791 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001792//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001793
1794/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001795 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1796 *
1797 * Enable server-side support for clients that reconnect from the same port.
1798 *
1799 * Some clients unexpectedly close the connection and try to reconnect using the
1800 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001801 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001802 * flag enables that support.
1803 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001804 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001805 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001806 * Comment this to disable support for clients reusing the source port.
1807 */
1808#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1809
1810/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001812 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001813 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001814 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001815 * session store remains the responsibility of the application, though).
1816 * Server-side, you also need to provide callbacks for writing and parsing
1817 * tickets, including authenticated encryption and key management. Example
1818 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001819 *
1820 * Comment this macro to disable support for SSL session tickets
1821 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001823
1824/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001826 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001827 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001828 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001829 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001830 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001831 * Comment this macro to disable support for server name indication in SSL
1832 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001833#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001834
1835/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001836 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1837 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001838 * When this option is enabled, the SSL buffer will be resized automatically
1839 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001840 *
1841 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001842 */
1843//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1844
1845/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001846 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1847 *
1848 * Enable testing of the constant-flow nature of some sensitive functions with
1849 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001850 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001851 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001852 * This setting requires compiling with clang -fsanitize=memory. The test
1853 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001854 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001855 * \warning This macro is only used for extended testing; it is not considered
1856 * part of the library's API, so it may change or disappear at any time.
1857 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001858 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001859 */
1860//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1861
1862/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001863 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1864 *
1865 * Enable testing of the constant-flow nature of some sensitive functions with
1866 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001867 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001868 *
1869 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001870 * testing if the tests suites are run with valgrind's memcheck. This can be
1871 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1872 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001873 *
1874 * \warning This macro is only used for extended testing; it is not considered
1875 * part of the library's API, so it may change or disappear at any time.
1876 *
1877 * Uncomment to enable testing of the constant-flow nature of selected code.
1878 */
1879//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1880
1881/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001882 * \def MBEDTLS_TEST_HOOKS
1883 *
1884 * Enable features for invasive testing such as introspection functions and
1885 * hooks for fault injection. This enables additional unit tests.
1886 *
1887 * Merely enabling this feature should not change the behavior of the product.
1888 * It only adds new code, and new branching points where the default behavior
1889 * is the same as when this feature is disabled.
1890 * However, this feature increases the attack surface: there is an added
1891 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1892 * Therefore this feature must never be enabled in production.
1893 *
1894 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1895 * information.
1896 *
1897 * Uncomment to enable invasive tests.
1898 */
1899//#define MBEDTLS_TEST_HOOKS
1900
1901/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001903 *
1904 * Provide your own alternate threading implementation.
1905 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001907 *
1908 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001909 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001911
1912/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001914 *
1915 * Enable the pthread wrapper layer for the threading layer.
1916 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001917 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001918 *
1919 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001920 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001922
1923/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001924 * \def MBEDTLS_USE_PSA_CRYPTO
1925 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001926 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1927 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001928 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001929 * \note Development of this option is currently in progress, and parts of Mbed
1930 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001931 * will still continue to work as usual, so enabling this option should not
1932 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001933 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001934 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001935 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1936 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001937 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001938 * \note An important and desirable effect of this option is that it allows
1939 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1940 * 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 +02001941 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001942 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1943 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001944 *
1945 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001946 *
1947 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001948 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001949 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001951//#define MBEDTLS_USE_PSA_CRYPTO
1952
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001954 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1955 *
John Durkop185764f2020-10-12 21:32:12 -07001956 * This setting allows support for cryptographic mechanisms through the PSA
1957 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001958 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001959 * When this option is disabled, the PSA API exposes the cryptographic
1960 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1961 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001962 *
1963 * When this option is enabled, the PSA API exposes the cryptographic
1964 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1965 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1966 * automatically enabled if required (i.e. if no PSA driver provides the
1967 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1968 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001969 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001970 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001971 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001972 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001973 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1974 * symbols is not completely finalized yet, and the configuration
1975 * tooling is not ideally adapted to having two separate configuration
1976 * files.
1977 * Future minor releases of Mbed TLS may make minor changes to those
1978 * symbols, but we will endeavor to provide a transition path.
1979 * Nonetheless, this option is considered mature enough to use in
1980 * production, as long as you accept that you may need to make
1981 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001982 */
1983//#define MBEDTLS_PSA_CRYPTO_CONFIG
1984
1985/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001986 * \def MBEDTLS_VERSION_FEATURES
1987 *
1988 * Allow run-time checking of compile-time enabled features. Thus allowing users
1989 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001990 * support via mbedtls_version_check_feature().
1991 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001992 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00001993 *
1994 * Comment this to disable run-time checking and save ROM space
1995 */
1996#define MBEDTLS_VERSION_FEATURES
1997
1998/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001999 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2000 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002001 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002002 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2003 * the set of trusted certificates through a callback instead of a linked
2004 * list.
2005 *
2006 * This is useful for example in environments where a large number of trusted
2007 * certificates is present and storing them in a linked list isn't efficient
2008 * enough, or when the set of trusted certificates changes frequently.
2009 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002010 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002011 * `mbedtls_ssl_conf_ca_cb()` for more information.
2012 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002013 * Requires: MBEDTLS_X509_CRT_PARSE_C
2014 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002015 * Uncomment to enable trusted certificate callbacks.
2016 */
2017//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2018
2019/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002020 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002021 *
Chris Jones2c745862020-12-16 11:41:06 +00002022 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002023 *
Chris Jones2c745862020-12-16 11:41:06 +00002024 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002025 * and other functions/constants only used by these functions, thus reducing
2026 * the code footprint by several KB.
2027 */
Chris Jones2c745862020-12-16 11:41:06 +00002028//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002029
2030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002032 *
2033 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2034 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2035 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002036 * Requires: MBEDTLS_PKCS1_V21
2037 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002038 * Comment this macro to disallow using RSASSA-PSS in certificates.
2039 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002040#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002041/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002042
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002043/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002044 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002045 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002046 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002047 * \{
2048 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002049
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002050/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002051 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002052 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002053 * Enable AES-NI support on x86-64 or x86-32.
2054 *
2055 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002056 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002057 * - GCC, x86-64, target not explicitly supporting AESNI:
2058 * requires MBEDTLS_HAVE_ASM.
2059 * - GCC, x86-32, target not explicitly supporting AESNI:
2060 * not supported.
2061 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2062 * For this assembly-less implementation, you must currently compile
2063 * `library/aesni.c` and `library/aes.c` with machine options to enable
2064 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2065 * `clang -maes -mpclmul`.
2066 * - Non-x86 targets: this option is silently ignored.
2067 * - Other compilers: this option is silently ignored.
2068 *
2069 * \note
2070 * Above, "GCC" includes compatible compilers such as Clang.
2071 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002072 *
2073 * Module: library/aesni.c
2074 * Caller: library/aes.c
2075 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002076 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002077 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002078 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002079 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002081
2082/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002083 * \def MBEDTLS_AESCE_C
2084 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002085 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002086 *
2087 * Module: library/aesce.c
2088 * Caller: library/aes.c
2089 *
Jerry Yuf015a932023-04-25 10:38:03 +08002090 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002091 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002092 * \warning Runtime detection only works on Linux. For non-Linux operating
2093 * system, Armv8-A Cryptographic Extensions must be supported by
2094 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002095 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002096 * \note Minimum compiler versions for this feature when targeting aarch64
2097 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2098 * Minimum compiler versions for this feature when targeting 32-bit
2099 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002100 *
2101 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2102 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002103 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002104 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002105 */
2106#define MBEDTLS_AESCE_C
2107
2108/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002110 *
2111 * Enable the AES block cipher.
2112 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002113 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002114 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002115 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002116 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002117 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002118 * This module enables the following ciphersuites (if other requisites are
2119 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2121 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2122 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2123 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2124 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2125 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2126 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2127 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2128 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2129 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2130 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2131 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2132 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2133 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2134 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2135 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2136 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2137 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2138 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2139 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2140 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2141 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2142 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2143 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2144 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2145 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2146 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2147 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2148 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2149 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2150 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2151 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2152 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2153 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2154 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2155 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2156 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2157 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2158 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2159 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2160 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2161 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2162 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2163 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2164 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2165 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2166 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2167 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2168 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2169 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2170 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2171 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2172 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2173 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2174 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2175 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2176 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2177 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002178 *
Paul Bakkercff68422013-09-15 20:43:33 +02002179 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002180 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002182
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002183/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002184 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002185 *
2186 * Enable the generic ASN1 parser.
2187 *
2188 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002189 * Caller: library/x509.c
2190 * library/dhm.c
2191 * library/pkcs12.c
2192 * library/pkcs5.c
2193 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002194 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002195#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002196
2197/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002198 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002199 *
2200 * Enable the generic ASN1 writer.
2201 *
2202 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002203 * Caller: library/ecdsa.c
2204 * library/pkwrite.c
2205 * library/x509_create.c
2206 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002207 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002208 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002209#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002210
2211/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002212 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002213 *
2214 * Enable the Base64 module.
2215 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002216 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002217 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002218 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002219 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002220 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002221#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002222
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002223/**
Yanray Wange367e472023-10-31 17:23:04 +08002224 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2225 *
2226 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2227 *
2228 * \note This feature is incompatible with insecure block cipher,
2229 * MBEDTLS_DES_C, and cipher modes which always require decryption
2230 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002231 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2232 * this feature is incompatible with following supported PSA equivalence,
2233 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2234 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002235 *
2236 * Module: library/aes.c
2237 * library/aesce.c
2238 * library/aesni.c
2239 * library/aria.c
2240 * library/camellia.c
2241 * library/cipher.c
2242 */
2243//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2244
2245/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002246 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002247 *
Paul Bakker9a736322012-11-14 12:39:52 +00002248 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002249 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002250 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002251 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002252 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002253 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002254 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002255 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002256 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002257 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002258 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002259 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002260 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002261 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002263#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002264
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002265/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002266 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002267 *
2268 * Enable the Camellia block cipher.
2269 *
Paul Bakker38119b12009-01-10 23:31:23 +00002270 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002271 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002272 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002273 * This module enables the following ciphersuites (if other requisites are
2274 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002275 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2276 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2277 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2278 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2279 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2280 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2281 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2282 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2283 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2284 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2285 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2286 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2287 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2288 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2289 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2290 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2291 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2292 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2293 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2294 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2295 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2296 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2297 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2298 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2299 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2300 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2301 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2302 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2303 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2304 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2305 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2306 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2307 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2308 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2309 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2310 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2311 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2312 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2313 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2314 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2315 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2316 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002318#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002319
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002320/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002321 * \def MBEDTLS_ARIA_C
2322 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002323 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002324 *
2325 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002326 * Caller: library/cipher.c
2327 *
2328 * This module enables the following ciphersuites (if other requisites are
2329 * enabled as well):
2330 *
2331 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2332 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2333 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2334 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2335 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2336 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2337 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2338 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2339 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2340 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2341 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2342 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2343 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2344 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2345 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2346 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2347 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2348 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2349 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2350 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2351 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2352 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2353 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2354 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2355 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2356 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2357 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2358 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2359 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2360 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2361 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2362 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2363 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2364 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2365 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2366 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2367 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2368 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002369 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002370#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002371
2372/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002374 *
2375 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2376 *
2377 * Module: library/ccm.c
2378 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002379 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2380 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002381 *
2382 * This module enables the AES-CCM ciphersuites, if other requisites are
2383 * enabled as well.
2384 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002385#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002386
2387/**
Daniel King34b822c2016-05-15 17:28:08 -03002388 * \def MBEDTLS_CHACHA20_C
2389 *
2390 * Enable the ChaCha20 stream cipher.
2391 *
2392 * Module: library/chacha20.c
2393 */
2394#define MBEDTLS_CHACHA20_C
2395
2396/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002397 * \def MBEDTLS_CHACHAPOLY_C
2398 *
2399 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2400 *
2401 * Module: library/chachapoly.c
2402 *
2403 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2404 */
2405#define MBEDTLS_CHACHAPOLY_C
2406
2407/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002409 *
2410 * Enable the generic cipher layer.
2411 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002412 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002413 * Caller: library/ccm.c
2414 * library/cmac.c
2415 * library/gcm.c
2416 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002417 * library/pkcs12.c
2418 * library/pkcs5.c
2419 * library/psa_crypto_aead.c
2420 * library/psa_crypto_mac.c
2421 * library/ssl_ciphersuites.c
2422 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002423 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002424 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2425 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002426 *
2427 * Uncomment to enable generic cipher wrappers.
2428 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002430
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002431/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002432 * \def MBEDTLS_CMAC_C
2433 *
Simon Butcher327398a2016-10-05 14:09:11 +01002434 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2435 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002436 *
2437 * Module: library/cmac.c
2438 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002439 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002440 *
2441 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002442#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002443
2444/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002445 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002446 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002447 * Enable the CTR_DRBG AES-based random generator.
2448 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002449 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002450 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002451 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002452 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2453 * is used.
2454 *
2455 * \warning When using PSA, the user should call `psa_crypto_init()` before
2456 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2457 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002458 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2459 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002460 * \note To achieve a 256-bit security strength with CTR_DRBG,
2461 * you must use AES-256 *and* use sufficient entropy.
2462 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002463 *
2464 * Module: library/ctr_drbg.c
2465 * Caller:
2466 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002467 * Requires: MBEDTLS_AES_C or
2468 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2469 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002470 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002471 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002474
2475/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002476 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002477 *
2478 * Enable the debug functions.
2479 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002480 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002481 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002482 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002483 * library/ssl_tls12_*.c
2484 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002485 *
2486 * This module provides debugging functions.
2487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002489
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002490/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002492 *
2493 * Enable the DES block cipher.
2494 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002495 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002496 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002497 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002498 *
Paul Bakkercff68422013-09-15 20:43:33 +02002499 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002500 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002501 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002502 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002504#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002505
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002506/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002508 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002509 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002510 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002511 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002512 * Caller: library/ssl_tls.c
2513 * library/ssl*_client.c
2514 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002515 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002516 * This module is used by the following key exchanges:
2517 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002518 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002519 * \warning Using DHE constitutes a security risk as it
2520 * is not possible to validate custom DH parameters.
2521 * If possible, it is recommended users should consider
2522 * preferring other methods of key exchange.
2523 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002524 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002527
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002528/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002529 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002530 *
2531 * Enable the elliptic curve Diffie-Hellman library.
2532 *
2533 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002534 * Caller: library/psa_crypto.c
2535 * library/ssl_tls.c
2536 * library/ssl*_client.c
2537 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002538 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002539 * This module is used by the following key exchanges:
2540 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002541 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002544#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002545
2546/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002547 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002548 *
2549 * Enable the elliptic curve DSA library.
2550 *
2551 * Module: library/ecdsa.c
2552 * Caller:
2553 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002554 * This module is used by the following key exchanges:
2555 * ECDHE-ECDSA
2556 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002557 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2558 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2559 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002560 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002561#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002562
2563/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002564 * \def MBEDTLS_ECJPAKE_C
2565 *
2566 * Enable the elliptic curve J-PAKE library.
2567 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002568 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2569 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002570 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002571 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002572 * Module: library/ecjpake.c
2573 * Caller:
2574 *
2575 * This module is used by the following key exchanges:
2576 * ECJPAKE
2577 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002578 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002579 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002580 * \warning If using a hash that is only provided by PSA drivers, you must
2581 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002582 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002583#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002584
2585/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002587 *
2588 * Enable the elliptic curve over GF(p) library.
2589 *
2590 * Module: library/ecp.c
2591 * Caller: library/ecdh.c
2592 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002593 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002594 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002596 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002597#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002598
2599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002601 *
2602 * Enable the platform-specific entropy code.
2603 *
2604 * Module: library/entropy.c
2605 * Caller:
2606 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002608 *
2609 * This module provides a generic entropy pool
2610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002612
2613/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002614 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002615 *
2616 * Enable error code to error string conversion.
2617 *
2618 * Module: library/error.c
2619 * Caller:
2620 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002622 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002624
2625/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002627 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002628 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002629 *
2630 * Module: library/gcm.c
2631 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002632 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2633 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002634 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002635 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2636 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002637 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002638#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002639
2640/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002641 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002642 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002643 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002644 * Can significantly increase throughput on systems without GCM hardware
2645 * acceleration (e.g., AESNI, AESCE).
2646 *
Matthias Schulz78266782024-02-08 13:54:48 +01002647 * The mbedtls_gcm_context size will increase by 3840 bytes.
2648 * The code size will increase by roughly 344 bytes.
2649 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002650 * Module: library/gcm.c
2651 *
2652 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002653 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002654//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002655
2656/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002657 * \def MBEDTLS_HKDF_C
2658 *
2659 * Enable the HKDF algorithm (RFC 5869).
2660 *
2661 * Module: library/hkdf.c
2662 * Caller:
2663 *
2664 * Requires: MBEDTLS_MD_C
2665 *
2666 * This module adds support for the Hashed Message Authentication Code
2667 * (HMAC)-based key derivation function (HKDF).
2668 */
2669#define MBEDTLS_HKDF_C
2670
2671/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002672 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002673 *
2674 * Enable the HMAC_DRBG random generator.
2675 *
2676 * Module: library/hmac_drbg.c
2677 * Caller:
2678 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002680 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002681 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002682 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002684
2685/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002686 * \def MBEDTLS_LMS_C
2687 *
2688 * Enable the LMS stateful-hash asymmetric signature algorithm.
2689 *
2690 * Module: library/lms.c
2691 * Caller:
2692 *
Raef Colesab4f8742022-09-01 12:24:31 +01002693 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002694 *
Raef Colesab4f8742022-09-01 12:24:31 +01002695 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002696 */
2697#define MBEDTLS_LMS_C
2698
2699/**
Raef Colesab4f8742022-09-01 12:24:31 +01002700 * \def MBEDTLS_LMS_PRIVATE
2701 *
2702 * Enable LMS private-key operations and signing code. Functions enabled by this
2703 * option are experimental, and should not be used in production.
2704 *
2705 * Requires: MBEDTLS_LMS_C
2706 *
2707 * Uncomment to enable the LMS signature algorithm and private key operations.
2708 */
Raef Coles5127e852022-10-07 10:35:56 +01002709//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002710
2711/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002712 * \def MBEDTLS_NIST_KW_C
2713 *
2714 * Enable the Key Wrapping mode for 128-bit block ciphers,
2715 * as defined in NIST SP 800-38F. Only KW and KWP modes
2716 * are supported. At the moment, only AES is approved by NIST.
2717 *
2718 * Module: library/nist_kw.c
2719 *
2720 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2721 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002722#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002723
2724/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002726 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002727 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002728 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002729 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2730 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002731 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002732 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002733 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002734 * Caller: library/constant_time.c
2735 * library/ecdsa.c
2736 * library/ecjpake.c
2737 * library/hkdf.c
2738 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002739 * library/pk.c
2740 * library/pkcs5.c
2741 * library/pkcs12.c
2742 * library/psa_crypto_ecp.c
2743 * library/psa_crypto_rsa.c
2744 * library/rsa.c
2745 * library/ssl_cookie.c
2746 * library/ssl_msg.c
2747 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002748 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002749 * library/x509_crt.c
2750 * library/x509write_crt.c
2751 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002752 *
2753 * Uncomment to enable generic message digest wrappers.
2754 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002755#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002756
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002757/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002758 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002759 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002760 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002761 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002762 * Module: library/md5.c
2763 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002764 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002765 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002766 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002767 * This module is required for TLS 1.2 depending on the handshake parameters.
2768 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2769 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002770 *
2771 * \warning MD5 is considered a weak message digest and its use constitutes a
2772 * security risk. If possible, we recommend avoiding dependencies on
2773 * it, and considering stronger message digests instead.
2774 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002775 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002776#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002777
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002778/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002780 *
2781 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002782 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002783 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002784 *
2785 * Module: library/memory_buffer_alloc.c
2786 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002787 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002788 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002789 *
2790 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002791 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002792//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002793
2794/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002795 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002796 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002797 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2798 *
Simon Butcherd567a232016-03-09 20:19:21 +00002799 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2800 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002801 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002802 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002803 * \note See also our Knowledge Base article about porting to a new
2804 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002805 * 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 +00002806 *
Andres AG788aa4a2016-09-14 14:32:09 +01002807 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002808 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002809 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002810 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002812
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002813/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002815 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002816 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002817 *
2818 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002819 * Caller: library/asn1write.c
2820 * library/pkcs5.c
2821 * library/pkparse.c
2822 * library/pkwrite.c
2823 * library/rsa.c
2824 * library/x509.c
2825 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002826 * library/x509_crl.c
2827 * library/x509_crt.c
2828 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002829 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002830 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002831 *
2832 * This modules translates between OIDs and internal values.
2833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002835
2836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002838 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002839 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002840 *
2841 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002842 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002843 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002844 * library/x509_crl.c
2845 * library/x509_crt.c
2846 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002847 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002848 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002849 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2850 *
2851 * \warning When parsing password-protected files, if MD5 is provided only by
2852 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002853 *
Paul Bakkercff68422013-09-15 20:43:33 +02002854 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002857
2858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002860 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002861 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002862 *
2863 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002864 * Caller: library/pkwrite.c
2865 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002866 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002867 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002868 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002869 *
2870 * This modules adds support for encoding / writing PEM files.
2871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002873
2874/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002876 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002877 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002878 *
2879 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002880 * Caller: library/psa_crypto_rsa.c
2881 * library/ssl_tls.c
2882 * library/ssl*_client.c
2883 * library/ssl*_server.c
2884 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002885 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002886 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002887 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002888 * Uncomment to enable generic public key wrappers.
2889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002891
2892/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002894 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002895 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002896 *
2897 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002898 * Caller: library/x509_crt.c
2899 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002900 *
Yanray Wang072a0682023-12-05 10:53:04 +08002901 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002902 *
2903 * Uncomment to enable generic public key parse functions.
2904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002905#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002906
2907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002909 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002910 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002911 *
2912 * Module: library/pkwrite.c
2913 * Caller: library/x509write.c
2914 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002915 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002916 *
2917 * Uncomment to enable generic public key write functions.
2918 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002920
2921/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002923 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002924 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002925 *
2926 * Module: library/pkcs5.c
2927 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002928 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002929 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002930 * \warning If using a hash that is only provided by PSA drivers, you must
2931 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002932 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002933 * This module adds support for the PKCS#5 functions.
2934 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002935#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002936
2937/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002938 * \def MBEDTLS_PKCS7_C
2939 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002940 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002941 * RFC Link - https://tools.ietf.org/html/rfc2315
2942 *
2943 * Module: library/pkcs7.c
2944 *
2945 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002946 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2947 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002948 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002949 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002950 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002951#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002952
2953/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002955 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002956 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002957 * Adds algorithms for parsing PKCS#8 encrypted private keys
2958 *
2959 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002960 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002961 *
Valerio Settie98ad592023-12-28 10:42:12 +01002962 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2963 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002964 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002965 * \warning If using a hash that is only provided by PSA drivers, you must
2966 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002967 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002968 * This module enables PKCS#12 functions.
2969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002971
2972/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002974 *
2975 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002976 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002977 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2979 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002980 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002981 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002982 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002983 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002984 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002985 * Module: library/platform.c
2986 * Caller: Most other .c files
2987 *
2988 * This module enables abstraction of common (libc) functions.
2989 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002990#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002991
2992/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002993 * \def MBEDTLS_POLY1305_C
2994 *
2995 * Enable the Poly1305 MAC algorithm.
2996 *
2997 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002998 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002999 */
3000#define MBEDTLS_POLY1305_C
3001
3002/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003003 * \def MBEDTLS_PSA_CRYPTO_C
3004 *
3005 * Enable the Platform Security Architecture cryptography API.
3006 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003007 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003008 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003009 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003010 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003011 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3012 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3013 * is enabled in PSA (unless it's fully accelerated, see
3014 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003015 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003016#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003017
3018/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003019 * \def MBEDTLS_PSA_CRYPTO_SE_C
3020 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003021 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003022 * cryptography API.
3023 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003024 * \deprecated This feature is deprecated. Please switch to the PSA driver
3025 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003026 *
Ryan Everett32a64582024-03-05 18:16:18 +00003027 * \warning This feature is not thread-safe, and should not be used in a
3028 * multi-threaded environment.
3029 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003030 * Module: library/psa_crypto_se.c
3031 *
3032 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3033 *
3034 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003035//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003036
3037/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003038 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3039 *
3040 * Enable the Platform Security Architecture persistent key storage.
3041 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003042 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003043 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003044 * Requires: MBEDTLS_PSA_CRYPTO_C,
3045 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3046 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003047 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003048#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003049
3050/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003051 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003052 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003053 * Enable the emulation of the Platform Security Architecture
3054 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003055 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003056 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003057 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003058 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003059 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003060#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003061
3062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003064 *
3065 * Enable the RIPEMD-160 hash algorithm.
3066 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003067 * Module: library/ripemd160.c
3068 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003069 *
3070 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003072
3073/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003074 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003075 *
3076 * Enable the RSA public-key cryptosystem.
3077 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003078 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003079 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003080 * Caller: library/pk.c
3081 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003082 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003083 * library/ssl*_client.c
3084 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003085 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003086 * This module is used by the following key exchanges:
3087 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003088 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003090 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003092
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003093/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003095 *
3096 * Enable the SHA1 cryptographic hash algorithm.
3097 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003098 * Module: library/sha1.c
3099 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003100 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003101 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003102 * This module is required for TLS 1.2 depending on the handshake parameters,
3103 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003104 *
3105 * \warning SHA-1 is considered a weak message digest and its use constitutes
3106 * a security risk. If possible, we recommend avoiding dependencies
3107 * on it, and considering stronger message digests instead.
3108 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003109 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003110#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003111
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003112/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003113 * \def MBEDTLS_SHA224_C
3114 *
3115 * Enable the SHA-224 cryptographic hash algorithm.
3116 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003117 * Module: library/sha256.c
3118 * Caller: library/md.c
3119 * library/ssl_cookie.c
3120 *
3121 * This module adds support for SHA-224.
3122 */
3123#define MBEDTLS_SHA224_C
3124
3125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003126 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003127 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003128 * Enable the SHA-256 cryptographic hash algorithm.
3129 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003130 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003131 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003132 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003133 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003134 * library/ssl*_client.c
3135 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003136 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003137 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003138 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003139 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003141
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003142/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003143 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003144 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003145 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3146 * with the ARMv8 cryptographic extensions if they are available at runtime.
3147 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003148 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003149 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003150 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003151 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003152 * \note Minimum compiler versions for this feature are Clang 4.0,
3153 * armclang 6.6 or GCC 6.0.
3154 *
3155 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3156 * armclang <= 6.9
3157 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003158 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3159 * That name is deprecated, but may still be used as an alternative form for this
3160 * option.
3161 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003162 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3163 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003164 *
3165 * Requires: MBEDTLS_SHA256_C.
3166 *
3167 * Module: library/sha256.c
3168 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003169 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003170 * and use them if available.
3171 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003172//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003173
Dave Rodgmand85277c2023-10-13 09:22:54 +01003174/**
3175 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3176 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003177 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003178 * This name is now deprecated, but may still be used as an alternative form for
3179 * this option.
3180 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003181//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3182
3183/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003184 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003185 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003186 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3187 * with the ARMv8 cryptographic extensions, which must be available at runtime
3188 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003189 *
3190 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003191 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003192 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003193 * \note Minimum compiler versions for this feature are Clang 4.0,
3194 * armclang 6.6 or GCC 6.0.
3195 *
3196 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3197 * armclang <= 6.9
3198 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003199 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003200 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003201 * option.
3202 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003203 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3204 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003205 *
3206 * Requires: MBEDTLS_SHA256_C.
3207 *
3208 * Module: library/sha256.c
3209 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003210 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003211 * unconditionally.
3212 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003213//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003214
Dave Rodgmand85277c2023-10-13 09:22:54 +01003215/**
3216 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3217 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003218 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003219 * This name is now deprecated, but may still be used as an alternative form for
3220 * this option.
3221 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003222//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3223
3224/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003225 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003226 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003227 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003228 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003229 * Module: library/sha512.c
3230 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003231 * library/psa_crypto_hash.c
3232 * library/ssl_tls.c
3233 * library/ssl*_client.c
3234 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003235 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003236 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003237 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003238#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003239
3240/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003242 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003243 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003244 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003245 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003246 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003247 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003248 * library/ssl_tls.c
3249 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003250 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003251 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003253#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003254
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003255/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003256 * \def MBEDTLS_SHA3_C
3257 *
3258 * Enable the SHA3 cryptographic hash algorithm.
3259 *
3260 * Module: library/sha3.c
3261 *
3262 * This module adds support for SHA3.
3263 */
3264#define MBEDTLS_SHA3_C
3265
3266/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003267 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3268 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003269 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3270 * with the ARMv8 cryptographic extensions if they are available at runtime.
3271 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003272 *
3273 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3274 * for a non-Aarch64 build it will be silently ignored.
3275 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003276 * \note Minimum compiler versions for this feature are Clang 7.0,
3277 * armclang 6.9 or GCC 8.0.
3278 *
3279 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3280 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003281 *
3282 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3283 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3284 *
3285 * Requires: MBEDTLS_SHA512_C.
3286 *
3287 * Module: library/sha512.c
3288 *
3289 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3290 * and use them if available.
3291 */
3292//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3293
3294/**
3295 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3296 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003297 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3298 * with the ARMv8 cryptographic extensions, which must be available at runtime
3299 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003300 *
3301 * \note This allows builds with a smaller code size than with
3302 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3303 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003304 * \note Minimum compiler versions for this feature are Clang 7.0,
3305 * armclang 6.9 or GCC 8.0.
3306 *
3307 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3308 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003309 *
3310 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3311 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3312 *
3313 * Requires: MBEDTLS_SHA512_C.
3314 *
3315 * Module: library/sha512.c
3316 *
3317 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3318 * unconditionally.
3319 */
3320//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3321
3322/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003324 *
3325 * Enable simple SSL cache implementation.
3326 *
3327 * Module: library/ssl_cache.c
3328 * Caller:
3329 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003331 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003333
3334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003336 *
3337 * Enable basic implementation of DTLS cookies for hello verification.
3338 *
3339 * Module: library/ssl_cookie.c
3340 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003341 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003342#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003343
3344/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003345 * \def MBEDTLS_SSL_TICKET_C
3346 *
3347 * Enable an implementation of TLS server-side callbacks for session tickets.
3348 *
3349 * Module: library/ssl_ticket.c
3350 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003351 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003352 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3353 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003354 */
3355#define MBEDTLS_SSL_TICKET_C
3356
3357/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003358 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003359 *
3360 * Enable the SSL/TLS client code.
3361 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003362 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003363 * Caller:
3364 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003365 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003366 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003367 * This module is required for SSL/TLS client support.
3368 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003370
Paul Bakker9a736322012-11-14 12:39:52 +00003371/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003372 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003373 *
3374 * Enable the SSL/TLS server code.
3375 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003376 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003377 * Caller:
3378 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003380 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003381 * This module is required for SSL/TLS server support.
3382 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003383#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003384
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003385/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003387 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003388 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003389 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003390 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003391 * Caller: library/ssl*_client.c
3392 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003393 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3395 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003396 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003397 * This module is required for SSL/TLS.
3398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003399#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003400
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003401/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003402 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003403 *
3404 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003405 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003406 * contexts are not shared between threads. If you do intend to use contexts
3407 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003408 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003409 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003410 *
3411 * Module: library/threading.c
3412 *
3413 * This allows different threading implementations (self-implemented or
3414 * provided).
3415 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 * You will have to enable either MBEDTLS_THREADING_ALT or
3417 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003418 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003419 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003420 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003421//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003422
3423/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003425 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003426 * Enable the semi-portable timing interface.
3427 *
Simon Butcherd567a232016-03-09 20:19:21 +00003428 * \note The provided implementation only works on POSIX/Unix (including Linux,
3429 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003430 * module and provide your own implementations of the callbacks needed by
3431 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3432 * your own implementation of the whole module by setting
3433 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003434 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003435 * \note The timing module will include time.h on suitable platforms
3436 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3437 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3438 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003439 * \note See also our Knowledge Base article about porting to a new
3440 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003441 * 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 +00003442 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003443 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003445#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003446
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003447/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003449 *
3450 * Enable run-time version information.
3451 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003452 * Module: library/version.c
3453 *
3454 * This module provides run-time version information.
3455 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003456#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003457
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003458/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003460 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003461 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003462 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003463 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003464 * Caller: library/x509_crl.c
3465 * library/x509_crt.c
3466 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003467 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003468 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003469 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3470 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003471 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3472 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003473 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003474 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003475 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003476#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003477
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003478/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003479 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003480 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003481 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003482 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003483 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003484 * Caller: library/ssl_tls.c
3485 * library/ssl*_client.c
3486 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003487 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003488 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003489 *
3490 * This module is required for X.509 certificate parsing.
3491 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003492#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003493
3494/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003496 *
3497 * Enable X.509 CRL parsing.
3498 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003499 * Module: library/x509_crl.c
3500 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003501 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003502 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003503 *
3504 * This module is required for X.509 CRL parsing.
3505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003506#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003507
3508/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003509 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003510 *
3511 * Enable X.509 Certificate Signing Request (CSR) parsing.
3512 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003513 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003514 * Caller: library/x509_crt_write.c
3515 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003516 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003517 *
3518 * This module is used for reading X.509 certificate request.
3519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003521
3522/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003523 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003524 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003525 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003526 *
3527 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003528 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003529 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003530 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3531 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003532 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3533 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003534 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003535 * This module is the basis for creating X.509 certificates and CSRs.
3536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003538
3539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003541 *
3542 * Enable creating X.509 certificates.
3543 *
3544 * Module: library/x509_crt_write.c
3545 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003546 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003547 *
3548 * This module is required for X.509 certificate creation.
3549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003551
3552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003553 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003554 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003555 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003556 *
3557 * Module: library/x509_csr_write.c
3558 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003559 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003560 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003561 * This module is required for X.509 certificate request writing.
3562 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003563#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003564
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003565/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003566
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003567/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003568 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003569 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003570 * This section contains Mbed TLS build settings that are not associated
3571 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003572 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003573 * \{
3574 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003575
Gilles Peskinea02c1242022-03-16 17:03:19 +01003576/**
3577 * \def MBEDTLS_CONFIG_FILE
3578 *
3579 * If defined, this is a header which will be included instead of
3580 * `"mbedtls/mbedtls_config.h"`.
3581 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003582 * Unlike other configuration options, this one must be defined on the
3583 * compiler command line: a definition in `mbedtls_config.h` would have
3584 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003585 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003586 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003587 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003588 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003589 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003590 * The value of this symbol is typically a path in double quotes, either
3591 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003592 */
3593//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3594
3595/**
3596 * \def MBEDTLS_USER_CONFIG_FILE
3597 *
3598 * If defined, this is a header which will be included after
3599 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003600 * This allows you to modify the default configuration, including the ability
3601 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003602 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003603 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003604 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003605 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003606 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003607 * The value of this symbol is typically a path in double quotes, either
3608 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003609 */
3610//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3611
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003612/**
3613 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3614 *
3615 * If defined, this is a header which will be included instead of
3616 * `"psa/crypto_config.h"`.
3617 * This header file specifies which cryptographic mechanisms are available
3618 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3619 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3620 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003621 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003622 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003623 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003624 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003625 * The value of this symbol is typically a path in double quotes, either
3626 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003627 */
3628//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3629
3630/**
3631 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3632 *
3633 * If defined, this is a header which will be included after
3634 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003635 * This allows you to modify the default configuration, including the ability
3636 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003637 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003638 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003639 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003640 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003641 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003642 * The value of this symbol is typically a path in double quotes, either
3643 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003644 */
3645//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3646
Gilles Peskineb1176f22023-02-22 22:07:28 +01003647/**
3648 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3649 *
3650 * If defined, this is a header which will be included instead of
3651 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3652 * as the one in Mbed TLS, but with definitions adapted to the platform on
3653 * which the library code will run.
3654 *
3655 * \note The required content of this header can vary from one version of
3656 * Mbed TLS to the next. Integrators who provide an alternative file
3657 * should review the changes in the original file whenever they
3658 * upgrade Mbed TLS.
3659 *
3660 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3661 * non-standard feature of the C language, so this feature is only available
3662 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3663 *
3664 * The value of this symbol is typically a path in double quotes, either
3665 * absolute or relative to a directory on the include search path.
3666 */
3667//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3668
3669/**
3670 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3671 *
3672 * If defined, this is a header which will be included instead of
3673 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3674 * as the one in Mbed TLS, but with definitions adapted to the environment
3675 * in which the library code will run. The typical use for this feature
3676 * is to provide alternative type definitions on the client side in
3677 * client-server integrations of PSA crypto, where operation structures
3678 * contain handles instead of cryptographic data.
3679 *
3680 * \note The required content of this header can vary from one version of
3681 * Mbed TLS to the next. Integrators who provide an alternative file
3682 * should review the changes in the original file whenever they
3683 * upgrade Mbed TLS.
3684 *
3685 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3686 * non-standard feature of the C language, so this feature is only available
3687 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3688 *
3689 * The value of this symbol is typically a path in double quotes, either
3690 * absolute or relative to a directory on the include search path.
3691 */
3692//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3693
Gilles Peskineba4162a2022-04-11 17:04:38 +02003694/** \} name SECTION: General configuration options */
3695
3696/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003697 * \name SECTION: Module configuration options
3698 *
3699 * This section allows for the setting of module specific sizes and
3700 * configuration options. The default values are already present in the
3701 * relevant header files and should suffice for the regular use cases.
3702 *
3703 * Our advice is to enable options and change their values here
3704 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003705 * \{
3706 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003707/* The Doxygen documentation here is used when a user comments out a
3708 * setting and runs doxygen themselves. On the other hand, when we typeset
3709 * the full documentation including disabled settings, the documentation
3710 * in specific modules' header files is used if present. When editing this
3711 * file, make sure that each option is documented in exactly one place,
3712 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3713 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003714
Paul Bakker088c5c52014-04-25 11:11:10 +02003715/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003716//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003717//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003718
Paul Bakker088c5c52014-04-25 11:11:10 +02003719/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003720//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3721//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3722//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3723//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3724//#define MBEDTLS_CTR_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/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003727//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3728//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3729//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3730//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003731
Paul Bakker088c5c52014-04-25 11:11:10 +02003732/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003733//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003734//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003735
Paul Bakker088c5c52014-04-25 11:11:10 +02003736/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003737//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3738//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003739//#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 +01003740
Paul Bakker088c5c52014-04-25 11:11:10 +02003741/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003742//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003743
Paul Bakker088c5c52014-04-25 11:11:10 +02003744/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003745//#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 -04003746
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003747/** \def MBEDTLS_PLATFORM_STD_CALLOC
3748 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003749 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003750 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003751 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003752 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003753 * 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 -04003754 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3755 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003756 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003757 */
3758//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003759
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003760/** \def MBEDTLS_PLATFORM_STD_FREE
3761 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003762 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003763 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003764 * 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 -04003765 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3766 * 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 -04003767 */
3768//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003769//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003770//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003771//#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 +02003772//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3773//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003774/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003775//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003776//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3777//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003778//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3779//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3780//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003781
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003782/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003783/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003784//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3785//#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 +02003786//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003787//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003788//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3789//#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 +02003790//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3791//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003792/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003793//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003794//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003795//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3796//#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 +08003797//#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 +08003798//#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 +02003799
Gilles Peskine3f106f72021-09-23 17:42:39 +02003800/** \def MBEDTLS_CHECK_RETURN
3801 *
3802 * This macro is used at the beginning of the declaration of a function
3803 * to indicate that its return value should be checked. It should
3804 * instruct the compiler to emit a warning or an error if the function
3805 * is called without checking its return value.
3806 *
3807 * There is a default implementation for popular compilers in platform_util.h.
3808 * You can override the default implementation by defining your own here.
3809 *
3810 * If the implementation here is empty, this will effectively disable the
3811 * checking of functions' return values.
3812 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003813//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003814
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003815/** \def MBEDTLS_IGNORE_RETURN
3816 *
3817 * This macro requires one argument, which should be a C function call.
3818 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3819 * warning is suppressed.
3820 */
3821//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3822
Gilles Peskineed038902020-11-13 21:33:21 +01003823/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003824/**
Gilles Peskineed038902020-11-13 21:33:21 +01003825 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3826 * PSA crypto subsystem.
3827 *
3828 * If this option is unset:
3829 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003830 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003831 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3832 * on unspecified heuristics.
3833 */
3834//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3835
Steven Cooreman863470a2021-02-15 14:03:19 +01003836/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003837 * Restrict the PSA library to supporting a maximum amount of simultaneously
3838 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3839 * volatile key, or a persistent key which is loaded temporarily by the
3840 * library as part of a crypto operation in flight.
3841 *
3842 * If this option is unset, the library will fall back to a default value of
3843 * 32 keys.
3844 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003845//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003846
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003847/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003848//#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 +00003849
Paul Bakker088c5c52014-04-25 11:11:10 +02003850/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003851//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3852//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003853
Paul Bakker088c5c52014-04-25 11:11:10 +02003854/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003855
Angus Grattond8213d02016-05-25 20:56:48 +10003856/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3857 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003858 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003859 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003860 * This determines the size of the incoming TLS I/O buffer in such a way
3861 * that it is capable of holding the specified amount of plaintext data,
3862 * regardless of the protection mechanism used.
3863 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003864 * \note When using a value less than the default of 16KB on the client, it is
3865 * recommended to use the Maximum Fragment Length (MFL) extension to
3866 * inform the server about this limitation. On the server, there
3867 * is no supported, standardized way of informing the client about
3868 * restriction on the maximum size of incoming messages, and unless
3869 * the limitation has been communicated by other means, it is recommended
3870 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3871 * while keeping the default value of 16KB for the incoming buffer.
3872 *
David Horstmann95d516f2021-05-04 18:36:56 +01003873 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003874 */
3875//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3876
Gilles Peskined3d02902020-03-04 21:35:27 +01003877/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3878 *
3879 * The maximum length of CIDs used for incoming DTLS messages.
3880 *
3881 */
3882//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3883
3884/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3885 *
3886 * The maximum length of CIDs used for outgoing DTLS messages.
3887 *
3888 */
3889//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3890
TRodziewicze8dd7092021-05-12 14:19:11 +02003891/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003892 *
3893 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003894 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003895 *
3896 * The padding will always be chosen so that the length of the
3897 * padded plaintext is a multiple of the value of this option.
3898 *
3899 * Note: A value of \c 1 means that no padding will be used
3900 * for outgoing records.
3901 *
3902 * Note: On systems lacking division instructions,
3903 * a power of two should be preferred.
3904 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003905//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003906
Angus Grattond8213d02016-05-25 20:56:48 +10003907/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3908 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003909 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003910 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003911 * This determines the size of the outgoing TLS I/O buffer in such a way
3912 * that it is capable of holding the specified amount of plaintext data,
3913 * regardless of the protection mechanism used.
3914 *
Angus Grattond8213d02016-05-25 20:56:48 +10003915 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3916 * the default inward 16384 byte buffer to conform to the TLS specification.
3917 *
3918 * The minimum required outward buffer size is determined by the handshake
3919 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3920 * The specific size requirement depends on the configured ciphers and any
3921 * certificate data which is sent during the handshake.
3922 *
David Horstmann95d516f2021-05-04 18:36:56 +01003923 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003924 */
3925//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3926
Hanno Beckere0b150f2018-08-21 15:51:03 +01003927/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3928 *
3929 * Maximum number of heap-allocated bytes for the purpose of
3930 * DTLS handshake message reassembly and future message buffering.
3931 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003932 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003933 * to account for a reassembled handshake message of maximum size,
3934 * together with its reassembly bitmap.
3935 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003936 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003937 * should be sufficient for all practical situations as it allows
3938 * to reassembly a large handshake message (such as a certificate)
3939 * while buffering multiple smaller handshake messages.
3940 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003941 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003942//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003943
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003944//#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 +02003945//#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 +02003946
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003947/**
3948 * Complete list of ciphersuites to use, in order of preference.
3949 *
3950 * \warning No dependency checking is done on that field! This option can only
3951 * be used to restrict the set of available ciphersuites. It is your
3952 * responsibility to make sure the needed modules are active.
3953 *
3954 * Use this to save a few hundred bytes of ROM (default ordering of all
3955 * available ciphersuites) and a few to a few hundred bytes of RAM.
3956 *
3957 * The value below is only an example, not the default.
3958 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003959//#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 +02003960
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003961/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003962 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3963 *
3964 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003965 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003966 *
3967 * It must be positive and smaller than UINT32_MAX.
3968 *
3969 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3970 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003971 */
3972//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3973
3974/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003975 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3976 *
Jerry Yucf913512023-11-14 11:06:52 +08003977 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003978 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003979 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003980 * - The client ticket age is the time difference between the time when the
3981 * client proposes to the server to use the ticket and the time the client
3982 * received the ticket from the server.
3983 * - The server ticket age is the time difference between the time when the
3984 * server receives a proposition from the client to use the ticket and the
3985 * time when the ticket was created by the server.
3986 *
Jerry Yucf913512023-11-14 11:06:52 +08003987 * The ages might be different due to the client and server clocks not running
3988 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3989 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3990 * 6s, thus in the worst case clients and servers must sync up their system time
3991 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003992 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003993 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003994 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003995//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003996
3997/**
3998 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3999 *
4000 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4001 *
4002 * This must be less than 256.
4003 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004004//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004005
4006/**
4007 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4008 *
4009 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4010 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4011 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4012 *
4013 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004014//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004015
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004016/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004017//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004018//#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 +01004019
Gilles Peskine611179c2022-04-13 23:04:48 +02004020/** \} name SECTION: Module configuration options */