blob: 193262b1609b166f546d13a6087847a7452ae03a [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
Steven Cooreman63342772017-04-04 11:47:16 +0200353//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354//#define MBEDTLS_DES_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300355//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200356//#define MBEDTLS_MD5_ALT
357//#define MBEDTLS_RIPEMD160_ALT
358//#define MBEDTLS_SHA1_ALT
359//#define MBEDTLS_SHA256_ALT
360//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000361
Paul Bakker90995b52013-06-24 19:20:35 +0200362/**
TRodziewicz75628d52021-06-18 12:56:27 +0200363 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200364 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200365 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100366 * alternate core implementation of symmetric crypto or hash function. Keep in
367 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200368 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200369 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200370 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200371 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200372 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373 * no longer provide the mbedtls_sha1_process() function, but it will still provide
374 * the other function (using your mbedtls_sha1_process() function) and the definition
375 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200376 * with this definition.
377 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200378 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100379 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
380 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200381 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200382 * Uncomment a macro to enable alternate implementation of the corresponding
383 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100384 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200385 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100386 * constitutes a security risk. If possible, we recommend avoiding
387 * dependencies on them, and considering stronger message digests
388 * and ciphers instead.
389 *
Janos Follath1231d212019-01-07 15:01:32 +0000390 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
391 * enabled, then the deterministic ECDH signature functions pass the
392 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
393 * alternative implementations should use the RNG only for generating
394 * the ephemeral key and nothing else. If this is not possible, then
395 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200396 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000397 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200399//#define MBEDTLS_MD5_PROCESS_ALT
400//#define MBEDTLS_RIPEMD160_PROCESS_ALT
401//#define MBEDTLS_SHA1_PROCESS_ALT
402//#define MBEDTLS_SHA256_PROCESS_ALT
403//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200404//#define MBEDTLS_DES_SETKEY_ALT
405//#define MBEDTLS_DES_CRYPT_ECB_ALT
406//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200407//#define MBEDTLS_AES_SETKEY_ENC_ALT
408//#define MBEDTLS_AES_SETKEY_DEC_ALT
409//#define MBEDTLS_AES_ENCRYPT_ALT
410//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300411//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300412//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300413//#define MBEDTLS_ECDSA_VERIFY_ALT
414//#define MBEDTLS_ECDSA_SIGN_ALT
415//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200416
417/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200418 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200419 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200420 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200421 * hardware entropy collector.
422 *
423 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000424 * prototype as declared in library/entropy_poll.h, and accept NULL as first
425 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200426 *
427 * Uncomment to use your own hardware entropy collector.
428 */
429//#define MBEDTLS_ENTROPY_HARDWARE_ALT
430
431/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200432 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000433 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100434 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000435 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100436 * Uncomment this macro to use precomputed AES tables stored in ROM.
437 * Comment this macro to generate AES tables in RAM at runtime.
438 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100439 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
440 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100441 * initialization time before the first AES operation can be performed.
442 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
443 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
444 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100445 *
446 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000447 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200448//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000449
450/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100451 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200452 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100453 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200454 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100455 * Uncommenting this macro omits 75% of the AES tables from
456 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
457 * by computing their values on the fly during operations
458 * (the tables are entry-wise rotations of one another).
459 *
460 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100461 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100462 * runtime. Specifically, one has to compare 4 accesses within
463 * different tables to 4 accesses with additional arithmetic
464 * operations within the same table. The performance gain/loss
465 * depends on the system and memory details.
466 *
467 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200468 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100469//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200470
471/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800472 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
473 *
474 * Use only 128-bit keys in AES operations to save ROM.
475 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800476 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800477 * or 256-bit keys.
478 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800479 * Uncommenting this macro reduces the size of AES code by ~300 bytes
480 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800481 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800482 * Module: library/aes.c
483 *
484 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800485 */
486//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
487
Gilles Peskinea8861e02023-09-05 20:20:51 +0200488/*
489 * Disable plain C implementation for AES.
490 *
491 * When the plain C implementation is enabled, and an implementation using a
492 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
493 * detection will be used to select between them.
494 *
495 * If only one implementation is present, runtime detection will not be used.
496 * This configuration will crash at runtime if running on a CPU without the
497 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
498 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
499 */
500//#define MBEDTLS_AES_USE_HARDWARE_ONLY
501
Arto Kinnunen732ca322023-04-14 14:26:10 +0800502/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200503 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200504 *
505 * Use less ROM for the Camellia implementation (saves about 768 bytes).
506 *
507 * Uncomment this macro to use less memory for Camellia.
508 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200509//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200510
511/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200512 * \def MBEDTLS_CHECK_RETURN_WARNING
513 *
514 * If this macro is defined, emit a compile-time warning if application code
515 * calls a function without checking its return value, but the return value
516 * should generally be checked in portable applications.
517 *
518 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
519 * implemented. Otherwise this option has no effect.
520 *
521 * Uncomment to get warnings on using fallible functions without checking
522 * their return value.
523 *
524 * \note This feature is a work in progress.
525 * Warnings will be added to more functions in the future.
526 *
527 * \note A few functions are considered critical, and ignoring the return
528 * value of these functions will trigger a warning even if this
529 * macro is not defined. To completely disable return value check
530 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
531 */
532//#define MBEDTLS_CHECK_RETURN_WARNING
533
534/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200536 *
537 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200539#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200540
541/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000543 *
544 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
545 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200546#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000547
548/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200549 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000550 *
551 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200553#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000554
555/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100556 * \def MBEDTLS_CIPHER_MODE_OFB
557 *
558 * Enable Output Feedback mode (OFB) for symmetric ciphers.
559 */
560#define MBEDTLS_CIPHER_MODE_OFB
561
562/**
563 * \def MBEDTLS_CIPHER_MODE_XTS
564 *
565 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
566 */
567#define MBEDTLS_CIPHER_MODE_XTS
568
569/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000571 *
572 * Enable NULL cipher.
573 * Warning: Only do so when you know what you are doing. This allows for
574 * encryption or channels without any security!
575 *
Ronald Croncee42702021-04-26 11:34:44 +0200576 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200577 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
578 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
579 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
580 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
581 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
582 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
583 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
584 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
585 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
586 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
587 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
588 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
589 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
590 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
591 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
592 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
593 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
594 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
595 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000596 *
597 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200599//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000600
601/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100602 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200603 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100604 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
605 * specific padding modes in the cipher layer with cipher modes that support
606 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200607 *
608 * If you disable all padding modes, only full blocks can be used with CBC.
609 *
610 * Enable padding modes in the cipher layer.
611 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612#define MBEDTLS_CIPHER_PADDING_PKCS7
613#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
614#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
615#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200616
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200617/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
618 *
619 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800620 * Without this, CTR_DRBG uses a 256-bit key
621 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200622 */
623//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
624
Paul Bakker48e93c82013-08-14 12:21:18 +0200625/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200626 * Enable the verified implementations of ECDH primitives from Project Everest
627 * (currently only Curve25519). This feature changes the layout of ECDH
628 * contexts and therefore is a compatibility break for applications that access
629 * fields of a mbedtls_ecdh_context structure directly. See also
630 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000631 *
632 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
633 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200634 */
635//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
636
637/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100638 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200639 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100640 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
641 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200642 *
643 * Comment macros to disable the curve and functions for it
644 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200645/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200646#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
647#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
648#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
649#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
650#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
651#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
652#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
653#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
654#define MBEDTLS_ECP_DP_BP256R1_ENABLED
655#define MBEDTLS_ECP_DP_BP384R1_ENABLED
656#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200657/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200658#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000659#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200660
661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200662 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200663 *
664 * Enable specific 'modulo p' routines for each NIST prime.
665 * Depending on the prime and architecture, makes operations 4 to 8 times
666 * faster on the corresponding curve.
667 *
668 * Comment this macro to disable NIST curves optimisation.
669 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200670#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200671
672/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200673 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100674 *
675 * Enable "non-blocking" ECC operations that can return early and be resumed.
676 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200677 * This allows various functions to pause by returning
678 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
679 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
680 * order to further progress and eventually complete their operation. This is
681 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
682 * number of ECC operations a function may perform before pausing; see
683 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100684 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200685 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200686 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100687 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100688 * This option:
689 * - Adds xxx_restartable() variants of existing operations in the
690 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100691 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
692 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100693 * - ECDSA: signature generation & verification;
694 * - PK: signature generation & verification;
695 * - X509: certificate chain verification.
696 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
697 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
698 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
699 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000700 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100701 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100702 * - verification of the server's key exchange signature;
703 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100704 * - generation of the client's signature if client authentication is used,
705 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100706 *
707 * \note In the cases above, the usual SSL/TLS functions, such as
708 * mbedtls_ssl_handshake(), can now return
709 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200710 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100711 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
712 * restartable operations in PK, X.509 and TLS (see above) are not
713 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100714 * PSA, and are not restartable. These are temporary limitations that
715 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200716 *
Ron Eldor19779c42018-11-05 16:58:13 +0200717 * \note This option only works with the default software implementation of
718 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100719 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100720 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100721 * Requires: MBEDTLS_ECP_C
722 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100723 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100724 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200725//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100726
727/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200728 * Uncomment to enable using new bignum code in the ECC modules.
729 *
730 * \warning This is currently experimental, incomplete and therefore should not
731 * be used in production.
732 */
733//#define MBEDTLS_ECP_WITH_MPI_UINT
734
735/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100737 *
738 * Enable deterministic ECDSA (RFC 6979).
739 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
740 * may result in a compromise of the long-term signing key. This is avoided by
741 * the deterministic variant.
742 *
John Durkop36a82e52020-10-26 09:39:05 -0700743 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100744 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100745 * Comment this macro to disable deterministic ECDSA.
746 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200747#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100748
749/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200750 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200751 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200752 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200753 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200754 * This enables the following ciphersuites (if other requisites are
755 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200756 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
757 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
758 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
759 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
760 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
761 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
762 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
763 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
764 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
765 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200766 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200768
769/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200770 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200771 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200772 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200773 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200774 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200775 *
776 * This enables the following ciphersuites (if other requisites are
777 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200778 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
779 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
780 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
781 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
782 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
783 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
784 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
785 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
786 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
787 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100788 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100789 * \warning Using DHE constitutes a security risk as it
790 * is not possible to validate custom DH parameters.
791 * If possible, it is recommended users should consider
792 * preferring other methods of key exchange.
793 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100794 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200795 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200796#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200797
798/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200799 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200800 *
801 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
802 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200803 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200804 *
805 * This enables the following ciphersuites (if other requisites are
806 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
808 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
809 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
810 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
811 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
812 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200815
816/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200817 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200818 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200819 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200820 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200821 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
822 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200823 *
824 * This enables the following ciphersuites (if other requisites are
825 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200826 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
827 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
828 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
829 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
830 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
831 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
832 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
833 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
834 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
835 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838
839/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200841 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200842 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200843 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
845 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200846 *
847 * This enables the following ciphersuites (if other requisites are
848 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200849 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
850 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
851 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
852 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
853 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
854 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
855 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
856 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
857 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
858 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
859 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
860 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863
864/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200867 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200868 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200869 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
870 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200871 *
872 * This enables the following ciphersuites (if other requisites are
873 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200874 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
875 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
876 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
877 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
878 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
879 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
880 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
881 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
882 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
883 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
884 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
885 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100886 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100887 * \warning Using DHE constitutes a security risk as it
888 * is not possible to validate custom DH parameters.
889 * If possible, it is recommended users should consider
890 * preferring other methods of key exchange.
891 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100892 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200895
896/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200898 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200899 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200900 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200901 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
902 * MBEDTLS_RSA_C
903 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200904 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200905 *
906 * This enables the following ciphersuites (if other requisites are
907 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
909 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
913 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
914 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
915 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
916 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
917 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200918 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200919#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200920
921/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200922 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200923 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200924 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200925 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200926 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
927 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
928 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200929 *
930 * This enables the following ciphersuites (if other requisites are
931 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
938 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
939 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
940 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
941 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200942 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200943#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200944
945/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200946 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100947 *
948 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
949 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200950 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
951 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
952 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100953 *
954 * This enables the following ciphersuites (if other requisites are
955 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200956 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
957 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
960 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
961 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
962 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
963 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
964 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
965 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100968
969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100971 *
972 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
973 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200974 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
975 * MBEDTLS_RSA_C
976 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100977 *
978 * This enables the following ciphersuites (if other requisites are
979 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200980 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
981 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
982 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
983 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
984 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
985 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
986 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
987 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
988 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
989 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100992
993/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200994 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
995 *
996 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
997 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200998 * \warning This is currently experimental. EC J-PAKE support is based on the
999 * Thread v1.0.0 specification; incompatible changes to the specification
1000 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001001 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001002 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001003 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001004 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1005 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001006 * \warning If SHA-256 is provided only by a PSA driver, you must call
1007 * psa_crypto_init() before the first hanshake (even if
1008 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1009 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001010 * This enables the following ciphersuites (if other requisites are
1011 * enabled as well):
1012 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1013 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001014//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001015
1016/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001018 *
1019 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1020 * RFC 5915 and RFC 5480.
1021 *
1022 * Currently this means parsing the SpecifiedECDomain choice of EC
1023 * parameters (only known groups are supported, not arbitrary domains, to
1024 * avoid validation issues).
1025 *
1026 * Disable if you only need to support RFC 5915 + 5480 key formats.
1027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001029
1030/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001031 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1032 *
1033 * Enable the support for parsing public keys of type Short Weierstrass
1034 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001035 * compressed point format. This parsing is done through ECP module's functions.
1036 *
1037 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1038 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1039 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001040 */
1041#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1042
1043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001045 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001046 * Enable a dummy error function to make use of mbedtls_strerror() in
1047 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1048 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001049 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1051 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001052 *
1053 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001057
1058/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001060 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001061 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001062 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001065#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001066
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001069 *
1070 * Enable functions that use the filesystem.
1071 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001072#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001073
1074/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001076 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001077 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001078 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001079 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001080 * application.
1081 *
1082 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001083 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001084//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001085
1086/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001087 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001088 *
1089 * Do not use built-in platform entropy functions.
1090 * This is useful if your platform does not support
1091 * standards like the /dev/urandom or Windows CryptoAPI.
1092 *
1093 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001096
1097/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001099 *
1100 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1101 * default SHA-512 based one (if both are available).
1102 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001104 *
1105 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1106 * if you have performance concerns.
1107 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 * This option is only useful if both MBEDTLS_SHA256_C and
1109 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001110 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001111//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001112
1113/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001114 * \def MBEDTLS_ENTROPY_NV_SEED
1115 *
1116 * Enable the non-volatile (NV) seed file-based entropy source.
1117 * (Also enables the NV seed read/write functions in the platform layer)
1118 *
1119 * This is crucial (if not required) on systems that do not have a
1120 * cryptographic entropy source (in hardware or kernel) available.
1121 *
1122 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1123 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001124 * \note The read/write functions that are used by the entropy source are
1125 * determined in the platform layer, and can be modified at runtime and/or
1126 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1127 *
1128 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001129 * with regular fopen(), please make sure you make a seedfile with the
1130 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1131 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001132 * and written to or you will get an entropy source error! The default
1133 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1134 * bytes from the file.
1135 *
1136 * \note The entropy collector will write to the seed file before entropy is
1137 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001138 */
1139//#define MBEDTLS_ENTROPY_NV_SEED
1140
Ronald Cron71016a92020-08-28 19:01:50 +02001141/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001142 *
Ronald Cron71016a92020-08-28 19:01:50 +02001143 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001144 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001145 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1146 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001147 *
1148 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001149 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001150 */
Ronald Cron71016a92020-08-28 19:01:50 +02001151//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001152
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001153/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001154 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001155 *
1156 * Enable debugging of buffer allocator memory issues. Automatically prints
1157 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1158 * function for 'debug output' of allocated memory.
1159 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001161 *
1162 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001165
1166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001168 *
1169 * Include backtrace information with each allocated block.
1170 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001172 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001173 *
1174 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001177
1178/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001180 *
1181 * Support external private RSA keys (eg from a HSM) in the PK layer.
1182 *
1183 * Comment this macro to disable support for external private RSA keys.
1184 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001186
1187/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001189 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001190 * Enable support for PKCS#1 v1.5 encoding.
1191 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001192 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001193 *
Paul Bakker48377d92013-08-30 12:06:24 +02001194 * This enables support for PKCS#1 v1.5 operations.
1195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001196#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001197
1198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001200 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001201 * Enable support for PKCS#1 v2.1 encoding.
1202 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001203 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001204 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001205 * \warning If using a hash that is only provided by PSA drivers, you must
1206 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001207 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001208 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1209 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001210#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001211
Steven Cooreman6801f082021-02-19 17:21:22 +01001212/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1213 *
1214 * Enable support for platform built-in keys. If you enable this feature,
1215 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1216 * See the documentation of that function for more information.
1217 *
1218 * Built-in keys are typically derived from a hardware unique key or
1219 * stored in a secure element.
1220 *
1221 * Requires: MBEDTLS_PSA_CRYPTO_C.
1222 *
1223 * \warning This interface is experimental and may change or be removed
1224 * without notice.
1225 */
1226//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1227
Ronald Cron3768ac12021-01-26 16:58:00 +01001228/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1229 *
1230 * Enable support for PSA crypto client.
1231 *
1232 * \note This option allows to include the code necessary for a PSA
1233 * crypto client when the PSA crypto implementation is not included in
1234 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1235 * code to set and get PSA key attributes.
1236 * The development of PSA drivers partially relying on the library to
1237 * fulfill the hardware gaps is another possible usage of this option.
1238 *
1239 * \warning This interface is experimental and may change or be removed
1240 * without notice.
1241 */
1242//#define MBEDTLS_PSA_CRYPTO_CLIENT
1243
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001244/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1245 *
1246 * Make the PSA Crypto module use an external random generator provided
1247 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1248 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001249 * \note This random generator must deliver random numbers with cryptographic
1250 * quality and high performance. It must supply unpredictable numbers
1251 * with a uniform distribution. The implementation of this function
1252 * is responsible for ensuring that the random generator is seeded
1253 * with sufficient entropy. If you have a hardware TRNG which is slow
1254 * or delivers non-uniform output, declare it as an entropy source
1255 * with mbedtls_entropy_add_source() instead of enabling this option.
1256 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001257 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001258 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1259 * and define a function called mbedtls_psa_external_get_random()
1260 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001261 * ```
1262 * psa_status_t mbedtls_psa_external_get_random(
1263 * mbedtls_psa_external_random_context_t *context,
1264 * uint8_t *output, size_t output_size, size_t *output_length);
1265 * );
1266 * ```
1267 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001268 * The function must fill the \c output buffer with \c output_size bytes
1269 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001270 *
1271 * Requires: MBEDTLS_PSA_CRYPTO_C
1272 *
1273 * \warning If you enable this option, code that uses the PSA cryptography
1274 * interface will not use any of the entropy sources set up for
1275 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1276 * enables.
1277 *
1278 * \note This option is experimental and may be removed without notice.
1279 */
1280//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1281
Paul Bakker9dcc3222011-03-08 14:16:06 +00001282/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001283 * \def MBEDTLS_PSA_CRYPTO_SPM
1284 *
1285 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1286 * Partition Manager) integration which separates the code into two parts: a
1287 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1288 * Environment).
1289 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001290 * If you enable this option, your build environment must include a header
1291 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1292 * header files, or in another directory on the compiler's include search
1293 * path). Alternatively, your platform may customize the header
1294 * `psa/crypto_platform.h`, in which case it can skip or replace the
1295 * inclusion of `"crypto_spe.h"`.
1296 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001297 * Module: library/psa_crypto.c
1298 * Requires: MBEDTLS_PSA_CRYPTO_C
1299 *
1300 */
1301//#define MBEDTLS_PSA_CRYPTO_SPM
1302
1303/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001304 * Uncomment to enable p256-m. This is an alternative implementation of
1305 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1306 * Compared to the default implementation:
1307 *
1308 * - p256-m has a much smaller code size and RAM footprint.
1309 * - p256-m is only available via the PSA API. This includes the pk module
1310 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1311 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1312 * over the core arithmetic, or deterministic derivation of keys.
1313 *
1314 * We recommend enabling this option if your application uses the PSA API
1315 * and the only elliptic curve support it needs is ECDH and ECDSA over
1316 * SECP256R1.
1317 *
1318 * If you enable this option, you do not need to enable any ECC-related
1319 * MBEDTLS_xxx option. You do need to separately request support for the
1320 * cryptographic mechanisms through the PSA API:
1321 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1322 * configuration;
1323 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1324 * - #PSA_WANT_ECC_SECP_R1_256;
1325 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1326 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1327 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1328 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1329 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001330 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001331 * \note To benefit from the smaller code size of p256-m, make sure that you
1332 * do not enable any ECC-related option not supported by p256-m: this
1333 * would cause the built-in ECC implementation to be built as well, in
1334 * order to provide the required option.
1335 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001336 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1337 * SECP256R1 are disabled as they are not supported by this driver.
1338 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1339 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001340 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001341 */
1342//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1343
1344/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001345 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001346 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001347 * Enable support for entropy injection at first boot. This feature is
1348 * required on systems that do not have a built-in entropy source (TRNG).
1349 * This feature is currently not supported on systems that have a built-in
1350 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001351 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001352 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001353 *
1354 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001355//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001356
1357/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001358 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001359 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001360 * Assume all buffers passed to PSA functions are owned exclusively by the
1361 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001362 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001363 * This option may be enabled if all buffers passed to any PSA function reside
1364 * in memory that is accessible only to the PSA function during its execution.
1365 *
1366 * This option MUST be disabled whenever buffer arguments are in memory shared
1367 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001368 * across a trust boundary.
1369 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001370 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001371 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001372 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001373 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001374 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001375//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001376
1377/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001378 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001379 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001380 * Do not use the Chinese Remainder Theorem
1381 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001382 *
1383 * Uncomment this macro to disable the use of CRT in RSA.
1384 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001386//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001387
1388/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001390 *
1391 * Enable the checkup functions (*_self_test).
1392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001393#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001394
1395/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001396 * \def MBEDTLS_SHA256_SMALLER
1397 *
1398 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1399 * lower performance.
1400 *
Adam Wolf039080f2019-09-10 09:53:08 -05001401 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001402 * performance and size. This version optimizes more aggressively for size at
1403 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1404 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1405 * 30%.
1406 *
1407 * Uncomment to enable the smaller implementation of SHA256.
1408 */
1409//#define MBEDTLS_SHA256_SMALLER
1410
1411/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001412 * \def MBEDTLS_SHA512_SMALLER
1413 *
1414 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1415 * lower performance.
1416 *
1417 * Uncomment to enable the smaller implementation of SHA512.
1418 */
1419//#define MBEDTLS_SHA512_SMALLER
1420
1421/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001422 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001423 *
1424 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001425 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001426 * with other servers, only debugging of failures is harder.
1427 *
1428 * The advantage of not sending alert messages, is that no information is given
1429 * about reasons for failures thus preventing adversaries of gaining intel.
1430 *
1431 * Enable sending of all alert messages
1432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001433#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001434
1435/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001436 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1437 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001438 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001439 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001440 * in the underlying transport. The CID functionality is described
1441 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001442 *
1443 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001444 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1445 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1446 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001447 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001448 * The maximum lengths of outgoing and incoming CIDs can be configured
1449 * through the options
1450 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1451 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1452 *
1453 * Requires: MBEDTLS_SSL_PROTO_DTLS
1454 *
1455 * Uncomment to enable the Connection ID extension.
1456 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001457#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1458
1459
1460/**
1461 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1462 *
1463 * Defines whether RFC 9146 (default) or the legacy version
1464 * (version draft-ietf-tls-dtls-connection-id-05,
1465 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1466 * is used.
1467 *
1468 * Set the value to 0 for the standard version, and
1469 * 1 for the legacy draft version.
1470 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001471 * \deprecated Support for the legacy version of the DTLS
1472 * Connection ID feature is deprecated. Please
1473 * switch to the standardized version defined
1474 * in RFC 9146 enabled by utilizing
1475 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1476 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1477 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001478 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1479 */
1480#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001481
1482/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001483 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1484 *
1485 * Enable asynchronous external private key operations in SSL. This allows
1486 * you to configure an SSL connection to call an external cryptographic
1487 * module to perform private key operations instead of performing the
1488 * operation inside the library.
1489 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001490 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001491 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001492//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001493
1494/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001495 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1496 *
1497 * Enable serialization of the TLS context structures, through use of the
1498 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1499 *
1500 * This pair of functions allows one side of a connection to serialize the
1501 * context associated with the connection, then free or re-use that context
1502 * while the serialized state is persisted elsewhere, and finally deserialize
1503 * that state to a live context for resuming read/write operations on the
1504 * connection. From a protocol perspective, the state of the connection is
1505 * unaffected, in particular this is entirely transparent to the peer.
1506 *
1507 * Note: this is distinct from TLS session resumption, which is part of the
1508 * protocol and fully visible by the peer. TLS session resumption enables
1509 * establishing new connections associated to a saved session with shorter,
1510 * lighter handshakes, while context serialization is a local optimization in
1511 * handling a single, potentially long-lived connection.
1512 *
1513 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1514 * saved after the handshake to allow for more efficient serialization, so if
1515 * you don't need this feature you'll save RAM by disabling it.
1516 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001517 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1518 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001519 * Comment to disable the context serialization APIs.
1520 */
1521#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1522
1523/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001525 *
1526 * Enable the debug messages in SSL module for all issues.
1527 * Debug messages have been disabled in some places to prevent timing
1528 * attacks due to (unbalanced) debugging function calls.
1529 *
1530 * If you need all error reporting you should enable this during debugging,
1531 * but remove this for production servers that should log as well.
1532 *
1533 * Uncomment this macro to report all debug messages on errors introducing
1534 * a timing side-channel.
1535 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001537//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001538
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001539/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001540 *
1541 * Enable support for Encrypt-then-MAC, RFC 7366.
1542 *
1543 * This allows peers that both support it to use a more robust protection for
1544 * ciphersuites using CBC, providing deep resistance against timing attacks
1545 * on the padding or underlying cipher.
1546 *
1547 * This only affects CBC ciphersuites, and is useless if none is defined.
1548 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001549 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001550 *
1551 * Comment this macro to disable support for Encrypt-then-MAC
1552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001553#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001554
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001556 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001557 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1558 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001559 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001560 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001561 * attacks, but it is recommended to always use it (even if you disable
1562 * renegotiation), since it actually fixes a more fundamental issue in the
1563 * original SSL/TLS design, and has implications beyond Triple Handshake.
1564 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001565 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001566 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001567 * Comment this macro to disable support for Extended Master Secret.
1568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001570
Paul Bakkerd66f0702013-01-31 16:57:45 +01001571/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001572 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1573 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001574 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001575 * giving access to the peer's certificate after completion of the handshake.
1576 *
1577 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1578 * recommended to disable this option for reduced RAM usage.
1579 *
1580 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1581 * defined, but always returns \c NULL.
1582 *
1583 * \note This option has no influence on the protection against the
1584 * triple handshake attack. Even if it is disabled, Mbed TLS will
1585 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001586 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001587 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001588 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001589 *
1590 * Comment this macro to disable storing the peer's certificate
1591 * after the handshake.
1592 */
1593#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1594
1595/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001596 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001597 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001598 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001599 *
1600 * The two main uses of renegotiation are (1) refresh keys on long-lived
1601 * connections and (2) client authentication after the initial handshake.
1602 * If you don't need renegotiation, it's probably better to disable it, since
1603 * it has been associated with security issues in the past and is easy to
1604 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001605 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001606 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1607 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001608 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001609 *
1610 * \note Even if this option is disabled, both client and server are aware
1611 * of the Renegotiation Indication Extension (RFC 5746) used to
1612 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1613 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1614 * configuration of this extension).
1615 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001617#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001618
1619/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001620 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001621 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001622 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001623 *
1624 * Comment this macro to disable support for the max_fragment_length extension
1625 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001627
1628/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001629 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1630 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001631 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001632 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001633 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1634 *
1635 * Uncomment this macro to enable support for the record_size_limit extension
1636 */
1637//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1638
1639/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001641 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001642 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001643 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001644 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001645 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1646 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001647 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001648 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001649 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001650 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1651 * are only provided by PSA drivers, you must call psa_crypto_init() before
1652 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001653 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001654 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001655 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001656#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001657
1658/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001659 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001660 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001661 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001662 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001663 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001664 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001665 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001666 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001667 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001668 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001669 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1670 * directly performed by TLS 1.3 code. As a consequence, you must
1671 * call psa_crypto_init() before the first TLS 1.3 handshake.
1672 *
1673 * \note Cryptographic operations performed indirectly via another module
1674 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1675 * running handshake hash) only use PSA crypto if
1676 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001677 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001678 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001679 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001680#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001681
1682/**
Ronald Cronab65c522021-11-24 10:47:20 +01001683 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1684 *
1685 * Enable TLS 1.3 middlebox compatibility mode.
1686 *
1687 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1688 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1689 * expecting TLS 1.2 traffic.
1690 *
1691 * Turning on the compatibility mode comes at the cost of a few added bytes
1692 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1693 * that don't use it. Therefore, unless transmission bandwidth is critical and
1694 * you know that middlebox compatibility issues won't occur, it is therefore
1695 * recommended to set this option.
1696 *
1697 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001698 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1699 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001700 *
1701 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001702#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001703
1704/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001705 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1706 *
1707 * Enable TLS 1.3 PSK key exchange mode.
1708 *
1709 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1710 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1711 * effect on the build.
1712 *
1713 */
1714#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1715
1716/**
1717 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1718 *
1719 * Enable TLS 1.3 ephemeral key exchange mode.
1720 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001721 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001722 * MBEDTLS_X509_CRT_PARSE_C
1723 * and at least one of:
1724 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1725 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001726 *
1727 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1728 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1729 * effect on the build.
1730 *
1731 */
1732#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1733
1734/**
1735 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1736 *
1737 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1738 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001739 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001740 *
1741 * Comment to disable support for the PSK ephemeral key exchange mode in
1742 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1743 * have any effect on the build.
1744 *
1745 */
1746#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1747
1748/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 * \def MBEDTLS_SSL_EARLY_DATA
1750 *
1751 * Enable support for RFC 8446 TLS 1.3 early data.
1752 *
1753 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1754 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1755 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1756 *
1757 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1758 * is not enabled, this option does not have any effect on the build.
1759 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001760 * \note The maximum amount of early data can be set with
1761 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1762 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001764//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001765
1766/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001768 *
1769 * Enable support for DTLS (all available versions).
1770 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001771 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001772 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001773 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001774 *
1775 * Comment this macro to disable support for DTLS
1776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001777#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001778
1779/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001780 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001781 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001782 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001783 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001784 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001786#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001787
1788/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001789 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001790 *
1791 * Enable support for the anti-replay mechanism in DTLS.
1792 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793 * Requires: MBEDTLS_SSL_TLS_C
1794 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001795 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001796 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001797 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001798 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001799 * Comment this to disable anti-replay in DTLS.
1800 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001802
1803/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001805 *
1806 * Enable support for HelloVerifyRequest on DTLS servers.
1807 *
1808 * This feature is highly recommended to prevent DTLS servers being used as
1809 * amplifiers in DoS attacks against other hosts. It should always be enabled
1810 * unless you know for sure amplification cannot be a problem in the
1811 * environment in which your server operates.
1812 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001813 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001814 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001815 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001816 *
1817 * Comment this to disable support for HelloVerifyRequest.
1818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001820
1821/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001822 * \def MBEDTLS_SSL_DTLS_SRTP
1823 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001824 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001825 * through the use_srtp extension.
1826 *
1827 * \note This feature provides the minimum functionality required
1828 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1829 * the associated SRTP packet protection key material.
1830 * In particular, the SRTP packet protection itself, as well as the
1831 * demultiplexing of RTP and DTLS packets at the datagram layer
1832 * (see Section 5 of RFC 5764), are not handled by this feature.
1833 * Instead, after successful completion of a handshake negotiating
1834 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001835 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001836 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1837 * (this is implemented in the SSL example programs).
1838 * The resulting key should then be passed to an SRTP stack.
1839 *
1840 * Setting this option enables the runtime API
1841 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1842 * through which the supported DTLS-SRTP protection
1843 * profiles can be configured. You must call this API at
1844 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001845 *
1846 * Requires: MBEDTLS_SSL_PROTO_DTLS
1847 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001848 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001849 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001850//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001851
1852/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001853 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1854 *
1855 * Enable server-side support for clients that reconnect from the same port.
1856 *
1857 * Some clients unexpectedly close the connection and try to reconnect using the
1858 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001859 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001860 * flag enables that support.
1861 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001862 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001863 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001864 * Comment this to disable support for clients reusing the source port.
1865 */
1866#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1867
1868/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001870 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001871 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001872 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001873 * session store remains the responsibility of the application, though).
1874 * Server-side, you also need to provide callbacks for writing and parsing
1875 * tickets, including authenticated encryption and key management. Example
1876 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001877 *
1878 * Comment this macro to disable support for SSL session tickets
1879 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001880#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001881
1882/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001884 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001885 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001886 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001887 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001888 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001889 * Comment this macro to disable support for server name indication in SSL
1890 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001891#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001892
1893/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001894 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1895 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001896 * When this option is enabled, the SSL buffer will be resized automatically
1897 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001898 *
1899 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001900 */
1901//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1902
1903/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001904 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1905 *
1906 * Enable testing of the constant-flow nature of some sensitive functions with
1907 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001908 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001909 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001910 * This setting requires compiling with clang -fsanitize=memory. The test
1911 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001912 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001913 * \warning This macro is only used for extended testing; it is not considered
1914 * part of the library's API, so it may change or disappear at any time.
1915 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001916 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001917 */
1918//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1919
1920/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001921 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1922 *
1923 * Enable testing of the constant-flow nature of some sensitive functions with
1924 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001925 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001926 *
1927 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001928 * testing if the tests suites are run with valgrind's memcheck. This can be
1929 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1930 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001931 *
1932 * \warning This macro is only used for extended testing; it is not considered
1933 * part of the library's API, so it may change or disappear at any time.
1934 *
1935 * Uncomment to enable testing of the constant-flow nature of selected code.
1936 */
1937//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1938
1939/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001940 * \def MBEDTLS_TEST_HOOKS
1941 *
1942 * Enable features for invasive testing such as introspection functions and
1943 * hooks for fault injection. This enables additional unit tests.
1944 *
1945 * Merely enabling this feature should not change the behavior of the product.
1946 * It only adds new code, and new branching points where the default behavior
1947 * is the same as when this feature is disabled.
1948 * However, this feature increases the attack surface: there is an added
1949 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1950 * Therefore this feature must never be enabled in production.
1951 *
1952 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1953 * information.
1954 *
1955 * Uncomment to enable invasive tests.
1956 */
1957//#define MBEDTLS_TEST_HOOKS
1958
1959/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001960 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001961 *
1962 * Provide your own alternate threading implementation.
1963 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001965 *
1966 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001969
1970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001971 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001972 *
1973 * Enable the pthread wrapper layer for the threading layer.
1974 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001975 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001976 *
1977 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001978 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001979//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001980
1981/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001982 * \def MBEDTLS_USE_PSA_CRYPTO
1983 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001984 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1985 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001986 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001987 * \note Development of this option is currently in progress, and parts of Mbed
1988 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001989 * will still continue to work as usual, so enabling this option should not
1990 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001991 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001992 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001993 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1994 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001995 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001996 * \note An important and desirable effect of this option is that it allows
1997 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1998 * 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 +02001999 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002000 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2001 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002002 *
2003 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002004 *
2005 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002006 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002007 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002009//#define MBEDTLS_USE_PSA_CRYPTO
2010
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002011/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002012 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2013 *
John Durkop185764f2020-10-12 21:32:12 -07002014 * This setting allows support for cryptographic mechanisms through the PSA
2015 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002016 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002017 * When this option is disabled, the PSA API exposes the cryptographic
2018 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2019 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002020 *
2021 * When this option is enabled, the PSA API exposes the cryptographic
2022 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2023 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2024 * automatically enabled if required (i.e. if no PSA driver provides the
2025 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2026 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002027 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002028 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002029 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002030 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002031 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2032 * symbols is not completely finalized yet, and the configuration
2033 * tooling is not ideally adapted to having two separate configuration
2034 * files.
2035 * Future minor releases of Mbed TLS may make minor changes to those
2036 * symbols, but we will endeavor to provide a transition path.
2037 * Nonetheless, this option is considered mature enough to use in
2038 * production, as long as you accept that you may need to make
2039 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002040 */
2041//#define MBEDTLS_PSA_CRYPTO_CONFIG
2042
2043/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002044 * \def MBEDTLS_VERSION_FEATURES
2045 *
2046 * Allow run-time checking of compile-time enabled features. Thus allowing users
2047 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002048 * support via mbedtls_version_check_feature().
2049 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002050 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002051 *
2052 * Comment this to disable run-time checking and save ROM space
2053 */
2054#define MBEDTLS_VERSION_FEATURES
2055
2056/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002057 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2058 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002059 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002060 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2061 * the set of trusted certificates through a callback instead of a linked
2062 * list.
2063 *
2064 * This is useful for example in environments where a large number of trusted
2065 * certificates is present and storing them in a linked list isn't efficient
2066 * enough, or when the set of trusted certificates changes frequently.
2067 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002068 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002069 * `mbedtls_ssl_conf_ca_cb()` for more information.
2070 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002071 * Requires: MBEDTLS_X509_CRT_PARSE_C
2072 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002073 * Uncomment to enable trusted certificate callbacks.
2074 */
2075//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2076
2077/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002078 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002079 *
Chris Jones2c745862020-12-16 11:41:06 +00002080 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002081 *
Chris Jones2c745862020-12-16 11:41:06 +00002082 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002083 * and other functions/constants only used by these functions, thus reducing
2084 * the code footprint by several KB.
2085 */
Chris Jones2c745862020-12-16 11:41:06 +00002086//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002087
2088/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002089 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002090 *
2091 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2092 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2093 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002094 * Requires: MBEDTLS_PKCS1_V21
2095 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002096 * Comment this macro to disallow using RSASSA-PSS in certificates.
2097 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002098#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002099/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002100
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002101/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002102 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002103 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002104 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002105 * \{
2106 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002107
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002108/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002110 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002111 * Enable AES-NI support on x86-64 or x86-32.
2112 *
2113 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002114 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002115 * - GCC, x86-64, target not explicitly supporting AESNI:
2116 * requires MBEDTLS_HAVE_ASM.
2117 * - GCC, x86-32, target not explicitly supporting AESNI:
2118 * not supported.
2119 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2120 * For this assembly-less implementation, you must currently compile
2121 * `library/aesni.c` and `library/aes.c` with machine options to enable
2122 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2123 * `clang -maes -mpclmul`.
2124 * - Non-x86 targets: this option is silently ignored.
2125 * - Other compilers: this option is silently ignored.
2126 *
2127 * \note
2128 * Above, "GCC" includes compatible compilers such as Clang.
2129 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002130 *
2131 * Module: library/aesni.c
2132 * Caller: library/aes.c
2133 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002134 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002135 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002136 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002138#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002139
2140/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002141 * \def MBEDTLS_AESCE_C
2142 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002143 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002144 *
2145 * Module: library/aesce.c
2146 * Caller: library/aes.c
2147 *
Jerry Yuf015a932023-04-25 10:38:03 +08002148 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002149 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002150 * \warning Runtime detection only works on Linux. For non-Linux operating
2151 * system, Armv8-A Cryptographic Extensions must be supported by
2152 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002153 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002154 * \note Minimum compiler versions for this feature when targeting aarch64
2155 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2156 * Minimum compiler versions for this feature when targeting 32-bit
2157 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002158 *
2159 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2160 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002161 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002162 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002163 */
2164#define MBEDTLS_AESCE_C
2165
2166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002168 *
2169 * Enable the AES block cipher.
2170 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002171 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002172 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002173 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002174 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002175 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002176 * This module enables the following ciphersuites (if other requisites are
2177 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2179 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2180 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2181 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2182 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2183 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2184 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2185 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2186 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2187 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2188 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2189 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2190 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2191 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2192 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2193 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2194 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2195 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2196 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2197 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2198 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2199 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2200 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2201 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2202 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2203 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2204 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2205 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2206 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2207 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2208 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2209 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2210 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2211 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2212 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2213 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2214 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2215 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2216 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2217 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2218 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2219 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2220 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2221 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2222 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2223 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2224 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2225 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2226 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2227 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2228 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2229 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2230 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2231 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2232 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2233 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2234 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2235 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002236 *
Paul Bakkercff68422013-09-15 20:43:33 +02002237 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002239#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002240
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002241/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002242 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002243 *
2244 * Enable the generic ASN1 parser.
2245 *
2246 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002247 * Caller: library/x509.c
2248 * library/dhm.c
2249 * library/pkcs12.c
2250 * library/pkcs5.c
2251 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002254
2255/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002256 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002257 *
2258 * Enable the generic ASN1 writer.
2259 *
2260 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002261 * Caller: library/ecdsa.c
2262 * library/pkwrite.c
2263 * library/x509_create.c
2264 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002265 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002268
2269/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002271 *
2272 * Enable the Base64 module.
2273 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002274 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002275 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002276 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002277 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002278 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002279#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002280
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002281/**
Yanray Wange367e472023-10-31 17:23:04 +08002282 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2283 *
2284 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2285 *
2286 * \note This feature is incompatible with insecure block cipher,
2287 * MBEDTLS_DES_C, and cipher modes which always require decryption
2288 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002289 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2290 * this feature is incompatible with following supported PSA equivalence,
2291 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2292 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002293 *
2294 * Module: library/aes.c
2295 * library/aesce.c
2296 * library/aesni.c
2297 * library/aria.c
2298 * library/camellia.c
2299 * library/cipher.c
2300 */
2301//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2302
2303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002304 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002305 *
Paul Bakker9a736322012-11-14 12:39:52 +00002306 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002307 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002308 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002309 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002310 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002311 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002312 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002313 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002314 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002315 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002316 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002317 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002318 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002319 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002320 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002322
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002323/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002325 *
2326 * Enable the Camellia block cipher.
2327 *
Paul Bakker38119b12009-01-10 23:31:23 +00002328 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002329 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002330 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002331 * This module enables the following ciphersuites (if other requisites are
2332 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002333 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2334 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2335 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2336 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2337 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2338 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2339 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2340 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2341 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2342 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2343 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2344 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2345 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2346 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2347 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2348 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2349 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2350 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2351 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2352 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2353 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2354 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2355 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2356 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2357 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2358 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2359 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2360 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2361 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2362 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2363 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2364 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2365 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2366 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2367 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2368 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2369 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2370 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2371 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2372 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2373 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2374 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002375 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002376#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002377
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002378/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002379 * \def MBEDTLS_ARIA_C
2380 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002381 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002382 *
2383 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002384 * Caller: library/cipher.c
2385 *
2386 * This module enables the following ciphersuites (if other requisites are
2387 * enabled as well):
2388 *
2389 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2390 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2391 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2392 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2393 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2394 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2395 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2396 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2397 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2398 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2399 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2400 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2401 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2402 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2403 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2404 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2405 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2406 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2407 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2408 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2409 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2410 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2411 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2412 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2413 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2414 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2415 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2416 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2417 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2418 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2419 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2420 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2421 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2422 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2423 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2424 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2425 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2426 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002427 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002428#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002429
2430/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002432 *
2433 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2434 *
2435 * Module: library/ccm.c
2436 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002437 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2438 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002439 *
2440 * This module enables the AES-CCM ciphersuites, if other requisites are
2441 * enabled as well.
2442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002444
2445/**
Daniel King34b822c2016-05-15 17:28:08 -03002446 * \def MBEDTLS_CHACHA20_C
2447 *
2448 * Enable the ChaCha20 stream cipher.
2449 *
2450 * Module: library/chacha20.c
2451 */
2452#define MBEDTLS_CHACHA20_C
2453
2454/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002455 * \def MBEDTLS_CHACHAPOLY_C
2456 *
2457 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2458 *
2459 * Module: library/chachapoly.c
2460 *
2461 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2462 */
2463#define MBEDTLS_CHACHAPOLY_C
2464
2465/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002467 *
2468 * Enable the generic cipher layer.
2469 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002470 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002471 * Caller: library/ccm.c
2472 * library/cmac.c
2473 * library/gcm.c
2474 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002475 * library/pkcs12.c
2476 * library/pkcs5.c
2477 * library/psa_crypto_aead.c
2478 * library/psa_crypto_mac.c
2479 * library/ssl_ciphersuites.c
2480 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002481 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002482 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2483 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002484 *
2485 * Uncomment to enable generic cipher wrappers.
2486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002487#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002488
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002489/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002490 * \def MBEDTLS_CMAC_C
2491 *
Simon Butcher327398a2016-10-05 14:09:11 +01002492 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2493 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002494 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002495 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2496 * implementation of the CMAC algorithm is provided by an alternate
2497 * implementation, that alternate implementation may opt to not support
2498 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2499 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002500 * Module: library/cmac.c
2501 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002502 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002503 *
2504 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002505#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002506
2507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002508 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002509 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002510 * Enable the CTR_DRBG AES-based random generator.
2511 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002512 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002513 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002514 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2515 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2516 * is used.
2517 *
2518 * \warning When using PSA, the user should call `psa_crypto_init()` before
2519 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2520 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002521 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2522 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002523 * \note To achieve a 256-bit security strength with CTR_DRBG,
2524 * you must use AES-256 *and* use sufficient entropy.
2525 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002526 *
2527 * Module: library/ctr_drbg.c
2528 * Caller:
2529 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002530 * Requires: MBEDTLS_AES_C or
2531 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2532 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002533 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002534 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002536#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002537
2538/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002540 *
2541 * Enable the debug functions.
2542 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002543 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002544 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002545 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002546 * library/ssl_tls12_*.c
2547 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002548 *
2549 * This module provides debugging functions.
2550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002552
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002553/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002555 *
2556 * Enable the DES block cipher.
2557 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002558 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002559 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002560 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002561 *
Paul Bakkercff68422013-09-15 20:43:33 +02002562 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002563 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002564 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002565 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002568
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002569/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002571 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002572 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002573 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002574 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002575 * Caller: library/ssl_tls.c
2576 * library/ssl*_client.c
2577 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002578 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002579 * This module is used by the following key exchanges:
2580 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002581 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002582 * \warning Using DHE constitutes a security risk as it
2583 * is not possible to validate custom DH parameters.
2584 * If possible, it is recommended users should consider
2585 * preferring other methods of key exchange.
2586 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002587 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002588 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002590
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002591/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002593 *
2594 * Enable the elliptic curve Diffie-Hellman library.
2595 *
2596 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002597 * Caller: library/psa_crypto.c
2598 * library/ssl_tls.c
2599 * library/ssl*_client.c
2600 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002601 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002602 * This module is used by the following key exchanges:
2603 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002604 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002605 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002606 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002608
2609/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002610 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002611 *
2612 * Enable the elliptic curve DSA library.
2613 *
2614 * Module: library/ecdsa.c
2615 * Caller:
2616 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002617 * This module is used by the following key exchanges:
2618 * ECDHE-ECDSA
2619 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002620 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2621 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2622 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002625
2626/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002627 * \def MBEDTLS_ECJPAKE_C
2628 *
2629 * Enable the elliptic curve J-PAKE library.
2630 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002631 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2632 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002633 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002634 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002635 * Module: library/ecjpake.c
2636 * Caller:
2637 *
2638 * This module is used by the following key exchanges:
2639 * ECJPAKE
2640 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002641 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002642 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002643 * \warning If using a hash that is only provided by PSA drivers, you must
2644 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002645 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002646#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002647
2648/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002650 *
2651 * Enable the elliptic curve over GF(p) library.
2652 *
2653 * Module: library/ecp.c
2654 * Caller: library/ecdh.c
2655 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002656 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002657 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002659 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002661
2662/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002664 *
2665 * Enable the platform-specific entropy code.
2666 *
2667 * Module: library/entropy.c
2668 * Caller:
2669 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002671 *
2672 * This module provides a generic entropy pool
2673 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002675
2676/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002678 *
2679 * Enable error code to error string conversion.
2680 *
2681 * Module: library/error.c
2682 * Caller:
2683 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002687
2688/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002690 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002691 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002692 *
2693 * Module: library/gcm.c
2694 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002695 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2696 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002697 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002698 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2699 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002700 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002701#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002702
2703/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002704 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002705 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002706 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002707 * Can significantly increase throughput on systems without GCM hardware
2708 * acceleration (e.g., AESNI, AESCE).
2709 *
Matthias Schulz78266782024-02-08 13:54:48 +01002710 * The mbedtls_gcm_context size will increase by 3840 bytes.
2711 * The code size will increase by roughly 344 bytes.
2712 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002713 * Module: library/gcm.c
2714 *
2715 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002716 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002717//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002718
2719/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002720 * \def MBEDTLS_HKDF_C
2721 *
2722 * Enable the HKDF algorithm (RFC 5869).
2723 *
2724 * Module: library/hkdf.c
2725 * Caller:
2726 *
2727 * Requires: MBEDTLS_MD_C
2728 *
2729 * This module adds support for the Hashed Message Authentication Code
2730 * (HMAC)-based key derivation function (HKDF).
2731 */
2732#define MBEDTLS_HKDF_C
2733
2734/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002736 *
2737 * Enable the HMAC_DRBG random generator.
2738 *
2739 * Module: library/hmac_drbg.c
2740 * Caller:
2741 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002742 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002743 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002744 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002747
2748/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002749 * \def MBEDTLS_LMS_C
2750 *
2751 * Enable the LMS stateful-hash asymmetric signature algorithm.
2752 *
2753 * Module: library/lms.c
2754 * Caller:
2755 *
Raef Colesab4f8742022-09-01 12:24:31 +01002756 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002757 *
Raef Colesab4f8742022-09-01 12:24:31 +01002758 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002759 */
2760#define MBEDTLS_LMS_C
2761
2762/**
Raef Colesab4f8742022-09-01 12:24:31 +01002763 * \def MBEDTLS_LMS_PRIVATE
2764 *
2765 * Enable LMS private-key operations and signing code. Functions enabled by this
2766 * option are experimental, and should not be used in production.
2767 *
2768 * Requires: MBEDTLS_LMS_C
2769 *
2770 * Uncomment to enable the LMS signature algorithm and private key operations.
2771 */
Raef Coles5127e852022-10-07 10:35:56 +01002772//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002773
2774/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002775 * \def MBEDTLS_NIST_KW_C
2776 *
2777 * Enable the Key Wrapping mode for 128-bit block ciphers,
2778 * as defined in NIST SP 800-38F. Only KW and KWP modes
2779 * are supported. At the moment, only AES is approved by NIST.
2780 *
2781 * Module: library/nist_kw.c
2782 *
2783 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2784 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002785#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002786
2787/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002788 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002789 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002790 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002791 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002792 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2793 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002794 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002795 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002796 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002797 * Caller: library/constant_time.c
2798 * library/ecdsa.c
2799 * library/ecjpake.c
2800 * library/hkdf.c
2801 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002802 * library/pk.c
2803 * library/pkcs5.c
2804 * library/pkcs12.c
2805 * library/psa_crypto_ecp.c
2806 * library/psa_crypto_rsa.c
2807 * library/rsa.c
2808 * library/ssl_cookie.c
2809 * library/ssl_msg.c
2810 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002811 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002812 * library/x509_crt.c
2813 * library/x509write_crt.c
2814 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002815 *
2816 * Uncomment to enable generic message digest wrappers.
2817 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002819
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002820/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002822 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002823 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002824 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002825 * Module: library/md5.c
2826 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002827 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002828 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002829 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002830 * This module is required for TLS 1.2 depending on the handshake parameters.
2831 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2832 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002833 *
2834 * \warning MD5 is considered a weak message digest and its use constitutes a
2835 * security risk. If possible, we recommend avoiding dependencies on
2836 * it, and considering stronger message digests instead.
2837 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002838 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002840
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002841/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002843 *
2844 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002845 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002846 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002847 *
2848 * Module: library/memory_buffer_alloc.c
2849 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002851 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002852 *
2853 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002854 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002856
2857/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002859 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002860 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2861 *
Simon Butcherd567a232016-03-09 20:19:21 +00002862 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2863 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002864 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002865 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002866 * \note See also our Knowledge Base article about porting to a new
2867 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002868 * 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 +00002869 *
Andres AG788aa4a2016-09-14 14:32:09 +01002870 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002871 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002872 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002873 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002875
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002876/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002878 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002879 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002880 *
2881 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002882 * Caller: library/asn1write.c
2883 * library/pkcs5.c
2884 * library/pkparse.c
2885 * library/pkwrite.c
2886 * library/rsa.c
2887 * library/x509.c
2888 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002889 * library/x509_crl.c
2890 * library/x509_crt.c
2891 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002892 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002893 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002894 *
2895 * This modules translates between OIDs and internal values.
2896 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002897#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002898
2899/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002900 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002901 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002902 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002903 *
2904 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002905 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002906 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002907 * library/x509_crl.c
2908 * library/x509_crt.c
2909 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002910 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002912 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2913 *
2914 * \warning When parsing password-protected files, if MD5 is provided only by
2915 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002916 *
Paul Bakkercff68422013-09-15 20:43:33 +02002917 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002918 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002920
2921/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002923 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002924 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002925 *
2926 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002927 * Caller: library/pkwrite.c
2928 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002929 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002930 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002932 *
2933 * This modules adds support for encoding / writing PEM files.
2934 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002935#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002936
2937/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002939 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002940 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002941 *
2942 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002943 * Caller: library/psa_crypto_rsa.c
2944 * library/ssl_tls.c
2945 * library/ssl*_client.c
2946 * library/ssl*_server.c
2947 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002948 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002949 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002950 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002951 * Uncomment to enable generic public key wrappers.
2952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002954
2955/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002957 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002958 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002959 *
2960 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002961 * Caller: library/x509_crt.c
2962 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002963 *
Yanray Wang072a0682023-12-05 10:53:04 +08002964 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002965 *
2966 * Uncomment to enable generic public key parse functions.
2967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002969
2970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002972 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002973 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002974 *
2975 * Module: library/pkwrite.c
2976 * Caller: library/x509write.c
2977 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002978 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002979 *
2980 * Uncomment to enable generic public key write functions.
2981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002983
2984/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002986 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002987 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002988 *
2989 * Module: library/pkcs5.c
2990 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002991 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002992 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002993 * \warning If using a hash that is only provided by PSA drivers, you must
2994 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002995 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002996 * This module adds support for the PKCS#5 functions.
2997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002999
3000/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003001 * \def MBEDTLS_PKCS7_C
3002 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003003 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003004 * RFC Link - https://tools.ietf.org/html/rfc2315
3005 *
3006 * Module: library/pkcs7.c
3007 *
3008 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003009 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3010 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003011 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003012 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003013 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003014#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003015
3016/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003018 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003019 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003020 * Adds algorithms for parsing PKCS#8 encrypted private keys
3021 *
3022 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003023 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003024 *
Valerio Settie98ad592023-12-28 10:42:12 +01003025 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3026 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003027 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003028 * \warning If using a hash that is only provided by PSA drivers, you must
3029 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003030 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003031 * This module enables PKCS#12 functions.
3032 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003034
3035/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003037 *
3038 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003039 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003040 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3042 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003043 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003044 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003045 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003046 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003047 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003048 * Module: library/platform.c
3049 * Caller: Most other .c files
3050 *
3051 * This module enables abstraction of common (libc) functions.
3052 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003053#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003054
3055/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003056 * \def MBEDTLS_POLY1305_C
3057 *
3058 * Enable the Poly1305 MAC algorithm.
3059 *
3060 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003061 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003062 */
3063#define MBEDTLS_POLY1305_C
3064
3065/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003066 * \def MBEDTLS_PSA_CRYPTO_C
3067 *
3068 * Enable the Platform Security Architecture cryptography API.
3069 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003070 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003071 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003072 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003073 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003074 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3075 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3076 * is enabled in PSA (unless it's fully accelerated, see
3077 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003078 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003079#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003080
3081/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003082 * \def MBEDTLS_PSA_CRYPTO_SE_C
3083 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003084 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003085 * cryptography API.
3086 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003087 * \deprecated This feature is deprecated. Please switch to the PSA driver
3088 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003089 *
Ryan Everett32a64582024-03-05 18:16:18 +00003090 * \warning This feature is not thread-safe, and should not be used in a
3091 * multi-threaded environment.
3092 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003093 * Module: library/psa_crypto_se.c
3094 *
3095 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3096 *
3097 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003098//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003099
3100/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003101 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3102 *
3103 * Enable the Platform Security Architecture persistent key storage.
3104 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003105 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003106 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003107 * Requires: MBEDTLS_PSA_CRYPTO_C,
3108 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3109 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003110 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003111#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003112
3113/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003114 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003115 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003116 * Enable the emulation of the Platform Security Architecture
3117 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003118 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003119 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003120 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003121 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003122 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003123#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003124
3125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003126 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003127 *
3128 * Enable the RIPEMD-160 hash algorithm.
3129 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003130 * Module: library/ripemd160.c
3131 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003132 *
3133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003135
3136/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003138 *
3139 * Enable the RSA public-key cryptosystem.
3140 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003141 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003142 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003143 * Caller: library/pk.c
3144 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003145 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003146 * library/ssl*_client.c
3147 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003148 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003149 * This module is used by the following key exchanges:
3150 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003151 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003152 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003153 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003155
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003158 *
3159 * Enable the SHA1 cryptographic hash algorithm.
3160 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003161 * Module: library/sha1.c
3162 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003163 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003164 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003165 * This module is required for TLS 1.2 depending on the handshake parameters,
3166 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003167 *
3168 * \warning SHA-1 is considered a weak message digest and its use constitutes
3169 * a security risk. If possible, we recommend avoiding dependencies
3170 * on it, and considering stronger message digests instead.
3171 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003172 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003173#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003174
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003175/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003176 * \def MBEDTLS_SHA224_C
3177 *
3178 * Enable the SHA-224 cryptographic hash algorithm.
3179 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003180 * Module: library/sha256.c
3181 * Caller: library/md.c
3182 * library/ssl_cookie.c
3183 *
3184 * This module adds support for SHA-224.
3185 */
3186#define MBEDTLS_SHA224_C
3187
3188/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003189 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003190 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003191 * Enable the SHA-256 cryptographic hash algorithm.
3192 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003193 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003194 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003195 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003196 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003197 * library/ssl*_client.c
3198 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003199 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003200 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003201 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003203#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003204
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003205/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003206 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003207 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003208 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3209 * with the ARMv8 cryptographic extensions if they are available at runtime.
3210 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003211 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003212 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003213 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003214 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003215 * \note Minimum compiler versions for this feature are Clang 4.0,
3216 * armclang 6.6 or GCC 6.0.
3217 *
3218 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3219 * armclang <= 6.9
3220 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003221 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3222 * That name is deprecated, but may still be used as an alternative form for this
3223 * option.
3224 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003225 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3226 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003227 *
3228 * Requires: MBEDTLS_SHA256_C.
3229 *
3230 * Module: library/sha256.c
3231 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003232 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003233 * and use them if available.
3234 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003235//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003236
Dave Rodgmand85277c2023-10-13 09:22:54 +01003237/**
3238 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3239 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003240 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003241 * This name is now deprecated, but may still be used as an alternative form for
3242 * this option.
3243 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003244//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3245
3246/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003247 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003248 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003249 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3250 * with the ARMv8 cryptographic extensions, which must be available at runtime
3251 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003252 *
3253 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003254 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003255 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003256 * \note Minimum compiler versions for this feature are Clang 4.0,
3257 * armclang 6.6 or GCC 6.0.
3258 *
3259 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3260 * armclang <= 6.9
3261 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003262 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003263 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003264 * option.
3265 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003266 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3267 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003268 *
3269 * Requires: MBEDTLS_SHA256_C.
3270 *
3271 * Module: library/sha256.c
3272 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003273 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003274 * unconditionally.
3275 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003276//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003277
Dave Rodgmand85277c2023-10-13 09:22:54 +01003278/**
3279 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3280 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003281 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003282 * This name is now deprecated, but may still be used as an alternative form for
3283 * this option.
3284 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003285//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3286
3287/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003288 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003289 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003290 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003291 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003292 * Module: library/sha512.c
3293 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003294 * library/psa_crypto_hash.c
3295 * library/ssl_tls.c
3296 * library/ssl*_client.c
3297 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003298 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003299 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003300 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003301#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003302
3303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003305 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003306 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003307 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003308 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003309 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003310 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003311 * library/ssl_tls.c
3312 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003313 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003314 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003317
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003318/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003319 * \def MBEDTLS_SHA3_C
3320 *
3321 * Enable the SHA3 cryptographic hash algorithm.
3322 *
3323 * Module: library/sha3.c
3324 *
3325 * This module adds support for SHA3.
3326 */
3327#define MBEDTLS_SHA3_C
3328
3329/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003330 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3331 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003332 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3333 * with the ARMv8 cryptographic extensions if they are available at runtime.
3334 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003335 *
3336 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3337 * for a non-Aarch64 build it will be silently ignored.
3338 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003339 * \note Minimum compiler versions for this feature are Clang 7.0,
3340 * armclang 6.9 or GCC 8.0.
3341 *
3342 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3343 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003344 *
3345 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3346 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3347 *
3348 * Requires: MBEDTLS_SHA512_C.
3349 *
3350 * Module: library/sha512.c
3351 *
3352 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3353 * and use them if available.
3354 */
3355//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3356
3357/**
3358 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3359 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003360 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3361 * with the ARMv8 cryptographic extensions, which must be available at runtime
3362 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003363 *
3364 * \note This allows builds with a smaller code size than with
3365 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3366 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003367 * \note Minimum compiler versions for this feature are Clang 7.0,
3368 * armclang 6.9 or GCC 8.0.
3369 *
3370 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3371 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003372 *
3373 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3374 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3375 *
3376 * Requires: MBEDTLS_SHA512_C.
3377 *
3378 * Module: library/sha512.c
3379 *
3380 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3381 * unconditionally.
3382 */
3383//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3384
3385/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003387 *
3388 * Enable simple SSL cache implementation.
3389 *
3390 * Module: library/ssl_cache.c
3391 * Caller:
3392 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003394 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003396
3397/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003399 *
3400 * Enable basic implementation of DTLS cookies for hello verification.
3401 *
3402 * Module: library/ssl_cookie.c
3403 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003404 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003406
3407/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003408 * \def MBEDTLS_SSL_TICKET_C
3409 *
3410 * Enable an implementation of TLS server-side callbacks for session tickets.
3411 *
3412 * Module: library/ssl_ticket.c
3413 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003414 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003415 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3416 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003417 */
3418#define MBEDTLS_SSL_TICKET_C
3419
3420/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003421 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003422 *
3423 * Enable the SSL/TLS client code.
3424 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003425 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003426 * Caller:
3427 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003429 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003430 * This module is required for SSL/TLS client support.
3431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003432#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003433
Paul Bakker9a736322012-11-14 12:39:52 +00003434/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003436 *
3437 * Enable the SSL/TLS server code.
3438 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003439 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003440 * Caller:
3441 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003442 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003443 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003444 * This module is required for SSL/TLS server support.
3445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003447
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003448/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003449 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003450 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003451 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003452 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003453 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003454 * Caller: library/ssl*_client.c
3455 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003456 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003457 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3458 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003459 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003460 * This module is required for SSL/TLS.
3461 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003463
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003464/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003466 *
3467 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003468 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003469 * contexts are not shared between threads. If you do intend to use contexts
3470 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003471 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003472 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003473 *
3474 * Module: library/threading.c
3475 *
3476 * This allows different threading implementations (self-implemented or
3477 * provided).
3478 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003479 * You will have to enable either MBEDTLS_THREADING_ALT or
3480 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003481 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003482 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003484//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003485
3486/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003488 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003489 * Enable the semi-portable timing interface.
3490 *
Simon Butcherd567a232016-03-09 20:19:21 +00003491 * \note The provided implementation only works on POSIX/Unix (including Linux,
3492 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003493 * module and provide your own implementations of the callbacks needed by
3494 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3495 * your own implementation of the whole module by setting
3496 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003497 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003498 * \note The timing module will include time.h on suitable platforms
3499 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3500 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3501 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003502 * \note See also our Knowledge Base article about porting to a new
3503 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003504 * 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 +00003505 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003506 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003509
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003510/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003511 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003512 *
3513 * Enable run-time version information.
3514 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003515 * Module: library/version.c
3516 *
3517 * This module provides run-time version information.
3518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003520
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003521/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003523 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003524 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003525 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003526 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003527 * Caller: library/x509_crl.c
3528 * library/x509_crt.c
3529 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003530 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003531 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003532 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3533 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003534 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3535 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003536 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003537 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003539#define MBEDTLS_X509_USE_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_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003543 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003544 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003545 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003546 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003547 * Caller: library/ssl_tls.c
3548 * library/ssl*_client.c
3549 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003550 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003551 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003552 *
3553 * This module is required for X.509 certificate parsing.
3554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003556
3557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003559 *
3560 * Enable X.509 CRL parsing.
3561 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003562 * Module: library/x509_crl.c
3563 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003564 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003565 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003566 *
3567 * This module is required for X.509 CRL parsing.
3568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570
3571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003573 *
3574 * Enable X.509 Certificate Signing Request (CSR) parsing.
3575 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003576 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003577 * Caller: library/x509_crt_write.c
3578 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003579 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003580 *
3581 * This module is used for reading X.509 certificate request.
3582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003583#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003584
3585/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003586 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003587 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003588 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003589 *
3590 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003591 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003592 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003593 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3594 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003595 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3596 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003597 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003598 * This module is the basis for creating X.509 certificates and CSRs.
3599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003600#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003601
3602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003604 *
3605 * Enable creating X.509 certificates.
3606 *
3607 * Module: library/x509_crt_write.c
3608 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003609 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003610 *
3611 * This module is required for X.509 certificate creation.
3612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003613#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003614
3615/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003617 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003618 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003619 *
3620 * Module: library/x509_csr_write.c
3621 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003622 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003623 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003624 * This module is required for X.509 certificate request writing.
3625 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003626#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003627
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003628/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003629
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003630/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003631 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003632 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003633 * This section contains Mbed TLS build settings that are not associated
3634 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003635 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003636 * \{
3637 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003638
Gilles Peskinea02c1242022-03-16 17:03:19 +01003639/**
3640 * \def MBEDTLS_CONFIG_FILE
3641 *
3642 * If defined, this is a header which will be included instead of
3643 * `"mbedtls/mbedtls_config.h"`.
3644 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003645 * Unlike other configuration options, this one must be defined on the
3646 * compiler command line: a definition in `mbedtls_config.h` would have
3647 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003648 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003649 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003650 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003651 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003652 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003653 * The value of this symbol is typically a path in double quotes, either
3654 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003655 */
3656//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3657
3658/**
3659 * \def MBEDTLS_USER_CONFIG_FILE
3660 *
3661 * If defined, this is a header which will be included after
3662 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003663 * This allows you to modify the default configuration, including the ability
3664 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003665 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003666 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003667 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003668 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003669 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003670 * The value of this symbol is typically a path in double quotes, either
3671 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003672 */
3673//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3674
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003675/**
3676 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3677 *
3678 * If defined, this is a header which will be included instead of
3679 * `"psa/crypto_config.h"`.
3680 * This header file specifies which cryptographic mechanisms are available
3681 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3682 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3683 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003684 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003685 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003686 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003687 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003688 * The value of this symbol is typically a path in double quotes, either
3689 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003690 */
3691//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3692
3693/**
3694 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3695 *
3696 * If defined, this is a header which will be included after
3697 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003698 * This allows you to modify the default configuration, including the ability
3699 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003700 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003701 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003702 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003703 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003704 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003705 * The value of this symbol is typically a path in double quotes, either
3706 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003707 */
3708//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3709
Gilles Peskineb1176f22023-02-22 22:07:28 +01003710/**
3711 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3712 *
3713 * If defined, this is a header which will be included instead of
3714 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3715 * as the one in Mbed TLS, but with definitions adapted to the platform on
3716 * which the library code will run.
3717 *
3718 * \note The required content of this header can vary from one version of
3719 * Mbed TLS to the next. Integrators who provide an alternative file
3720 * should review the changes in the original file whenever they
3721 * upgrade Mbed TLS.
3722 *
3723 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3724 * non-standard feature of the C language, so this feature is only available
3725 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3726 *
3727 * The value of this symbol is typically a path in double quotes, either
3728 * absolute or relative to a directory on the include search path.
3729 */
3730//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3731
3732/**
3733 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3734 *
3735 * If defined, this is a header which will be included instead of
3736 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3737 * as the one in Mbed TLS, but with definitions adapted to the environment
3738 * in which the library code will run. The typical use for this feature
3739 * is to provide alternative type definitions on the client side in
3740 * client-server integrations of PSA crypto, where operation structures
3741 * contain handles instead of cryptographic data.
3742 *
3743 * \note The required content of this header can vary from one version of
3744 * Mbed TLS to the next. Integrators who provide an alternative file
3745 * should review the changes in the original file whenever they
3746 * upgrade Mbed TLS.
3747 *
3748 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3749 * non-standard feature of the C language, so this feature is only available
3750 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3751 *
3752 * The value of this symbol is typically a path in double quotes, either
3753 * absolute or relative to a directory on the include search path.
3754 */
3755//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3756
Gilles Peskineba4162a2022-04-11 17:04:38 +02003757/** \} name SECTION: General configuration options */
3758
3759/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003760 * \name SECTION: Module configuration options
3761 *
3762 * This section allows for the setting of module specific sizes and
3763 * configuration options. The default values are already present in the
3764 * relevant header files and should suffice for the regular use cases.
3765 *
3766 * Our advice is to enable options and change their values here
3767 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003768 * \{
3769 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003770/* The Doxygen documentation here is used when a user comments out a
3771 * setting and runs doxygen themselves. On the other hand, when we typeset
3772 * the full documentation including disabled settings, the documentation
3773 * in specific modules' header files is used if present. When editing this
3774 * file, make sure that each option is documented in exactly one place,
3775 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3776 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003777
Paul Bakker088c5c52014-04-25 11:11:10 +02003778/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003779//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003780//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003781
Paul Bakker088c5c52014-04-25 11:11:10 +02003782/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003783//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3784//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3785//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3786//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3787//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003788
Paul Bakker088c5c52014-04-25 11:11:10 +02003789/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003790//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3791//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3792//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3793//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003794
Paul Bakker088c5c52014-04-25 11:11:10 +02003795/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003796//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003797//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003798
Paul Bakker088c5c52014-04-25 11:11:10 +02003799/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003800//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3801//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003802//#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 +01003803
Paul Bakker088c5c52014-04-25 11:11:10 +02003804/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003805//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003806
Paul Bakker088c5c52014-04-25 11:11:10 +02003807/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003808//#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 -04003809
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003810/** \def MBEDTLS_PLATFORM_STD_CALLOC
3811 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003812 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003813 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003814 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003815 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003816 * 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 -04003817 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3818 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003819 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003820 */
3821//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003822
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003823/** \def MBEDTLS_PLATFORM_STD_FREE
3824 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003825 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003826 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003827 * 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 -04003828 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3829 * 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 -04003830 */
3831//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003832//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003833//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003834//#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 +02003835//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3836//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003837/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003838//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003839//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3840//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003841//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3842//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3843//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003844
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003845/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003846/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003847//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3848//#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 +02003849//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003850//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003851//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3852//#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 +02003853//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3854//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003855/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003856//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003857//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003858//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3859//#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 +08003860//#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 +08003861//#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 +02003862
Gilles Peskine3f106f72021-09-23 17:42:39 +02003863/** \def MBEDTLS_CHECK_RETURN
3864 *
3865 * This macro is used at the beginning of the declaration of a function
3866 * to indicate that its return value should be checked. It should
3867 * instruct the compiler to emit a warning or an error if the function
3868 * is called without checking its return value.
3869 *
3870 * There is a default implementation for popular compilers in platform_util.h.
3871 * You can override the default implementation by defining your own here.
3872 *
3873 * If the implementation here is empty, this will effectively disable the
3874 * checking of functions' return values.
3875 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003876//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003877
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003878/** \def MBEDTLS_IGNORE_RETURN
3879 *
3880 * This macro requires one argument, which should be a C function call.
3881 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3882 * warning is suppressed.
3883 */
3884//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3885
Gilles Peskineed038902020-11-13 21:33:21 +01003886/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003887/**
Gilles Peskineed038902020-11-13 21:33:21 +01003888 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3889 * PSA crypto subsystem.
3890 *
3891 * If this option is unset:
3892 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003893 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003894 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3895 * on unspecified heuristics.
3896 */
3897//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3898
Steven Cooreman863470a2021-02-15 14:03:19 +01003899/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003900 * Restrict the PSA library to supporting a maximum amount of simultaneously
3901 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3902 * volatile key, or a persistent key which is loaded temporarily by the
3903 * library as part of a crypto operation in flight.
3904 *
3905 * If this option is unset, the library will fall back to a default value of
3906 * 32 keys.
3907 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003908//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003909
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003910/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003911//#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 +00003912
Paul Bakker088c5c52014-04-25 11:11:10 +02003913/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003914//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3915//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003916
Paul Bakker088c5c52014-04-25 11:11:10 +02003917/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003918
Angus Grattond8213d02016-05-25 20:56:48 +10003919/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3920 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003921 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003922 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003923 * This determines the size of the incoming TLS I/O buffer in such a way
3924 * that it is capable of holding the specified amount of plaintext data,
3925 * regardless of the protection mechanism used.
3926 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003927 * \note When using a value less than the default of 16KB on the client, it is
3928 * recommended to use the Maximum Fragment Length (MFL) extension to
3929 * inform the server about this limitation. On the server, there
3930 * is no supported, standardized way of informing the client about
3931 * restriction on the maximum size of incoming messages, and unless
3932 * the limitation has been communicated by other means, it is recommended
3933 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3934 * while keeping the default value of 16KB for the incoming buffer.
3935 *
David Horstmann95d516f2021-05-04 18:36:56 +01003936 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003937 */
3938//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3939
Gilles Peskined3d02902020-03-04 21:35:27 +01003940/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3941 *
3942 * The maximum length of CIDs used for incoming DTLS messages.
3943 *
3944 */
3945//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3946
3947/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3948 *
3949 * The maximum length of CIDs used for outgoing DTLS messages.
3950 *
3951 */
3952//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3953
TRodziewicze8dd7092021-05-12 14:19:11 +02003954/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003955 *
3956 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003957 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003958 *
3959 * The padding will always be chosen so that the length of the
3960 * padded plaintext is a multiple of the value of this option.
3961 *
3962 * Note: A value of \c 1 means that no padding will be used
3963 * for outgoing records.
3964 *
3965 * Note: On systems lacking division instructions,
3966 * a power of two should be preferred.
3967 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003968//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003969
Angus Grattond8213d02016-05-25 20:56:48 +10003970/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3971 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003972 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003973 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003974 * This determines the size of the outgoing TLS I/O buffer in such a way
3975 * that it is capable of holding the specified amount of plaintext data,
3976 * regardless of the protection mechanism used.
3977 *
Angus Grattond8213d02016-05-25 20:56:48 +10003978 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3979 * the default inward 16384 byte buffer to conform to the TLS specification.
3980 *
3981 * The minimum required outward buffer size is determined by the handshake
3982 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3983 * The specific size requirement depends on the configured ciphers and any
3984 * certificate data which is sent during the handshake.
3985 *
David Horstmann95d516f2021-05-04 18:36:56 +01003986 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003987 */
3988//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3989
Hanno Beckere0b150f2018-08-21 15:51:03 +01003990/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3991 *
3992 * Maximum number of heap-allocated bytes for the purpose of
3993 * DTLS handshake message reassembly and future message buffering.
3994 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003995 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003996 * to account for a reassembled handshake message of maximum size,
3997 * together with its reassembly bitmap.
3998 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003999 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004000 * should be sufficient for all practical situations as it allows
4001 * to reassembly a large handshake message (such as a certificate)
4002 * while buffering multiple smaller handshake messages.
4003 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004004 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004005//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004006
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004007//#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 +02004008//#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 +02004009
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004010/**
4011 * Complete list of ciphersuites to use, in order of preference.
4012 *
4013 * \warning No dependency checking is done on that field! This option can only
4014 * be used to restrict the set of available ciphersuites. It is your
4015 * responsibility to make sure the needed modules are active.
4016 *
4017 * Use this to save a few hundred bytes of ROM (default ordering of all
4018 * available ciphersuites) and a few to a few hundred bytes of RAM.
4019 *
4020 * The value below is only an example, not the default.
4021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004022//#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 +02004023
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004024/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004025 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4026 *
4027 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004028 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004029 *
4030 * It must be positive and smaller than UINT32_MAX.
4031 *
4032 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4033 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004034 */
4035//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4036
4037/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004038 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4039 *
Jerry Yucf913512023-11-14 11:06:52 +08004040 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004041 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004042 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004043 * - The client ticket age is the time difference between the time when the
4044 * client proposes to the server to use the ticket and the time the client
4045 * received the ticket from the server.
4046 * - The server ticket age is the time difference between the time when the
4047 * server receives a proposition from the client to use the ticket and the
4048 * time when the ticket was created by the server.
4049 *
Jerry Yucf913512023-11-14 11:06:52 +08004050 * The ages might be different due to the client and server clocks not running
4051 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4052 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4053 * 6s, thus in the worst case clients and servers must sync up their system time
4054 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004055 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004056 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004057 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004058//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004059
4060/**
4061 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4062 *
4063 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4064 *
4065 * This must be less than 256.
4066 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004067//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004068
4069/**
4070 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4071 *
4072 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4073 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4074 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4075 *
4076 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004077//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004078
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004079/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004080//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004081//#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 +01004082
Gilles Peskine611179c2022-04-13 23:04:48 +02004083/** \} name SECTION: Module configuration options */