blob: ad96fc3fabb91f27b1e72d80869c1c4fdecfb542 [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
353/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100354 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200355 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200356 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100357 * alternate core implementation of a symmetric crypto, an arithmetic or hash
358 * module (e.g. platform specific assembly optimized implementations). Keep
359 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200360 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200361 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200362 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200364 * Example: In case you uncomment MBEDTLS_AES_ALT, Mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000365 * provide the "struct mbedtls_aes_context" definition and omit the base
366 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200367 * "aes.h" to include the new function definitions.
368 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200369 * Uncomment a macro to enable alternate implementation of the corresponding
370 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100371 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200372 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100373 * use constitutes a security risk. If possible, we recommend
374 * avoiding dependencies on them, and considering stronger message
375 * digests and ciphers instead.
376 *
Paul Bakker90995b52013-06-24 19:20:35 +0200377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000379//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200381//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300382//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200383//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200384//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200385//#define MBEDTLS_DES_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100386//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300387//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200388//#define MBEDTLS_MD5_ALT
389//#define MBEDTLS_RIPEMD160_ALT
390//#define MBEDTLS_SHA1_ALT
391//#define MBEDTLS_SHA256_ALT
392//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000393
Paul Bakker90995b52013-06-24 19:20:35 +0200394/**
TRodziewicz75628d52021-06-18 12:56:27 +0200395 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200396 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200397 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100398 * alternate core implementation of symmetric crypto or hash function. Keep in
399 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200400 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200401 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200402 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200403 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200404 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200405 * no longer provide the mbedtls_sha1_process() function, but it will still provide
406 * the other function (using your mbedtls_sha1_process() function) and the definition
407 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200408 * with this definition.
409 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200410 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100411 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
412 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200413 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200414 * Uncomment a macro to enable alternate implementation of the corresponding
415 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100416 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200417 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100418 * constitutes a security risk. If possible, we recommend avoiding
419 * dependencies on them, and considering stronger message digests
420 * and ciphers instead.
421 *
Janos Follath1231d212019-01-07 15:01:32 +0000422 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
423 * enabled, then the deterministic ECDH signature functions pass the
424 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
425 * alternative implementations should use the RNG only for generating
426 * the ephemeral key and nothing else. If this is not possible, then
427 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200428 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000429 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431//#define MBEDTLS_MD5_PROCESS_ALT
432//#define MBEDTLS_RIPEMD160_PROCESS_ALT
433//#define MBEDTLS_SHA1_PROCESS_ALT
434//#define MBEDTLS_SHA256_PROCESS_ALT
435//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200436//#define MBEDTLS_DES_SETKEY_ALT
437//#define MBEDTLS_DES_CRYPT_ECB_ALT
438//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200439//#define MBEDTLS_AES_SETKEY_ENC_ALT
440//#define MBEDTLS_AES_SETKEY_DEC_ALT
441//#define MBEDTLS_AES_ENCRYPT_ALT
442//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300443//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300444//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300445//#define MBEDTLS_ECDSA_VERIFY_ALT
446//#define MBEDTLS_ECDSA_SIGN_ALT
447//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200448
449/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200450 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200451 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200452 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200453 * hardware entropy collector.
454 *
455 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000456 * prototype as declared in library/entropy_poll.h, and accept NULL as first
457 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200458 *
459 * Uncomment to use your own hardware entropy collector.
460 */
461//#define MBEDTLS_ENTROPY_HARDWARE_ALT
462
463/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200464 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000465 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100466 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000467 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100468 * Uncomment this macro to use precomputed AES tables stored in ROM.
469 * Comment this macro to generate AES tables in RAM at runtime.
470 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100471 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
472 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100473 * initialization time before the first AES operation can be performed.
474 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
475 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
476 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100477 *
478 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200480//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000481
482/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100483 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200484 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100485 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200486 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100487 * Uncommenting this macro omits 75% of the AES tables from
488 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
489 * by computing their values on the fly during operations
490 * (the tables are entry-wise rotations of one another).
491 *
492 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100493 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100494 * runtime. Specifically, one has to compare 4 accesses within
495 * different tables to 4 accesses with additional arithmetic
496 * operations within the same table. The performance gain/loss
497 * depends on the system and memory details.
498 *
499 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200500 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100501//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200502
503/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800504 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
505 *
506 * Use only 128-bit keys in AES operations to save ROM.
507 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800508 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800509 * or 256-bit keys.
510 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800511 * Uncommenting this macro reduces the size of AES code by ~300 bytes
512 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800513 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800514 * Module: library/aes.c
515 *
516 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800517 */
518//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
519
Gilles Peskinea8861e02023-09-05 20:20:51 +0200520/*
521 * Disable plain C implementation for AES.
522 *
523 * When the plain C implementation is enabled, and an implementation using a
524 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
525 * detection will be used to select between them.
526 *
527 * If only one implementation is present, runtime detection will not be used.
528 * This configuration will crash at runtime if running on a CPU without the
529 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
530 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
531 */
532//#define MBEDTLS_AES_USE_HARDWARE_ONLY
533
Arto Kinnunen732ca322023-04-14 14:26:10 +0800534/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200536 *
537 * Use less ROM for the Camellia implementation (saves about 768 bytes).
538 *
539 * Uncomment this macro to use less memory for Camellia.
540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200541//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200542
543/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200544 * \def MBEDTLS_CHECK_RETURN_WARNING
545 *
546 * If this macro is defined, emit a compile-time warning if application code
547 * calls a function without checking its return value, but the return value
548 * should generally be checked in portable applications.
549 *
550 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
551 * implemented. Otherwise this option has no effect.
552 *
553 * Uncomment to get warnings on using fallible functions without checking
554 * their return value.
555 *
556 * \note This feature is a work in progress.
557 * Warnings will be added to more functions in the future.
558 *
559 * \note A few functions are considered critical, and ignoring the return
560 * value of these functions will trigger a warning even if this
561 * macro is not defined. To completely disable return value check
562 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
563 */
564//#define MBEDTLS_CHECK_RETURN_WARNING
565
566/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200568 *
569 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200572
573/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000575 *
576 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
577 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000579
580/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200581 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000582 *
583 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200585#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000586
587/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100588 * \def MBEDTLS_CIPHER_MODE_OFB
589 *
590 * Enable Output Feedback mode (OFB) for symmetric ciphers.
591 */
592#define MBEDTLS_CIPHER_MODE_OFB
593
594/**
595 * \def MBEDTLS_CIPHER_MODE_XTS
596 *
597 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
598 */
599#define MBEDTLS_CIPHER_MODE_XTS
600
601/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000603 *
604 * Enable NULL cipher.
605 * Warning: Only do so when you know what you are doing. This allows for
606 * encryption or channels without any security!
607 *
Ronald Croncee42702021-04-26 11:34:44 +0200608 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200609 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
610 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
611 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
612 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
613 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
614 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
615 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
616 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
617 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
618 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
619 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
620 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
621 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
622 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
623 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
624 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
625 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
626 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
627 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000628 *
629 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000630 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200631//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000632
633/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100634 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200635 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100636 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
637 * specific padding modes in the cipher layer with cipher modes that support
638 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200639 *
640 * If you disable all padding modes, only full blocks can be used with CBC.
641 *
642 * Enable padding modes in the cipher layer.
643 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200644#define MBEDTLS_CIPHER_PADDING_PKCS7
645#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
646#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
647#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200648
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200649/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
650 *
651 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800652 * Without this, CTR_DRBG uses a 256-bit key
653 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200654 */
655//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
656
Paul Bakker48e93c82013-08-14 12:21:18 +0200657/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200658 * Enable the verified implementations of ECDH primitives from Project Everest
659 * (currently only Curve25519). This feature changes the layout of ECDH
660 * contexts and therefore is a compatibility break for applications that access
661 * fields of a mbedtls_ecdh_context structure directly. See also
662 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000663 *
664 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
665 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200666 */
667//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
668
669/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100670 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200671 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100672 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
673 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200674 *
675 * Comment macros to disable the curve and functions for it
676 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200677/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200678#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
679#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
680#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
681#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
682#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
683#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
684#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
685#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
686#define MBEDTLS_ECP_DP_BP256R1_ENABLED
687#define MBEDTLS_ECP_DP_BP384R1_ENABLED
688#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200689/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200690#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000691#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200692
693/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200694 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200695 *
696 * Enable specific 'modulo p' routines for each NIST prime.
697 * Depending on the prime and architecture, makes operations 4 to 8 times
698 * faster on the corresponding curve.
699 *
700 * Comment this macro to disable NIST curves optimisation.
701 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200703
704/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200705 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100706 *
707 * Enable "non-blocking" ECC operations that can return early and be resumed.
708 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200709 * This allows various functions to pause by returning
710 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
711 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
712 * order to further progress and eventually complete their operation. This is
713 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
714 * number of ECC operations a function may perform before pausing; see
715 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100716 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200717 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200718 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100719 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100720 * This option:
721 * - Adds xxx_restartable() variants of existing operations in the
722 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100723 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
724 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100725 * - ECDSA: signature generation & verification;
726 * - PK: signature generation & verification;
727 * - X509: certificate chain verification.
728 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
729 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
730 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
731 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000732 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100733 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100734 * - verification of the server's key exchange signature;
735 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100736 * - generation of the client's signature if client authentication is used,
737 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100738 *
739 * \note In the cases above, the usual SSL/TLS functions, such as
740 * mbedtls_ssl_handshake(), can now return
741 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200742 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100743 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
744 * restartable operations in PK, X.509 and TLS (see above) are not
745 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100746 * PSA, and are not restartable. These are temporary limitations that
747 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200748 *
Ron Eldor19779c42018-11-05 16:58:13 +0200749 * \note This option only works with the default software implementation of
750 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100751 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100752 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100753 * Requires: MBEDTLS_ECP_C
754 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100755 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100756 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200757//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100758
759/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200760 * Uncomment to enable using new bignum code in the ECC modules.
761 *
762 * \warning This is currently experimental, incomplete and therefore should not
763 * be used in production.
764 */
765//#define MBEDTLS_ECP_WITH_MPI_UINT
766
767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100769 *
770 * Enable deterministic ECDSA (RFC 6979).
771 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
772 * may result in a compromise of the long-term signing key. This is avoided by
773 * the deterministic variant.
774 *
John Durkop36a82e52020-10-26 09:39:05 -0700775 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100776 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100777 * Comment this macro to disable deterministic ECDSA.
778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200779#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100780
781/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200783 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200784 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200785 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200786 * This enables the following ciphersuites (if other requisites are
787 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200788 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
789 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
790 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
791 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
792 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
793 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
794 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
795 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
796 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
797 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200798 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200799#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200800
801/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200803 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200804 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200805 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200807 *
808 * This enables the following ciphersuites (if other requisites are
809 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
811 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
812 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
813 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
814 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
815 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
816 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
817 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
818 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
819 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100820 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100821 * \warning Using DHE constitutes a security risk as it
822 * is not possible to validate custom DH parameters.
823 * If possible, it is recommended users should consider
824 * preferring other methods of key exchange.
825 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100826 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200827 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200829
830/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200831 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200832 *
833 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
834 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200835 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200836 *
837 * This enables the following ciphersuites (if other requisites are
838 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
840 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
841 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
842 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
843 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
844 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200845 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200847
848/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200849 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200850 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200851 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200852 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200853 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
854 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200855 *
856 * This enables the following ciphersuites (if other requisites are
857 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
859 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
860 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
861 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
862 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
863 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
864 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
865 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
866 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
867 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200868 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200869#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200870
871/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200873 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200874 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200875 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
877 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200878 *
879 * This enables the following ciphersuites (if other requisites are
880 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
882 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
883 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
884 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
885 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
886 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
887 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
888 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
889 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
890 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
891 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
892 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200895
896/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200898 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200899 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200900 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
902 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200903 *
904 * This enables the following ciphersuites (if other requisites are
905 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
907 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
908 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
909 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
910 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
911 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
912 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
913 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
914 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
915 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
916 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
917 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100918 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100919 * \warning Using DHE constitutes a security risk as it
920 * is not possible to validate custom DH parameters.
921 * If possible, it is recommended users should consider
922 * preferring other methods of key exchange.
923 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100924 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200925 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200927
928/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200929 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200930 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200931 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200932 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200933 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
934 * MBEDTLS_RSA_C
935 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200937 *
938 * This enables the following ciphersuites (if other requisites are
939 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
941 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
942 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
943 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
944 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
945 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
946 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
947 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
948 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
949 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200950 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200951#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200952
953/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200954 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200955 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200956 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200957 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200958 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
959 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
960 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200961 *
962 * This enables the following ciphersuites (if other requisites are
963 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
965 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
966 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
967 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
968 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
969 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
970 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
971 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
972 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
973 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200974 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200975#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200976
977/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200978 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100979 *
980 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
981 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200982 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
983 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
984 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100985 *
986 * This enables the following ciphersuites (if other requisites are
987 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
989 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
990 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
991 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
992 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
993 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
994 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
995 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
996 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
997 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100998 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200999#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001000
1001/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001002 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001003 *
1004 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1005 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001006 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1007 * MBEDTLS_RSA_C
1008 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001009 *
1010 * This enables the following ciphersuites (if other requisites are
1011 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1013 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1014 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1015 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1016 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1017 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1018 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1019 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1020 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1021 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001024
1025/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001026 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1027 *
1028 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1029 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001030 * \warning This is currently experimental. EC J-PAKE support is based on the
1031 * Thread v1.0.0 specification; incompatible changes to the specification
1032 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001033 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001034 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001035 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001036 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1037 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001038 * \warning If SHA-256 is provided only by a PSA driver, you must call
1039 * psa_crypto_init() before the first hanshake (even if
1040 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1041 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001042 * This enables the following ciphersuites (if other requisites are
1043 * enabled as well):
1044 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1045 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001046//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001047
1048/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001050 *
1051 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1052 * RFC 5915 and RFC 5480.
1053 *
1054 * Currently this means parsing the SpecifiedECDomain choice of EC
1055 * parameters (only known groups are supported, not arbitrary domains, to
1056 * avoid validation issues).
1057 *
1058 * Disable if you only need to support RFC 5915 + 5480 key formats.
1059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001061
1062/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001063 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1064 *
1065 * Enable the support for parsing public keys of type Short Weierstrass
1066 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001067 * compressed point format. This parsing is done through ECP module's functions.
1068 *
1069 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1070 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1071 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001072 */
1073#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1074
1075/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001076 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001077 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078 * Enable a dummy error function to make use of mbedtls_strerror() in
1079 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1080 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001081 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1083 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001084 *
1085 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001088#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001089
1090/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001092 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001093 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001094 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001098
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001099/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001101 *
1102 * Enable functions that use the filesystem.
1103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001105
1106/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001108 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001109 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001110 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001111 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001112 * application.
1113 *
1114 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001117
1118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001120 *
1121 * Do not use built-in platform entropy functions.
1122 * This is useful if your platform does not support
1123 * standards like the /dev/urandom or Windows CryptoAPI.
1124 *
1125 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001128
1129/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001131 *
1132 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1133 * default SHA-512 based one (if both are available).
1134 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001135 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001136 *
1137 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1138 * if you have performance concerns.
1139 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140 * This option is only useful if both MBEDTLS_SHA256_C and
1141 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001144
1145/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001146 * \def MBEDTLS_ENTROPY_NV_SEED
1147 *
1148 * Enable the non-volatile (NV) seed file-based entropy source.
1149 * (Also enables the NV seed read/write functions in the platform layer)
1150 *
1151 * This is crucial (if not required) on systems that do not have a
1152 * cryptographic entropy source (in hardware or kernel) available.
1153 *
1154 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1155 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001156 * \note The read/write functions that are used by the entropy source are
1157 * determined in the platform layer, and can be modified at runtime and/or
1158 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1159 *
1160 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001161 * with regular fopen(), please make sure you make a seedfile with the
1162 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1163 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001164 * and written to or you will get an entropy source error! The default
1165 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1166 * bytes from the file.
1167 *
1168 * \note The entropy collector will write to the seed file before entropy is
1169 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001170 */
1171//#define MBEDTLS_ENTROPY_NV_SEED
1172
Ronald Cron71016a92020-08-28 19:01:50 +02001173/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001174 *
Ronald Cron71016a92020-08-28 19:01:50 +02001175 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001176 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001177 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1178 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001179 *
1180 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001181 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001182 */
Ronald Cron71016a92020-08-28 19:01:50 +02001183//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001184
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001185/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001187 *
1188 * Enable debugging of buffer allocator memory issues. Automatically prints
1189 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1190 * function for 'debug output' of allocated memory.
1191 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001192 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001193 *
1194 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001196//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001197
1198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001200 *
1201 * Include backtrace information with each allocated block.
1202 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001203 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001204 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001205 *
1206 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001208//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001209
1210/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001211 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001212 *
1213 * Support external private RSA keys (eg from a HSM) in the PK layer.
1214 *
1215 * Comment this macro to disable support for external private RSA keys.
1216 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001217#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001218
1219/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001220 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001221 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001222 * Enable support for PKCS#1 v1.5 encoding.
1223 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001224 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001225 *
Paul Bakker48377d92013-08-30 12:06:24 +02001226 * This enables support for PKCS#1 v1.5 operations.
1227 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001228#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001229
1230/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001232 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001233 * Enable support for PKCS#1 v2.1 encoding.
1234 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001235 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001236 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001237 * \warning If using a hash that is only provided by PSA drivers, you must
1238 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001239 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001240 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1241 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001242#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001243
Steven Cooreman6801f082021-02-19 17:21:22 +01001244/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1245 *
1246 * Enable support for platform built-in keys. If you enable this feature,
1247 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1248 * See the documentation of that function for more information.
1249 *
1250 * Built-in keys are typically derived from a hardware unique key or
1251 * stored in a secure element.
1252 *
1253 * Requires: MBEDTLS_PSA_CRYPTO_C.
1254 *
1255 * \warning This interface is experimental and may change or be removed
1256 * without notice.
1257 */
1258//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1259
Ronald Cron3768ac12021-01-26 16:58:00 +01001260/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1261 *
1262 * Enable support for PSA crypto client.
1263 *
1264 * \note This option allows to include the code necessary for a PSA
1265 * crypto client when the PSA crypto implementation is not included in
1266 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1267 * code to set and get PSA key attributes.
1268 * The development of PSA drivers partially relying on the library to
1269 * fulfill the hardware gaps is another possible usage of this option.
1270 *
1271 * \warning This interface is experimental and may change or be removed
1272 * without notice.
1273 */
1274//#define MBEDTLS_PSA_CRYPTO_CLIENT
1275
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001276/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1277 *
1278 * Make the PSA Crypto module use an external random generator provided
1279 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1280 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001281 * \note This random generator must deliver random numbers with cryptographic
1282 * quality and high performance. It must supply unpredictable numbers
1283 * with a uniform distribution. The implementation of this function
1284 * is responsible for ensuring that the random generator is seeded
1285 * with sufficient entropy. If you have a hardware TRNG which is slow
1286 * or delivers non-uniform output, declare it as an entropy source
1287 * with mbedtls_entropy_add_source() instead of enabling this option.
1288 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001289 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001290 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1291 * and define a function called mbedtls_psa_external_get_random()
1292 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001293 * ```
1294 * psa_status_t mbedtls_psa_external_get_random(
1295 * mbedtls_psa_external_random_context_t *context,
1296 * uint8_t *output, size_t output_size, size_t *output_length);
1297 * );
1298 * ```
1299 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001300 * The function must fill the \c output buffer with \c output_size bytes
1301 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001302 *
1303 * Requires: MBEDTLS_PSA_CRYPTO_C
1304 *
1305 * \warning If you enable this option, code that uses the PSA cryptography
1306 * interface will not use any of the entropy sources set up for
1307 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1308 * enables.
1309 *
1310 * \note This option is experimental and may be removed without notice.
1311 */
1312//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1313
Paul Bakker9dcc3222011-03-08 14:16:06 +00001314/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001315 * \def MBEDTLS_PSA_CRYPTO_SPM
1316 *
1317 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1318 * Partition Manager) integration which separates the code into two parts: a
1319 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1320 * Environment).
1321 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001322 * If you enable this option, your build environment must include a header
1323 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1324 * header files, or in another directory on the compiler's include search
1325 * path). Alternatively, your platform may customize the header
1326 * `psa/crypto_platform.h`, in which case it can skip or replace the
1327 * inclusion of `"crypto_spe.h"`.
1328 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001329 * Module: library/psa_crypto.c
1330 * Requires: MBEDTLS_PSA_CRYPTO_C
1331 *
1332 */
1333//#define MBEDTLS_PSA_CRYPTO_SPM
1334
1335/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001336 * Uncomment to enable p256-m. This is an alternative implementation of
1337 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1338 * Compared to the default implementation:
1339 *
1340 * - p256-m has a much smaller code size and RAM footprint.
1341 * - p256-m is only available via the PSA API. This includes the pk module
1342 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1343 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1344 * over the core arithmetic, or deterministic derivation of keys.
1345 *
1346 * We recommend enabling this option if your application uses the PSA API
1347 * and the only elliptic curve support it needs is ECDH and ECDSA over
1348 * SECP256R1.
1349 *
1350 * If you enable this option, you do not need to enable any ECC-related
1351 * MBEDTLS_xxx option. You do need to separately request support for the
1352 * cryptographic mechanisms through the PSA API:
1353 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1354 * configuration;
1355 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1356 * - #PSA_WANT_ECC_SECP_R1_256;
1357 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1358 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1359 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1360 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1361 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001362 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001363 * \note To benefit from the smaller code size of p256-m, make sure that you
1364 * do not enable any ECC-related option not supported by p256-m: this
1365 * would cause the built-in ECC implementation to be built as well, in
1366 * order to provide the required option.
1367 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001368 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1369 * SECP256R1 are disabled as they are not supported by this driver.
1370 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1371 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001372 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001373 */
1374//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1375
1376/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001377 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001378 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001379 * Enable support for entropy injection at first boot. This feature is
1380 * required on systems that do not have a built-in entropy source (TRNG).
1381 * This feature is currently not supported on systems that have a built-in
1382 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001383 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001384 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001385 *
1386 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001387//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001388
1389/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001390 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001391 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001392 * Assume all buffers passed to PSA functions are owned exclusively by the
1393 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001394 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001395 * This option may be enabled if all buffers passed to any PSA function reside
1396 * in memory that is accessible only to the PSA function during its execution.
1397 *
1398 * This option MUST be disabled whenever buffer arguments are in memory shared
1399 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001400 * across a trust boundary.
1401 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001402 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001403 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001404 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001405 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001406 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001407//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001408
1409/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001410 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001411 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001412 * Do not use the Chinese Remainder Theorem
1413 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001414 *
1415 * Uncomment this macro to disable the use of CRT in RSA.
1416 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001417 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001418//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001419
1420/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001421 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001422 *
1423 * Enable the checkup functions (*_self_test).
1424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001425#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001426
1427/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001428 * \def MBEDTLS_SHA256_SMALLER
1429 *
1430 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1431 * lower performance.
1432 *
Adam Wolf039080f2019-09-10 09:53:08 -05001433 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001434 * performance and size. This version optimizes more aggressively for size at
1435 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1436 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1437 * 30%.
1438 *
1439 * Uncomment to enable the smaller implementation of SHA256.
1440 */
1441//#define MBEDTLS_SHA256_SMALLER
1442
1443/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001444 * \def MBEDTLS_SHA512_SMALLER
1445 *
1446 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1447 * lower performance.
1448 *
1449 * Uncomment to enable the smaller implementation of SHA512.
1450 */
1451//#define MBEDTLS_SHA512_SMALLER
1452
1453/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001454 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001455 *
1456 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001457 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001458 * with other servers, only debugging of failures is harder.
1459 *
1460 * The advantage of not sending alert messages, is that no information is given
1461 * about reasons for failures thus preventing adversaries of gaining intel.
1462 *
1463 * Enable sending of all alert messages
1464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001465#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001466
1467/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001468 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1469 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001470 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001471 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001472 * in the underlying transport. The CID functionality is described
1473 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001474 *
1475 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001476 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1477 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1478 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001479 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001480 * The maximum lengths of outgoing and incoming CIDs can be configured
1481 * through the options
1482 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1483 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1484 *
1485 * Requires: MBEDTLS_SSL_PROTO_DTLS
1486 *
1487 * Uncomment to enable the Connection ID extension.
1488 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001489#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1490
1491
1492/**
1493 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1494 *
1495 * Defines whether RFC 9146 (default) or the legacy version
1496 * (version draft-ietf-tls-dtls-connection-id-05,
1497 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1498 * is used.
1499 *
1500 * Set the value to 0 for the standard version, and
1501 * 1 for the legacy draft version.
1502 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001503 * \deprecated Support for the legacy version of the DTLS
1504 * Connection ID feature is deprecated. Please
1505 * switch to the standardized version defined
1506 * in RFC 9146 enabled by utilizing
1507 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1508 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1509 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001510 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1511 */
1512#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001513
1514/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001515 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1516 *
1517 * Enable asynchronous external private key operations in SSL. This allows
1518 * you to configure an SSL connection to call an external cryptographic
1519 * module to perform private key operations instead of performing the
1520 * operation inside the library.
1521 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001522 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001523 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001524//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001525
1526/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001527 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1528 *
1529 * Enable serialization of the TLS context structures, through use of the
1530 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1531 *
1532 * This pair of functions allows one side of a connection to serialize the
1533 * context associated with the connection, then free or re-use that context
1534 * while the serialized state is persisted elsewhere, and finally deserialize
1535 * that state to a live context for resuming read/write operations on the
1536 * connection. From a protocol perspective, the state of the connection is
1537 * unaffected, in particular this is entirely transparent to the peer.
1538 *
1539 * Note: this is distinct from TLS session resumption, which is part of the
1540 * protocol and fully visible by the peer. TLS session resumption enables
1541 * establishing new connections associated to a saved session with shorter,
1542 * lighter handshakes, while context serialization is a local optimization in
1543 * handling a single, potentially long-lived connection.
1544 *
1545 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1546 * saved after the handshake to allow for more efficient serialization, so if
1547 * you don't need this feature you'll save RAM by disabling it.
1548 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001549 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1550 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001551 * Comment to disable the context serialization APIs.
1552 */
1553#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1554
1555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001557 *
1558 * Enable the debug messages in SSL module for all issues.
1559 * Debug messages have been disabled in some places to prevent timing
1560 * attacks due to (unbalanced) debugging function calls.
1561 *
1562 * If you need all error reporting you should enable this during debugging,
1563 * but remove this for production servers that should log as well.
1564 *
1565 * Uncomment this macro to report all debug messages on errors introducing
1566 * a timing side-channel.
1567 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001572 *
1573 * Enable support for Encrypt-then-MAC, RFC 7366.
1574 *
1575 * This allows peers that both support it to use a more robust protection for
1576 * ciphersuites using CBC, providing deep resistance against timing attacks
1577 * on the padding or underlying cipher.
1578 *
1579 * This only affects CBC ciphersuites, and is useless if none is defined.
1580 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001581 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001582 *
1583 * Comment this macro to disable support for Encrypt-then-MAC
1584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001586
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001587/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001588 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001589 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1590 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001591 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001592 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001593 * attacks, but it is recommended to always use it (even if you disable
1594 * renegotiation), since it actually fixes a more fundamental issue in the
1595 * original SSL/TLS design, and has implications beyond Triple Handshake.
1596 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001597 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001598 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001599 * Comment this macro to disable support for Extended Master Secret.
1600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001601#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001602
Paul Bakkerd66f0702013-01-31 16:57:45 +01001603/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001604 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1605 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001606 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001607 * giving access to the peer's certificate after completion of the handshake.
1608 *
1609 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1610 * recommended to disable this option for reduced RAM usage.
1611 *
1612 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1613 * defined, but always returns \c NULL.
1614 *
1615 * \note This option has no influence on the protection against the
1616 * triple handshake attack. Even if it is disabled, Mbed TLS will
1617 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001618 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001619 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001620 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001621 *
1622 * Comment this macro to disable storing the peer's certificate
1623 * after the handshake.
1624 */
1625#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1626
1627/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001628 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001629 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001630 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001631 *
1632 * The two main uses of renegotiation are (1) refresh keys on long-lived
1633 * connections and (2) client authentication after the initial handshake.
1634 * If you don't need renegotiation, it's probably better to disable it, since
1635 * it has been associated with security issues in the past and is easy to
1636 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001637 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001638 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1639 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001640 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001641 *
1642 * \note Even if this option is disabled, both client and server are aware
1643 * of the Renegotiation Indication Extension (RFC 5746) used to
1644 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1645 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1646 * configuration of this extension).
1647 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001648 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001650
1651/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001653 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001654 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001655 *
1656 * Comment this macro to disable support for the max_fragment_length extension
1657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001658#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001659
1660/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001661 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1662 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001663 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001664 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001665 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1666 *
1667 * Uncomment this macro to enable support for the record_size_limit extension
1668 */
1669//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1670
1671/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001672 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001673 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001674 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001675 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001676 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001677 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1678 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001679 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001680 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001681 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001682 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1683 * are only provided by PSA drivers, you must call psa_crypto_init() before
1684 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001685 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001686 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001687 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001688#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001689
1690/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001691 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001692 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001693 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001694 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001695 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001696 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001697 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001698 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001699 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001700 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001701 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1702 * directly performed by TLS 1.3 code. As a consequence, you must
1703 * call psa_crypto_init() before the first TLS 1.3 handshake.
1704 *
1705 * \note Cryptographic operations performed indirectly via another module
1706 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1707 * running handshake hash) only use PSA crypto if
1708 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001709 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001710 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001711 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001712#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001713
1714/**
Ronald Cronab65c522021-11-24 10:47:20 +01001715 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1716 *
1717 * Enable TLS 1.3 middlebox compatibility mode.
1718 *
1719 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1720 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1721 * expecting TLS 1.2 traffic.
1722 *
1723 * Turning on the compatibility mode comes at the cost of a few added bytes
1724 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1725 * that don't use it. Therefore, unless transmission bandwidth is critical and
1726 * you know that middlebox compatibility issues won't occur, it is therefore
1727 * recommended to set this option.
1728 *
1729 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001730 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1731 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001732 *
1733 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001734#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001735
1736/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001737 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1738 *
1739 * Enable TLS 1.3 PSK key exchange mode.
1740 *
1741 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1742 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1743 * effect on the build.
1744 *
1745 */
1746#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1747
1748/**
1749 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1750 *
1751 * Enable TLS 1.3 ephemeral key exchange mode.
1752 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001753 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001754 * MBEDTLS_X509_CRT_PARSE_C
1755 * and at least one of:
1756 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1757 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001758 *
1759 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1760 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1761 * effect on the build.
1762 *
1763 */
1764#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1765
1766/**
1767 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1768 *
1769 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1770 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001771 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001772 *
1773 * Comment to disable support for the PSK ephemeral key exchange mode in
1774 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1775 * have any effect on the build.
1776 *
1777 */
1778#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1779
1780/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 * \def MBEDTLS_SSL_EARLY_DATA
1782 *
1783 * Enable support for RFC 8446 TLS 1.3 early data.
1784 *
1785 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1786 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1787 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1788 *
1789 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1790 * is not enabled, this option does not have any effect on the build.
1791 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001792 * \note The maximum amount of early data can be set with
1793 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1794 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001796//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001797
1798/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001800 *
1801 * Enable support for DTLS (all available versions).
1802 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001803 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001804 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001805 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001806 *
1807 * Comment this macro to disable support for DTLS
1808 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001810
1811/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001813 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001814 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001815 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001816 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001817 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001819
1820/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001822 *
1823 * Enable support for the anti-replay mechanism in DTLS.
1824 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825 * Requires: MBEDTLS_SSL_TLS_C
1826 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001827 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001828 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001829 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001830 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001831 * Comment this to disable anti-replay in DTLS.
1832 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001833#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001834
1835/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001836 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001837 *
1838 * Enable support for HelloVerifyRequest on DTLS servers.
1839 *
1840 * This feature is highly recommended to prevent DTLS servers being used as
1841 * amplifiers in DoS attacks against other hosts. It should always be enabled
1842 * unless you know for sure amplification cannot be a problem in the
1843 * environment in which your server operates.
1844 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001845 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001846 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001847 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001848 *
1849 * Comment this to disable support for HelloVerifyRequest.
1850 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001851#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001852
1853/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001854 * \def MBEDTLS_SSL_DTLS_SRTP
1855 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001856 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001857 * through the use_srtp extension.
1858 *
1859 * \note This feature provides the minimum functionality required
1860 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1861 * the associated SRTP packet protection key material.
1862 * In particular, the SRTP packet protection itself, as well as the
1863 * demultiplexing of RTP and DTLS packets at the datagram layer
1864 * (see Section 5 of RFC 5764), are not handled by this feature.
1865 * Instead, after successful completion of a handshake negotiating
1866 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001867 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001868 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1869 * (this is implemented in the SSL example programs).
1870 * The resulting key should then be passed to an SRTP stack.
1871 *
1872 * Setting this option enables the runtime API
1873 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1874 * through which the supported DTLS-SRTP protection
1875 * profiles can be configured. You must call this API at
1876 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001877 *
1878 * Requires: MBEDTLS_SSL_PROTO_DTLS
1879 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001880 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001881 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001882//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001883
1884/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001885 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1886 *
1887 * Enable server-side support for clients that reconnect from the same port.
1888 *
1889 * Some clients unexpectedly close the connection and try to reconnect using the
1890 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001891 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001892 * flag enables that support.
1893 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001894 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001895 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001896 * Comment this to disable support for clients reusing the source port.
1897 */
1898#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1899
1900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001902 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001903 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001904 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001905 * session store remains the responsibility of the application, though).
1906 * Server-side, you also need to provide callbacks for writing and parsing
1907 * tickets, including authenticated encryption and key management. Example
1908 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001909 *
1910 * Comment this macro to disable support for SSL session tickets
1911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001913
1914/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001915 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001916 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001917 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001918 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001920 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001921 * Comment this macro to disable support for server name indication in SSL
1922 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001924
1925/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001926 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1927 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001928 * When this option is enabled, the SSL buffer will be resized automatically
1929 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001930 *
1931 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001932 */
1933//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1934
1935/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001936 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1937 *
1938 * Enable testing of the constant-flow nature of some sensitive functions with
1939 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001940 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001941 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001942 * This setting requires compiling with clang -fsanitize=memory. The test
1943 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001944 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001945 * \warning This macro is only used for extended testing; it is not considered
1946 * part of the library's API, so it may change or disappear at any time.
1947 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001948 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001949 */
1950//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1951
1952/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001953 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1954 *
1955 * Enable testing of the constant-flow nature of some sensitive functions with
1956 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001957 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001958 *
1959 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001960 * testing if the tests suites are run with valgrind's memcheck. This can be
1961 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1962 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001963 *
1964 * \warning This macro is only used for extended testing; it is not considered
1965 * part of the library's API, so it may change or disappear at any time.
1966 *
1967 * Uncomment to enable testing of the constant-flow nature of selected code.
1968 */
1969//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1970
1971/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001972 * \def MBEDTLS_TEST_HOOKS
1973 *
1974 * Enable features for invasive testing such as introspection functions and
1975 * hooks for fault injection. This enables additional unit tests.
1976 *
1977 * Merely enabling this feature should not change the behavior of the product.
1978 * It only adds new code, and new branching points where the default behavior
1979 * is the same as when this feature is disabled.
1980 * However, this feature increases the attack surface: there is an added
1981 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1982 * Therefore this feature must never be enabled in production.
1983 *
1984 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1985 * information.
1986 *
1987 * Uncomment to enable invasive tests.
1988 */
1989//#define MBEDTLS_TEST_HOOKS
1990
1991/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001992 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001993 *
1994 * Provide your own alternate threading implementation.
1995 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001996 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001997 *
1998 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001999 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002000//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002001
2002/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002004 *
2005 * Enable the pthread wrapper layer for the threading layer.
2006 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002008 *
2009 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002010 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002011//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002012
2013/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002014 * \def MBEDTLS_USE_PSA_CRYPTO
2015 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002016 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
2017 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002018 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002019 * \note Development of this option is currently in progress, and parts of Mbed
2020 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002021 * will still continue to work as usual, so enabling this option should not
2022 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002023 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02002024 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02002025 * before calling any function from the SSL/TLS, X.509 or PK modules, except
2026 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00002027 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002028 * \note An important and desirable effect of this option is that it allows
2029 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2030 * 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 +02002031 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002032 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2033 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002034 *
2035 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002036 *
2037 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002038 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002039 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002040 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002041//#define MBEDTLS_USE_PSA_CRYPTO
2042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002044 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2045 *
John Durkop185764f2020-10-12 21:32:12 -07002046 * This setting allows support for cryptographic mechanisms through the PSA
2047 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002048 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002049 * When this option is disabled, the PSA API exposes the cryptographic
2050 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2051 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002052 *
2053 * When this option is enabled, the PSA API exposes the cryptographic
2054 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2055 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2056 * automatically enabled if required (i.e. if no PSA driver provides the
2057 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2058 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002059 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002060 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002061 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002062 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002063 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2064 * symbols is not completely finalized yet, and the configuration
2065 * tooling is not ideally adapted to having two separate configuration
2066 * files.
2067 * Future minor releases of Mbed TLS may make minor changes to those
2068 * symbols, but we will endeavor to provide a transition path.
2069 * Nonetheless, this option is considered mature enough to use in
2070 * production, as long as you accept that you may need to make
2071 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002072 */
2073//#define MBEDTLS_PSA_CRYPTO_CONFIG
2074
2075/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002076 * \def MBEDTLS_VERSION_FEATURES
2077 *
2078 * Allow run-time checking of compile-time enabled features. Thus allowing users
2079 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002080 * support via mbedtls_version_check_feature().
2081 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002082 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002083 *
2084 * Comment this to disable run-time checking and save ROM space
2085 */
2086#define MBEDTLS_VERSION_FEATURES
2087
2088/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002089 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2090 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002091 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002092 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2093 * the set of trusted certificates through a callback instead of a linked
2094 * list.
2095 *
2096 * This is useful for example in environments where a large number of trusted
2097 * certificates is present and storing them in a linked list isn't efficient
2098 * enough, or when the set of trusted certificates changes frequently.
2099 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002100 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002101 * `mbedtls_ssl_conf_ca_cb()` for more information.
2102 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002103 * Requires: MBEDTLS_X509_CRT_PARSE_C
2104 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002105 * Uncomment to enable trusted certificate callbacks.
2106 */
2107//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2108
2109/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002110 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002111 *
Chris Jones2c745862020-12-16 11:41:06 +00002112 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002113 *
Chris Jones2c745862020-12-16 11:41:06 +00002114 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002115 * and other functions/constants only used by these functions, thus reducing
2116 * the code footprint by several KB.
2117 */
Chris Jones2c745862020-12-16 11:41:06 +00002118//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002119
2120/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002122 *
2123 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2124 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2125 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002126 * Requires: MBEDTLS_PKCS1_V21
2127 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002128 * Comment this macro to disallow using RSASSA-PSS in certificates.
2129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002130#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002131/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002132
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002133/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002134 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002135 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002136 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002137 * \{
2138 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002139
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002140/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002141 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002142 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002143 * Enable AES-NI support on x86-64 or x86-32.
2144 *
2145 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002146 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002147 * - GCC, x86-64, target not explicitly supporting AESNI:
2148 * requires MBEDTLS_HAVE_ASM.
2149 * - GCC, x86-32, target not explicitly supporting AESNI:
2150 * not supported.
2151 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2152 * For this assembly-less implementation, you must currently compile
2153 * `library/aesni.c` and `library/aes.c` with machine options to enable
2154 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2155 * `clang -maes -mpclmul`.
2156 * - Non-x86 targets: this option is silently ignored.
2157 * - Other compilers: this option is silently ignored.
2158 *
2159 * \note
2160 * Above, "GCC" includes compatible compilers such as Clang.
2161 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002162 *
2163 * Module: library/aesni.c
2164 * Caller: library/aes.c
2165 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002166 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002167 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002168 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002169 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002171
2172/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002173 * \def MBEDTLS_AESCE_C
2174 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002175 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002176 *
2177 * Module: library/aesce.c
2178 * Caller: library/aes.c
2179 *
Jerry Yuf015a932023-04-25 10:38:03 +08002180 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002181 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002182 * \warning Runtime detection only works on Linux. For non-Linux operating
2183 * system, Armv8-A Cryptographic Extensions must be supported by
2184 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002185 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002186 * \note Minimum compiler versions for this feature when targeting aarch64
2187 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2188 * Minimum compiler versions for this feature when targeting 32-bit
2189 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002190 *
2191 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2192 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002193 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002194 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002195 */
2196#define MBEDTLS_AESCE_C
2197
2198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002200 *
2201 * Enable the AES block cipher.
2202 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002203 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002204 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002205 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002206 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002207 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002208 * This module enables the following ciphersuites (if other requisites are
2209 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2211 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2212 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2213 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2214 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2215 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2216 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2217 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2218 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2219 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2220 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2221 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2222 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2223 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2224 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2225 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2226 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2227 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2228 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2229 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2230 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2231 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2232 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2233 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2234 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2235 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2236 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2237 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2238 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2239 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2240 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2241 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2242 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2243 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2244 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2245 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2246 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2247 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2248 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2249 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2250 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2251 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2252 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2253 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2254 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2255 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2256 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2257 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2258 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2259 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2260 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2261 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2262 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2263 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2264 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2265 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2266 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2267 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002268 *
Paul Bakkercff68422013-09-15 20:43:33 +02002269 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002270 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002271#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002272
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002273/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002274 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002275 *
2276 * Enable the generic ASN1 parser.
2277 *
2278 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002279 * Caller: library/x509.c
2280 * library/dhm.c
2281 * library/pkcs12.c
2282 * library/pkcs5.c
2283 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002284 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002286
2287/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002288 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002289 *
2290 * Enable the generic ASN1 writer.
2291 *
2292 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002293 * Caller: library/ecdsa.c
2294 * library/pkwrite.c
2295 * library/x509_create.c
2296 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002297 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002299#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002300
2301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002302 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002303 *
2304 * Enable the Base64 module.
2305 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002306 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002307 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002308 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002309 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002310 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002311#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002312
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002313/**
Yanray Wange367e472023-10-31 17:23:04 +08002314 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2315 *
2316 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2317 *
2318 * \note This feature is incompatible with insecure block cipher,
2319 * MBEDTLS_DES_C, and cipher modes which always require decryption
2320 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002321 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2322 * this feature is incompatible with following supported PSA equivalence,
2323 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2324 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002325 *
2326 * Module: library/aes.c
2327 * library/aesce.c
2328 * library/aesni.c
2329 * library/aria.c
2330 * library/camellia.c
2331 * library/cipher.c
2332 */
2333//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2334
2335/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002336 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002337 *
Paul Bakker9a736322012-11-14 12:39:52 +00002338 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002339 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002340 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002341 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002342 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002343 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002344 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002345 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002346 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002347 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002348 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002349 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002350 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002351 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002352 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002353#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002354
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002355/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002356 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002357 *
2358 * Enable the Camellia block cipher.
2359 *
Paul Bakker38119b12009-01-10 23:31:23 +00002360 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002361 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002362 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002363 * This module enables the following ciphersuites (if other requisites are
2364 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002365 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2366 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2367 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2368 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2369 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2370 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2371 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2372 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2373 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2374 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2375 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2376 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2377 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2378 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2379 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2380 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2381 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2382 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2383 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2384 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2385 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2386 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2387 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2388 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2389 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2390 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2391 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2392 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2393 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2394 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2395 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2396 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2397 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2398 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2399 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2400 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2401 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2402 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2403 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2404 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2405 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2406 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002407 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002409
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002410/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002411 * \def MBEDTLS_ARIA_C
2412 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002413 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002414 *
2415 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002416 * Caller: library/cipher.c
2417 *
2418 * This module enables the following ciphersuites (if other requisites are
2419 * enabled as well):
2420 *
2421 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2422 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2423 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2424 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2425 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2426 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2427 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2428 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2429 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2430 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2431 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2432 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2433 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2434 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2435 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2436 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2437 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2438 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2439 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2440 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2441 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2442 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2443 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2444 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2445 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2446 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2447 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2448 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2449 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2450 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2451 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2452 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2453 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2454 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2455 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2456 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2457 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2458 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002459 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002460#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002461
2462/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002463 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002464 *
2465 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2466 *
2467 * Module: library/ccm.c
2468 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002469 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2470 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002471 *
2472 * This module enables the AES-CCM ciphersuites, if other requisites are
2473 * enabled as well.
2474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002475#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002476
2477/**
Daniel King34b822c2016-05-15 17:28:08 -03002478 * \def MBEDTLS_CHACHA20_C
2479 *
2480 * Enable the ChaCha20 stream cipher.
2481 *
2482 * Module: library/chacha20.c
2483 */
2484#define MBEDTLS_CHACHA20_C
2485
2486/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002487 * \def MBEDTLS_CHACHAPOLY_C
2488 *
2489 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2490 *
2491 * Module: library/chachapoly.c
2492 *
2493 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2494 */
2495#define MBEDTLS_CHACHAPOLY_C
2496
2497/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002499 *
2500 * Enable the generic cipher layer.
2501 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002502 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002503 * Caller: library/ccm.c
2504 * library/cmac.c
2505 * library/gcm.c
2506 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002507 * library/pkcs12.c
2508 * library/pkcs5.c
2509 * library/psa_crypto_aead.c
2510 * library/psa_crypto_mac.c
2511 * library/ssl_ciphersuites.c
2512 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002513 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002514 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2515 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002516 *
2517 * Uncomment to enable generic cipher wrappers.
2518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002520
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002521/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002522 * \def MBEDTLS_CMAC_C
2523 *
Simon Butcher327398a2016-10-05 14:09:11 +01002524 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2525 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002526 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002527 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2528 * implementation of the CMAC algorithm is provided by an alternate
2529 * implementation, that alternate implementation may opt to not support
2530 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2531 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002532 * Module: library/cmac.c
2533 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002534 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002535 *
2536 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002537#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002538
2539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002541 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002542 * Enable the CTR_DRBG AES-based random generator.
2543 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002544 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002545 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002546 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2547 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2548 * is used.
2549 *
2550 * \warning When using PSA, the user should call `psa_crypto_init()` before
2551 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2552 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002553 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2554 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002555 * \note To achieve a 256-bit security strength with CTR_DRBG,
2556 * you must use AES-256 *and* use sufficient entropy.
2557 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002558 *
2559 * Module: library/ctr_drbg.c
2560 * Caller:
2561 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002562 * Requires: MBEDTLS_AES_C or
2563 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2564 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002565 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002566 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002569
2570/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002572 *
2573 * Enable the debug functions.
2574 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002575 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002576 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002577 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002578 * library/ssl_tls12_*.c
2579 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002580 *
2581 * This module provides debugging functions.
2582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002584
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002585/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002587 *
2588 * Enable the DES block cipher.
2589 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002590 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002591 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002592 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002593 *
Paul Bakkercff68422013-09-15 20:43:33 +02002594 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002595 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002596 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002597 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002600
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002601/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002603 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002604 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002605 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002606 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002607 * Caller: library/ssl_tls.c
2608 * library/ssl*_client.c
2609 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002610 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002611 * This module is used by the following key exchanges:
2612 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002613 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002614 * \warning Using DHE constitutes a security risk as it
2615 * is not possible to validate custom DH parameters.
2616 * If possible, it is recommended users should consider
2617 * preferring other methods of key exchange.
2618 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002619 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002622
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002623/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002625 *
2626 * Enable the elliptic curve Diffie-Hellman library.
2627 *
2628 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002629 * Caller: library/psa_crypto.c
2630 * library/ssl_tls.c
2631 * library/ssl*_client.c
2632 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002633 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002634 * This module is used by the following key exchanges:
2635 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002636 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002638 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002639#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002640
2641/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002643 *
2644 * Enable the elliptic curve DSA library.
2645 *
2646 * Module: library/ecdsa.c
2647 * Caller:
2648 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002649 * This module is used by the following key exchanges:
2650 * ECDHE-ECDSA
2651 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002652 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2653 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2654 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002655 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002657
2658/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002659 * \def MBEDTLS_ECJPAKE_C
2660 *
2661 * Enable the elliptic curve J-PAKE library.
2662 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002663 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2664 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002665 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002666 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002667 * Module: library/ecjpake.c
2668 * Caller:
2669 *
2670 * This module is used by the following key exchanges:
2671 * ECJPAKE
2672 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002673 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002674 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002675 * \warning If using a hash that is only provided by PSA drivers, you must
2676 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002677 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002678#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002679
2680/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002682 *
2683 * Enable the elliptic curve over GF(p) library.
2684 *
2685 * Module: library/ecp.c
2686 * Caller: library/ecdh.c
2687 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002688 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002689 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002691 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002693
2694/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002696 *
2697 * Enable the platform-specific entropy code.
2698 *
2699 * Module: library/entropy.c
2700 * Caller:
2701 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002703 *
2704 * This module provides a generic entropy pool
2705 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002706#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002707
2708/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002710 *
2711 * Enable error code to error string conversion.
2712 *
2713 * Module: library/error.c
2714 * Caller:
2715 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002718#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002719
2720/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002721 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002722 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002723 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002724 *
2725 * Module: library/gcm.c
2726 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002727 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2728 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002729 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002730 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2731 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002732 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002734
2735/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002736 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002737 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002738 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002739 * Can significantly increase throughput on systems without GCM hardware
2740 * acceleration (e.g., AESNI, AESCE).
2741 *
Matthias Schulz78266782024-02-08 13:54:48 +01002742 * The mbedtls_gcm_context size will increase by 3840 bytes.
2743 * The code size will increase by roughly 344 bytes.
2744 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002745 * Module: library/gcm.c
2746 *
2747 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002748 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002749//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002750
2751/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002752 * \def MBEDTLS_HKDF_C
2753 *
2754 * Enable the HKDF algorithm (RFC 5869).
2755 *
2756 * Module: library/hkdf.c
2757 * Caller:
2758 *
2759 * Requires: MBEDTLS_MD_C
2760 *
2761 * This module adds support for the Hashed Message Authentication Code
2762 * (HMAC)-based key derivation function (HKDF).
2763 */
2764#define MBEDTLS_HKDF_C
2765
2766/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002767 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002768 *
2769 * Enable the HMAC_DRBG random generator.
2770 *
2771 * Module: library/hmac_drbg.c
2772 * Caller:
2773 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002775 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002776 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002777 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002778#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002779
2780/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002781 * \def MBEDTLS_LMS_C
2782 *
2783 * Enable the LMS stateful-hash asymmetric signature algorithm.
2784 *
2785 * Module: library/lms.c
2786 * Caller:
2787 *
Raef Colesab4f8742022-09-01 12:24:31 +01002788 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002789 *
Raef Colesab4f8742022-09-01 12:24:31 +01002790 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002791 */
2792#define MBEDTLS_LMS_C
2793
2794/**
Raef Colesab4f8742022-09-01 12:24:31 +01002795 * \def MBEDTLS_LMS_PRIVATE
2796 *
2797 * Enable LMS private-key operations and signing code. Functions enabled by this
2798 * option are experimental, and should not be used in production.
2799 *
2800 * Requires: MBEDTLS_LMS_C
2801 *
2802 * Uncomment to enable the LMS signature algorithm and private key operations.
2803 */
Raef Coles5127e852022-10-07 10:35:56 +01002804//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002805
2806/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002807 * \def MBEDTLS_NIST_KW_C
2808 *
2809 * Enable the Key Wrapping mode for 128-bit block ciphers,
2810 * as defined in NIST SP 800-38F. Only KW and KWP modes
2811 * are supported. At the moment, only AES is approved by NIST.
2812 *
2813 * Module: library/nist_kw.c
2814 *
2815 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2816 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002817#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002818
2819/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002821 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002822 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002823 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002824 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2825 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002826 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002827 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002828 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002829 * Caller: library/constant_time.c
2830 * library/ecdsa.c
2831 * library/ecjpake.c
2832 * library/hkdf.c
2833 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002834 * library/pk.c
2835 * library/pkcs5.c
2836 * library/pkcs12.c
2837 * library/psa_crypto_ecp.c
2838 * library/psa_crypto_rsa.c
2839 * library/rsa.c
2840 * library/ssl_cookie.c
2841 * library/ssl_msg.c
2842 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002843 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002844 * library/x509_crt.c
2845 * library/x509write_crt.c
2846 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002847 *
2848 * Uncomment to enable generic message digest wrappers.
2849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002851
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002852/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002854 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002855 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002856 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002857 * Module: library/md5.c
2858 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002859 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002860 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002861 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002862 * This module is required for TLS 1.2 depending on the handshake parameters.
2863 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2864 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002865 *
2866 * \warning MD5 is considered a weak message digest and its use constitutes a
2867 * security risk. If possible, we recommend avoiding dependencies on
2868 * it, and considering stronger message digests instead.
2869 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002870 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002872
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002873/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002875 *
2876 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002877 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002878 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002879 *
2880 * Module: library/memory_buffer_alloc.c
2881 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002882 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002883 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002884 *
2885 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002888
2889/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002891 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002892 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2893 *
Simon Butcherd567a232016-03-09 20:19:21 +00002894 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2895 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002896 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002897 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002898 * \note See also our Knowledge Base article about porting to a new
2899 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002900 * 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 +00002901 *
Andres AG788aa4a2016-09-14 14:32:09 +01002902 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002903 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002904 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002905 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002907
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002908/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002909 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002910 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002911 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002912 *
2913 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002914 * Caller: library/asn1write.c
2915 * library/pkcs5.c
2916 * library/pkparse.c
2917 * library/pkwrite.c
2918 * library/rsa.c
2919 * library/x509.c
2920 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002921 * library/x509_crl.c
2922 * library/x509_crt.c
2923 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002924 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002925 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002926 *
2927 * This modules translates between OIDs and internal values.
2928 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002929#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002930
2931/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002933 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002934 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002935 *
2936 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002937 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002938 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002939 * library/x509_crl.c
2940 * library/x509_crt.c
2941 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002942 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002943 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002944 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2945 *
2946 * \warning When parsing password-protected files, if MD5 is provided only by
2947 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002948 *
Paul Bakkercff68422013-09-15 20:43:33 +02002949 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002950 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002952
2953/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002955 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002956 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002957 *
2958 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002959 * Caller: library/pkwrite.c
2960 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002961 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002962 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002964 *
2965 * This modules adds support for encoding / writing PEM files.
2966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002968
2969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002971 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002972 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002973 *
2974 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002975 * Caller: library/psa_crypto_rsa.c
2976 * library/ssl_tls.c
2977 * library/ssl*_client.c
2978 * library/ssl*_server.c
2979 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002980 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002981 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002982 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002983 * Uncomment to enable generic public key wrappers.
2984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002986
2987/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002989 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002990 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002991 *
2992 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002993 * Caller: library/x509_crt.c
2994 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002995 *
Yanray Wang072a0682023-12-05 10:53:04 +08002996 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002997 *
2998 * Uncomment to enable generic public key parse functions.
2999 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003001
3002/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003003 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003004 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003005 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003006 *
3007 * Module: library/pkwrite.c
3008 * Caller: library/x509write.c
3009 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08003010 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003011 *
3012 * Uncomment to enable generic public key write functions.
3013 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003014#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003015
3016/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003018 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003019 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003020 *
3021 * Module: library/pkcs5.c
3022 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01003023 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003024 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003025 * \warning If using a hash that is only provided by PSA drivers, you must
3026 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003027 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003028 * This module adds support for the PKCS#5 functions.
3029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003031
3032/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003033 * \def MBEDTLS_PKCS7_C
3034 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003035 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003036 * RFC Link - https://tools.ietf.org/html/rfc2315
3037 *
3038 * Module: library/pkcs7.c
3039 *
3040 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003041 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3042 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003043 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003044 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003045 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003046#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003047
3048/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003050 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003051 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003052 * Adds algorithms for parsing PKCS#8 encrypted private keys
3053 *
3054 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003055 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003056 *
Valerio Settie98ad592023-12-28 10:42:12 +01003057 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3058 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003059 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003060 * \warning If using a hash that is only provided by PSA drivers, you must
3061 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003062 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003063 * This module enables PKCS#12 functions.
3064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003066
3067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003069 *
3070 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003071 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003072 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3074 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003075 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003076 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003077 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003078 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003079 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003080 * Module: library/platform.c
3081 * Caller: Most other .c files
3082 *
3083 * This module enables abstraction of common (libc) functions.
3084 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003085#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003086
3087/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003088 * \def MBEDTLS_POLY1305_C
3089 *
3090 * Enable the Poly1305 MAC algorithm.
3091 *
3092 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003093 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003094 */
3095#define MBEDTLS_POLY1305_C
3096
3097/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003098 * \def MBEDTLS_PSA_CRYPTO_C
3099 *
3100 * Enable the Platform Security Architecture cryptography API.
3101 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003102 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003103 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003104 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003105 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003106 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3107 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3108 * is enabled in PSA (unless it's fully accelerated, see
3109 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003110 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003111#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003112
3113/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003114 * \def MBEDTLS_PSA_CRYPTO_SE_C
3115 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003116 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003117 * cryptography API.
3118 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003119 * \deprecated This feature is deprecated. Please switch to the PSA driver
3120 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003121 *
Ryan Everett32a64582024-03-05 18:16:18 +00003122 * \warning This feature is not thread-safe, and should not be used in a
3123 * multi-threaded environment.
3124 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003125 * Module: library/psa_crypto_se.c
3126 *
3127 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3128 *
3129 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003130//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003131
3132/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003133 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3134 *
3135 * Enable the Platform Security Architecture persistent key storage.
3136 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003137 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003138 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003139 * Requires: MBEDTLS_PSA_CRYPTO_C,
3140 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3141 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003142 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003143#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003144
3145/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003146 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003147 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003148 * Enable the emulation of the Platform Security Architecture
3149 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003150 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003151 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003152 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003153 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003154 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003155#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003156
3157/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003158 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003159 *
3160 * Enable the RIPEMD-160 hash algorithm.
3161 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003162 * Module: library/ripemd160.c
3163 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003164 *
3165 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003166#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003167
3168/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003169 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003170 *
3171 * Enable the RSA public-key cryptosystem.
3172 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003173 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003174 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003175 * Caller: library/pk.c
3176 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003177 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003178 * library/ssl*_client.c
3179 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003180 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003181 * This module is used by the following key exchanges:
3182 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003183 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003185 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003187
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003188/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003189 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003190 *
3191 * Enable the SHA1 cryptographic hash algorithm.
3192 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003193 * Module: library/sha1.c
3194 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003195 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003196 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003197 * This module is required for TLS 1.2 depending on the handshake parameters,
3198 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003199 *
3200 * \warning SHA-1 is considered a weak message digest and its use constitutes
3201 * a security risk. If possible, we recommend avoiding dependencies
3202 * on it, and considering stronger message digests instead.
3203 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003206
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003207/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003208 * \def MBEDTLS_SHA224_C
3209 *
3210 * Enable the SHA-224 cryptographic hash algorithm.
3211 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003212 * Module: library/sha256.c
3213 * Caller: library/md.c
3214 * library/ssl_cookie.c
3215 *
3216 * This module adds support for SHA-224.
3217 */
3218#define MBEDTLS_SHA224_C
3219
3220/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003221 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003222 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003223 * Enable the SHA-256 cryptographic hash algorithm.
3224 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003225 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003226 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003227 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003228 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003229 * library/ssl*_client.c
3230 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003231 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003232 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003233 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003234 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003235#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003236
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003237/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003238 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003239 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003240 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3241 * with the ARMv8 cryptographic extensions if they are available at runtime.
3242 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003243 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003244 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003245 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003246 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003247 * \note Minimum compiler versions for this feature are Clang 4.0,
3248 * armclang 6.6 or GCC 6.0.
3249 *
3250 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3251 * armclang <= 6.9
3252 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003253 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3254 * That name is deprecated, but may still be used as an alternative form for this
3255 * option.
3256 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003257 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3258 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003259 *
3260 * Requires: MBEDTLS_SHA256_C.
3261 *
3262 * Module: library/sha256.c
3263 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003264 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003265 * and use them if available.
3266 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003267//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003268
Dave Rodgmand85277c2023-10-13 09:22:54 +01003269/**
3270 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3271 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003272 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003273 * This name is now deprecated, but may still be used as an alternative form for
3274 * this option.
3275 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003276//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3277
3278/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003279 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003280 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003281 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3282 * with the ARMv8 cryptographic extensions, which must be available at runtime
3283 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003284 *
3285 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003286 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003287 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003288 * \note Minimum compiler versions for this feature are Clang 4.0,
3289 * armclang 6.6 or GCC 6.0.
3290 *
3291 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3292 * armclang <= 6.9
3293 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003294 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003295 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003296 * option.
3297 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003298 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3299 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003300 *
3301 * Requires: MBEDTLS_SHA256_C.
3302 *
3303 * Module: library/sha256.c
3304 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003305 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003306 * unconditionally.
3307 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003308//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003309
Dave Rodgmand85277c2023-10-13 09:22:54 +01003310/**
3311 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3312 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003313 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003314 * This name is now deprecated, but may still be used as an alternative form for
3315 * this option.
3316 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003317//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3318
3319/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003320 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003321 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003322 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003323 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003324 * Module: library/sha512.c
3325 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003326 * library/psa_crypto_hash.c
3327 * library/ssl_tls.c
3328 * library/ssl*_client.c
3329 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003330 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003331 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003332 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003333#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003334
3335/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003336 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003337 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003338 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003339 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003340 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003341 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003342 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003343 * library/ssl_tls.c
3344 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003345 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003346 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003347 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003349
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003350/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003351 * \def MBEDTLS_SHA3_C
3352 *
3353 * Enable the SHA3 cryptographic hash algorithm.
3354 *
3355 * Module: library/sha3.c
3356 *
3357 * This module adds support for SHA3.
3358 */
3359#define MBEDTLS_SHA3_C
3360
3361/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003362 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3363 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003364 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3365 * with the ARMv8 cryptographic extensions if they are available at runtime.
3366 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003367 *
3368 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3369 * for a non-Aarch64 build it will be silently ignored.
3370 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003371 * \note Minimum compiler versions for this feature are Clang 7.0,
3372 * armclang 6.9 or GCC 8.0.
3373 *
3374 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3375 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003376 *
3377 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3378 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3379 *
3380 * Requires: MBEDTLS_SHA512_C.
3381 *
3382 * Module: library/sha512.c
3383 *
3384 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3385 * and use them if available.
3386 */
3387//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3388
3389/**
3390 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3391 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003392 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3393 * with the ARMv8 cryptographic extensions, which must be available at runtime
3394 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003395 *
3396 * \note This allows builds with a smaller code size than with
3397 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3398 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003399 * \note Minimum compiler versions for this feature are Clang 7.0,
3400 * armclang 6.9 or GCC 8.0.
3401 *
3402 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3403 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003404 *
3405 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3406 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3407 *
3408 * Requires: MBEDTLS_SHA512_C.
3409 *
3410 * Module: library/sha512.c
3411 *
3412 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3413 * unconditionally.
3414 */
3415//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3416
3417/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003419 *
3420 * Enable simple SSL cache implementation.
3421 *
3422 * Module: library/ssl_cache.c
3423 * Caller:
3424 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003428
3429/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003431 *
3432 * Enable basic implementation of DTLS cookies for hello verification.
3433 *
3434 * Module: library/ssl_cookie.c
3435 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003436 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003437#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003438
3439/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003440 * \def MBEDTLS_SSL_TICKET_C
3441 *
3442 * Enable an implementation of TLS server-side callbacks for session tickets.
3443 *
3444 * Module: library/ssl_ticket.c
3445 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003446 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003447 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3448 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003449 */
3450#define MBEDTLS_SSL_TICKET_C
3451
3452/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003454 *
3455 * Enable the SSL/TLS client code.
3456 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003457 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003458 * Caller:
3459 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003461 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003462 * This module is required for SSL/TLS client support.
3463 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003464#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003465
Paul Bakker9a736322012-11-14 12:39:52 +00003466/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003467 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003468 *
3469 * Enable the SSL/TLS server code.
3470 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003471 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003472 * Caller:
3473 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003474 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003475 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003476 * This module is required for SSL/TLS server support.
3477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003479
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003480/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003481 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003482 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003483 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003484 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003485 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003486 * Caller: library/ssl*_client.c
3487 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003488 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003489 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3490 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003491 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003492 * This module is required for SSL/TLS.
3493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003495
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003498 *
3499 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003500 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003501 * contexts are not shared between threads. If you do intend to use contexts
3502 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003503 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003504 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003505 *
3506 * Module: library/threading.c
3507 *
3508 * This allows different threading implementations (self-implemented or
3509 * provided).
3510 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003511 * You will have to enable either MBEDTLS_THREADING_ALT or
3512 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003513 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003514 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003515 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003516//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003517
3518/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003520 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003521 * Enable the semi-portable timing interface.
3522 *
Simon Butcherd567a232016-03-09 20:19:21 +00003523 * \note The provided implementation only works on POSIX/Unix (including Linux,
3524 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003525 * module and provide your own implementations of the callbacks needed by
3526 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3527 * your own implementation of the whole module by setting
3528 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003529 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003530 * \note The timing module will include time.h on suitable platforms
3531 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3532 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3533 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003534 * \note See also our Knowledge Base article about porting to a new
3535 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003536 * 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 +00003537 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003538 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003541
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003544 *
3545 * Enable run-time version information.
3546 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003547 * Module: library/version.c
3548 *
3549 * This module provides run-time version information.
3550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003551#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003552
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003553/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003554 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003555 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003556 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003557 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003558 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003559 * Caller: library/x509_crl.c
3560 * library/x509_crt.c
3561 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003562 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003563 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003564 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3565 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003566 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3567 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003568 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003569 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003571#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003572
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003573/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003574 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003575 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003576 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003577 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003578 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003579 * Caller: library/ssl_tls.c
3580 * library/ssl*_client.c
3581 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003582 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003583 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003584 *
3585 * This module is required for X.509 certificate parsing.
3586 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003587#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003588
3589/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003590 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003591 *
3592 * Enable X.509 CRL parsing.
3593 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003594 * Module: library/x509_crl.c
3595 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003596 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003597 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003598 *
3599 * This module is required for X.509 CRL parsing.
3600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003602
3603/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003604 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003605 *
3606 * Enable X.509 Certificate Signing Request (CSR) parsing.
3607 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003608 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003609 * Caller: library/x509_crt_write.c
3610 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003611 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003612 *
3613 * This module is used for reading X.509 certificate request.
3614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003615#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003616
3617/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003618 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003619 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003620 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003621 *
3622 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003623 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003624 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003625 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3626 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003627 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3628 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003629 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003630 * This module is the basis for creating X.509 certificates and CSRs.
3631 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003632#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003633
3634/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003635 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003636 *
3637 * Enable creating X.509 certificates.
3638 *
3639 * Module: library/x509_crt_write.c
3640 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003641 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003642 *
3643 * This module is required for X.509 certificate creation.
3644 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003645#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003646
3647/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003648 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003649 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003650 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003651 *
3652 * Module: library/x509_csr_write.c
3653 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003654 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003655 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003656 * This module is required for X.509 certificate request writing.
3657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003658#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003659
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003660/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003661
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003662/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003663 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003664 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003665 * This section contains Mbed TLS build settings that are not associated
3666 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003667 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003668 * \{
3669 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003670
Gilles Peskinea02c1242022-03-16 17:03:19 +01003671/**
3672 * \def MBEDTLS_CONFIG_FILE
3673 *
3674 * If defined, this is a header which will be included instead of
3675 * `"mbedtls/mbedtls_config.h"`.
3676 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003677 * Unlike other configuration options, this one must be defined on the
3678 * compiler command line: a definition in `mbedtls_config.h` would have
3679 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003680 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003681 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003682 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003683 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003684 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003685 * The value of this symbol is typically a path in double quotes, either
3686 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003687 */
3688//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3689
3690/**
3691 * \def MBEDTLS_USER_CONFIG_FILE
3692 *
3693 * If defined, this is a header which will be included after
3694 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003695 * This allows you to modify the default configuration, including the ability
3696 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003697 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003698 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003699 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003700 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003701 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003702 * The value of this symbol is typically a path in double quotes, either
3703 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003704 */
3705//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3706
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003707/**
3708 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3709 *
3710 * If defined, this is a header which will be included instead of
3711 * `"psa/crypto_config.h"`.
3712 * This header file specifies which cryptographic mechanisms are available
3713 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3714 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3715 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003716 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003717 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003718 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003719 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003720 * The value of this symbol is typically a path in double quotes, either
3721 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003722 */
3723//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3724
3725/**
3726 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3727 *
3728 * If defined, this is a header which will be included after
3729 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003730 * This allows you to modify the default configuration, including the ability
3731 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003732 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003733 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003734 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003735 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003736 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003737 * The value of this symbol is typically a path in double quotes, either
3738 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003739 */
3740//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3741
Gilles Peskineb1176f22023-02-22 22:07:28 +01003742/**
3743 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3744 *
3745 * If defined, this is a header which will be included instead of
3746 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3747 * as the one in Mbed TLS, but with definitions adapted to the platform on
3748 * which the library code will run.
3749 *
3750 * \note The required content of this header can vary from one version of
3751 * Mbed TLS to the next. Integrators who provide an alternative file
3752 * should review the changes in the original file whenever they
3753 * upgrade Mbed TLS.
3754 *
3755 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3756 * non-standard feature of the C language, so this feature is only available
3757 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3758 *
3759 * The value of this symbol is typically a path in double quotes, either
3760 * absolute or relative to a directory on the include search path.
3761 */
3762//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3763
3764/**
3765 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3766 *
3767 * If defined, this is a header which will be included instead of
3768 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3769 * as the one in Mbed TLS, but with definitions adapted to the environment
3770 * in which the library code will run. The typical use for this feature
3771 * is to provide alternative type definitions on the client side in
3772 * client-server integrations of PSA crypto, where operation structures
3773 * contain handles instead of cryptographic data.
3774 *
3775 * \note The required content of this header can vary from one version of
3776 * Mbed TLS to the next. Integrators who provide an alternative file
3777 * should review the changes in the original file whenever they
3778 * upgrade Mbed TLS.
3779 *
3780 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3781 * non-standard feature of the C language, so this feature is only available
3782 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3783 *
3784 * The value of this symbol is typically a path in double quotes, either
3785 * absolute or relative to a directory on the include search path.
3786 */
3787//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3788
Gilles Peskineba4162a2022-04-11 17:04:38 +02003789/** \} name SECTION: General configuration options */
3790
3791/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003792 * \name SECTION: Module configuration options
3793 *
3794 * This section allows for the setting of module specific sizes and
3795 * configuration options. The default values are already present in the
3796 * relevant header files and should suffice for the regular use cases.
3797 *
3798 * Our advice is to enable options and change their values here
3799 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003800 * \{
3801 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003802/* The Doxygen documentation here is used when a user comments out a
3803 * setting and runs doxygen themselves. On the other hand, when we typeset
3804 * the full documentation including disabled settings, the documentation
3805 * in specific modules' header files is used if present. When editing this
3806 * file, make sure that each option is documented in exactly one place,
3807 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3808 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003809
Paul Bakker088c5c52014-04-25 11:11:10 +02003810/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003811//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003812//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003813
Paul Bakker088c5c52014-04-25 11:11:10 +02003814/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003815//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3816//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3817//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3818//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3819//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003820
Paul Bakker088c5c52014-04-25 11:11:10 +02003821/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003822//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3823//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3824//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3825//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003826
Paul Bakker088c5c52014-04-25 11:11:10 +02003827/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003828//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003829//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003830
Paul Bakker088c5c52014-04-25 11:11:10 +02003831/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003832//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3833//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003834//#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 +01003835
Paul Bakker088c5c52014-04-25 11:11:10 +02003836/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003837//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003838
Paul Bakker088c5c52014-04-25 11:11:10 +02003839/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003840//#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 -04003841
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003842/** \def MBEDTLS_PLATFORM_STD_CALLOC
3843 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003844 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003845 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003846 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003847 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003848 * 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 -04003849 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3850 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003851 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003852 */
3853//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003854
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003855/** \def MBEDTLS_PLATFORM_STD_FREE
3856 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003857 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003858 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003859 * 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 -04003860 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3861 * 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 -04003862 */
3863//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003864//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003865//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003866//#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 +02003867//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3868//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003869/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003870//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003871//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3872//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003873//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3874//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3875//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003876
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003877/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003878/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003879//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3880//#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 +02003881//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003882//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003883//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3884//#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 +02003885//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3886//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003887/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003888//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003889//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003890//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3891//#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 +08003892//#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 +08003893//#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 +02003894
Gilles Peskine3f106f72021-09-23 17:42:39 +02003895/** \def MBEDTLS_CHECK_RETURN
3896 *
3897 * This macro is used at the beginning of the declaration of a function
3898 * to indicate that its return value should be checked. It should
3899 * instruct the compiler to emit a warning or an error if the function
3900 * is called without checking its return value.
3901 *
3902 * There is a default implementation for popular compilers in platform_util.h.
3903 * You can override the default implementation by defining your own here.
3904 *
3905 * If the implementation here is empty, this will effectively disable the
3906 * checking of functions' return values.
3907 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003908//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003909
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003910/** \def MBEDTLS_IGNORE_RETURN
3911 *
3912 * This macro requires one argument, which should be a C function call.
3913 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3914 * warning is suppressed.
3915 */
3916//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3917
Gilles Peskineed038902020-11-13 21:33:21 +01003918/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003919/**
Gilles Peskineed038902020-11-13 21:33:21 +01003920 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3921 * PSA crypto subsystem.
3922 *
3923 * If this option is unset:
3924 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003925 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003926 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3927 * on unspecified heuristics.
3928 */
3929//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3930
Steven Cooreman863470a2021-02-15 14:03:19 +01003931/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003932 * Restrict the PSA library to supporting a maximum amount of simultaneously
3933 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3934 * volatile key, or a persistent key which is loaded temporarily by the
3935 * library as part of a crypto operation in flight.
3936 *
3937 * If this option is unset, the library will fall back to a default value of
3938 * 32 keys.
3939 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003940//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003941
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003942/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003943//#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 +00003944
Paul Bakker088c5c52014-04-25 11:11:10 +02003945/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003946//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3947//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003948
Paul Bakker088c5c52014-04-25 11:11:10 +02003949/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003950
Angus Grattond8213d02016-05-25 20:56:48 +10003951/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3952 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003953 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003954 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003955 * This determines the size of the incoming TLS I/O buffer in such a way
3956 * that it is capable of holding the specified amount of plaintext data,
3957 * regardless of the protection mechanism used.
3958 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003959 * \note When using a value less than the default of 16KB on the client, it is
3960 * recommended to use the Maximum Fragment Length (MFL) extension to
3961 * inform the server about this limitation. On the server, there
3962 * is no supported, standardized way of informing the client about
3963 * restriction on the maximum size of incoming messages, and unless
3964 * the limitation has been communicated by other means, it is recommended
3965 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3966 * while keeping the default value of 16KB for the incoming buffer.
3967 *
David Horstmann95d516f2021-05-04 18:36:56 +01003968 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003969 */
3970//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3971
Gilles Peskined3d02902020-03-04 21:35:27 +01003972/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3973 *
3974 * The maximum length of CIDs used for incoming DTLS messages.
3975 *
3976 */
3977//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3978
3979/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3980 *
3981 * The maximum length of CIDs used for outgoing DTLS messages.
3982 *
3983 */
3984//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3985
TRodziewicze8dd7092021-05-12 14:19:11 +02003986/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003987 *
3988 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003989 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003990 *
3991 * The padding will always be chosen so that the length of the
3992 * padded plaintext is a multiple of the value of this option.
3993 *
3994 * Note: A value of \c 1 means that no padding will be used
3995 * for outgoing records.
3996 *
3997 * Note: On systems lacking division instructions,
3998 * a power of two should be preferred.
3999 */
TRodziewicze8dd7092021-05-12 14:19:11 +02004000//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01004001
Angus Grattond8213d02016-05-25 20:56:48 +10004002/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4003 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004004 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004005 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004006 * This determines the size of the outgoing TLS I/O buffer in such a way
4007 * that it is capable of holding the specified amount of plaintext data,
4008 * regardless of the protection mechanism used.
4009 *
Angus Grattond8213d02016-05-25 20:56:48 +10004010 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4011 * the default inward 16384 byte buffer to conform to the TLS specification.
4012 *
4013 * The minimum required outward buffer size is determined by the handshake
4014 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4015 * The specific size requirement depends on the configured ciphers and any
4016 * certificate data which is sent during the handshake.
4017 *
David Horstmann95d516f2021-05-04 18:36:56 +01004018 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004019 */
4020//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4021
Hanno Beckere0b150f2018-08-21 15:51:03 +01004022/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4023 *
4024 * Maximum number of heap-allocated bytes for the purpose of
4025 * DTLS handshake message reassembly and future message buffering.
4026 *
Yuto Takano7828ca22021-08-10 11:26:15 +01004027 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004028 * to account for a reassembled handshake message of maximum size,
4029 * together with its reassembly bitmap.
4030 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004031 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004032 * should be sufficient for all practical situations as it allows
4033 * to reassembly a large handshake message (such as a certificate)
4034 * while buffering multiple smaller handshake messages.
4035 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004036 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004037//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004038
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004039//#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 +02004040//#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 +02004041
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004042/**
4043 * Complete list of ciphersuites to use, in order of preference.
4044 *
4045 * \warning No dependency checking is done on that field! This option can only
4046 * be used to restrict the set of available ciphersuites. It is your
4047 * responsibility to make sure the needed modules are active.
4048 *
4049 * Use this to save a few hundred bytes of ROM (default ordering of all
4050 * available ciphersuites) and a few to a few hundred bytes of RAM.
4051 *
4052 * The value below is only an example, not the default.
4053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004054//#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 +02004055
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004056/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004057 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4058 *
4059 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004060 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004061 *
4062 * It must be positive and smaller than UINT32_MAX.
4063 *
4064 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4065 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004066 */
4067//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4068
4069/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004070 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4071 *
Jerry Yucf913512023-11-14 11:06:52 +08004072 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004073 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004074 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004075 * - The client ticket age is the time difference between the time when the
4076 * client proposes to the server to use the ticket and the time the client
4077 * received the ticket from the server.
4078 * - The server ticket age is the time difference between the time when the
4079 * server receives a proposition from the client to use the ticket and the
4080 * time when the ticket was created by the server.
4081 *
Jerry Yucf913512023-11-14 11:06:52 +08004082 * The ages might be different due to the client and server clocks not running
4083 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4084 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4085 * 6s, thus in the worst case clients and servers must sync up their system time
4086 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004087 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004088 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004089 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004090//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004091
4092/**
4093 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4094 *
4095 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4096 *
4097 * This must be less than 256.
4098 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004099//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004100
4101/**
4102 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4103 *
4104 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4105 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4106 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4107 *
4108 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004109//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004110
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004111/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004112//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004113//#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 +01004114
Gilles Peskine611179c2022-04-13 23:04:48 +02004115/** \} name SECTION: Module configuration options */