blob: 6b36dd79790823d937022bad932cab8235864ec0 [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
Steven Cooreman63342772017-04-04 11:47:16 +0200383//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384//#define MBEDTLS_DES_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100385//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300386//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200387//#define MBEDTLS_MD5_ALT
388//#define MBEDTLS_RIPEMD160_ALT
389//#define MBEDTLS_SHA1_ALT
390//#define MBEDTLS_SHA256_ALT
391//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000392
Paul Bakker90995b52013-06-24 19:20:35 +0200393/**
TRodziewicz75628d52021-06-18 12:56:27 +0200394 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200395 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200396 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100397 * alternate core implementation of symmetric crypto or hash function. Keep in
398 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200399 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200400 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200402 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200403 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200404 * no longer provide the mbedtls_sha1_process() function, but it will still provide
405 * the other function (using your mbedtls_sha1_process() function) and the definition
406 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200407 * with this definition.
408 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200409 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100410 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
411 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200412 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200413 * Uncomment a macro to enable alternate implementation of the corresponding
414 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100415 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200416 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100417 * constitutes a security risk. If possible, we recommend avoiding
418 * dependencies on them, and considering stronger message digests
419 * and ciphers instead.
420 *
Janos Follath1231d212019-01-07 15:01:32 +0000421 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
422 * enabled, then the deterministic ECDH signature functions pass the
423 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
424 * alternative implementations should use the RNG only for generating
425 * the ephemeral key and nothing else. If this is not possible, then
426 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200427 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000428 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200430//#define MBEDTLS_MD5_PROCESS_ALT
431//#define MBEDTLS_RIPEMD160_PROCESS_ALT
432//#define MBEDTLS_SHA1_PROCESS_ALT
433//#define MBEDTLS_SHA256_PROCESS_ALT
434//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200435//#define MBEDTLS_DES_SETKEY_ALT
436//#define MBEDTLS_DES_CRYPT_ECB_ALT
437//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200438//#define MBEDTLS_AES_SETKEY_ENC_ALT
439//#define MBEDTLS_AES_SETKEY_DEC_ALT
440//#define MBEDTLS_AES_ENCRYPT_ALT
441//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300442//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300443//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300444//#define MBEDTLS_ECDSA_VERIFY_ALT
445//#define MBEDTLS_ECDSA_SIGN_ALT
446//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200447
448/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200449 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200450 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200451 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200452 * hardware entropy collector.
453 *
454 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000455 * prototype as declared in library/entropy_poll.h, and accept NULL as first
456 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200457 *
458 * Uncomment to use your own hardware entropy collector.
459 */
460//#define MBEDTLS_ENTROPY_HARDWARE_ALT
461
462/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200463 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000464 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100465 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000466 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100467 * Uncomment this macro to use precomputed AES tables stored in ROM.
468 * Comment this macro to generate AES tables in RAM at runtime.
469 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100470 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
471 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100472 * initialization time before the first AES operation can be performed.
473 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
474 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
475 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100476 *
477 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200479//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000480
481/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100482 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200483 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100484 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200485 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100486 * Uncommenting this macro omits 75% of the AES tables from
487 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
488 * by computing their values on the fly during operations
489 * (the tables are entry-wise rotations of one another).
490 *
491 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100492 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100493 * runtime. Specifically, one has to compare 4 accesses within
494 * different tables to 4 accesses with additional arithmetic
495 * operations within the same table. The performance gain/loss
496 * depends on the system and memory details.
497 *
498 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200499 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100500//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200501
502/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800503 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
504 *
505 * Use only 128-bit keys in AES operations to save ROM.
506 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800507 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800508 * or 256-bit keys.
509 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800510 * Uncommenting this macro reduces the size of AES code by ~300 bytes
511 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800512 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800513 * Module: library/aes.c
514 *
515 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800516 */
517//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
518
Gilles Peskinea8861e02023-09-05 20:20:51 +0200519/*
520 * Disable plain C implementation for AES.
521 *
522 * When the plain C implementation is enabled, and an implementation using a
523 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
524 * detection will be used to select between them.
525 *
526 * If only one implementation is present, runtime detection will not be used.
527 * This configuration will crash at runtime if running on a CPU without the
528 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
529 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
530 */
531//#define MBEDTLS_AES_USE_HARDWARE_ONLY
532
Arto Kinnunen732ca322023-04-14 14:26:10 +0800533/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200534 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200535 *
536 * Use less ROM for the Camellia implementation (saves about 768 bytes).
537 *
538 * Uncomment this macro to use less memory for Camellia.
539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200541
542/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200543 * \def MBEDTLS_CHECK_RETURN_WARNING
544 *
545 * If this macro is defined, emit a compile-time warning if application code
546 * calls a function without checking its return value, but the return value
547 * should generally be checked in portable applications.
548 *
549 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
550 * implemented. Otherwise this option has no effect.
551 *
552 * Uncomment to get warnings on using fallible functions without checking
553 * their return value.
554 *
555 * \note This feature is a work in progress.
556 * Warnings will be added to more functions in the future.
557 *
558 * \note A few functions are considered critical, and ignoring the return
559 * value of these functions will trigger a warning even if this
560 * macro is not defined. To completely disable return value check
561 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
562 */
563//#define MBEDTLS_CHECK_RETURN_WARNING
564
565/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200566 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200567 *
568 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200571
572/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200573 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000574 *
575 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200577#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000578
579/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200580 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000581 *
582 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200584#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000585
586/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100587 * \def MBEDTLS_CIPHER_MODE_OFB
588 *
589 * Enable Output Feedback mode (OFB) for symmetric ciphers.
590 */
591#define MBEDTLS_CIPHER_MODE_OFB
592
593/**
594 * \def MBEDTLS_CIPHER_MODE_XTS
595 *
596 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
597 */
598#define MBEDTLS_CIPHER_MODE_XTS
599
600/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200601 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000602 *
603 * Enable NULL cipher.
604 * Warning: Only do so when you know what you are doing. This allows for
605 * encryption or channels without any security!
606 *
Ronald Croncee42702021-04-26 11:34:44 +0200607 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200608 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
609 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
610 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
611 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
612 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
613 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
614 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
615 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
616 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
617 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
618 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
619 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
620 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
621 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
622 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
623 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
624 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
625 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
626 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000627 *
628 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000629 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200630//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000631
632/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100633 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200634 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100635 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
636 * specific padding modes in the cipher layer with cipher modes that support
637 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200638 *
639 * If you disable all padding modes, only full blocks can be used with CBC.
640 *
641 * Enable padding modes in the cipher layer.
642 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200643#define MBEDTLS_CIPHER_PADDING_PKCS7
644#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
645#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
646#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200647
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200648/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
649 *
650 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800651 * Without this, CTR_DRBG uses a 256-bit key
652 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200653 */
654//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
655
Paul Bakker48e93c82013-08-14 12:21:18 +0200656/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200657 * Enable the verified implementations of ECDH primitives from Project Everest
658 * (currently only Curve25519). This feature changes the layout of ECDH
659 * contexts and therefore is a compatibility break for applications that access
660 * fields of a mbedtls_ecdh_context structure directly. See also
661 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000662 *
663 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
664 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200665 */
666//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
667
668/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100669 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200670 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100671 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
672 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200673 *
674 * Comment macros to disable the curve and functions for it
675 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200676/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
678#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
679#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
680#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
681#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
682#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
683#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
684#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
685#define MBEDTLS_ECP_DP_BP256R1_ENABLED
686#define MBEDTLS_ECP_DP_BP384R1_ENABLED
687#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200688/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200689#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000690#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200691
692/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200694 *
695 * Enable specific 'modulo p' routines for each NIST prime.
696 * Depending on the prime and architecture, makes operations 4 to 8 times
697 * faster on the corresponding curve.
698 *
699 * Comment this macro to disable NIST curves optimisation.
700 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200702
703/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200704 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100705 *
706 * Enable "non-blocking" ECC operations that can return early and be resumed.
707 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200708 * This allows various functions to pause by returning
709 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
710 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
711 * order to further progress and eventually complete their operation. This is
712 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
713 * number of ECC operations a function may perform before pausing; see
714 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100715 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200716 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200717 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100718 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100719 * This option:
720 * - Adds xxx_restartable() variants of existing operations in the
721 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100722 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
723 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100724 * - ECDSA: signature generation & verification;
725 * - PK: signature generation & verification;
726 * - X509: certificate chain verification.
727 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
728 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
729 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
730 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000731 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100732 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100733 * - verification of the server's key exchange signature;
734 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100735 * - generation of the client's signature if client authentication is used,
736 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100737 *
738 * \note In the cases above, the usual SSL/TLS functions, such as
739 * mbedtls_ssl_handshake(), can now return
740 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200741 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100742 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
743 * restartable operations in PK, X.509 and TLS (see above) are not
744 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100745 * PSA, and are not restartable. These are temporary limitations that
746 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200747 *
Ron Eldor19779c42018-11-05 16:58:13 +0200748 * \note This option only works with the default software implementation of
749 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100750 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100751 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100752 * Requires: MBEDTLS_ECP_C
753 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100754 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100755 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200756//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100757
758/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200759 * Uncomment to enable using new bignum code in the ECC modules.
760 *
761 * \warning This is currently experimental, incomplete and therefore should not
762 * be used in production.
763 */
764//#define MBEDTLS_ECP_WITH_MPI_UINT
765
766/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100768 *
769 * Enable deterministic ECDSA (RFC 6979).
770 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
771 * may result in a compromise of the long-term signing key. This is avoided by
772 * the deterministic variant.
773 *
John Durkop36a82e52020-10-26 09:39:05 -0700774 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100775 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100776 * Comment this macro to disable deterministic ECDSA.
777 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200778#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100779
780/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200782 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200783 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200784 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200785 * This enables the following ciphersuites (if other requisites are
786 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
788 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
789 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
790 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
791 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
792 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
793 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
794 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
795 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
796 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200799
800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200801 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200802 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200803 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200804 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200806 *
807 * This enables the following ciphersuites (if other requisites are
808 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
810 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
811 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
812 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
813 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
814 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
815 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
816 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
817 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
818 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100819 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100820 * \warning Using DHE constitutes a security risk as it
821 * is not possible to validate custom DH parameters.
822 * If possible, it is recommended users should consider
823 * preferring other methods of key exchange.
824 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100825 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200826 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200827#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200828
829/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200830 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200831 *
832 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
833 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200834 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200835 *
836 * This enables the following ciphersuites (if other requisites are
837 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
839 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
840 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
841 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
842 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
843 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200844 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200846
847/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200848 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200849 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200850 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200851 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200852 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
853 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200854 *
855 * This enables the following ciphersuites (if other requisites are
856 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200857 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
858 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
859 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
860 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
861 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
862 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
863 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
864 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
865 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
866 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200867 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200869
870/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200872 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200873 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200874 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
876 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200877 *
878 * This enables the following ciphersuites (if other requisites are
879 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200880 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
881 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
882 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
883 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
884 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
885 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
886 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
887 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
888 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
889 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
890 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
891 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200892 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200893#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200894
895/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200897 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200898 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200899 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200900 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
901 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200902 *
903 * This enables the following ciphersuites (if other requisites are
904 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
906 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
907 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
908 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
909 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
910 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
911 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
912 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
913 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
914 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
915 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
916 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100917 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100918 * \warning Using DHE constitutes a security risk as it
919 * is not possible to validate custom DH parameters.
920 * If possible, it is recommended users should consider
921 * preferring other methods of key exchange.
922 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100923 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200924 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200926
927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200929 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200930 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200931 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200932 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
933 * MBEDTLS_RSA_C
934 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200936 *
937 * This enables the following ciphersuites (if other requisites are
938 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
940 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
941 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
942 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
943 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
944 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
945 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
946 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
947 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
948 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200949 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200951
952/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200953 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200954 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200955 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200956 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200957 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
958 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
959 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200960 *
961 * This enables the following ciphersuites (if other requisites are
962 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200963 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
964 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
965 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
966 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
967 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
968 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
969 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
970 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
971 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
972 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200973 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200975
976/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200977 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100978 *
979 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
980 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200981 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
982 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
983 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100984 *
985 * This enables the following ciphersuites (if other requisites are
986 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
988 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
989 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
990 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
991 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
992 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
993 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
994 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
995 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
996 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100999
1000/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001002 *
1003 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1004 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001005 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1006 * MBEDTLS_RSA_C
1007 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001008 *
1009 * This enables the following ciphersuites (if other requisites are
1010 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1012 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1013 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1014 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1015 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1016 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1017 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1018 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1019 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1020 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001022#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001023
1024/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001025 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1026 *
1027 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1028 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001029 * \warning This is currently experimental. EC J-PAKE support is based on the
1030 * Thread v1.0.0 specification; incompatible changes to the specification
1031 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001032 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001033 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001034 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001035 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1036 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001037 * \warning If SHA-256 is provided only by a PSA driver, you must call
1038 * psa_crypto_init() before the first hanshake (even if
1039 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1040 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001041 * This enables the following ciphersuites (if other requisites are
1042 * enabled as well):
1043 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1044 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001045//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001046
1047/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001049 *
1050 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1051 * RFC 5915 and RFC 5480.
1052 *
1053 * Currently this means parsing the SpecifiedECDomain choice of EC
1054 * parameters (only known groups are supported, not arbitrary domains, to
1055 * avoid validation issues).
1056 *
1057 * Disable if you only need to support RFC 5915 + 5480 key formats.
1058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001060
1061/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001062 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1063 *
1064 * Enable the support for parsing public keys of type Short Weierstrass
1065 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001066 * compressed point format. This parsing is done through ECP module's functions.
1067 *
1068 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1069 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1070 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001071 */
1072#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1073
1074/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001076 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077 * Enable a dummy error function to make use of mbedtls_strerror() in
1078 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1079 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001080 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001081 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1082 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001083 *
1084 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001086 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001087#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001088
1089/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001091 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001092 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001093 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001095 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001097
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001098/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001099 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001100 *
1101 * Enable functions that use the filesystem.
1102 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001104
1105/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001107 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001108 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001109 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001110 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001111 * application.
1112 *
1113 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001114 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001116
1117/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001118 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001119 *
1120 * Do not use built-in platform entropy functions.
1121 * This is useful if your platform does not support
1122 * standards like the /dev/urandom or Windows CryptoAPI.
1123 *
1124 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001127
1128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001130 *
1131 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1132 * default SHA-512 based one (if both are available).
1133 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001135 *
1136 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1137 * if you have performance concerns.
1138 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139 * This option is only useful if both MBEDTLS_SHA256_C and
1140 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001142//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001143
1144/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001145 * \def MBEDTLS_ENTROPY_NV_SEED
1146 *
1147 * Enable the non-volatile (NV) seed file-based entropy source.
1148 * (Also enables the NV seed read/write functions in the platform layer)
1149 *
1150 * This is crucial (if not required) on systems that do not have a
1151 * cryptographic entropy source (in hardware or kernel) available.
1152 *
1153 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1154 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001155 * \note The read/write functions that are used by the entropy source are
1156 * determined in the platform layer, and can be modified at runtime and/or
1157 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1158 *
1159 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001160 * with regular fopen(), please make sure you make a seedfile with the
1161 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1162 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001163 * and written to or you will get an entropy source error! The default
1164 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1165 * bytes from the file.
1166 *
1167 * \note The entropy collector will write to the seed file before entropy is
1168 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001169 */
1170//#define MBEDTLS_ENTROPY_NV_SEED
1171
Ronald Cron71016a92020-08-28 19:01:50 +02001172/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001173 *
Ronald Cron71016a92020-08-28 19:01:50 +02001174 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001175 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001176 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1177 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001178 *
1179 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001180 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001181 */
Ronald Cron71016a92020-08-28 19:01:50 +02001182//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001183
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001186 *
1187 * Enable debugging of buffer allocator memory issues. Automatically prints
1188 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1189 * function for 'debug output' of allocated memory.
1190 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001192 *
1193 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001194 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001196
1197/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001199 *
1200 * Include backtrace information with each allocated block.
1201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001203 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001204 *
1205 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001208
1209/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001210 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001211 *
1212 * Support external private RSA keys (eg from a HSM) in the PK layer.
1213 *
1214 * Comment this macro to disable support for external private RSA keys.
1215 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001216#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001217
1218/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001220 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001221 * Enable support for PKCS#1 v1.5 encoding.
1222 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001223 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001224 *
Paul Bakker48377d92013-08-30 12:06:24 +02001225 * This enables support for PKCS#1 v1.5 operations.
1226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001227#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001228
1229/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001230 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001231 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001232 * Enable support for PKCS#1 v2.1 encoding.
1233 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001234 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001235 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001236 * \warning If using a hash that is only provided by PSA drivers, you must
1237 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001238 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001239 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1240 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001241#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001242
Steven Cooreman6801f082021-02-19 17:21:22 +01001243/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1244 *
1245 * Enable support for platform built-in keys. If you enable this feature,
1246 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1247 * See the documentation of that function for more information.
1248 *
1249 * Built-in keys are typically derived from a hardware unique key or
1250 * stored in a secure element.
1251 *
1252 * Requires: MBEDTLS_PSA_CRYPTO_C.
1253 *
1254 * \warning This interface is experimental and may change or be removed
1255 * without notice.
1256 */
1257//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1258
Ronald Cron3768ac12021-01-26 16:58:00 +01001259/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1260 *
1261 * Enable support for PSA crypto client.
1262 *
1263 * \note This option allows to include the code necessary for a PSA
1264 * crypto client when the PSA crypto implementation is not included in
1265 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1266 * code to set and get PSA key attributes.
1267 * The development of PSA drivers partially relying on the library to
1268 * fulfill the hardware gaps is another possible usage of this option.
1269 *
1270 * \warning This interface is experimental and may change or be removed
1271 * without notice.
1272 */
1273//#define MBEDTLS_PSA_CRYPTO_CLIENT
1274
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001275/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1276 *
1277 * Make the PSA Crypto module use an external random generator provided
1278 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1279 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001280 * \note This random generator must deliver random numbers with cryptographic
1281 * quality and high performance. It must supply unpredictable numbers
1282 * with a uniform distribution. The implementation of this function
1283 * is responsible for ensuring that the random generator is seeded
1284 * with sufficient entropy. If you have a hardware TRNG which is slow
1285 * or delivers non-uniform output, declare it as an entropy source
1286 * with mbedtls_entropy_add_source() instead of enabling this option.
1287 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001288 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001289 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1290 * and define a function called mbedtls_psa_external_get_random()
1291 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001292 * ```
1293 * psa_status_t mbedtls_psa_external_get_random(
1294 * mbedtls_psa_external_random_context_t *context,
1295 * uint8_t *output, size_t output_size, size_t *output_length);
1296 * );
1297 * ```
1298 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001299 * The function must fill the \c output buffer with \c output_size bytes
1300 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001301 *
1302 * Requires: MBEDTLS_PSA_CRYPTO_C
1303 *
1304 * \warning If you enable this option, code that uses the PSA cryptography
1305 * interface will not use any of the entropy sources set up for
1306 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1307 * enables.
1308 *
1309 * \note This option is experimental and may be removed without notice.
1310 */
1311//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1312
Paul Bakker9dcc3222011-03-08 14:16:06 +00001313/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001314 * \def MBEDTLS_PSA_CRYPTO_SPM
1315 *
1316 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1317 * Partition Manager) integration which separates the code into two parts: a
1318 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1319 * Environment).
1320 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001321 * If you enable this option, your build environment must include a header
1322 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1323 * header files, or in another directory on the compiler's include search
1324 * path). Alternatively, your platform may customize the header
1325 * `psa/crypto_platform.h`, in which case it can skip or replace the
1326 * inclusion of `"crypto_spe.h"`.
1327 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001328 * Module: library/psa_crypto.c
1329 * Requires: MBEDTLS_PSA_CRYPTO_C
1330 *
1331 */
1332//#define MBEDTLS_PSA_CRYPTO_SPM
1333
1334/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001335 * Uncomment to enable p256-m. This is an alternative implementation of
1336 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1337 * Compared to the default implementation:
1338 *
1339 * - p256-m has a much smaller code size and RAM footprint.
1340 * - p256-m is only available via the PSA API. This includes the pk module
1341 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1342 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1343 * over the core arithmetic, or deterministic derivation of keys.
1344 *
1345 * We recommend enabling this option if your application uses the PSA API
1346 * and the only elliptic curve support it needs is ECDH and ECDSA over
1347 * SECP256R1.
1348 *
1349 * If you enable this option, you do not need to enable any ECC-related
1350 * MBEDTLS_xxx option. You do need to separately request support for the
1351 * cryptographic mechanisms through the PSA API:
1352 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1353 * configuration;
1354 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1355 * - #PSA_WANT_ECC_SECP_R1_256;
1356 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1357 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1358 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1359 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1360 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001361 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001362 * \note To benefit from the smaller code size of p256-m, make sure that you
1363 * do not enable any ECC-related option not supported by p256-m: this
1364 * would cause the built-in ECC implementation to be built as well, in
1365 * order to provide the required option.
1366 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001367 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1368 * SECP256R1 are disabled as they are not supported by this driver.
1369 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1370 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001371 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001372 */
1373//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1374
1375/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001376 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001377 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001378 * Enable support for entropy injection at first boot. This feature is
1379 * required on systems that do not have a built-in entropy source (TRNG).
1380 * This feature is currently not supported on systems that have a built-in
1381 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001382 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001383 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001384 *
1385 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001386//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001387
1388/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001389 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001390 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001391 * Assume all buffers passed to PSA functions are owned exclusively by the
1392 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001393 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001394 * This option may be enabled if all buffers passed to any PSA function reside
1395 * in memory that is accessible only to the PSA function during its execution.
1396 *
1397 * This option MUST be disabled whenever buffer arguments are in memory shared
1398 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001399 * across a trust boundary.
1400 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001401 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001402 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001403 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001404 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001405 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001406//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001407
1408/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001409 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001410 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001411 * Do not use the Chinese Remainder Theorem
1412 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001413 *
1414 * Uncomment this macro to disable the use of CRT in RSA.
1415 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001416 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001417//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001418
1419/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001421 *
1422 * Enable the checkup functions (*_self_test).
1423 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001424#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001425
1426/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001427 * \def MBEDTLS_SHA256_SMALLER
1428 *
1429 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1430 * lower performance.
1431 *
Adam Wolf039080f2019-09-10 09:53:08 -05001432 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001433 * performance and size. This version optimizes more aggressively for size at
1434 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1435 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1436 * 30%.
1437 *
1438 * Uncomment to enable the smaller implementation of SHA256.
1439 */
1440//#define MBEDTLS_SHA256_SMALLER
1441
1442/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001443 * \def MBEDTLS_SHA512_SMALLER
1444 *
1445 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1446 * lower performance.
1447 *
1448 * Uncomment to enable the smaller implementation of SHA512.
1449 */
1450//#define MBEDTLS_SHA512_SMALLER
1451
1452/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001453 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001454 *
1455 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001456 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001457 * with other servers, only debugging of failures is harder.
1458 *
1459 * The advantage of not sending alert messages, is that no information is given
1460 * about reasons for failures thus preventing adversaries of gaining intel.
1461 *
1462 * Enable sending of all alert messages
1463 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001464#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001465
1466/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001467 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1468 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001469 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001470 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001471 * in the underlying transport. The CID functionality is described
1472 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001473 *
1474 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001475 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1476 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1477 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001478 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001479 * The maximum lengths of outgoing and incoming CIDs can be configured
1480 * through the options
1481 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1482 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1483 *
1484 * Requires: MBEDTLS_SSL_PROTO_DTLS
1485 *
1486 * Uncomment to enable the Connection ID extension.
1487 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001488#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1489
1490
1491/**
1492 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1493 *
1494 * Defines whether RFC 9146 (default) or the legacy version
1495 * (version draft-ietf-tls-dtls-connection-id-05,
1496 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1497 * is used.
1498 *
1499 * Set the value to 0 for the standard version, and
1500 * 1 for the legacy draft version.
1501 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001502 * \deprecated Support for the legacy version of the DTLS
1503 * Connection ID feature is deprecated. Please
1504 * switch to the standardized version defined
1505 * in RFC 9146 enabled by utilizing
1506 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1507 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1508 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001509 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1510 */
1511#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001512
1513/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001514 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1515 *
1516 * Enable asynchronous external private key operations in SSL. This allows
1517 * you to configure an SSL connection to call an external cryptographic
1518 * module to perform private key operations instead of performing the
1519 * operation inside the library.
1520 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001521 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001522 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001523//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001524
1525/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001526 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1527 *
1528 * Enable serialization of the TLS context structures, through use of the
1529 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1530 *
1531 * This pair of functions allows one side of a connection to serialize the
1532 * context associated with the connection, then free or re-use that context
1533 * while the serialized state is persisted elsewhere, and finally deserialize
1534 * that state to a live context for resuming read/write operations on the
1535 * connection. From a protocol perspective, the state of the connection is
1536 * unaffected, in particular this is entirely transparent to the peer.
1537 *
1538 * Note: this is distinct from TLS session resumption, which is part of the
1539 * protocol and fully visible by the peer. TLS session resumption enables
1540 * establishing new connections associated to a saved session with shorter,
1541 * lighter handshakes, while context serialization is a local optimization in
1542 * handling a single, potentially long-lived connection.
1543 *
1544 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1545 * saved after the handshake to allow for more efficient serialization, so if
1546 * you don't need this feature you'll save RAM by disabling it.
1547 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001548 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1549 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001550 * Comment to disable the context serialization APIs.
1551 */
1552#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1553
1554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001556 *
1557 * Enable the debug messages in SSL module for all issues.
1558 * Debug messages have been disabled in some places to prevent timing
1559 * attacks due to (unbalanced) debugging function calls.
1560 *
1561 * If you need all error reporting you should enable this during debugging,
1562 * but remove this for production servers that should log as well.
1563 *
1564 * Uncomment this macro to report all debug messages on errors introducing
1565 * a timing side-channel.
1566 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001568//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001571 *
1572 * Enable support for Encrypt-then-MAC, RFC 7366.
1573 *
1574 * This allows peers that both support it to use a more robust protection for
1575 * ciphersuites using CBC, providing deep resistance against timing attacks
1576 * on the padding or underlying cipher.
1577 *
1578 * This only affects CBC ciphersuites, and is useless if none is defined.
1579 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001580 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001581 *
1582 * Comment this macro to disable support for Encrypt-then-MAC
1583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001584#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001585
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001586/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001587 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001588 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1589 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001590 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001591 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001592 * attacks, but it is recommended to always use it (even if you disable
1593 * renegotiation), since it actually fixes a more fundamental issue in the
1594 * original SSL/TLS design, and has implications beyond Triple Handshake.
1595 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001596 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001597 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001598 * Comment this macro to disable support for Extended Master Secret.
1599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001601
Paul Bakkerd66f0702013-01-31 16:57:45 +01001602/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001603 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1604 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001605 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001606 * giving access to the peer's certificate after completion of the handshake.
1607 *
1608 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1609 * recommended to disable this option for reduced RAM usage.
1610 *
1611 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1612 * defined, but always returns \c NULL.
1613 *
1614 * \note This option has no influence on the protection against the
1615 * triple handshake attack. Even if it is disabled, Mbed TLS will
1616 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001617 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001618 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001619 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001620 *
1621 * Comment this macro to disable storing the peer's certificate
1622 * after the handshake.
1623 */
1624#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1625
1626/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001627 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001628 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001629 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001630 *
1631 * The two main uses of renegotiation are (1) refresh keys on long-lived
1632 * connections and (2) client authentication after the initial handshake.
1633 * If you don't need renegotiation, it's probably better to disable it, since
1634 * it has been associated with security issues in the past and is easy to
1635 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001636 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001637 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1638 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001639 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001640 *
1641 * \note Even if this option is disabled, both client and server are aware
1642 * of the Renegotiation Indication Extension (RFC 5746) used to
1643 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1644 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1645 * configuration of this extension).
1646 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001647 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001649
1650/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001651 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001652 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001653 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001654 *
1655 * Comment this macro to disable support for the max_fragment_length extension
1656 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001657#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001658
1659/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001660 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1661 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001662 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001663 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001664 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1665 *
1666 * Uncomment this macro to enable support for the record_size_limit extension
1667 */
1668//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1669
1670/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001671 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001672 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001673 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001674 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001675 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001676 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1677 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001678 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001679 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001680 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001681 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1682 * are only provided by PSA drivers, you must call psa_crypto_init() before
1683 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001684 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001685 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001688
1689/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001690 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001691 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001692 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001693 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001694 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001695 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001696 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001697 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001698 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001699 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001700 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1701 * directly performed by TLS 1.3 code. As a consequence, you must
1702 * call psa_crypto_init() before the first TLS 1.3 handshake.
1703 *
1704 * \note Cryptographic operations performed indirectly via another module
1705 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1706 * running handshake hash) only use PSA crypto if
1707 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001708 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001709 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001710 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001711#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001712
1713/**
Ronald Cronab65c522021-11-24 10:47:20 +01001714 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1715 *
1716 * Enable TLS 1.3 middlebox compatibility mode.
1717 *
1718 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1719 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1720 * expecting TLS 1.2 traffic.
1721 *
1722 * Turning on the compatibility mode comes at the cost of a few added bytes
1723 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1724 * that don't use it. Therefore, unless transmission bandwidth is critical and
1725 * you know that middlebox compatibility issues won't occur, it is therefore
1726 * recommended to set this option.
1727 *
1728 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001729 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1730 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001731 *
1732 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001733#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001734
1735/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001736 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1737 *
1738 * Enable TLS 1.3 PSK key exchange mode.
1739 *
1740 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1741 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1742 * effect on the build.
1743 *
1744 */
1745#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1746
1747/**
1748 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1749 *
1750 * Enable TLS 1.3 ephemeral key exchange mode.
1751 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001752 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001753 * MBEDTLS_X509_CRT_PARSE_C
1754 * and at least one of:
1755 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1756 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001757 *
1758 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1759 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1760 * effect on the build.
1761 *
1762 */
1763#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1764
1765/**
1766 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1767 *
1768 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1769 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001770 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001771 *
1772 * Comment to disable support for the PSK ephemeral key exchange mode in
1773 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1774 * have any effect on the build.
1775 *
1776 */
1777#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1778
1779/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 * \def MBEDTLS_SSL_EARLY_DATA
1781 *
1782 * Enable support for RFC 8446 TLS 1.3 early data.
1783 *
1784 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1785 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1786 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1787 *
1788 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1789 * is not enabled, this option does not have any effect on the build.
1790 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001791 * \note The maximum amount of early data can be set with
1792 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1793 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001795//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001796
1797/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001798 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001799 *
1800 * Enable support for DTLS (all available versions).
1801 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001802 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001803 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001804 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001805 *
1806 * Comment this macro to disable support for DTLS
1807 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001808#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001809
1810/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001812 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001813 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001814 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001815 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001816 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001818
1819/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001820 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001821 *
1822 * Enable support for the anti-replay mechanism in DTLS.
1823 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824 * Requires: MBEDTLS_SSL_TLS_C
1825 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001826 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001827 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001828 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001829 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001830 * Comment this to disable anti-replay in DTLS.
1831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001832#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001833
1834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001835 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001836 *
1837 * Enable support for HelloVerifyRequest on DTLS servers.
1838 *
1839 * This feature is highly recommended to prevent DTLS servers being used as
1840 * amplifiers in DoS attacks against other hosts. It should always be enabled
1841 * unless you know for sure amplification cannot be a problem in the
1842 * environment in which your server operates.
1843 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001844 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001845 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001846 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001847 *
1848 * Comment this to disable support for HelloVerifyRequest.
1849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001850#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001851
1852/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001853 * \def MBEDTLS_SSL_DTLS_SRTP
1854 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001855 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001856 * through the use_srtp extension.
1857 *
1858 * \note This feature provides the minimum functionality required
1859 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1860 * the associated SRTP packet protection key material.
1861 * In particular, the SRTP packet protection itself, as well as the
1862 * demultiplexing of RTP and DTLS packets at the datagram layer
1863 * (see Section 5 of RFC 5764), are not handled by this feature.
1864 * Instead, after successful completion of a handshake negotiating
1865 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001866 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001867 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1868 * (this is implemented in the SSL example programs).
1869 * The resulting key should then be passed to an SRTP stack.
1870 *
1871 * Setting this option enables the runtime API
1872 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1873 * through which the supported DTLS-SRTP protection
1874 * profiles can be configured. You must call this API at
1875 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001876 *
1877 * Requires: MBEDTLS_SSL_PROTO_DTLS
1878 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001879 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001880 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001881//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001882
1883/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001884 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1885 *
1886 * Enable server-side support for clients that reconnect from the same port.
1887 *
1888 * Some clients unexpectedly close the connection and try to reconnect using the
1889 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001890 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001891 * flag enables that support.
1892 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001893 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001894 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001895 * Comment this to disable support for clients reusing the source port.
1896 */
1897#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1898
1899/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001900 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001901 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001902 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001903 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001904 * session store remains the responsibility of the application, though).
1905 * Server-side, you also need to provide callbacks for writing and parsing
1906 * tickets, including authenticated encryption and key management. Example
1907 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001908 *
1909 * Comment this macro to disable support for SSL session tickets
1910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001912
1913/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001915 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001916 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001917 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001918 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001919 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001920 * Comment this macro to disable support for server name indication in SSL
1921 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001922#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001923
1924/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001925 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1926 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001927 * When this option is enabled, the SSL buffer will be resized automatically
1928 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001929 *
1930 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001931 */
1932//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1933
1934/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001935 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1936 *
1937 * Enable testing of the constant-flow nature of some sensitive functions with
1938 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001939 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001940 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001941 * This setting requires compiling with clang -fsanitize=memory. The test
1942 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001943 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001944 * \warning This macro is only used for extended testing; it is not considered
1945 * part of the library's API, so it may change or disappear at any time.
1946 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001947 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001948 */
1949//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1950
1951/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001952 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1953 *
1954 * Enable testing of the constant-flow nature of some sensitive functions with
1955 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001956 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001957 *
1958 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001959 * testing if the tests suites are run with valgrind's memcheck. This can be
1960 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1961 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001962 *
1963 * \warning This macro is only used for extended testing; it is not considered
1964 * part of the library's API, so it may change or disappear at any time.
1965 *
1966 * Uncomment to enable testing of the constant-flow nature of selected code.
1967 */
1968//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1969
1970/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001971 * \def MBEDTLS_TEST_HOOKS
1972 *
1973 * Enable features for invasive testing such as introspection functions and
1974 * hooks for fault injection. This enables additional unit tests.
1975 *
1976 * Merely enabling this feature should not change the behavior of the product.
1977 * It only adds new code, and new branching points where the default behavior
1978 * is the same as when this feature is disabled.
1979 * However, this feature increases the attack surface: there is an added
1980 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1981 * Therefore this feature must never be enabled in production.
1982 *
1983 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1984 * information.
1985 *
1986 * Uncomment to enable invasive tests.
1987 */
1988//#define MBEDTLS_TEST_HOOKS
1989
1990/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001992 *
1993 * Provide your own alternate threading implementation.
1994 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001995 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001996 *
1997 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001998 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001999//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002000
2001/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002003 *
2004 * Enable the pthread wrapper layer for the threading layer.
2005 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002006 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002007 *
2008 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002010//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002011
2012/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002013 * \def MBEDTLS_USE_PSA_CRYPTO
2014 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002015 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
2016 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002017 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002018 * \note Development of this option is currently in progress, and parts of Mbed
2019 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002020 * will still continue to work as usual, so enabling this option should not
2021 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002022 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02002023 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02002024 * before calling any function from the SSL/TLS, X.509 or PK modules, except
2025 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00002026 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002027 * \note An important and desirable effect of this option is that it allows
2028 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2029 * 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 +02002030 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002031 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2032 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002033 *
2034 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002035 *
2036 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002037 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002038 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002040//#define MBEDTLS_USE_PSA_CRYPTO
2041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002042/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002043 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2044 *
John Durkop185764f2020-10-12 21:32:12 -07002045 * This setting allows support for cryptographic mechanisms through the PSA
2046 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002047 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002048 * When this option is disabled, the PSA API exposes the cryptographic
2049 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2050 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002051 *
2052 * When this option is enabled, the PSA API exposes the cryptographic
2053 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2054 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2055 * automatically enabled if required (i.e. if no PSA driver provides the
2056 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2057 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002058 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002059 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002060 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002061 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002062 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2063 * symbols is not completely finalized yet, and the configuration
2064 * tooling is not ideally adapted to having two separate configuration
2065 * files.
2066 * Future minor releases of Mbed TLS may make minor changes to those
2067 * symbols, but we will endeavor to provide a transition path.
2068 * Nonetheless, this option is considered mature enough to use in
2069 * production, as long as you accept that you may need to make
2070 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002071 */
2072//#define MBEDTLS_PSA_CRYPTO_CONFIG
2073
2074/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002075 * \def MBEDTLS_VERSION_FEATURES
2076 *
2077 * Allow run-time checking of compile-time enabled features. Thus allowing users
2078 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002079 * support via mbedtls_version_check_feature().
2080 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002081 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002082 *
2083 * Comment this to disable run-time checking and save ROM space
2084 */
2085#define MBEDTLS_VERSION_FEATURES
2086
2087/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002088 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2089 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002090 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002091 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2092 * the set of trusted certificates through a callback instead of a linked
2093 * list.
2094 *
2095 * This is useful for example in environments where a large number of trusted
2096 * certificates is present and storing them in a linked list isn't efficient
2097 * enough, or when the set of trusted certificates changes frequently.
2098 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002099 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002100 * `mbedtls_ssl_conf_ca_cb()` for more information.
2101 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002102 * Requires: MBEDTLS_X509_CRT_PARSE_C
2103 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002104 * Uncomment to enable trusted certificate callbacks.
2105 */
2106//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2107
2108/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002109 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002110 *
Chris Jones2c745862020-12-16 11:41:06 +00002111 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002112 *
Chris Jones2c745862020-12-16 11:41:06 +00002113 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002114 * and other functions/constants only used by these functions, thus reducing
2115 * the code footprint by several KB.
2116 */
Chris Jones2c745862020-12-16 11:41:06 +00002117//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002118
2119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002121 *
2122 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2123 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2124 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002125 * Requires: MBEDTLS_PKCS1_V21
2126 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002127 * Comment this macro to disallow using RSASSA-PSS in certificates.
2128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002129#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002130/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002131
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002132/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002133 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002134 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002135 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002136 * \{
2137 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002138
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002141 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002142 * Enable AES-NI support on x86-64 or x86-32.
2143 *
2144 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002145 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002146 * - GCC, x86-64, target not explicitly supporting AESNI:
2147 * requires MBEDTLS_HAVE_ASM.
2148 * - GCC, x86-32, target not explicitly supporting AESNI:
2149 * not supported.
2150 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2151 * For this assembly-less implementation, you must currently compile
2152 * `library/aesni.c` and `library/aes.c` with machine options to enable
2153 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2154 * `clang -maes -mpclmul`.
2155 * - Non-x86 targets: this option is silently ignored.
2156 * - Other compilers: this option is silently ignored.
2157 *
2158 * \note
2159 * Above, "GCC" includes compatible compilers such as Clang.
2160 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002161 *
2162 * Module: library/aesni.c
2163 * Caller: library/aes.c
2164 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002165 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002166 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002167 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002168 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002169#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002170
2171/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002172 * \def MBEDTLS_AESCE_C
2173 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002174 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002175 *
2176 * Module: library/aesce.c
2177 * Caller: library/aes.c
2178 *
Jerry Yuf015a932023-04-25 10:38:03 +08002179 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002180 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002181 * \warning Runtime detection only works on Linux. For non-Linux operating
2182 * system, Armv8-A Cryptographic Extensions must be supported by
2183 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002184 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002185 * \note Minimum compiler versions for this feature when targeting aarch64
2186 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2187 * Minimum compiler versions for this feature when targeting 32-bit
2188 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002189 *
2190 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2191 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002192 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002193 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002194 */
2195#define MBEDTLS_AESCE_C
2196
2197/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002198 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002199 *
2200 * Enable the AES block cipher.
2201 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002202 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002203 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002204 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002205 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002206 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002207 * This module enables the following ciphersuites (if other requisites are
2208 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002209 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2210 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2211 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2212 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2213 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2214 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2215 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2216 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2217 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2218 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2219 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2220 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2221 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2222 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2223 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2224 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2225 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2226 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2227 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2228 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2229 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2230 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2231 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2232 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2233 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2234 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2235 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2236 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2237 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2238 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2239 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2240 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2241 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2242 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2243 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2244 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2245 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2246 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2247 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2248 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2249 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2250 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2251 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2252 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2253 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2254 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2255 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2256 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2257 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2258 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2259 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2260 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2261 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2262 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2263 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2264 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2265 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2266 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002267 *
Paul Bakkercff68422013-09-15 20:43:33 +02002268 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002269 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002271
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002272/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002274 *
2275 * Enable the generic ASN1 parser.
2276 *
2277 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002278 * Caller: library/x509.c
2279 * library/dhm.c
2280 * library/pkcs12.c
2281 * library/pkcs5.c
2282 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002283 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002284#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002285
2286/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002287 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002288 *
2289 * Enable the generic ASN1 writer.
2290 *
2291 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002292 * Caller: library/ecdsa.c
2293 * library/pkwrite.c
2294 * library/x509_create.c
2295 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002296 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002297 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002298#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002299
2300/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002301 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002302 *
2303 * Enable the Base64 module.
2304 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002305 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002306 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002307 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002308 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002311
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002312/**
Yanray Wange367e472023-10-31 17:23:04 +08002313 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2314 *
2315 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2316 *
2317 * \note This feature is incompatible with insecure block cipher,
2318 * MBEDTLS_DES_C, and cipher modes which always require decryption
2319 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002320 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2321 * this feature is incompatible with following supported PSA equivalence,
2322 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2323 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002324 *
2325 * Module: library/aes.c
2326 * library/aesce.c
2327 * library/aesni.c
2328 * library/aria.c
2329 * library/camellia.c
2330 * library/cipher.c
2331 */
2332//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2333
2334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002336 *
Paul Bakker9a736322012-11-14 12:39:52 +00002337 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002338 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002339 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002340 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002341 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002342 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002343 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002344 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002345 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002346 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002347 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002348 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002349 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002350 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002352#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002353
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002354/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002355 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002356 *
2357 * Enable the Camellia block cipher.
2358 *
Paul Bakker38119b12009-01-10 23:31:23 +00002359 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002360 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002361 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002362 * This module enables the following ciphersuites (if other requisites are
2363 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002364 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2365 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2366 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2367 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2368 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2369 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2370 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2371 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2372 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2373 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2374 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2375 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2376 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2377 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2378 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2379 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2380 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2381 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2382 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2383 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2384 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2385 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2386 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2387 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2388 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2389 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2390 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2391 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2392 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2393 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2394 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2395 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2396 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2397 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2398 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2399 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2400 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2401 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2402 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2403 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2404 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2405 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002407#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002408
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002409/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002410 * \def MBEDTLS_ARIA_C
2411 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002412 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002413 *
2414 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002415 * Caller: library/cipher.c
2416 *
2417 * This module enables the following ciphersuites (if other requisites are
2418 * enabled as well):
2419 *
2420 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2421 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2422 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2423 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2424 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2425 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2426 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2427 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2428 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2429 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2430 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2431 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2432 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2433 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2434 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2435 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2436 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2437 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2438 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2439 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2440 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2441 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2442 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2443 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2444 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2445 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2446 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2447 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2448 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2449 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2450 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2451 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2452 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2453 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2454 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2455 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2456 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2457 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002458 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002459#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002460
2461/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002462 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002463 *
2464 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2465 *
2466 * Module: library/ccm.c
2467 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002468 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2469 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002470 *
2471 * This module enables the AES-CCM ciphersuites, if other requisites are
2472 * enabled as well.
2473 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002474#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002475
2476/**
Daniel King34b822c2016-05-15 17:28:08 -03002477 * \def MBEDTLS_CHACHA20_C
2478 *
2479 * Enable the ChaCha20 stream cipher.
2480 *
2481 * Module: library/chacha20.c
2482 */
2483#define MBEDTLS_CHACHA20_C
2484
2485/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002486 * \def MBEDTLS_CHACHAPOLY_C
2487 *
2488 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2489 *
2490 * Module: library/chachapoly.c
2491 *
2492 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2493 */
2494#define MBEDTLS_CHACHAPOLY_C
2495
2496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002498 *
2499 * Enable the generic cipher layer.
2500 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002501 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002502 * Caller: library/ccm.c
2503 * library/cmac.c
2504 * library/gcm.c
2505 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002506 * library/pkcs12.c
2507 * library/pkcs5.c
2508 * library/psa_crypto_aead.c
2509 * library/psa_crypto_mac.c
2510 * library/ssl_ciphersuites.c
2511 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002512 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002513 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2514 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002515 *
2516 * Uncomment to enable generic cipher wrappers.
2517 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002518#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002519
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002520/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002521 * \def MBEDTLS_CMAC_C
2522 *
Simon Butcher327398a2016-10-05 14:09:11 +01002523 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2524 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002525 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002526 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2527 * implementation of the CMAC algorithm is provided by an alternate
2528 * implementation, that alternate implementation may opt to not support
2529 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2530 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002531 * Module: library/cmac.c
2532 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002533 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002534 *
2535 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002536#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002537
2538/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002540 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002541 * Enable the CTR_DRBG AES-based random generator.
2542 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002543 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002544 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002545 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2546 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2547 * is used.
2548 *
2549 * \warning When using PSA, the user should call `psa_crypto_init()` before
2550 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2551 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002552 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2553 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002554 * \note To achieve a 256-bit security strength with CTR_DRBG,
2555 * you must use AES-256 *and* use sufficient entropy.
2556 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002557 *
2558 * Module: library/ctr_drbg.c
2559 * Caller:
2560 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002561 * Requires: MBEDTLS_AES_C or
2562 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2563 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002564 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002565 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002568
2569/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002571 *
2572 * Enable the debug functions.
2573 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002574 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002575 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002576 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002577 * library/ssl_tls12_*.c
2578 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002579 *
2580 * This module provides debugging functions.
2581 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002582#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002583
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002584/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002586 *
2587 * Enable the DES block cipher.
2588 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002589 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002590 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002591 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002592 *
Paul Bakkercff68422013-09-15 20:43:33 +02002593 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002594 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002595 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002596 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002599
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002600/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002602 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002603 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002604 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002605 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002606 * Caller: library/ssl_tls.c
2607 * library/ssl*_client.c
2608 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002609 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002610 * This module is used by the following key exchanges:
2611 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002612 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002613 * \warning Using DHE constitutes a security risk as it
2614 * is not possible to validate custom DH parameters.
2615 * If possible, it is recommended users should consider
2616 * preferring other methods of key exchange.
2617 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002618 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002621
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002622/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002624 *
2625 * Enable the elliptic curve Diffie-Hellman library.
2626 *
2627 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002628 * Caller: library/psa_crypto.c
2629 * library/ssl_tls.c
2630 * library/ssl*_client.c
2631 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002632 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002633 * This module is used by the following key exchanges:
2634 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002635 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002636 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002637 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002638#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002639
2640/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002642 *
2643 * Enable the elliptic curve DSA library.
2644 *
2645 * Module: library/ecdsa.c
2646 * Caller:
2647 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002648 * This module is used by the following key exchanges:
2649 * ECDHE-ECDSA
2650 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002651 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2652 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2653 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002656
2657/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002658 * \def MBEDTLS_ECJPAKE_C
2659 *
2660 * Enable the elliptic curve J-PAKE library.
2661 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002662 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2663 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002664 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002665 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002666 * Module: library/ecjpake.c
2667 * Caller:
2668 *
2669 * This module is used by the following key exchanges:
2670 * ECJPAKE
2671 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002672 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002673 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002674 * \warning If using a hash that is only provided by PSA drivers, you must
2675 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002676 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002677#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002678
2679/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002681 *
2682 * Enable the elliptic curve over GF(p) library.
2683 *
2684 * Module: library/ecp.c
2685 * Caller: library/ecdh.c
2686 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002687 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002688 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002690 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002692
2693/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002695 *
2696 * Enable the platform-specific entropy code.
2697 *
2698 * Module: library/entropy.c
2699 * Caller:
2700 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002701 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002702 *
2703 * This module provides a generic entropy pool
2704 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002706
2707/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002709 *
2710 * Enable error code to error string conversion.
2711 *
2712 * Module: library/error.c
2713 * Caller:
2714 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002715 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002716 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002717#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002718
2719/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002720 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002721 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002722 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002723 *
2724 * Module: library/gcm.c
2725 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002726 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2727 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002728 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002729 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2730 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002731 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002733
2734/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002735 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002736 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002737 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002738 * Can significantly increase throughput on systems without GCM hardware
2739 * acceleration (e.g., AESNI, AESCE).
2740 *
Matthias Schulz78266782024-02-08 13:54:48 +01002741 * The mbedtls_gcm_context size will increase by 3840 bytes.
2742 * The code size will increase by roughly 344 bytes.
2743 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002744 * Module: library/gcm.c
2745 *
2746 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002747 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002748//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002749
2750/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002751 * \def MBEDTLS_HKDF_C
2752 *
2753 * Enable the HKDF algorithm (RFC 5869).
2754 *
2755 * Module: library/hkdf.c
2756 * Caller:
2757 *
2758 * Requires: MBEDTLS_MD_C
2759 *
2760 * This module adds support for the Hashed Message Authentication Code
2761 * (HMAC)-based key derivation function (HKDF).
2762 */
2763#define MBEDTLS_HKDF_C
2764
2765/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002766 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002767 *
2768 * Enable the HMAC_DRBG random generator.
2769 *
2770 * Module: library/hmac_drbg.c
2771 * Caller:
2772 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002774 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002775 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002778
2779/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002780 * \def MBEDTLS_LMS_C
2781 *
2782 * Enable the LMS stateful-hash asymmetric signature algorithm.
2783 *
2784 * Module: library/lms.c
2785 * Caller:
2786 *
Raef Colesab4f8742022-09-01 12:24:31 +01002787 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002788 *
Raef Colesab4f8742022-09-01 12:24:31 +01002789 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002790 */
2791#define MBEDTLS_LMS_C
2792
2793/**
Raef Colesab4f8742022-09-01 12:24:31 +01002794 * \def MBEDTLS_LMS_PRIVATE
2795 *
2796 * Enable LMS private-key operations and signing code. Functions enabled by this
2797 * option are experimental, and should not be used in production.
2798 *
2799 * Requires: MBEDTLS_LMS_C
2800 *
2801 * Uncomment to enable the LMS signature algorithm and private key operations.
2802 */
Raef Coles5127e852022-10-07 10:35:56 +01002803//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002804
2805/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002806 * \def MBEDTLS_NIST_KW_C
2807 *
2808 * Enable the Key Wrapping mode for 128-bit block ciphers,
2809 * as defined in NIST SP 800-38F. Only KW and KWP modes
2810 * are supported. At the moment, only AES is approved by NIST.
2811 *
2812 * Module: library/nist_kw.c
2813 *
2814 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2815 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002816#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002817
2818/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002820 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002821 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002822 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002823 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2824 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002825 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002826 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002827 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002828 * Caller: library/constant_time.c
2829 * library/ecdsa.c
2830 * library/ecjpake.c
2831 * library/hkdf.c
2832 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002833 * library/pk.c
2834 * library/pkcs5.c
2835 * library/pkcs12.c
2836 * library/psa_crypto_ecp.c
2837 * library/psa_crypto_rsa.c
2838 * library/rsa.c
2839 * library/ssl_cookie.c
2840 * library/ssl_msg.c
2841 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002842 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002843 * library/x509_crt.c
2844 * library/x509write_crt.c
2845 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002846 *
2847 * Uncomment to enable generic message digest wrappers.
2848 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002850
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002851/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002853 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002854 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002855 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002856 * Module: library/md5.c
2857 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002858 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002859 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002860 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002861 * This module is required for TLS 1.2 depending on the handshake parameters.
2862 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2863 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002864 *
2865 * \warning MD5 is considered a weak message digest and its use constitutes a
2866 * security risk. If possible, we recommend avoiding dependencies on
2867 * it, and considering stronger message digests instead.
2868 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002869 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002870#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002871
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002872/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002874 *
2875 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002876 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002877 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002878 *
2879 * Module: library/memory_buffer_alloc.c
2880 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002881 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002882 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002883 *
2884 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002887
2888/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002890 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002891 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2892 *
Simon Butcherd567a232016-03-09 20:19:21 +00002893 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2894 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002895 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002896 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002897 * \note See also our Knowledge Base article about porting to a new
2898 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002899 * 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 +00002900 *
Andres AG788aa4a2016-09-14 14:32:09 +01002901 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002902 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002903 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002905#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002906
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002909 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002910 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002911 *
2912 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002913 * Caller: library/asn1write.c
2914 * library/pkcs5.c
2915 * library/pkparse.c
2916 * library/pkwrite.c
2917 * library/rsa.c
2918 * library/x509.c
2919 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002920 * library/x509_crl.c
2921 * library/x509_crt.c
2922 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002923 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002924 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002925 *
2926 * This modules translates between OIDs and internal values.
2927 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002929
2930/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002932 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002933 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002934 *
2935 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002936 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002937 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002938 * library/x509_crl.c
2939 * library/x509_crt.c
2940 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002941 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002943 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2944 *
2945 * \warning When parsing password-protected files, if MD5 is provided only by
2946 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002947 *
Paul Bakkercff68422013-09-15 20:43:33 +02002948 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002949 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002950#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002951
2952/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002954 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002955 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002956 *
2957 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002958 * Caller: library/pkwrite.c
2959 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002960 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002961 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002963 *
2964 * This modules adds support for encoding / writing PEM files.
2965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002967
2968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002970 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002971 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002972 *
2973 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002974 * Caller: library/psa_crypto_rsa.c
2975 * library/ssl_tls.c
2976 * library/ssl*_client.c
2977 * library/ssl*_server.c
2978 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002979 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002980 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002981 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002982 * Uncomment to enable generic public key wrappers.
2983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002985
2986/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002988 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002989 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002990 *
2991 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002992 * Caller: library/x509_crt.c
2993 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002994 *
Yanray Wang072a0682023-12-05 10:53:04 +08002995 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002996 *
2997 * Uncomment to enable generic public key parse functions.
2998 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002999#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003000
3001/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003003 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003004 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003005 *
3006 * Module: library/pkwrite.c
3007 * Caller: library/x509write.c
3008 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08003009 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003010 *
3011 * Uncomment to enable generic public key write functions.
3012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003014
3015/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003017 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003018 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003019 *
3020 * Module: library/pkcs5.c
3021 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01003022 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003023 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003024 * \warning If using a hash that is only provided by PSA drivers, you must
3025 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003026 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003027 * This module adds support for the PKCS#5 functions.
3028 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003030
3031/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003032 * \def MBEDTLS_PKCS7_C
3033 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003034 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003035 * RFC Link - https://tools.ietf.org/html/rfc2315
3036 *
3037 * Module: library/pkcs7.c
3038 *
3039 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003040 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3041 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003042 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003043 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003044 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003045#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003046
3047/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003049 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003050 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003051 * Adds algorithms for parsing PKCS#8 encrypted private keys
3052 *
3053 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003054 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003055 *
Valerio Settie98ad592023-12-28 10:42:12 +01003056 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3057 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003058 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003059 * \warning If using a hash that is only provided by PSA drivers, you must
3060 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003061 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003062 * This module enables PKCS#12 functions.
3063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003065
3066/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003068 *
3069 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003070 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003071 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3073 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003074 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003075 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003076 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003077 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003078 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003079 * Module: library/platform.c
3080 * Caller: Most other .c files
3081 *
3082 * This module enables abstraction of common (libc) functions.
3083 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003084#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003085
3086/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003087 * \def MBEDTLS_POLY1305_C
3088 *
3089 * Enable the Poly1305 MAC algorithm.
3090 *
3091 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003092 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003093 */
3094#define MBEDTLS_POLY1305_C
3095
3096/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003097 * \def MBEDTLS_PSA_CRYPTO_C
3098 *
3099 * Enable the Platform Security Architecture cryptography API.
3100 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003101 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003102 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003103 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003104 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003105 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3106 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3107 * is enabled in PSA (unless it's fully accelerated, see
3108 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003109 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003110#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003111
3112/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003113 * \def MBEDTLS_PSA_CRYPTO_SE_C
3114 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003115 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003116 * cryptography API.
3117 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003118 * \deprecated This feature is deprecated. Please switch to the PSA driver
3119 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003120 *
Ryan Everett32a64582024-03-05 18:16:18 +00003121 * \warning This feature is not thread-safe, and should not be used in a
3122 * multi-threaded environment.
3123 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003124 * Module: library/psa_crypto_se.c
3125 *
3126 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3127 *
3128 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003129//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003130
3131/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003132 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3133 *
3134 * Enable the Platform Security Architecture persistent key storage.
3135 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003136 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003137 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003138 * Requires: MBEDTLS_PSA_CRYPTO_C,
3139 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3140 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003141 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003142#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003143
3144/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003145 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003146 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003147 * Enable the emulation of the Platform Security Architecture
3148 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003149 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003150 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003151 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003152 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003153 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003154#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003155
3156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003158 *
3159 * Enable the RIPEMD-160 hash algorithm.
3160 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003161 * Module: library/ripemd160.c
3162 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003163 *
3164 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003166
3167/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003168 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003169 *
3170 * Enable the RSA public-key cryptosystem.
3171 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003172 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003173 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003174 * Caller: library/pk.c
3175 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003176 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003177 * library/ssl*_client.c
3178 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003179 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003180 * This module is used by the following key exchanges:
3181 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003182 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003184 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003186
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003187/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003189 *
3190 * Enable the SHA1 cryptographic hash algorithm.
3191 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003192 * Module: library/sha1.c
3193 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003194 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003195 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003196 * This module is required for TLS 1.2 depending on the handshake parameters,
3197 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003198 *
3199 * \warning SHA-1 is considered a weak message digest and its use constitutes
3200 * a security risk. If possible, we recommend avoiding dependencies
3201 * on it, and considering stronger message digests instead.
3202 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003203 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003204#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003205
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003206/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003207 * \def MBEDTLS_SHA224_C
3208 *
3209 * Enable the SHA-224 cryptographic hash algorithm.
3210 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003211 * Module: library/sha256.c
3212 * Caller: library/md.c
3213 * library/ssl_cookie.c
3214 *
3215 * This module adds support for SHA-224.
3216 */
3217#define MBEDTLS_SHA224_C
3218
3219/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003221 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003222 * Enable the SHA-256 cryptographic hash algorithm.
3223 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003224 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003225 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003226 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003227 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003228 * library/ssl*_client.c
3229 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003230 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003231 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003232 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003235
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003236/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003237 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003238 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003239 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3240 * with the ARMv8 cryptographic extensions if they are available at runtime.
3241 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003242 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003243 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003244 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003245 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003246 * \note Minimum compiler versions for this feature are Clang 4.0,
3247 * armclang 6.6 or GCC 6.0.
3248 *
3249 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3250 * armclang <= 6.9
3251 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003252 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3253 * That name is deprecated, but may still be used as an alternative form for this
3254 * option.
3255 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003256 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3257 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003258 *
3259 * Requires: MBEDTLS_SHA256_C.
3260 *
3261 * Module: library/sha256.c
3262 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003263 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003264 * and use them if available.
3265 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003266//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003267
Dave Rodgmand85277c2023-10-13 09:22:54 +01003268/**
3269 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3270 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003271 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003272 * This name is now deprecated, but may still be used as an alternative form for
3273 * this option.
3274 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003275//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3276
3277/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003278 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003279 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003280 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3281 * with the ARMv8 cryptographic extensions, which must be available at runtime
3282 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003283 *
3284 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003285 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003286 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003287 * \note Minimum compiler versions for this feature are Clang 4.0,
3288 * armclang 6.6 or GCC 6.0.
3289 *
3290 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3291 * armclang <= 6.9
3292 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003293 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003294 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003295 * option.
3296 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003297 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3298 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003299 *
3300 * Requires: MBEDTLS_SHA256_C.
3301 *
3302 * Module: library/sha256.c
3303 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003304 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003305 * unconditionally.
3306 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003307//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003308
Dave Rodgmand85277c2023-10-13 09:22:54 +01003309/**
3310 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3311 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003312 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003313 * This name is now deprecated, but may still be used as an alternative form for
3314 * this option.
3315 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003316//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3317
3318/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003319 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003320 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003321 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003322 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003323 * Module: library/sha512.c
3324 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003325 * library/psa_crypto_hash.c
3326 * library/ssl_tls.c
3327 * library/ssl*_client.c
3328 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003329 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003330 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003331 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003332#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003333
3334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003336 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003337 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003338 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003339 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003340 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003341 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003342 * library/ssl_tls.c
3343 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003344 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003345 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003347#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003348
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003349/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003350 * \def MBEDTLS_SHA3_C
3351 *
3352 * Enable the SHA3 cryptographic hash algorithm.
3353 *
3354 * Module: library/sha3.c
3355 *
3356 * This module adds support for SHA3.
3357 */
3358#define MBEDTLS_SHA3_C
3359
3360/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003361 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3362 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003363 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3364 * with the ARMv8 cryptographic extensions if they are available at runtime.
3365 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003366 *
3367 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3368 * for a non-Aarch64 build it will be silently ignored.
3369 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003370 * \note Minimum compiler versions for this feature are Clang 7.0,
3371 * armclang 6.9 or GCC 8.0.
3372 *
3373 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3374 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003375 *
3376 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3377 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3378 *
3379 * Requires: MBEDTLS_SHA512_C.
3380 *
3381 * Module: library/sha512.c
3382 *
3383 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3384 * and use them if available.
3385 */
3386//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3387
3388/**
3389 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3390 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003391 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3392 * with the ARMv8 cryptographic extensions, which must be available at runtime
3393 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003394 *
3395 * \note This allows builds with a smaller code size than with
3396 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3397 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003398 * \note Minimum compiler versions for this feature are Clang 7.0,
3399 * armclang 6.9 or GCC 8.0.
3400 *
3401 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3402 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003403 *
3404 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3405 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3406 *
3407 * Requires: MBEDTLS_SHA512_C.
3408 *
3409 * Module: library/sha512.c
3410 *
3411 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3412 * unconditionally.
3413 */
3414//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3415
3416/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003418 *
3419 * Enable simple SSL cache implementation.
3420 *
3421 * Module: library/ssl_cache.c
3422 * Caller:
3423 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003427
3428/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003429 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003430 *
3431 * Enable basic implementation of DTLS cookies for hello verification.
3432 *
3433 * Module: library/ssl_cookie.c
3434 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003435 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003436#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003437
3438/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003439 * \def MBEDTLS_SSL_TICKET_C
3440 *
3441 * Enable an implementation of TLS server-side callbacks for session tickets.
3442 *
3443 * Module: library/ssl_ticket.c
3444 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003445 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003446 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3447 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003448 */
3449#define MBEDTLS_SSL_TICKET_C
3450
3451/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003452 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003453 *
3454 * Enable the SSL/TLS client code.
3455 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003456 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003457 * Caller:
3458 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003460 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003461 * This module is required for SSL/TLS client support.
3462 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003463#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003464
Paul Bakker9a736322012-11-14 12:39:52 +00003465/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003466 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003467 *
3468 * Enable the SSL/TLS server code.
3469 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003470 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003471 * Caller:
3472 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003474 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003475 * This module is required for SSL/TLS server support.
3476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003477#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003478
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003479/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003481 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003482 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003483 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003484 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003485 * Caller: library/ssl*_client.c
3486 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003487 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003488 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3489 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003490 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003491 * This module is required for SSL/TLS.
3492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003493#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003494
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003495/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003496 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003497 *
3498 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003499 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003500 * contexts are not shared between threads. If you do intend to use contexts
3501 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003502 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003503 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003504 *
3505 * Module: library/threading.c
3506 *
3507 * This allows different threading implementations (self-implemented or
3508 * provided).
3509 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003510 * You will have to enable either MBEDTLS_THREADING_ALT or
3511 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003512 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003513 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003514 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003515//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003516
3517/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003518 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003519 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003520 * Enable the semi-portable timing interface.
3521 *
Simon Butcherd567a232016-03-09 20:19:21 +00003522 * \note The provided implementation only works on POSIX/Unix (including Linux,
3523 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003524 * module and provide your own implementations of the callbacks needed by
3525 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3526 * your own implementation of the whole module by setting
3527 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003528 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003529 * \note The timing module will include time.h on suitable platforms
3530 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3531 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3532 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003533 * \note See also our Knowledge Base article about porting to a new
3534 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003535 * 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 +00003536 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003537 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003539#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003540
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003541/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003543 *
3544 * Enable run-time version information.
3545 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003546 * Module: library/version.c
3547 *
3548 * This module provides run-time version information.
3549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003551
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003553 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003554 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003555 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003556 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003557 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003558 * Caller: library/x509_crl.c
3559 * library/x509_crt.c
3560 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003561 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003562 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003563 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3564 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003565 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3566 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003567 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003568 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003570#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003571
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003572/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003574 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003575 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003576 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003577 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003578 * Caller: library/ssl_tls.c
3579 * library/ssl*_client.c
3580 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003581 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003582 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003583 *
3584 * This module is required for X.509 certificate parsing.
3585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003586#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003587
3588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003589 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003590 *
3591 * Enable X.509 CRL parsing.
3592 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003593 * Module: library/x509_crl.c
3594 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003595 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003597 *
3598 * This module is required for X.509 CRL parsing.
3599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003600#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003601
3602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003604 *
3605 * Enable X.509 Certificate Signing Request (CSR) parsing.
3606 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003607 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003608 * Caller: library/x509_crt_write.c
3609 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003610 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003611 *
3612 * This module is used for reading X.509 certificate request.
3613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003614#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003615
3616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003617 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003618 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003619 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003620 *
3621 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003622 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003623 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003624 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3625 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003626 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3627 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003628 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003629 * This module is the basis for creating X.509 certificates and CSRs.
3630 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003631#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003632
3633/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003634 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003635 *
3636 * Enable creating X.509 certificates.
3637 *
3638 * Module: library/x509_crt_write.c
3639 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003640 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003641 *
3642 * This module is required for X.509 certificate creation.
3643 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003644#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003645
3646/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003647 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003648 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003649 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003650 *
3651 * Module: library/x509_csr_write.c
3652 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003653 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003654 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003655 * This module is required for X.509 certificate request writing.
3656 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003657#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003658
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003659/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003660
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003661/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003662 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003663 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003664 * This section contains Mbed TLS build settings that are not associated
3665 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003666 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003667 * \{
3668 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003669
Gilles Peskinea02c1242022-03-16 17:03:19 +01003670/**
3671 * \def MBEDTLS_CONFIG_FILE
3672 *
3673 * If defined, this is a header which will be included instead of
3674 * `"mbedtls/mbedtls_config.h"`.
3675 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003676 * Unlike other configuration options, this one must be defined on the
3677 * compiler command line: a definition in `mbedtls_config.h` would have
3678 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003679 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003680 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003681 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003682 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003683 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003684 * The value of this symbol is typically a path in double quotes, either
3685 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003686 */
3687//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3688
3689/**
3690 * \def MBEDTLS_USER_CONFIG_FILE
3691 *
3692 * If defined, this is a header which will be included after
3693 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003694 * This allows you to modify the default configuration, including the ability
3695 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003696 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003697 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003698 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003699 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003700 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003701 * The value of this symbol is typically a path in double quotes, either
3702 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003703 */
3704//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3705
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003706/**
3707 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3708 *
3709 * If defined, this is a header which will be included instead of
3710 * `"psa/crypto_config.h"`.
3711 * This header file specifies which cryptographic mechanisms are available
3712 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3713 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3714 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003715 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003716 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003717 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003718 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003719 * The value of this symbol is typically a path in double quotes, either
3720 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003721 */
3722//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3723
3724/**
3725 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3726 *
3727 * If defined, this is a header which will be included after
3728 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003729 * This allows you to modify the default configuration, including the ability
3730 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003731 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003732 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003733 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003734 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003735 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003736 * The value of this symbol is typically a path in double quotes, either
3737 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003738 */
3739//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3740
Gilles Peskineb1176f22023-02-22 22:07:28 +01003741/**
3742 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3743 *
3744 * If defined, this is a header which will be included instead of
3745 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3746 * as the one in Mbed TLS, but with definitions adapted to the platform on
3747 * which the library code will run.
3748 *
3749 * \note The required content of this header can vary from one version of
3750 * Mbed TLS to the next. Integrators who provide an alternative file
3751 * should review the changes in the original file whenever they
3752 * upgrade Mbed TLS.
3753 *
3754 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3755 * non-standard feature of the C language, so this feature is only available
3756 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3757 *
3758 * The value of this symbol is typically a path in double quotes, either
3759 * absolute or relative to a directory on the include search path.
3760 */
3761//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3762
3763/**
3764 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3765 *
3766 * If defined, this is a header which will be included instead of
3767 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3768 * as the one in Mbed TLS, but with definitions adapted to the environment
3769 * in which the library code will run. The typical use for this feature
3770 * is to provide alternative type definitions on the client side in
3771 * client-server integrations of PSA crypto, where operation structures
3772 * contain handles instead of cryptographic data.
3773 *
3774 * \note The required content of this header can vary from one version of
3775 * Mbed TLS to the next. Integrators who provide an alternative file
3776 * should review the changes in the original file whenever they
3777 * upgrade Mbed TLS.
3778 *
3779 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3780 * non-standard feature of the C language, so this feature is only available
3781 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3782 *
3783 * The value of this symbol is typically a path in double quotes, either
3784 * absolute or relative to a directory on the include search path.
3785 */
3786//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3787
Gilles Peskineba4162a2022-04-11 17:04:38 +02003788/** \} name SECTION: General configuration options */
3789
3790/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003791 * \name SECTION: Module configuration options
3792 *
3793 * This section allows for the setting of module specific sizes and
3794 * configuration options. The default values are already present in the
3795 * relevant header files and should suffice for the regular use cases.
3796 *
3797 * Our advice is to enable options and change their values here
3798 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003799 * \{
3800 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003801/* The Doxygen documentation here is used when a user comments out a
3802 * setting and runs doxygen themselves. On the other hand, when we typeset
3803 * the full documentation including disabled settings, the documentation
3804 * in specific modules' header files is used if present. When editing this
3805 * file, make sure that each option is documented in exactly one place,
3806 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3807 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003808
Paul Bakker088c5c52014-04-25 11:11:10 +02003809/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003810//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003811//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003812
Paul Bakker088c5c52014-04-25 11:11:10 +02003813/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003814//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3815//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3816//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3817//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3818//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003819
Paul Bakker088c5c52014-04-25 11:11:10 +02003820/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003821//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3822//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3823//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3824//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003825
Paul Bakker088c5c52014-04-25 11:11:10 +02003826/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003827//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003828//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003829
Paul Bakker088c5c52014-04-25 11:11:10 +02003830/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003831//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3832//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003833//#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 +01003834
Paul Bakker088c5c52014-04-25 11:11:10 +02003835/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003836//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003837
Paul Bakker088c5c52014-04-25 11:11:10 +02003838/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003839//#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 -04003840
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003841/** \def MBEDTLS_PLATFORM_STD_CALLOC
3842 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003843 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003844 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003845 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003846 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003847 * 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 -04003848 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3849 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003850 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003851 */
3852//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003853
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003854/** \def MBEDTLS_PLATFORM_STD_FREE
3855 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003856 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003857 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003858 * 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 -04003859 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3860 * 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 -04003861 */
3862//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003863//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003864//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003865//#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 +02003866//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3867//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003868/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003869//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003870//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3871//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003872//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3873//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3874//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003875
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003876/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003877/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003878//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3879//#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 +02003880//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003881//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003882//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3883//#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 +02003884//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3885//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003886/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003887//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003888//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003889//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3890//#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 +08003891//#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 +08003892//#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 +02003893
Gilles Peskine3f106f72021-09-23 17:42:39 +02003894/** \def MBEDTLS_CHECK_RETURN
3895 *
3896 * This macro is used at the beginning of the declaration of a function
3897 * to indicate that its return value should be checked. It should
3898 * instruct the compiler to emit a warning or an error if the function
3899 * is called without checking its return value.
3900 *
3901 * There is a default implementation for popular compilers in platform_util.h.
3902 * You can override the default implementation by defining your own here.
3903 *
3904 * If the implementation here is empty, this will effectively disable the
3905 * checking of functions' return values.
3906 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003907//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003908
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003909/** \def MBEDTLS_IGNORE_RETURN
3910 *
3911 * This macro requires one argument, which should be a C function call.
3912 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3913 * warning is suppressed.
3914 */
3915//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3916
Gilles Peskineed038902020-11-13 21:33:21 +01003917/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003918/**
Gilles Peskineed038902020-11-13 21:33:21 +01003919 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3920 * PSA crypto subsystem.
3921 *
3922 * If this option is unset:
3923 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003924 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003925 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3926 * on unspecified heuristics.
3927 */
3928//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3929
Steven Cooreman863470a2021-02-15 14:03:19 +01003930/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003931 * Restrict the PSA library to supporting a maximum amount of simultaneously
3932 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3933 * volatile key, or a persistent key which is loaded temporarily by the
3934 * library as part of a crypto operation in flight.
3935 *
3936 * If this option is unset, the library will fall back to a default value of
3937 * 32 keys.
3938 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003939//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003940
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003941/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003942//#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 +00003943
Paul Bakker088c5c52014-04-25 11:11:10 +02003944/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003945//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3946//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003947
Paul Bakker088c5c52014-04-25 11:11:10 +02003948/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003949
Angus Grattond8213d02016-05-25 20:56:48 +10003950/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3951 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003952 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003953 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003954 * This determines the size of the incoming TLS I/O buffer in such a way
3955 * that it is capable of holding the specified amount of plaintext data,
3956 * regardless of the protection mechanism used.
3957 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003958 * \note When using a value less than the default of 16KB on the client, it is
3959 * recommended to use the Maximum Fragment Length (MFL) extension to
3960 * inform the server about this limitation. On the server, there
3961 * is no supported, standardized way of informing the client about
3962 * restriction on the maximum size of incoming messages, and unless
3963 * the limitation has been communicated by other means, it is recommended
3964 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3965 * while keeping the default value of 16KB for the incoming buffer.
3966 *
David Horstmann95d516f2021-05-04 18:36:56 +01003967 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003968 */
3969//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3970
Gilles Peskined3d02902020-03-04 21:35:27 +01003971/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3972 *
3973 * The maximum length of CIDs used for incoming DTLS messages.
3974 *
3975 */
3976//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3977
3978/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3979 *
3980 * The maximum length of CIDs used for outgoing DTLS messages.
3981 *
3982 */
3983//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3984
TRodziewicze8dd7092021-05-12 14:19:11 +02003985/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003986 *
3987 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003988 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003989 *
3990 * The padding will always be chosen so that the length of the
3991 * padded plaintext is a multiple of the value of this option.
3992 *
3993 * Note: A value of \c 1 means that no padding will be used
3994 * for outgoing records.
3995 *
3996 * Note: On systems lacking division instructions,
3997 * a power of two should be preferred.
3998 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003999//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01004000
Angus Grattond8213d02016-05-25 20:56:48 +10004001/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4002 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004003 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004004 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004005 * This determines the size of the outgoing TLS I/O buffer in such a way
4006 * that it is capable of holding the specified amount of plaintext data,
4007 * regardless of the protection mechanism used.
4008 *
Angus Grattond8213d02016-05-25 20:56:48 +10004009 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4010 * the default inward 16384 byte buffer to conform to the TLS specification.
4011 *
4012 * The minimum required outward buffer size is determined by the handshake
4013 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4014 * The specific size requirement depends on the configured ciphers and any
4015 * certificate data which is sent during the handshake.
4016 *
David Horstmann95d516f2021-05-04 18:36:56 +01004017 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004018 */
4019//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4020
Hanno Beckere0b150f2018-08-21 15:51:03 +01004021/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4022 *
4023 * Maximum number of heap-allocated bytes for the purpose of
4024 * DTLS handshake message reassembly and future message buffering.
4025 *
Yuto Takano7828ca22021-08-10 11:26:15 +01004026 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004027 * to account for a reassembled handshake message of maximum size,
4028 * together with its reassembly bitmap.
4029 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004030 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004031 * should be sufficient for all practical situations as it allows
4032 * to reassembly a large handshake message (such as a certificate)
4033 * while buffering multiple smaller handshake messages.
4034 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004035 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004036//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004037
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004038//#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 +02004039//#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 +02004040
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004041/**
4042 * Complete list of ciphersuites to use, in order of preference.
4043 *
4044 * \warning No dependency checking is done on that field! This option can only
4045 * be used to restrict the set of available ciphersuites. It is your
4046 * responsibility to make sure the needed modules are active.
4047 *
4048 * Use this to save a few hundred bytes of ROM (default ordering of all
4049 * available ciphersuites) and a few to a few hundred bytes of RAM.
4050 *
4051 * The value below is only an example, not the default.
4052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004053//#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 +02004054
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004055/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004056 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4057 *
4058 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004059 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004060 *
4061 * It must be positive and smaller than UINT32_MAX.
4062 *
4063 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4064 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004065 */
4066//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4067
4068/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004069 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4070 *
Jerry Yucf913512023-11-14 11:06:52 +08004071 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004072 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004073 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004074 * - The client ticket age is the time difference between the time when the
4075 * client proposes to the server to use the ticket and the time the client
4076 * received the ticket from the server.
4077 * - The server ticket age is the time difference between the time when the
4078 * server receives a proposition from the client to use the ticket and the
4079 * time when the ticket was created by the server.
4080 *
Jerry Yucf913512023-11-14 11:06:52 +08004081 * The ages might be different due to the client and server clocks not running
4082 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4083 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4084 * 6s, thus in the worst case clients and servers must sync up their system time
4085 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004086 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004087 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004088 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004089//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004090
4091/**
4092 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4093 *
4094 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4095 *
4096 * This must be less than 256.
4097 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004098//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004099
4100/**
4101 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4102 *
4103 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4104 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4105 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4106 *
4107 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004108//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004109
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004110/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004111//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004112//#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 +01004113
Gilles Peskine611179c2022-04-13 23:04:48 +02004114/** \} name SECTION: Module configuration options */