blob: 83b9c92de8697caeed1965d0becc937629597958 [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
Ron Eldor466a57f2018-05-03 16:54:28 +0300354//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200355//#define MBEDTLS_MD5_ALT
356//#define MBEDTLS_RIPEMD160_ALT
357//#define MBEDTLS_SHA1_ALT
358//#define MBEDTLS_SHA256_ALT
359//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000360
Paul Bakker90995b52013-06-24 19:20:35 +0200361/**
TRodziewicz75628d52021-06-18 12:56:27 +0200362 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200364 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100365 * alternate core implementation of symmetric crypto or hash function. Keep in
366 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200367 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200368 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200369 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200370 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200371 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200372 * no longer provide the mbedtls_sha1_process() function, but it will still provide
373 * the other function (using your mbedtls_sha1_process() function) and the definition
374 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200375 * with this definition.
376 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200377 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100378 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
379 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200380 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200381 * Uncomment a macro to enable alternate implementation of the corresponding
382 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100383 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200384 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100385 * constitutes a security risk. If possible, we recommend avoiding
386 * dependencies on them, and considering stronger message digests
387 * and ciphers instead.
388 *
Janos Follath1231d212019-01-07 15:01:32 +0000389 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
390 * enabled, then the deterministic ECDH signature functions pass the
391 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
392 * alternative implementations should use the RNG only for generating
393 * the ephemeral key and nothing else. If this is not possible, then
394 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200395 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000396 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200397 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200398//#define MBEDTLS_MD5_PROCESS_ALT
399//#define MBEDTLS_RIPEMD160_PROCESS_ALT
400//#define MBEDTLS_SHA1_PROCESS_ALT
401//#define MBEDTLS_SHA256_PROCESS_ALT
402//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200403//#define MBEDTLS_DES_SETKEY_ALT
404//#define MBEDTLS_DES_CRYPT_ECB_ALT
405//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200406//#define MBEDTLS_AES_SETKEY_ENC_ALT
407//#define MBEDTLS_AES_SETKEY_DEC_ALT
408//#define MBEDTLS_AES_ENCRYPT_ALT
409//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300410//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300411//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300412//#define MBEDTLS_ECDSA_VERIFY_ALT
413//#define MBEDTLS_ECDSA_SIGN_ALT
414//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200415
416/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200417 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200418 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200419 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200420 * hardware entropy collector.
421 *
422 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000423 * prototype as declared in library/entropy_poll.h, and accept NULL as first
424 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200425 *
426 * Uncomment to use your own hardware entropy collector.
427 */
428//#define MBEDTLS_ENTROPY_HARDWARE_ALT
429
430/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000432 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100433 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000434 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100435 * Uncomment this macro to use precomputed AES tables stored in ROM.
436 * Comment this macro to generate AES tables in RAM at runtime.
437 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100438 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
439 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100440 * initialization time before the first AES operation can be performed.
441 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
442 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
443 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100444 *
445 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200447//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000448
449/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100450 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200451 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100452 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200453 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100454 * Uncommenting this macro omits 75% of the AES tables from
455 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
456 * by computing their values on the fly during operations
457 * (the tables are entry-wise rotations of one another).
458 *
459 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100460 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100461 * runtime. Specifically, one has to compare 4 accesses within
462 * different tables to 4 accesses with additional arithmetic
463 * operations within the same table. The performance gain/loss
464 * depends on the system and memory details.
465 *
466 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200467 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100468//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200469
470/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800471 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
472 *
473 * Use only 128-bit keys in AES operations to save ROM.
474 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800475 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800476 * or 256-bit keys.
477 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800478 * Uncommenting this macro reduces the size of AES code by ~300 bytes
479 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800480 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800481 * Module: library/aes.c
482 *
483 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800484 */
485//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
486
Gilles Peskinea8861e02023-09-05 20:20:51 +0200487/*
488 * Disable plain C implementation for AES.
489 *
490 * When the plain C implementation is enabled, and an implementation using a
491 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
492 * detection will be used to select between them.
493 *
494 * If only one implementation is present, runtime detection will not be used.
495 * This configuration will crash at runtime if running on a CPU without the
496 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
497 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
498 */
499//#define MBEDTLS_AES_USE_HARDWARE_ONLY
500
Arto Kinnunen732ca322023-04-14 14:26:10 +0800501/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200502 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200503 *
504 * Use less ROM for the Camellia implementation (saves about 768 bytes).
505 *
506 * Uncomment this macro to use less memory for Camellia.
507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200508//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200509
510/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200511 * \def MBEDTLS_CHECK_RETURN_WARNING
512 *
513 * If this macro is defined, emit a compile-time warning if application code
514 * calls a function without checking its return value, but the return value
515 * should generally be checked in portable applications.
516 *
517 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
518 * implemented. Otherwise this option has no effect.
519 *
520 * Uncomment to get warnings on using fallible functions without checking
521 * their return value.
522 *
523 * \note This feature is a work in progress.
524 * Warnings will be added to more functions in the future.
525 *
526 * \note A few functions are considered critical, and ignoring the return
527 * value of these functions will trigger a warning even if this
528 * macro is not defined. To completely disable return value check
529 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
530 */
531//#define MBEDTLS_CHECK_RETURN_WARNING
532
533/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200534 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200535 *
536 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200538#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200539
540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200541 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000542 *
543 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000546
547/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000549 *
550 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200552#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000553
554/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100555 * \def MBEDTLS_CIPHER_MODE_OFB
556 *
557 * Enable Output Feedback mode (OFB) for symmetric ciphers.
558 */
559#define MBEDTLS_CIPHER_MODE_OFB
560
561/**
562 * \def MBEDTLS_CIPHER_MODE_XTS
563 *
564 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
565 */
566#define MBEDTLS_CIPHER_MODE_XTS
567
568/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200569 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000570 *
571 * Enable NULL cipher.
572 * Warning: Only do so when you know what you are doing. This allows for
573 * encryption or channels without any security!
574 *
Ronald Croncee42702021-04-26 11:34:44 +0200575 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
577 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
578 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
579 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
580 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
581 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
582 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
583 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
584 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
585 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
586 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
587 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
588 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
589 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
590 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
591 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
592 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
593 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
594 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000595 *
596 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000599
600/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100601 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200602 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100603 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
604 * specific padding modes in the cipher layer with cipher modes that support
605 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200606 *
607 * If you disable all padding modes, only full blocks can be used with CBC.
608 *
609 * Enable padding modes in the cipher layer.
610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200611#define MBEDTLS_CIPHER_PADDING_PKCS7
612#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
613#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
614#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200615
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200616/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
617 *
618 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800619 * Without this, CTR_DRBG uses a 256-bit key
620 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200621 */
622//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
623
Paul Bakker48e93c82013-08-14 12:21:18 +0200624/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200625 * Enable the verified implementations of ECDH primitives from Project Everest
626 * (currently only Curve25519). This feature changes the layout of ECDH
627 * contexts and therefore is a compatibility break for applications that access
628 * fields of a mbedtls_ecdh_context structure directly. See also
629 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000630 *
631 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
632 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200633 */
634//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
635
636/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100637 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200638 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100639 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
640 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200641 *
642 * Comment macros to disable the curve and functions for it
643 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200644/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200645#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
646#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
647#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
648#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
649#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
650#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
651#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
652#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
653#define MBEDTLS_ECP_DP_BP256R1_ENABLED
654#define MBEDTLS_ECP_DP_BP384R1_ENABLED
655#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200656/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200657#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000658#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200659
660/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200662 *
663 * Enable specific 'modulo p' routines for each NIST prime.
664 * Depending on the prime and architecture, makes operations 4 to 8 times
665 * faster on the corresponding curve.
666 *
667 * Comment this macro to disable NIST curves optimisation.
668 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200669#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200670
671/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200672 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100673 *
674 * Enable "non-blocking" ECC operations that can return early and be resumed.
675 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200676 * This allows various functions to pause by returning
677 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
678 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
679 * order to further progress and eventually complete their operation. This is
680 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
681 * number of ECC operations a function may perform before pausing; see
682 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100683 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200684 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200685 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100686 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100687 * This option:
688 * - Adds xxx_restartable() variants of existing operations in the
689 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100690 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
691 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100692 * - ECDSA: signature generation & verification;
693 * - PK: signature generation & verification;
694 * - X509: certificate chain verification.
695 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
696 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
697 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
698 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000699 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100700 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100701 * - verification of the server's key exchange signature;
702 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100703 * - generation of the client's signature if client authentication is used,
704 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100705 *
706 * \note In the cases above, the usual SSL/TLS functions, such as
707 * mbedtls_ssl_handshake(), can now return
708 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200709 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100710 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
711 * restartable operations in PK, X.509 and TLS (see above) are not
712 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100713 * PSA, and are not restartable. These are temporary limitations that
714 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200715 *
Ron Eldor19779c42018-11-05 16:58:13 +0200716 * \note This option only works with the default software implementation of
717 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100718 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100719 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100720 * Requires: MBEDTLS_ECP_C
721 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100722 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100723 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200724//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100725
726/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200727 * Uncomment to enable using new bignum code in the ECC modules.
728 *
729 * \warning This is currently experimental, incomplete and therefore should not
730 * be used in production.
731 */
732//#define MBEDTLS_ECP_WITH_MPI_UINT
733
734/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200735 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100736 *
737 * Enable deterministic ECDSA (RFC 6979).
738 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
739 * may result in a compromise of the long-term signing key. This is avoided by
740 * the deterministic variant.
741 *
John Durkop36a82e52020-10-26 09:39:05 -0700742 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100743 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100744 * Comment this macro to disable deterministic ECDSA.
745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100747
748/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200749 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200750 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200751 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200752 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200753 * This enables the following ciphersuites (if other requisites are
754 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200755 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
756 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
757 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
758 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
759 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
760 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
761 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
762 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
763 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
764 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200765 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200767
768/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200770 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200771 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200772 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200773 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200774 *
775 * This enables the following ciphersuites (if other requisites are
776 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200777 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
778 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
779 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
780 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
781 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
782 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
783 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
784 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
785 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
786 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100787 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100788 * \warning Using DHE constitutes a security risk as it
789 * is not possible to validate custom DH parameters.
790 * If possible, it is recommended users should consider
791 * preferring other methods of key exchange.
792 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100793 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200794 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200795#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200796
797/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200799 *
800 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
801 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200802 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200803 *
804 * This enables the following ciphersuites (if other requisites are
805 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
807 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
808 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
809 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
810 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
811 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200814
815/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200816 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200817 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200818 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200819 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200820 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
821 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200822 *
823 * This enables the following ciphersuites (if other requisites are
824 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200825 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
826 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
827 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
828 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
829 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
830 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
831 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
832 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
833 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
834 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200835 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200836#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200837
838/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200840 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200841 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200842 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200843 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
844 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200845 *
846 * This enables the following ciphersuites (if other requisites are
847 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200848 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
849 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
850 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
851 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
852 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
853 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
854 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
855 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
856 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
857 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
858 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
859 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200860 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200861#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200862
863/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200864 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200865 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200866 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200867 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
869 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200870 *
871 * This enables the following ciphersuites (if other requisites are
872 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200873 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
874 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
875 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
876 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
877 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
878 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
879 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
880 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
881 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
882 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
883 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
884 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100885 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100886 * \warning Using DHE constitutes a security risk as it
887 * is not possible to validate custom DH parameters.
888 * If possible, it is recommended users should consider
889 * preferring other methods of key exchange.
890 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100891 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200892 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200893#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200894
895/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200897 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200898 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200899 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200900 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
901 * MBEDTLS_RSA_C
902 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200903 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200904 *
905 * This enables the following ciphersuites (if other requisites are
906 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
908 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
909 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
913 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
914 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
915 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
916 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200917 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200919
920/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200922 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200923 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200924 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200925 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
926 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
927 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200928 *
929 * This enables the following ciphersuites (if other requisites are
930 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
938 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
939 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
940 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200941 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200942#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200943
944/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100946 *
947 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
948 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200949 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
950 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
951 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100952 *
953 * This enables the following ciphersuites (if other requisites are
954 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
956 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
957 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
960 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
961 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
962 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
963 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
964 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200966#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100967
968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100970 *
971 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
972 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200973 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
974 * MBEDTLS_RSA_C
975 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100976 *
977 * This enables the following ciphersuites (if other requisites are
978 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200979 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
980 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
981 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
982 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
983 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
984 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
985 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
986 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
987 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
988 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100989 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100991
992/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200993 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
994 *
995 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
996 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200997 * \warning This is currently experimental. EC J-PAKE support is based on the
998 * Thread v1.0.0 specification; incompatible changes to the specification
999 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001000 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001001 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001002 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001003 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1004 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001005 * \warning If SHA-256 is provided only by a PSA driver, you must call
1006 * psa_crypto_init() before the first hanshake (even if
1007 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1008 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001009 * This enables the following ciphersuites (if other requisites are
1010 * enabled as well):
1011 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1012 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001013//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001014
1015/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001017 *
1018 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1019 * RFC 5915 and RFC 5480.
1020 *
1021 * Currently this means parsing the SpecifiedECDomain choice of EC
1022 * parameters (only known groups are supported, not arbitrary domains, to
1023 * avoid validation issues).
1024 *
1025 * Disable if you only need to support RFC 5915 + 5480 key formats.
1026 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001028
1029/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001030 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1031 *
1032 * Enable the support for parsing public keys of type Short Weierstrass
1033 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001034 * compressed point format. This parsing is done through ECP module's functions.
1035 *
1036 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1037 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1038 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001039 */
1040#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1041
1042/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001044 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045 * Enable a dummy error function to make use of mbedtls_strerror() in
1046 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1047 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001048 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1050 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001051 *
1052 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001056
1057/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001059 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001060 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001061 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001064#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001065
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001066/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001068 *
1069 * Enable functions that use the filesystem.
1070 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001071#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001072
1073/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001075 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001076 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001077 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001078 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001079 * application.
1080 *
1081 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001082 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001083//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001084
1085/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001087 *
1088 * Do not use built-in platform entropy functions.
1089 * This is useful if your platform does not support
1090 * standards like the /dev/urandom or Windows CryptoAPI.
1091 *
1092 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001093 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001095
1096/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001098 *
1099 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1100 * default SHA-512 based one (if both are available).
1101 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001103 *
1104 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1105 * if you have performance concerns.
1106 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107 * This option is only useful if both MBEDTLS_SHA256_C and
1108 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001109 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001110//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001111
1112/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001113 * \def MBEDTLS_ENTROPY_NV_SEED
1114 *
1115 * Enable the non-volatile (NV) seed file-based entropy source.
1116 * (Also enables the NV seed read/write functions in the platform layer)
1117 *
1118 * This is crucial (if not required) on systems that do not have a
1119 * cryptographic entropy source (in hardware or kernel) available.
1120 *
1121 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1122 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001123 * \note The read/write functions that are used by the entropy source are
1124 * determined in the platform layer, and can be modified at runtime and/or
1125 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1126 *
1127 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001128 * with regular fopen(), please make sure you make a seedfile with the
1129 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1130 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001131 * and written to or you will get an entropy source error! The default
1132 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1133 * bytes from the file.
1134 *
1135 * \note The entropy collector will write to the seed file before entropy is
1136 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001137 */
1138//#define MBEDTLS_ENTROPY_NV_SEED
1139
Ronald Cron71016a92020-08-28 19:01:50 +02001140/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001141 *
Ronald Cron71016a92020-08-28 19:01:50 +02001142 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001143 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001144 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1145 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001146 *
1147 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001148 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001149 */
Ronald Cron71016a92020-08-28 19:01:50 +02001150//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001151
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001154 *
1155 * Enable debugging of buffer allocator memory issues. Automatically prints
1156 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1157 * function for 'debug output' of allocated memory.
1158 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001160 *
1161 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001162 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001163//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001164
1165/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001167 *
1168 * Include backtrace information with each allocated block.
1169 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001171 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001172 *
1173 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001175//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001176
1177/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001179 *
1180 * Support external private RSA keys (eg from a HSM) in the PK layer.
1181 *
1182 * Comment this macro to disable support for external private RSA keys.
1183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001185
1186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001188 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001189 * Enable support for PKCS#1 v1.5 encoding.
1190 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001191 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001192 *
Paul Bakker48377d92013-08-30 12:06:24 +02001193 * This enables support for PKCS#1 v1.5 operations.
1194 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001196
1197/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001199 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001200 * Enable support for PKCS#1 v2.1 encoding.
1201 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001202 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001203 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001204 * \warning If using a hash that is only provided by PSA drivers, you must
1205 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001206 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001207 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1208 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001210
Steven Cooreman6801f082021-02-19 17:21:22 +01001211/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1212 *
1213 * Enable support for platform built-in keys. If you enable this feature,
1214 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1215 * See the documentation of that function for more information.
1216 *
1217 * Built-in keys are typically derived from a hardware unique key or
1218 * stored in a secure element.
1219 *
1220 * Requires: MBEDTLS_PSA_CRYPTO_C.
1221 *
1222 * \warning This interface is experimental and may change or be removed
1223 * without notice.
1224 */
1225//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1226
Ronald Cron3768ac12021-01-26 16:58:00 +01001227/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1228 *
1229 * Enable support for PSA crypto client.
1230 *
1231 * \note This option allows to include the code necessary for a PSA
1232 * crypto client when the PSA crypto implementation is not included in
1233 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1234 * code to set and get PSA key attributes.
1235 * The development of PSA drivers partially relying on the library to
1236 * fulfill the hardware gaps is another possible usage of this option.
1237 *
1238 * \warning This interface is experimental and may change or be removed
1239 * without notice.
1240 */
1241//#define MBEDTLS_PSA_CRYPTO_CLIENT
1242
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001243/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1244 *
1245 * Make the PSA Crypto module use an external random generator provided
1246 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1247 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001248 * \note This random generator must deliver random numbers with cryptographic
1249 * quality and high performance. It must supply unpredictable numbers
1250 * with a uniform distribution. The implementation of this function
1251 * is responsible for ensuring that the random generator is seeded
1252 * with sufficient entropy. If you have a hardware TRNG which is slow
1253 * or delivers non-uniform output, declare it as an entropy source
1254 * with mbedtls_entropy_add_source() instead of enabling this option.
1255 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001256 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001257 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1258 * and define a function called mbedtls_psa_external_get_random()
1259 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001260 * ```
1261 * psa_status_t mbedtls_psa_external_get_random(
1262 * mbedtls_psa_external_random_context_t *context,
1263 * uint8_t *output, size_t output_size, size_t *output_length);
1264 * );
1265 * ```
1266 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001267 * The function must fill the \c output buffer with \c output_size bytes
1268 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001269 *
1270 * Requires: MBEDTLS_PSA_CRYPTO_C
1271 *
1272 * \warning If you enable this option, code that uses the PSA cryptography
1273 * interface will not use any of the entropy sources set up for
1274 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1275 * enables.
1276 *
1277 * \note This option is experimental and may be removed without notice.
1278 */
1279//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1280
Paul Bakker9dcc3222011-03-08 14:16:06 +00001281/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001282 * \def MBEDTLS_PSA_CRYPTO_SPM
1283 *
1284 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1285 * Partition Manager) integration which separates the code into two parts: a
1286 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1287 * Environment).
1288 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001289 * If you enable this option, your build environment must include a header
1290 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1291 * header files, or in another directory on the compiler's include search
1292 * path). Alternatively, your platform may customize the header
1293 * `psa/crypto_platform.h`, in which case it can skip or replace the
1294 * inclusion of `"crypto_spe.h"`.
1295 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001296 * Module: library/psa_crypto.c
1297 * Requires: MBEDTLS_PSA_CRYPTO_C
1298 *
1299 */
1300//#define MBEDTLS_PSA_CRYPTO_SPM
1301
1302/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001303 * Uncomment to enable p256-m. This is an alternative implementation of
1304 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1305 * Compared to the default implementation:
1306 *
1307 * - p256-m has a much smaller code size and RAM footprint.
1308 * - p256-m is only available via the PSA API. This includes the pk module
1309 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1310 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1311 * over the core arithmetic, or deterministic derivation of keys.
1312 *
1313 * We recommend enabling this option if your application uses the PSA API
1314 * and the only elliptic curve support it needs is ECDH and ECDSA over
1315 * SECP256R1.
1316 *
1317 * If you enable this option, you do not need to enable any ECC-related
1318 * MBEDTLS_xxx option. You do need to separately request support for the
1319 * cryptographic mechanisms through the PSA API:
1320 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1321 * configuration;
1322 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1323 * - #PSA_WANT_ECC_SECP_R1_256;
1324 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1325 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1326 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1327 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1328 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001329 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001330 * \note To benefit from the smaller code size of p256-m, make sure that you
1331 * do not enable any ECC-related option not supported by p256-m: this
1332 * would cause the built-in ECC implementation to be built as well, in
1333 * order to provide the required option.
1334 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001335 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1336 * SECP256R1 are disabled as they are not supported by this driver.
1337 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1338 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001339 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001340 */
1341//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1342
1343/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001344 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001345 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001346 * Enable support for entropy injection at first boot. This feature is
1347 * required on systems that do not have a built-in entropy source (TRNG).
1348 * This feature is currently not supported on systems that have a built-in
1349 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001350 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001351 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001352 *
1353 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001354//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001355
1356/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001357 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001358 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001359 * Assume all buffers passed to PSA functions are owned exclusively by the
1360 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001361 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001362 * This option may be enabled if all buffers passed to any PSA function reside
1363 * in memory that is accessible only to the PSA function during its execution.
1364 *
1365 * This option MUST be disabled whenever buffer arguments are in memory shared
1366 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001367 * across a trust boundary.
1368 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001369 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001370 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001371 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001372 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001373 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001374//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001375
1376/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001378 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001379 * Do not use the Chinese Remainder Theorem
1380 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001381 *
1382 * Uncomment this macro to disable the use of CRT in RSA.
1383 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001384 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001385//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001386
1387/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001389 *
1390 * Enable the checkup functions (*_self_test).
1391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001393
1394/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001395 * \def MBEDTLS_SHA256_SMALLER
1396 *
1397 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1398 * lower performance.
1399 *
Adam Wolf039080f2019-09-10 09:53:08 -05001400 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001401 * performance and size. This version optimizes more aggressively for size at
1402 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1403 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1404 * 30%.
1405 *
1406 * Uncomment to enable the smaller implementation of SHA256.
1407 */
1408//#define MBEDTLS_SHA256_SMALLER
1409
1410/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001411 * \def MBEDTLS_SHA512_SMALLER
1412 *
1413 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1414 * lower performance.
1415 *
1416 * Uncomment to enable the smaller implementation of SHA512.
1417 */
1418//#define MBEDTLS_SHA512_SMALLER
1419
1420/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001421 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001422 *
1423 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001424 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001425 * with other servers, only debugging of failures is harder.
1426 *
1427 * The advantage of not sending alert messages, is that no information is given
1428 * about reasons for failures thus preventing adversaries of gaining intel.
1429 *
1430 * Enable sending of all alert messages
1431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001432#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001433
1434/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001435 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1436 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001437 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001438 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001439 * in the underlying transport. The CID functionality is described
1440 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001441 *
1442 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001443 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1444 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1445 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001446 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001447 * The maximum lengths of outgoing and incoming CIDs can be configured
1448 * through the options
1449 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1450 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1451 *
1452 * Requires: MBEDTLS_SSL_PROTO_DTLS
1453 *
1454 * Uncomment to enable the Connection ID extension.
1455 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001456#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1457
1458
1459/**
1460 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1461 *
1462 * Defines whether RFC 9146 (default) or the legacy version
1463 * (version draft-ietf-tls-dtls-connection-id-05,
1464 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1465 * is used.
1466 *
1467 * Set the value to 0 for the standard version, and
1468 * 1 for the legacy draft version.
1469 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001470 * \deprecated Support for the legacy version of the DTLS
1471 * Connection ID feature is deprecated. Please
1472 * switch to the standardized version defined
1473 * in RFC 9146 enabled by utilizing
1474 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1475 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1476 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001477 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1478 */
1479#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001480
1481/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001482 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1483 *
1484 * Enable asynchronous external private key operations in SSL. This allows
1485 * you to configure an SSL connection to call an external cryptographic
1486 * module to perform private key operations instead of performing the
1487 * operation inside the library.
1488 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001489 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001490 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001491//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001492
1493/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001494 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1495 *
1496 * Enable serialization of the TLS context structures, through use of the
1497 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1498 *
1499 * This pair of functions allows one side of a connection to serialize the
1500 * context associated with the connection, then free or re-use that context
1501 * while the serialized state is persisted elsewhere, and finally deserialize
1502 * that state to a live context for resuming read/write operations on the
1503 * connection. From a protocol perspective, the state of the connection is
1504 * unaffected, in particular this is entirely transparent to the peer.
1505 *
1506 * Note: this is distinct from TLS session resumption, which is part of the
1507 * protocol and fully visible by the peer. TLS session resumption enables
1508 * establishing new connections associated to a saved session with shorter,
1509 * lighter handshakes, while context serialization is a local optimization in
1510 * handling a single, potentially long-lived connection.
1511 *
1512 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1513 * saved after the handshake to allow for more efficient serialization, so if
1514 * you don't need this feature you'll save RAM by disabling it.
1515 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001516 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1517 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001518 * Comment to disable the context serialization APIs.
1519 */
1520#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1521
1522/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001524 *
1525 * Enable the debug messages in SSL module for all issues.
1526 * Debug messages have been disabled in some places to prevent timing
1527 * attacks due to (unbalanced) debugging function calls.
1528 *
1529 * If you need all error reporting you should enable this during debugging,
1530 * but remove this for production servers that should log as well.
1531 *
1532 * Uncomment this macro to report all debug messages on errors introducing
1533 * a timing side-channel.
1534 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001538/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001539 *
1540 * Enable support for Encrypt-then-MAC, RFC 7366.
1541 *
1542 * This allows peers that both support it to use a more robust protection for
1543 * ciphersuites using CBC, providing deep resistance against timing attacks
1544 * on the padding or underlying cipher.
1545 *
1546 * This only affects CBC ciphersuites, and is useless if none is defined.
1547 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001548 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001549 *
1550 * Comment this macro to disable support for Encrypt-then-MAC
1551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001553
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001555 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001556 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1557 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001558 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001559 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001560 * attacks, but it is recommended to always use it (even if you disable
1561 * renegotiation), since it actually fixes a more fundamental issue in the
1562 * original SSL/TLS design, and has implications beyond Triple Handshake.
1563 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001564 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001565 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001566 * Comment this macro to disable support for Extended Master Secret.
1567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001568#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001569
Paul Bakkerd66f0702013-01-31 16:57:45 +01001570/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001571 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1572 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001573 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001574 * giving access to the peer's certificate after completion of the handshake.
1575 *
1576 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1577 * recommended to disable this option for reduced RAM usage.
1578 *
1579 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1580 * defined, but always returns \c NULL.
1581 *
1582 * \note This option has no influence on the protection against the
1583 * triple handshake attack. Even if it is disabled, Mbed TLS will
1584 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001585 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001586 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001587 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001588 *
1589 * Comment this macro to disable storing the peer's certificate
1590 * after the handshake.
1591 */
1592#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1593
1594/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001595 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001596 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001597 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001598 *
1599 * The two main uses of renegotiation are (1) refresh keys on long-lived
1600 * connections and (2) client authentication after the initial handshake.
1601 * If you don't need renegotiation, it's probably better to disable it, since
1602 * it has been associated with security issues in the past and is easy to
1603 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001604 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001605 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1606 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001607 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001608 *
1609 * \note Even if this option is disabled, both client and server are aware
1610 * of the Renegotiation Indication Extension (RFC 5746) used to
1611 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1612 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1613 * configuration of this extension).
1614 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001616#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001617
1618/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001619 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001620 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001621 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001622 *
1623 * Comment this macro to disable support for the max_fragment_length extension
1624 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001625#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001626
1627/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001628 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1629 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001630 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001631 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001632 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1633 *
1634 * Uncomment this macro to enable support for the record_size_limit extension
1635 */
1636//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1637
1638/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001639 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001640 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001641 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001642 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001643 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001644 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1645 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001646 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001647 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001648 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001649 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1650 * are only provided by PSA drivers, you must call psa_crypto_init() before
1651 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001652 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001653 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001656
1657/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001658 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001659 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001660 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001661 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001662 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001663 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001664 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001665 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001666 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001667 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001668 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1669 * directly performed by TLS 1.3 code. As a consequence, you must
1670 * call psa_crypto_init() before the first TLS 1.3 handshake.
1671 *
1672 * \note Cryptographic operations performed indirectly via another module
1673 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1674 * running handshake hash) only use PSA crypto if
1675 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001676 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001677 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001678 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001679#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001680
1681/**
Ronald Cronab65c522021-11-24 10:47:20 +01001682 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1683 *
1684 * Enable TLS 1.3 middlebox compatibility mode.
1685 *
1686 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1687 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1688 * expecting TLS 1.2 traffic.
1689 *
1690 * Turning on the compatibility mode comes at the cost of a few added bytes
1691 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1692 * that don't use it. Therefore, unless transmission bandwidth is critical and
1693 * you know that middlebox compatibility issues won't occur, it is therefore
1694 * recommended to set this option.
1695 *
1696 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001697 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1698 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001699 *
1700 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001701#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001702
1703/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001704 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1705 *
1706 * Enable TLS 1.3 PSK key exchange mode.
1707 *
1708 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1709 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1710 * effect on the build.
1711 *
1712 */
1713#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1714
1715/**
1716 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1717 *
1718 * Enable TLS 1.3 ephemeral key exchange mode.
1719 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001720 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001721 * MBEDTLS_X509_CRT_PARSE_C
1722 * and at least one of:
1723 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1724 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001725 *
1726 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1727 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1728 * effect on the build.
1729 *
1730 */
1731#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1732
1733/**
1734 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1735 *
1736 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1737 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001738 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001739 *
1740 * Comment to disable support for the PSK ephemeral key exchange mode in
1741 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1742 * have any effect on the build.
1743 *
1744 */
1745#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1746
1747/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 * \def MBEDTLS_SSL_EARLY_DATA
1749 *
1750 * Enable support for RFC 8446 TLS 1.3 early data.
1751 *
1752 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1753 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1754 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1755 *
1756 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1757 * is not enabled, this option does not have any effect on the build.
1758 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001759 * \note The maximum amount of early data can be set with
1760 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1761 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001763//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001764
1765/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001766 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001767 *
1768 * Enable support for DTLS (all available versions).
1769 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001770 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001771 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001772 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001773 *
1774 * Comment this macro to disable support for DTLS
1775 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001776#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001777
1778/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001779 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001780 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001781 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001782 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001783 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001784 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001785#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001786
1787/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001789 *
1790 * Enable support for the anti-replay mechanism in DTLS.
1791 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001792 * Requires: MBEDTLS_SSL_TLS_C
1793 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001794 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001795 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001796 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001797 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001798 * Comment this to disable anti-replay in DTLS.
1799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001800#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001801
1802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001804 *
1805 * Enable support for HelloVerifyRequest on DTLS servers.
1806 *
1807 * This feature is highly recommended to prevent DTLS servers being used as
1808 * amplifiers in DoS attacks against other hosts. It should always be enabled
1809 * unless you know for sure amplification cannot be a problem in the
1810 * environment in which your server operates.
1811 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001812 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001813 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001814 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001815 *
1816 * Comment this to disable support for HelloVerifyRequest.
1817 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001819
1820/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001821 * \def MBEDTLS_SSL_DTLS_SRTP
1822 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001823 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001824 * through the use_srtp extension.
1825 *
1826 * \note This feature provides the minimum functionality required
1827 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1828 * the associated SRTP packet protection key material.
1829 * In particular, the SRTP packet protection itself, as well as the
1830 * demultiplexing of RTP and DTLS packets at the datagram layer
1831 * (see Section 5 of RFC 5764), are not handled by this feature.
1832 * Instead, after successful completion of a handshake negotiating
1833 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001834 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001835 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1836 * (this is implemented in the SSL example programs).
1837 * The resulting key should then be passed to an SRTP stack.
1838 *
1839 * Setting this option enables the runtime API
1840 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1841 * through which the supported DTLS-SRTP protection
1842 * profiles can be configured. You must call this API at
1843 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001844 *
1845 * Requires: MBEDTLS_SSL_PROTO_DTLS
1846 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001847 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001848 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001849//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001850
1851/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001852 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1853 *
1854 * Enable server-side support for clients that reconnect from the same port.
1855 *
1856 * Some clients unexpectedly close the connection and try to reconnect using the
1857 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001858 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001859 * flag enables that support.
1860 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001861 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001862 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001863 * Comment this to disable support for clients reusing the source port.
1864 */
1865#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1866
1867/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001869 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001870 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001871 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001872 * session store remains the responsibility of the application, though).
1873 * Server-side, you also need to provide callbacks for writing and parsing
1874 * tickets, including authenticated encryption and key management. Example
1875 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001876 *
1877 * Comment this macro to disable support for SSL session tickets
1878 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001880
1881/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001883 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001884 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001885 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001887 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001888 * Comment this macro to disable support for server name indication in SSL
1889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001891
1892/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001893 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1894 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001895 * When this option is enabled, the SSL buffer will be resized automatically
1896 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001897 *
1898 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001899 */
1900//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1901
1902/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001903 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1904 *
1905 * Enable testing of the constant-flow nature of some sensitive functions with
1906 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001907 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001908 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001909 * This setting requires compiling with clang -fsanitize=memory. The test
1910 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001911 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001912 * \warning This macro is only used for extended testing; it is not considered
1913 * part of the library's API, so it may change or disappear at any time.
1914 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001915 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001916 */
1917//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1918
1919/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001920 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1921 *
1922 * Enable testing of the constant-flow nature of some sensitive functions with
1923 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001924 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001925 *
1926 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001927 * testing if the tests suites are run with valgrind's memcheck. This can be
1928 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1929 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001930 *
1931 * \warning This macro is only used for extended testing; it is not considered
1932 * part of the library's API, so it may change or disappear at any time.
1933 *
1934 * Uncomment to enable testing of the constant-flow nature of selected code.
1935 */
1936//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1937
1938/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001939 * \def MBEDTLS_TEST_HOOKS
1940 *
1941 * Enable features for invasive testing such as introspection functions and
1942 * hooks for fault injection. This enables additional unit tests.
1943 *
1944 * Merely enabling this feature should not change the behavior of the product.
1945 * It only adds new code, and new branching points where the default behavior
1946 * is the same as when this feature is disabled.
1947 * However, this feature increases the attack surface: there is an added
1948 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1949 * Therefore this feature must never be enabled in production.
1950 *
1951 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1952 * information.
1953 *
1954 * Uncomment to enable invasive tests.
1955 */
1956//#define MBEDTLS_TEST_HOOKS
1957
1958/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001960 *
1961 * Provide your own alternate threading implementation.
1962 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001963 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001964 *
1965 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001968
1969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001971 *
1972 * Enable the pthread wrapper layer for the threading layer.
1973 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001975 *
1976 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001977 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001979
1980/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001981 * \def MBEDTLS_USE_PSA_CRYPTO
1982 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001983 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1984 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001985 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001986 * \note Development of this option is currently in progress, and parts of Mbed
1987 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001988 * will still continue to work as usual, so enabling this option should not
1989 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001990 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001991 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001992 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1993 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001994 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001995 * \note An important and desirable effect of this option is that it allows
1996 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1997 * 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 +02001998 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001999 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2000 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002001 *
2002 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002003 *
2004 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002005 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002006 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002008//#define MBEDTLS_USE_PSA_CRYPTO
2009
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002010/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002011 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2012 *
John Durkop185764f2020-10-12 21:32:12 -07002013 * This setting allows support for cryptographic mechanisms through the PSA
2014 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002015 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002016 * When this option is disabled, the PSA API exposes the cryptographic
2017 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2018 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002019 *
2020 * When this option is enabled, the PSA API exposes the cryptographic
2021 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2022 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2023 * automatically enabled if required (i.e. if no PSA driver provides the
2024 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2025 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002026 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002027 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002028 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002029 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002030 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2031 * symbols is not completely finalized yet, and the configuration
2032 * tooling is not ideally adapted to having two separate configuration
2033 * files.
2034 * Future minor releases of Mbed TLS may make minor changes to those
2035 * symbols, but we will endeavor to provide a transition path.
2036 * Nonetheless, this option is considered mature enough to use in
2037 * production, as long as you accept that you may need to make
2038 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002039 */
2040//#define MBEDTLS_PSA_CRYPTO_CONFIG
2041
2042/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002043 * \def MBEDTLS_VERSION_FEATURES
2044 *
2045 * Allow run-time checking of compile-time enabled features. Thus allowing users
2046 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002047 * support via mbedtls_version_check_feature().
2048 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002049 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002050 *
2051 * Comment this to disable run-time checking and save ROM space
2052 */
2053#define MBEDTLS_VERSION_FEATURES
2054
2055/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002056 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2057 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002058 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002059 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2060 * the set of trusted certificates through a callback instead of a linked
2061 * list.
2062 *
2063 * This is useful for example in environments where a large number of trusted
2064 * certificates is present and storing them in a linked list isn't efficient
2065 * enough, or when the set of trusted certificates changes frequently.
2066 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002067 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002068 * `mbedtls_ssl_conf_ca_cb()` for more information.
2069 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002070 * Requires: MBEDTLS_X509_CRT_PARSE_C
2071 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002072 * Uncomment to enable trusted certificate callbacks.
2073 */
2074//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2075
2076/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002077 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002078 *
Chris Jones2c745862020-12-16 11:41:06 +00002079 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002080 *
Chris Jones2c745862020-12-16 11:41:06 +00002081 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002082 * and other functions/constants only used by these functions, thus reducing
2083 * the code footprint by several KB.
2084 */
Chris Jones2c745862020-12-16 11:41:06 +00002085//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002086
2087/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002089 *
2090 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2091 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2092 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002093 * Requires: MBEDTLS_PKCS1_V21
2094 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002095 * Comment this macro to disallow using RSASSA-PSS in certificates.
2096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002097#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002098/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002099
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002100/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002101 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002102 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002103 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002104 * \{
2105 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002106
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002107/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002108 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002109 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002110 * Enable AES-NI support on x86-64 or x86-32.
2111 *
2112 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002113 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002114 * - GCC, x86-64, target not explicitly supporting AESNI:
2115 * requires MBEDTLS_HAVE_ASM.
2116 * - GCC, x86-32, target not explicitly supporting AESNI:
2117 * not supported.
2118 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2119 * For this assembly-less implementation, you must currently compile
2120 * `library/aesni.c` and `library/aes.c` with machine options to enable
2121 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2122 * `clang -maes -mpclmul`.
2123 * - Non-x86 targets: this option is silently ignored.
2124 * - Other compilers: this option is silently ignored.
2125 *
2126 * \note
2127 * Above, "GCC" includes compatible compilers such as Clang.
2128 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002129 *
2130 * Module: library/aesni.c
2131 * Caller: library/aes.c
2132 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002133 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002134 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002135 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002137#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002138
2139/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002140 * \def MBEDTLS_AESCE_C
2141 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002142 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002143 *
2144 * Module: library/aesce.c
2145 * Caller: library/aes.c
2146 *
Jerry Yuf015a932023-04-25 10:38:03 +08002147 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002148 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002149 * \warning Runtime detection only works on Linux. For non-Linux operating
2150 * system, Armv8-A Cryptographic Extensions must be supported by
2151 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002152 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002153 * \note Minimum compiler versions for this feature when targeting aarch64
2154 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2155 * Minimum compiler versions for this feature when targeting 32-bit
2156 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002157 *
2158 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2159 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002160 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002161 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002162 */
2163#define MBEDTLS_AESCE_C
2164
2165/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002167 *
2168 * Enable the AES block cipher.
2169 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002170 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002171 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002172 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002173 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002174 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002175 * This module enables the following ciphersuites (if other requisites are
2176 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002177 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2178 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2179 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2180 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2181 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2182 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2183 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2184 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2185 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2186 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2187 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2188 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2189 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2190 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2191 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2192 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2193 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2194 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2195 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2196 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2197 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2198 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2199 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2200 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2201 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2202 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2203 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2204 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2205 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2206 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2207 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2208 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2209 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2210 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2211 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2212 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2213 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2214 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2215 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2216 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2217 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2218 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2219 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2220 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2221 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2222 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2223 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2224 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2225 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2226 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2227 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2228 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2229 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2230 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2231 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2232 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2233 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2234 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002235 *
Paul Bakkercff68422013-09-15 20:43:33 +02002236 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002237 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002238#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002239
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002240/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002242 *
2243 * Enable the generic ASN1 parser.
2244 *
2245 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002246 * Caller: library/x509.c
2247 * library/dhm.c
2248 * library/pkcs12.c
2249 * library/pkcs5.c
2250 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002251 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002252#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002253
2254/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002256 *
2257 * Enable the generic ASN1 writer.
2258 *
2259 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002260 * Caller: library/ecdsa.c
2261 * library/pkwrite.c
2262 * library/x509_create.c
2263 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002264 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002265 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002266#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002267
2268/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002270 *
2271 * Enable the Base64 module.
2272 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002273 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002274 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002275 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002276 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002278#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002279
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002280/**
Yanray Wange367e472023-10-31 17:23:04 +08002281 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2282 *
2283 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2284 *
2285 * \note This feature is incompatible with insecure block cipher,
2286 * MBEDTLS_DES_C, and cipher modes which always require decryption
2287 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002288 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2289 * this feature is incompatible with following supported PSA equivalence,
2290 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2291 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002292 *
2293 * Module: library/aes.c
2294 * library/aesce.c
2295 * library/aesni.c
2296 * library/aria.c
2297 * library/camellia.c
2298 * library/cipher.c
2299 */
2300//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2301
2302/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002303 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002304 *
Paul Bakker9a736322012-11-14 12:39:52 +00002305 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002306 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002307 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002308 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002309 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002310 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002311 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002312 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002313 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002314 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002315 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002316 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002317 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002318 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002319 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002320#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002321
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002322/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002324 *
2325 * Enable the Camellia block cipher.
2326 *
Paul Bakker38119b12009-01-10 23:31:23 +00002327 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002328 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002329 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002330 * This module enables the following ciphersuites (if other requisites are
2331 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002332 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2333 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2334 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2335 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2336 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2337 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2338 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2339 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2340 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2341 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2342 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2343 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2344 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2345 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2346 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2347 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2348 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2349 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2350 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2351 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2352 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2353 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2354 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2355 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2356 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2357 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2358 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2359 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2360 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2361 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2362 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2363 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2364 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2365 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2366 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2367 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2368 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2369 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2370 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2371 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2372 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2373 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002374 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002376
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002377/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002378 * \def MBEDTLS_ARIA_C
2379 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002380 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002381 *
2382 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002383 * Caller: library/cipher.c
2384 *
2385 * This module enables the following ciphersuites (if other requisites are
2386 * enabled as well):
2387 *
2388 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2389 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2390 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2391 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2392 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2393 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2394 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2395 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2396 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2397 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2398 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2399 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2400 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2401 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2402 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2403 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2404 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2405 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2406 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2407 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2408 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2409 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2410 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2411 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2412 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2413 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2414 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2415 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2416 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2417 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2418 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2419 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2420 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2421 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2422 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2423 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2424 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2425 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002426 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002427#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002428
2429/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002431 *
2432 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2433 *
2434 * Module: library/ccm.c
2435 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002436 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2437 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002438 *
2439 * This module enables the AES-CCM ciphersuites, if other requisites are
2440 * enabled as well.
2441 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002443
2444/**
Daniel King34b822c2016-05-15 17:28:08 -03002445 * \def MBEDTLS_CHACHA20_C
2446 *
2447 * Enable the ChaCha20 stream cipher.
2448 *
2449 * Module: library/chacha20.c
2450 */
2451#define MBEDTLS_CHACHA20_C
2452
2453/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002454 * \def MBEDTLS_CHACHAPOLY_C
2455 *
2456 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2457 *
2458 * Module: library/chachapoly.c
2459 *
2460 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2461 */
2462#define MBEDTLS_CHACHAPOLY_C
2463
2464/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002465 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002466 *
2467 * Enable the generic cipher layer.
2468 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002469 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002470 * Caller: library/ccm.c
2471 * library/cmac.c
2472 * library/gcm.c
2473 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002474 * library/pkcs12.c
2475 * library/pkcs5.c
2476 * library/psa_crypto_aead.c
2477 * library/psa_crypto_mac.c
2478 * library/ssl_ciphersuites.c
2479 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002480 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002481 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2482 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002483 *
2484 * Uncomment to enable generic cipher wrappers.
2485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002487
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002488/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002489 * \def MBEDTLS_CMAC_C
2490 *
Simon Butcher327398a2016-10-05 14:09:11 +01002491 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2492 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002493 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002494 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2495 * implementation of the CMAC algorithm is provided by an alternate
2496 * implementation, that alternate implementation may opt to not support
2497 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2498 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002499 * Module: library/cmac.c
2500 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002501 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002502 *
2503 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002504#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002505
2506/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002508 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002509 * Enable the CTR_DRBG AES-based random generator.
2510 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002511 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002512 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002513 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2514 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2515 * is used.
2516 *
2517 * \warning When using PSA, the user should call `psa_crypto_init()` before
2518 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2519 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002520 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2521 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002522 * \note To achieve a 256-bit security strength with CTR_DRBG,
2523 * you must use AES-256 *and* use sufficient entropy.
2524 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002525 *
2526 * Module: library/ctr_drbg.c
2527 * Caller:
2528 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002529 * Requires: MBEDTLS_AES_C or
2530 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2531 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002532 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002533 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002535#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002536
2537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002539 *
2540 * Enable the debug functions.
2541 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002542 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002543 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002544 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002545 * library/ssl_tls12_*.c
2546 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002547 *
2548 * This module provides debugging functions.
2549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002550#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002551
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002554 *
2555 * Enable the DES block cipher.
2556 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002557 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002558 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002559 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002560 *
Paul Bakkercff68422013-09-15 20:43:33 +02002561 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002562 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002563 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002564 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002566#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002567
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002568/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002570 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002571 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002572 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002573 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002574 * Caller: library/ssl_tls.c
2575 * library/ssl*_client.c
2576 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002577 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002578 * This module is used by the following key exchanges:
2579 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002580 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002581 * \warning Using DHE constitutes a security risk as it
2582 * is not possible to validate custom DH parameters.
2583 * If possible, it is recommended users should consider
2584 * preferring other methods of key exchange.
2585 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002586 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002587 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002588#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002589
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002590/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002591 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002592 *
2593 * Enable the elliptic curve Diffie-Hellman library.
2594 *
2595 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002596 * Caller: library/psa_crypto.c
2597 * library/ssl_tls.c
2598 * library/ssl*_client.c
2599 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002600 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002601 * This module is used by the following key exchanges:
2602 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002603 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002606#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002607
2608/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002610 *
2611 * Enable the elliptic curve DSA library.
2612 *
2613 * Module: library/ecdsa.c
2614 * Caller:
2615 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002616 * This module is used by the following key exchanges:
2617 * ECDHE-ECDSA
2618 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002619 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2620 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2621 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002622 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002624
2625/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002626 * \def MBEDTLS_ECJPAKE_C
2627 *
2628 * Enable the elliptic curve J-PAKE library.
2629 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002630 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2631 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002632 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002633 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002634 * Module: library/ecjpake.c
2635 * Caller:
2636 *
2637 * This module is used by the following key exchanges:
2638 * ECJPAKE
2639 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002640 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002641 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002642 * \warning If using a hash that is only provided by PSA drivers, you must
2643 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002644 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002645#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002646
2647/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002648 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002649 *
2650 * Enable the elliptic curve over GF(p) library.
2651 *
2652 * Module: library/ecp.c
2653 * Caller: library/ecdh.c
2654 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002655 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002656 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002660
2661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002662 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002663 *
2664 * Enable the platform-specific entropy code.
2665 *
2666 * Module: library/entropy.c
2667 * Caller:
2668 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002670 *
2671 * This module provides a generic entropy pool
2672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002674
2675/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002677 *
2678 * Enable error code to error string conversion.
2679 *
2680 * Module: library/error.c
2681 * Caller:
2682 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002684 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002686
2687/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002688 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002689 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002690 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002691 *
2692 * Module: library/gcm.c
2693 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002694 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2695 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002696 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002697 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2698 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002699 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002701
2702/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002703 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002704 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002705 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002706 * Can significantly increase throughput on systems without GCM hardware
2707 * acceleration (e.g., AESNI, AESCE).
2708 *
Matthias Schulz78266782024-02-08 13:54:48 +01002709 * The mbedtls_gcm_context size will increase by 3840 bytes.
2710 * The code size will increase by roughly 344 bytes.
2711 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002712 * Module: library/gcm.c
2713 *
2714 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002715 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002716//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002717
2718/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002719 * \def MBEDTLS_HKDF_C
2720 *
2721 * Enable the HKDF algorithm (RFC 5869).
2722 *
2723 * Module: library/hkdf.c
2724 * Caller:
2725 *
2726 * Requires: MBEDTLS_MD_C
2727 *
2728 * This module adds support for the Hashed Message Authentication Code
2729 * (HMAC)-based key derivation function (HKDF).
2730 */
2731#define MBEDTLS_HKDF_C
2732
2733/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002735 *
2736 * Enable the HMAC_DRBG random generator.
2737 *
2738 * Module: library/hmac_drbg.c
2739 * Caller:
2740 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002742 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002743 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002744 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002745#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002746
2747/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002748 * \def MBEDTLS_LMS_C
2749 *
2750 * Enable the LMS stateful-hash asymmetric signature algorithm.
2751 *
2752 * Module: library/lms.c
2753 * Caller:
2754 *
Raef Colesab4f8742022-09-01 12:24:31 +01002755 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002756 *
Raef Colesab4f8742022-09-01 12:24:31 +01002757 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002758 */
2759#define MBEDTLS_LMS_C
2760
2761/**
Raef Colesab4f8742022-09-01 12:24:31 +01002762 * \def MBEDTLS_LMS_PRIVATE
2763 *
2764 * Enable LMS private-key operations and signing code. Functions enabled by this
2765 * option are experimental, and should not be used in production.
2766 *
2767 * Requires: MBEDTLS_LMS_C
2768 *
2769 * Uncomment to enable the LMS signature algorithm and private key operations.
2770 */
Raef Coles5127e852022-10-07 10:35:56 +01002771//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002772
2773/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002774 * \def MBEDTLS_NIST_KW_C
2775 *
2776 * Enable the Key Wrapping mode for 128-bit block ciphers,
2777 * as defined in NIST SP 800-38F. Only KW and KWP modes
2778 * are supported. At the moment, only AES is approved by NIST.
2779 *
2780 * Module: library/nist_kw.c
2781 *
2782 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2783 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002784#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002785
2786/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002787 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002788 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002789 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002790 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002791 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2792 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002793 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002794 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002795 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002796 * Caller: library/constant_time.c
2797 * library/ecdsa.c
2798 * library/ecjpake.c
2799 * library/hkdf.c
2800 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002801 * library/pk.c
2802 * library/pkcs5.c
2803 * library/pkcs12.c
2804 * library/psa_crypto_ecp.c
2805 * library/psa_crypto_rsa.c
2806 * library/rsa.c
2807 * library/ssl_cookie.c
2808 * library/ssl_msg.c
2809 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002810 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002811 * library/x509_crt.c
2812 * library/x509write_crt.c
2813 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002814 *
2815 * Uncomment to enable generic message digest wrappers.
2816 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002817#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002818
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002819/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002821 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002822 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002823 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002824 * Module: library/md5.c
2825 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002826 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002827 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002828 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002829 * This module is required for TLS 1.2 depending on the handshake parameters.
2830 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2831 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002832 *
2833 * \warning MD5 is considered a weak message digest and its use constitutes a
2834 * security risk. If possible, we recommend avoiding dependencies on
2835 * it, and considering stronger message digests instead.
2836 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002837 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002838#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002839
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002840/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002841 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002842 *
2843 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002844 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002845 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002846 *
2847 * Module: library/memory_buffer_alloc.c
2848 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002850 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002851 *
2852 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002853 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002855
2856/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002858 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002859 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2860 *
Simon Butcherd567a232016-03-09 20:19:21 +00002861 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2862 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002863 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002864 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002865 * \note See also our Knowledge Base article about porting to a new
2866 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002867 * 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 +00002868 *
Andres AG788aa4a2016-09-14 14:32:09 +01002869 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002870 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002871 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002872 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002874
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002875/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002877 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002878 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002879 *
2880 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002881 * Caller: library/asn1write.c
2882 * library/pkcs5.c
2883 * library/pkparse.c
2884 * library/pkwrite.c
2885 * library/rsa.c
2886 * library/x509.c
2887 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002888 * library/x509_crl.c
2889 * library/x509_crt.c
2890 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002891 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002892 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002893 *
2894 * This modules translates between OIDs and internal values.
2895 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002897
2898/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002899 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002900 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002901 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002902 *
2903 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002904 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002905 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002906 * library/x509_crl.c
2907 * library/x509_crt.c
2908 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002909 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002910 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002911 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2912 *
2913 * \warning When parsing password-protected files, if MD5 is provided only by
2914 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002915 *
Paul Bakkercff68422013-09-15 20:43:33 +02002916 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002917 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002919
2920/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002921 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002922 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002923 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002924 *
2925 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002926 * Caller: library/pkwrite.c
2927 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002928 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002929 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002931 *
2932 * This modules adds support for encoding / writing PEM files.
2933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002935
2936/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002937 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002938 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002939 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002940 *
2941 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002942 * Caller: library/psa_crypto_rsa.c
2943 * library/ssl_tls.c
2944 * library/ssl*_client.c
2945 * library/ssl*_server.c
2946 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002947 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002948 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002949 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002950 * Uncomment to enable generic public key wrappers.
2951 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002952#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002953
2954/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002956 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002957 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002958 *
2959 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002960 * Caller: library/x509_crt.c
2961 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002962 *
Yanray Wang072a0682023-12-05 10:53:04 +08002963 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002964 *
2965 * Uncomment to enable generic public key parse functions.
2966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002968
2969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002971 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002972 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002973 *
2974 * Module: library/pkwrite.c
2975 * Caller: library/x509write.c
2976 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002977 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002978 *
2979 * Uncomment to enable generic public key write functions.
2980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002982
2983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002985 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002986 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002987 *
2988 * Module: library/pkcs5.c
2989 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002990 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002991 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002992 * \warning If using a hash that is only provided by PSA drivers, you must
2993 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002994 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002995 * This module adds support for the PKCS#5 functions.
2996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002998
2999/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003000 * \def MBEDTLS_PKCS7_C
3001 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003002 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003003 * RFC Link - https://tools.ietf.org/html/rfc2315
3004 *
3005 * Module: library/pkcs7.c
3006 *
3007 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003008 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3009 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003010 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003011 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003012 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003013#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003014
3015/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003017 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003018 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003019 * Adds algorithms for parsing PKCS#8 encrypted private keys
3020 *
3021 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003022 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003023 *
Valerio Settie98ad592023-12-28 10:42:12 +01003024 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3025 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003026 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003027 * \warning If using a hash that is only provided by PSA drivers, you must
3028 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003029 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003030 * This module enables PKCS#12 functions.
3031 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003033
3034/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003036 *
3037 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003038 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003039 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3041 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003042 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003043 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003044 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003045 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003046 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003047 * Module: library/platform.c
3048 * Caller: Most other .c files
3049 *
3050 * This module enables abstraction of common (libc) functions.
3051 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003052#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003053
3054/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003055 * \def MBEDTLS_POLY1305_C
3056 *
3057 * Enable the Poly1305 MAC algorithm.
3058 *
3059 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003060 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003061 */
3062#define MBEDTLS_POLY1305_C
3063
3064/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003065 * \def MBEDTLS_PSA_CRYPTO_C
3066 *
3067 * Enable the Platform Security Architecture cryptography API.
3068 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003069 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003070 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003071 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003072 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003073 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3074 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3075 * is enabled in PSA (unless it's fully accelerated, see
3076 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003077 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003078#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003079
3080/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003081 * \def MBEDTLS_PSA_CRYPTO_SE_C
3082 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003083 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003084 * cryptography API.
3085 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003086 * \deprecated This feature is deprecated. Please switch to the PSA driver
3087 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003088 *
Ryan Everett32a64582024-03-05 18:16:18 +00003089 * \warning This feature is not thread-safe, and should not be used in a
3090 * multi-threaded environment.
3091 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003092 * Module: library/psa_crypto_se.c
3093 *
3094 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3095 *
3096 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003097//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003098
3099/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003100 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3101 *
3102 * Enable the Platform Security Architecture persistent key storage.
3103 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003104 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003105 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003106 * Requires: MBEDTLS_PSA_CRYPTO_C,
3107 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3108 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003109 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003110#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003111
3112/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003113 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003114 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003115 * Enable the emulation of the Platform Security Architecture
3116 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003117 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003118 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003119 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003120 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003121 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003122#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003123
3124/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003125 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003126 *
3127 * Enable the RIPEMD-160 hash algorithm.
3128 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003129 * Module: library/ripemd160.c
3130 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003131 *
3132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003134
3135/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003137 *
3138 * Enable the RSA public-key cryptosystem.
3139 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003140 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003141 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003142 * Caller: library/pk.c
3143 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003144 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003145 * library/ssl*_client.c
3146 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003147 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003148 * This module is used by the following key exchanges:
3149 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003150 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003154
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003156 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003157 *
3158 * Enable the SHA1 cryptographic hash algorithm.
3159 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003160 * Module: library/sha1.c
3161 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003162 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003163 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003164 * This module is required for TLS 1.2 depending on the handshake parameters,
3165 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003166 *
3167 * \warning SHA-1 is considered a weak message digest and its use constitutes
3168 * a security risk. If possible, we recommend avoiding dependencies
3169 * on it, and considering stronger message digests instead.
3170 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003171 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003173
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003174/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003175 * \def MBEDTLS_SHA224_C
3176 *
3177 * Enable the SHA-224 cryptographic hash algorithm.
3178 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003179 * Module: library/sha256.c
3180 * Caller: library/md.c
3181 * library/ssl_cookie.c
3182 *
3183 * This module adds support for SHA-224.
3184 */
3185#define MBEDTLS_SHA224_C
3186
3187/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003189 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003190 * Enable the SHA-256 cryptographic hash algorithm.
3191 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003192 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003193 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003194 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003195 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003196 * library/ssl*_client.c
3197 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003198 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003199 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003200 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003201 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003202#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003203
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003204/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003205 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003206 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003207 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3208 * with the ARMv8 cryptographic extensions if they are available at runtime.
3209 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003210 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003211 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003212 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003213 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003214 * \note Minimum compiler versions for this feature are Clang 4.0,
3215 * armclang 6.6 or GCC 6.0.
3216 *
3217 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3218 * armclang <= 6.9
3219 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003220 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3221 * That name is deprecated, but may still be used as an alternative form for this
3222 * option.
3223 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003224 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3225 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003226 *
3227 * Requires: MBEDTLS_SHA256_C.
3228 *
3229 * Module: library/sha256.c
3230 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003231 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003232 * and use them if available.
3233 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003234//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003235
Dave Rodgmand85277c2023-10-13 09:22:54 +01003236/**
3237 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3238 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003239 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003240 * This name is now deprecated, but may still be used as an alternative form for
3241 * this option.
3242 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003243//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3244
3245/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003246 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003247 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003248 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3249 * with the ARMv8 cryptographic extensions, which must be available at runtime
3250 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003251 *
3252 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003253 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003254 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003255 * \note Minimum compiler versions for this feature are Clang 4.0,
3256 * armclang 6.6 or GCC 6.0.
3257 *
3258 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3259 * armclang <= 6.9
3260 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003261 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003262 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003263 * option.
3264 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003265 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3266 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003267 *
3268 * Requires: MBEDTLS_SHA256_C.
3269 *
3270 * Module: library/sha256.c
3271 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003272 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003273 * unconditionally.
3274 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003275//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003276
Dave Rodgmand85277c2023-10-13 09:22:54 +01003277/**
3278 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3279 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003280 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003281 * This name is now deprecated, but may still be used as an alternative form for
3282 * this option.
3283 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003284//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3285
3286/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003287 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003288 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003289 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003290 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003291 * Module: library/sha512.c
3292 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003293 * library/psa_crypto_hash.c
3294 * library/ssl_tls.c
3295 * library/ssl*_client.c
3296 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003297 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003298 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003299 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003300#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003301
3302/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003304 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003305 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003306 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003307 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003308 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003309 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003310 * library/ssl_tls.c
3311 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003312 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003313 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003316
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003317/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003318 * \def MBEDTLS_SHA3_C
3319 *
3320 * Enable the SHA3 cryptographic hash algorithm.
3321 *
3322 * Module: library/sha3.c
3323 *
3324 * This module adds support for SHA3.
3325 */
3326#define MBEDTLS_SHA3_C
3327
3328/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003329 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3330 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003331 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3332 * with the ARMv8 cryptographic extensions if they are available at runtime.
3333 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003334 *
3335 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3336 * for a non-Aarch64 build it will be silently ignored.
3337 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003338 * \note Minimum compiler versions for this feature are Clang 7.0,
3339 * armclang 6.9 or GCC 8.0.
3340 *
3341 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3342 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003343 *
3344 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3345 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3346 *
3347 * Requires: MBEDTLS_SHA512_C.
3348 *
3349 * Module: library/sha512.c
3350 *
3351 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3352 * and use them if available.
3353 */
3354//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3355
3356/**
3357 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3358 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003359 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3360 * with the ARMv8 cryptographic extensions, which must be available at runtime
3361 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003362 *
3363 * \note This allows builds with a smaller code size than with
3364 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3365 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003366 * \note Minimum compiler versions for this feature are Clang 7.0,
3367 * armclang 6.9 or GCC 8.0.
3368 *
3369 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3370 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003371 *
3372 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3373 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3374 *
3375 * Requires: MBEDTLS_SHA512_C.
3376 *
3377 * Module: library/sha512.c
3378 *
3379 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3380 * unconditionally.
3381 */
3382//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3383
3384/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003385 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003386 *
3387 * Enable simple SSL cache implementation.
3388 *
3389 * Module: library/ssl_cache.c
3390 * Caller:
3391 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003395
3396/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003398 *
3399 * Enable basic implementation of DTLS cookies for hello verification.
3400 *
3401 * Module: library/ssl_cookie.c
3402 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003403 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003405
3406/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003407 * \def MBEDTLS_SSL_TICKET_C
3408 *
3409 * Enable an implementation of TLS server-side callbacks for session tickets.
3410 *
3411 * Module: library/ssl_ticket.c
3412 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003413 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003414 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3415 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003416 */
3417#define MBEDTLS_SSL_TICKET_C
3418
3419/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003421 *
3422 * Enable the SSL/TLS client code.
3423 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003424 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003425 * Caller:
3426 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003428 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003429 * This module is required for SSL/TLS client support.
3430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003432
Paul Bakker9a736322012-11-14 12:39:52 +00003433/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003434 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003435 *
3436 * Enable the SSL/TLS server code.
3437 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003438 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003439 * Caller:
3440 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003442 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003443 * This module is required for SSL/TLS server support.
3444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003445#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003446
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003447/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003449 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003450 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003451 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003452 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003453 * Caller: library/ssl*_client.c
3454 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003455 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003456 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3457 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003458 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003459 * This module is required for SSL/TLS.
3460 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003462
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003463/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003464 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003465 *
3466 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003467 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003468 * contexts are not shared between threads. If you do intend to use contexts
3469 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003470 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003471 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003472 *
3473 * Module: library/threading.c
3474 *
3475 * This allows different threading implementations (self-implemented or
3476 * provided).
3477 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478 * You will have to enable either MBEDTLS_THREADING_ALT or
3479 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003480 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003481 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003482 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003484
3485/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003486 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003487 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003488 * Enable the semi-portable timing interface.
3489 *
Simon Butcherd567a232016-03-09 20:19:21 +00003490 * \note The provided implementation only works on POSIX/Unix (including Linux,
3491 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003492 * module and provide your own implementations of the callbacks needed by
3493 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3494 * your own implementation of the whole module by setting
3495 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003496 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003497 * \note The timing module will include time.h on suitable platforms
3498 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3499 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3500 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003501 * \note See also our Knowledge Base article about porting to a new
3502 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003503 * 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 +00003504 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003505 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003508
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003509/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003510 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003511 *
3512 * Enable run-time version information.
3513 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003514 * Module: library/version.c
3515 *
3516 * This module provides run-time version information.
3517 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003518#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003519
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003520/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003521 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003522 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003523 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003524 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003525 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003526 * Caller: library/x509_crl.c
3527 * library/x509_crt.c
3528 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003529 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003530 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003531 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3532 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003533 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3534 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003535 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003536 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003538#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003539
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003542 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003543 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003544 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003545 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003546 * Caller: library/ssl_tls.c
3547 * library/ssl*_client.c
3548 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003549 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003551 *
3552 * This module is required for X.509 certificate parsing.
3553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003554#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003555
3556/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003557 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003558 *
3559 * Enable X.509 CRL parsing.
3560 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003561 * Module: library/x509_crl.c
3562 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003563 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003564 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003565 *
3566 * This module is required for X.509 CRL parsing.
3567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003568#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003569
3570/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003571 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003572 *
3573 * Enable X.509 Certificate Signing Request (CSR) parsing.
3574 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003575 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003576 * Caller: library/x509_crt_write.c
3577 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003578 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003579 *
3580 * This module is used for reading X.509 certificate request.
3581 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003582#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003583
3584/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003585 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003586 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003587 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003588 *
3589 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003590 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003591 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003592 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3593 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003594 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3595 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003596 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003597 * This module is the basis for creating X.509 certificates and CSRs.
3598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003599#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003600
3601/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003603 *
3604 * Enable creating X.509 certificates.
3605 *
3606 * Module: library/x509_crt_write.c
3607 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003608 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003609 *
3610 * This module is required for X.509 certificate creation.
3611 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003612#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003613
3614/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003615 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003616 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003617 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003618 *
3619 * Module: library/x509_csr_write.c
3620 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003621 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003622 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003623 * This module is required for X.509 certificate request writing.
3624 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003625#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003626
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003627/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003628
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003629/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003630 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003631 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003632 * This section contains Mbed TLS build settings that are not associated
3633 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003634 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003635 * \{
3636 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003637
Gilles Peskinea02c1242022-03-16 17:03:19 +01003638/**
3639 * \def MBEDTLS_CONFIG_FILE
3640 *
3641 * If defined, this is a header which will be included instead of
3642 * `"mbedtls/mbedtls_config.h"`.
3643 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003644 * Unlike other configuration options, this one must be defined on the
3645 * compiler command line: a definition in `mbedtls_config.h` would have
3646 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003647 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003648 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003649 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003650 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003651 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003652 * The value of this symbol is typically a path in double quotes, either
3653 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003654 */
3655//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3656
3657/**
3658 * \def MBEDTLS_USER_CONFIG_FILE
3659 *
3660 * If defined, this is a header which will be included after
3661 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003662 * This allows you to modify the default configuration, including the ability
3663 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003664 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003665 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003666 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003667 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003668 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003669 * The value of this symbol is typically a path in double quotes, either
3670 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003671 */
3672//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3673
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003674/**
3675 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3676 *
3677 * If defined, this is a header which will be included instead of
3678 * `"psa/crypto_config.h"`.
3679 * This header file specifies which cryptographic mechanisms are available
3680 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3681 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3682 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003683 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003684 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003685 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003686 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003687 * The value of this symbol is typically a path in double quotes, either
3688 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003689 */
3690//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3691
3692/**
3693 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3694 *
3695 * If defined, this is a header which will be included after
3696 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003697 * This allows you to modify the default configuration, including the ability
3698 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003699 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003700 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003701 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003702 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003703 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003704 * The value of this symbol is typically a path in double quotes, either
3705 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003706 */
3707//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3708
Gilles Peskineb1176f22023-02-22 22:07:28 +01003709/**
3710 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3711 *
3712 * If defined, this is a header which will be included instead of
3713 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3714 * as the one in Mbed TLS, but with definitions adapted to the platform on
3715 * which the library code will run.
3716 *
3717 * \note The required content of this header can vary from one version of
3718 * Mbed TLS to the next. Integrators who provide an alternative file
3719 * should review the changes in the original file whenever they
3720 * upgrade Mbed TLS.
3721 *
3722 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3723 * non-standard feature of the C language, so this feature is only available
3724 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3725 *
3726 * The value of this symbol is typically a path in double quotes, either
3727 * absolute or relative to a directory on the include search path.
3728 */
3729//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3730
3731/**
3732 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3733 *
3734 * If defined, this is a header which will be included instead of
3735 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3736 * as the one in Mbed TLS, but with definitions adapted to the environment
3737 * in which the library code will run. The typical use for this feature
3738 * is to provide alternative type definitions on the client side in
3739 * client-server integrations of PSA crypto, where operation structures
3740 * contain handles instead of cryptographic data.
3741 *
3742 * \note The required content of this header can vary from one version of
3743 * Mbed TLS to the next. Integrators who provide an alternative file
3744 * should review the changes in the original file whenever they
3745 * upgrade Mbed TLS.
3746 *
3747 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3748 * non-standard feature of the C language, so this feature is only available
3749 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3750 *
3751 * The value of this symbol is typically a path in double quotes, either
3752 * absolute or relative to a directory on the include search path.
3753 */
3754//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3755
Gilles Peskineba4162a2022-04-11 17:04:38 +02003756/** \} name SECTION: General configuration options */
3757
3758/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003759 * \name SECTION: Module configuration options
3760 *
3761 * This section allows for the setting of module specific sizes and
3762 * configuration options. The default values are already present in the
3763 * relevant header files and should suffice for the regular use cases.
3764 *
3765 * Our advice is to enable options and change their values here
3766 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003767 * \{
3768 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003769/* The Doxygen documentation here is used when a user comments out a
3770 * setting and runs doxygen themselves. On the other hand, when we typeset
3771 * the full documentation including disabled settings, the documentation
3772 * in specific modules' header files is used if present. When editing this
3773 * file, make sure that each option is documented in exactly one place,
3774 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3775 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003776
Paul Bakker088c5c52014-04-25 11:11:10 +02003777/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003778//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003779//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003780
Paul Bakker088c5c52014-04-25 11:11:10 +02003781/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003782//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3783//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3784//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3785//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3786//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003787
Paul Bakker088c5c52014-04-25 11:11:10 +02003788/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003789//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3790//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3791//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3792//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003793
Paul Bakker088c5c52014-04-25 11:11:10 +02003794/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003795//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003796//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003797
Paul Bakker088c5c52014-04-25 11:11:10 +02003798/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003799//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3800//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003801//#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 +01003802
Paul Bakker088c5c52014-04-25 11:11:10 +02003803/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003804//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003805
Paul Bakker088c5c52014-04-25 11:11:10 +02003806/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003807//#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 -04003808
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003809/** \def MBEDTLS_PLATFORM_STD_CALLOC
3810 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003811 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003812 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003813 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003814 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003815 * 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 -04003816 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3817 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003818 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003819 */
3820//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003821
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003822/** \def MBEDTLS_PLATFORM_STD_FREE
3823 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003824 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003825 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003826 * 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 -04003827 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3828 * 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 -04003829 */
3830//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003831//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003832//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003833//#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 +02003834//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3835//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003836/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003837//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003838//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3839//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003840//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3841//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3842//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003843
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003844/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003845/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003846//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3847//#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 +02003848//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003849//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003850//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3851//#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 +02003852//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3853//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003854/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003855//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003856//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003857//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3858//#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 +08003859//#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 +08003860//#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 +02003861
Gilles Peskine3f106f72021-09-23 17:42:39 +02003862/** \def MBEDTLS_CHECK_RETURN
3863 *
3864 * This macro is used at the beginning of the declaration of a function
3865 * to indicate that its return value should be checked. It should
3866 * instruct the compiler to emit a warning or an error if the function
3867 * is called without checking its return value.
3868 *
3869 * There is a default implementation for popular compilers in platform_util.h.
3870 * You can override the default implementation by defining your own here.
3871 *
3872 * If the implementation here is empty, this will effectively disable the
3873 * checking of functions' return values.
3874 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003875//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003876
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003877/** \def MBEDTLS_IGNORE_RETURN
3878 *
3879 * This macro requires one argument, which should be a C function call.
3880 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3881 * warning is suppressed.
3882 */
3883//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3884
Gilles Peskineed038902020-11-13 21:33:21 +01003885/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003886/**
Gilles Peskineed038902020-11-13 21:33:21 +01003887 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3888 * PSA crypto subsystem.
3889 *
3890 * If this option is unset:
3891 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003892 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003893 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3894 * on unspecified heuristics.
3895 */
3896//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3897
Steven Cooreman863470a2021-02-15 14:03:19 +01003898/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003899 * Restrict the PSA library to supporting a maximum amount of simultaneously
3900 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3901 * volatile key, or a persistent key which is loaded temporarily by the
3902 * library as part of a crypto operation in flight.
3903 *
3904 * If this option is unset, the library will fall back to a default value of
3905 * 32 keys.
3906 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003907//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003908
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003909/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003910//#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 +00003911
Paul Bakker088c5c52014-04-25 11:11:10 +02003912/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003913//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3914//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003915
Paul Bakker088c5c52014-04-25 11:11:10 +02003916/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003917
Angus Grattond8213d02016-05-25 20:56:48 +10003918/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3919 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003920 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003921 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003922 * This determines the size of the incoming TLS I/O buffer in such a way
3923 * that it is capable of holding the specified amount of plaintext data,
3924 * regardless of the protection mechanism used.
3925 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003926 * \note When using a value less than the default of 16KB on the client, it is
3927 * recommended to use the Maximum Fragment Length (MFL) extension to
3928 * inform the server about this limitation. On the server, there
3929 * is no supported, standardized way of informing the client about
3930 * restriction on the maximum size of incoming messages, and unless
3931 * the limitation has been communicated by other means, it is recommended
3932 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3933 * while keeping the default value of 16KB for the incoming buffer.
3934 *
David Horstmann95d516f2021-05-04 18:36:56 +01003935 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003936 */
3937//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3938
Gilles Peskined3d02902020-03-04 21:35:27 +01003939/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3940 *
3941 * The maximum length of CIDs used for incoming DTLS messages.
3942 *
3943 */
3944//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3945
3946/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3947 *
3948 * The maximum length of CIDs used for outgoing DTLS messages.
3949 *
3950 */
3951//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3952
TRodziewicze8dd7092021-05-12 14:19:11 +02003953/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003954 *
3955 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003956 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003957 *
3958 * The padding will always be chosen so that the length of the
3959 * padded plaintext is a multiple of the value of this option.
3960 *
3961 * Note: A value of \c 1 means that no padding will be used
3962 * for outgoing records.
3963 *
3964 * Note: On systems lacking division instructions,
3965 * a power of two should be preferred.
3966 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003967//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003968
Angus Grattond8213d02016-05-25 20:56:48 +10003969/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3970 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003971 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003972 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003973 * This determines the size of the outgoing TLS I/O buffer in such a way
3974 * that it is capable of holding the specified amount of plaintext data,
3975 * regardless of the protection mechanism used.
3976 *
Angus Grattond8213d02016-05-25 20:56:48 +10003977 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3978 * the default inward 16384 byte buffer to conform to the TLS specification.
3979 *
3980 * The minimum required outward buffer size is determined by the handshake
3981 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3982 * The specific size requirement depends on the configured ciphers and any
3983 * certificate data which is sent during the handshake.
3984 *
David Horstmann95d516f2021-05-04 18:36:56 +01003985 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003986 */
3987//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3988
Hanno Beckere0b150f2018-08-21 15:51:03 +01003989/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3990 *
3991 * Maximum number of heap-allocated bytes for the purpose of
3992 * DTLS handshake message reassembly and future message buffering.
3993 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003994 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003995 * to account for a reassembled handshake message of maximum size,
3996 * together with its reassembly bitmap.
3997 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003998 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003999 * should be sufficient for all practical situations as it allows
4000 * to reassembly a large handshake message (such as a certificate)
4001 * while buffering multiple smaller handshake messages.
4002 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004003 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004004//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004005
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004006//#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 +02004007//#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 +02004008
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004009/**
4010 * Complete list of ciphersuites to use, in order of preference.
4011 *
4012 * \warning No dependency checking is done on that field! This option can only
4013 * be used to restrict the set of available ciphersuites. It is your
4014 * responsibility to make sure the needed modules are active.
4015 *
4016 * Use this to save a few hundred bytes of ROM (default ordering of all
4017 * available ciphersuites) and a few to a few hundred bytes of RAM.
4018 *
4019 * The value below is only an example, not the default.
4020 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004021//#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 +02004022
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004023/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004024 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4025 *
4026 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004027 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004028 *
4029 * It must be positive and smaller than UINT32_MAX.
4030 *
4031 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4032 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004033 */
4034//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4035
4036/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004037 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4038 *
Jerry Yucf913512023-11-14 11:06:52 +08004039 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004040 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004041 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004042 * - The client ticket age is the time difference between the time when the
4043 * client proposes to the server to use the ticket and the time the client
4044 * received the ticket from the server.
4045 * - The server ticket age is the time difference between the time when the
4046 * server receives a proposition from the client to use the ticket and the
4047 * time when the ticket was created by the server.
4048 *
Jerry Yucf913512023-11-14 11:06:52 +08004049 * The ages might be different due to the client and server clocks not running
4050 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4051 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4052 * 6s, thus in the worst case clients and servers must sync up their system time
4053 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004054 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004055 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004056 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004057//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004058
4059/**
4060 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4061 *
4062 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4063 *
4064 * This must be less than 256.
4065 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004066//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004067
4068/**
4069 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4070 *
4071 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4072 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4073 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4074 *
4075 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004076//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004077
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004078/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004079//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004080//#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 +01004081
Gilles Peskine611179c2022-04-13 23:04:48 +02004082/** \} name SECTION: Module configuration options */