blob: 33b89ef469a0e929a9a2ceeabb48c6e8b5fc9d64 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020034 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000035 *
36 * Requires support for asm() in compiler.
37 *
38 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000039 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010040 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000041 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000042 * library/constant_time.c
Paul Bakker68041ec2009-04-19 21:17:55 +000043 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010044 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000045 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010046 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020048 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000051
Paul Bakkerf3b86c12011-01-27 15:24:17 +000052/**
Gilles Peskineed942f82017-06-08 15:19:20 +020053 * \def MBEDTLS_NO_UDBL_DIVISION
54 *
55 * The platform lacks support for double-width integer division (64-bit
56 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
57 *
58 * Used in:
59 * include/mbedtls/bignum.h
60 * library/bignum.c
61 *
62 * The bignum code uses double-width division to speed up some operations.
63 * Double-width division is often implemented in software that needs to
64 * be linked with the program. The presence of a double-width integer
65 * type is usually detected automatically through preprocessor macros,
66 * but the automatic detection cannot know whether the code needs to
67 * and can be linked with an implementation of division for that type.
68 * By default division is assumed to be usable if the type is present.
69 * Uncomment this option to prevent the use of double-width division.
70 *
71 * Note that division for the native integer type is always required.
72 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010073 * platform, but it need not support multiplication or division. In some
74 * cases it is also desirable to disable some double-width operations. For
75 * example, if double-width division is implemented in software, disabling
76 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020077 */
78//#define MBEDTLS_NO_UDBL_DIVISION
79
80/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020081 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
82 *
83 * The platform lacks support for 32x32 -> 64-bit multiplication.
84 *
85 * Used in:
86 * library/poly1305.c
87 *
88 * Some parts of the library may use multiplication of two unsigned 32-bit
89 * operands with a 64-bit result in order to speed up computations. On some
90 * platforms, this is not available in hardware and has to be implemented in
91 * software, usually in a library provided by the toolchain.
92 *
93 * Sometimes it is not desirable to have to link to that library. This option
94 * removes the dependency of that library on platforms that lack a hardware
95 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
96 *
97 * Note that depending on the compiler, this may decrease performance compared
98 * to using the library function provided by the toolchain.
99 */
100//#define MBEDTLS_NO_64BIT_MULTIPLICATION
101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000104 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000105 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200113 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200114 * System has time.h and time().
115 * The time does not need to be correct, only time differences are used,
116 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200117 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100118 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
119 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
120 * MBEDTLS_PLATFORM_STD_TIME.
121 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400122 * Comment if your system does not support time functions.
123 *
124 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
125 * interface - timing.c will include time.h on suitable platforms
126 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
127 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100130
131/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200132 * \def MBEDTLS_HAVE_TIME_DATE
133 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100134 * System has time.h, time(), and an implementation for
135 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100136 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200137 * the date should be correct). This is used to verify the validity period of
138 * X.509 certificates.
139 *
140 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100141 *
Hanno Becker6a739782018-09-05 15:06:19 +0100142 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100143 * behaves similarly to the gmtime_r() function from the C standard. Refer to
144 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100145 *
146 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100147 * mbedtls_platform_gmtime_r() at compile-time by using the macro
148 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200149 */
150#define MBEDTLS_HAVE_TIME_DATE
151
152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100154 *
155 * Enable the memory allocation layer.
156 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200157 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 * This allows different allocators (self-implemented or provided) to be
159 * provided to the platform abstraction layer.
160 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400161 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200162 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
163 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000164 * free() function pointer at runtime.
165 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400166 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100169 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400170 * An overview of how the value of mbedtls_calloc is determined:
171 *
172 * - if !MBEDTLS_PLATFORM_MEMORY
173 * - mbedtls_calloc = calloc
174 * - if MBEDTLS_PLATFORM_MEMORY
175 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
176 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
177 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
179 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
180 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
182 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
183 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
184 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
185 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
186 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
187 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
188 *
189 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
190 * - if !MBEDTLS_PLATFORM_STD_CALLOC
191 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
192 *
193 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
194 *
195 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
196 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
197 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
198 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
199 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
200 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100203 *
204 * Enable this layer to allow use of alternative memory allocators.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100207
208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200211 * Do not assign standard functions in the platform layer (e.g. calloc() to
212 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200213 *
214 * This makes sure there are no linking errors on platforms that do not support
215 * these functions. You will HAVE to provide alternatives, either at runtime
216 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
218 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
222 * Uncomment to prevent default assignment of standard functions in the
223 * platform layer.
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200226
227/**
Janos Follathc351d182016-03-21 08:43:59 +0000228 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200230 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100231 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200233 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 * alternative printf function pointer.
236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200239 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
240 * it will be enabled automatically by check_config.h
241 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200242 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000244 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100245 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
246 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 * Uncomment a macro to enable alternate implementation of specific base
248 * platform function
249 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200250//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100252//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_FPRINTF_ALT
254//#define MBEDTLS_PLATFORM_PRINTF_ALT
255//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200256//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100257//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100258//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800259//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260
261/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200262 * Uncomment the macro to let Mbed TLS use your alternate implementation of
263 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
264 * platform_util.c.
265 *
266 * gmtime() is not a thread-safe function as defined in the C standard. The
267 * library will try to use safer implementations of this function, such as
268 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
269 * system, the implementation of mbedtls_platform_gmtime_r() will default to
270 * using the standard gmtime(). In this case, calls from the library to
271 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
272 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
273 * library are also guarded with this mutex to avoid race conditions. However,
274 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
275 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
276 * supplied at compile time.
277 */
278//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
279
280/**
Gilles Peskine86733832023-09-07 15:02:39 +0200281 * Uncomment the macro to let Mbed TLS use your alternate implementation of
282 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
283 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200284 *
Gilles Peskine86733832023-09-07 15:02:39 +0200285 * By default, the library uses a system function such as memset_s()
286 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
287 * SecureZeroMemory (Windows). If no such function is detected, the library
288 * falls back to a plain C implementation. Compilers are technically
289 * permitted to optimize this implementation out, meaning that the memory is
290 * not actually wiped. The library tries to prevent that, but the C language
291 * makes it impossible to guarantee that the memory will always be wiped.
292 *
293 * If your platform provides a guaranteed method to wipe memory which
294 * `platform_util.c` does not detect, define this macro to the name of
295 * a function that takes two arguments, a `void *` pointer and a length,
296 * and wipes that many bytes starting at the specified address. For example,
297 * if your platform has explicit_bzero() but `platform_util.c` does not
298 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
299 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200300 */
301//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
302
303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Mark deprecated functions and features so that they generate a warning if
307 * used. Functionality deprecated in one version will usually be removed in the
308 * next version. You can enable this to help you prepare the transition to a
309 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100310 *
311 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100313 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000314 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317
318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100320 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000321 * Remove deprecated functions and features so that they generate an error if
322 * used. Functionality deprecated in one version will usually be removed in the
323 * next version. You can enable this to help you prepare the transition to a
324 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100325 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000326 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100330/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000331
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000332/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200333 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000334 *
335 * This section sets support for features that are or are not needed
336 * within the modules that are enabled.
337 * \{
338 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
TRodziewiczd8540832021-06-10 15:16:50 +0200343 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200344 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
348 * You will need to provide a header "timing_alt.h" and an implementation at
349 * compile time.
350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100352
Steven Cooreman63342772017-04-04 11:47:16 +0200353//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354//#define MBEDTLS_MD5_ALT
355//#define MBEDTLS_RIPEMD160_ALT
356//#define MBEDTLS_SHA1_ALT
357//#define MBEDTLS_SHA256_ALT
358//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000359
Paul Bakker90995b52013-06-24 19:20:35 +0200360/**
TRodziewicz75628d52021-06-18 12:56:27 +0200361 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200362 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200363 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100364 * alternate core implementation of symmetric crypto or hash function. Keep in
365 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200366 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200367 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200369 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200370 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200371 * no longer provide the mbedtls_sha1_process() function, but it will still provide
372 * the other function (using your mbedtls_sha1_process() function) and the definition
373 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200374 * with this definition.
375 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200376 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100377 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
378 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200379 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200380 * Uncomment a macro to enable alternate implementation of the corresponding
381 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100382 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200383 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100384 * constitutes a security risk. If possible, we recommend avoiding
385 * dependencies on them, and considering stronger message digests
386 * and ciphers instead.
387 *
Janos Follath1231d212019-01-07 15:01:32 +0000388 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
389 * enabled, then the deterministic ECDH signature functions pass the
390 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
391 * alternative implementations should use the RNG only for generating
392 * the ephemeral key and nothing else. If this is not possible, then
393 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200394 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000395 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200397//#define MBEDTLS_MD5_PROCESS_ALT
398//#define MBEDTLS_RIPEMD160_PROCESS_ALT
399//#define MBEDTLS_SHA1_PROCESS_ALT
400//#define MBEDTLS_SHA256_PROCESS_ALT
401//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200402//#define MBEDTLS_DES_SETKEY_ALT
403//#define MBEDTLS_DES_CRYPT_ECB_ALT
404//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200405//#define MBEDTLS_AES_SETKEY_ENC_ALT
406//#define MBEDTLS_AES_SETKEY_DEC_ALT
407//#define MBEDTLS_AES_ENCRYPT_ALT
408//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300409//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300410//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300411//#define MBEDTLS_ECDSA_VERIFY_ALT
412//#define MBEDTLS_ECDSA_SIGN_ALT
413//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200414
415/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200416 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200417 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200418 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200419 * hardware entropy collector.
420 *
421 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000422 * prototype as declared in library/entropy_poll.h, and accept NULL as first
423 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200424 *
425 * Uncomment to use your own hardware entropy collector.
426 */
427//#define MBEDTLS_ENTROPY_HARDWARE_ALT
428
429/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200430 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000431 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100432 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000433 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100434 * Uncomment this macro to use precomputed AES tables stored in ROM.
435 * Comment this macro to generate AES tables in RAM at runtime.
436 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100437 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
438 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100439 * initialization time before the first AES operation can be performed.
440 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
441 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
442 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100443 *
444 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200446//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000447
448/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100449 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200450 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100451 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200452 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100453 * Uncommenting this macro omits 75% of the AES tables from
454 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
455 * by computing their values on the fly during operations
456 * (the tables are entry-wise rotations of one another).
457 *
458 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100459 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100460 * runtime. Specifically, one has to compare 4 accesses within
461 * different tables to 4 accesses with additional arithmetic
462 * operations within the same table. The performance gain/loss
463 * depends on the system and memory details.
464 *
465 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200466 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100467//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200468
469/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800470 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
471 *
472 * Use only 128-bit keys in AES operations to save ROM.
473 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800474 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800475 * or 256-bit keys.
476 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800477 * Uncommenting this macro reduces the size of AES code by ~300 bytes
478 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800479 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800480 * Module: library/aes.c
481 *
482 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800483 */
484//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
485
Gilles Peskinea8861e02023-09-05 20:20:51 +0200486/*
487 * Disable plain C implementation for AES.
488 *
489 * When the plain C implementation is enabled, and an implementation using a
490 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
491 * detection will be used to select between them.
492 *
493 * If only one implementation is present, runtime detection will not be used.
494 * This configuration will crash at runtime if running on a CPU without the
495 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
496 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
497 */
498//#define MBEDTLS_AES_USE_HARDWARE_ONLY
499
Arto Kinnunen732ca322023-04-14 14:26:10 +0800500/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200501 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200502 *
503 * Use less ROM for the Camellia implementation (saves about 768 bytes).
504 *
505 * Uncomment this macro to use less memory for Camellia.
506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200507//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200508
509/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200510 * \def MBEDTLS_CHECK_RETURN_WARNING
511 *
512 * If this macro is defined, emit a compile-time warning if application code
513 * calls a function without checking its return value, but the return value
514 * should generally be checked in portable applications.
515 *
516 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
517 * implemented. Otherwise this option has no effect.
518 *
519 * Uncomment to get warnings on using fallible functions without checking
520 * their return value.
521 *
522 * \note This feature is a work in progress.
523 * Warnings will be added to more functions in the future.
524 *
525 * \note A few functions are considered critical, and ignoring the return
526 * value of these functions will trigger a warning even if this
527 * macro is not defined. To completely disable return value check
528 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
529 */
530//#define MBEDTLS_CHECK_RETURN_WARNING
531
532/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200534 *
535 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200537#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200538
539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000541 *
542 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000545
546/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200547 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000548 *
549 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000552
553/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100554 * \def MBEDTLS_CIPHER_MODE_OFB
555 *
556 * Enable Output Feedback mode (OFB) for symmetric ciphers.
557 */
558#define MBEDTLS_CIPHER_MODE_OFB
559
560/**
561 * \def MBEDTLS_CIPHER_MODE_XTS
562 *
563 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
564 */
565#define MBEDTLS_CIPHER_MODE_XTS
566
567/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200568 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000569 *
570 * Enable NULL cipher.
571 * Warning: Only do so when you know what you are doing. This allows for
572 * encryption or channels without any security!
573 *
Ronald Croncee42702021-04-26 11:34:44 +0200574 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
576 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
577 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
578 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
579 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
580 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
581 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
582 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
583 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
584 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
585 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
586 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
587 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
588 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
589 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
590 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
591 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
592 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
593 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000594 *
595 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000596 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200597//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000598
599/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100600 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200601 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100602 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
603 * specific padding modes in the cipher layer with cipher modes that support
604 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200605 *
606 * If you disable all padding modes, only full blocks can be used with CBC.
607 *
608 * Enable padding modes in the cipher layer.
609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610#define MBEDTLS_CIPHER_PADDING_PKCS7
611#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
612#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
613#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200614
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200615/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
616 *
617 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800618 * Without this, CTR_DRBG uses a 256-bit key
619 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200620 */
621//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
622
Paul Bakker48e93c82013-08-14 12:21:18 +0200623/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200624 * Enable the verified implementations of ECDH primitives from Project Everest
625 * (currently only Curve25519). This feature changes the layout of ECDH
626 * contexts and therefore is a compatibility break for applications that access
627 * fields of a mbedtls_ecdh_context structure directly. See also
628 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000629 *
630 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
631 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200632 */
633//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
634
635/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100636 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200637 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100638 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
639 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200640 *
641 * Comment macros to disable the curve and functions for it
642 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200643/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200644#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
645#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
646#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
647#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
648#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
649#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
650#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
651#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
652#define MBEDTLS_ECP_DP_BP256R1_ENABLED
653#define MBEDTLS_ECP_DP_BP384R1_ENABLED
654#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200655/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200656#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000657#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200658
659/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200661 *
662 * Enable specific 'modulo p' routines for each NIST prime.
663 * Depending on the prime and architecture, makes operations 4 to 8 times
664 * faster on the corresponding curve.
665 *
666 * Comment this macro to disable NIST curves optimisation.
667 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200668#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200669
670/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200671 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100672 *
673 * Enable "non-blocking" ECC operations that can return early and be resumed.
674 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200675 * This allows various functions to pause by returning
676 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
677 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
678 * order to further progress and eventually complete their operation. This is
679 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
680 * number of ECC operations a function may perform before pausing; see
681 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100682 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200683 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200684 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100685 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100686 * This option:
687 * - Adds xxx_restartable() variants of existing operations in the
688 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100689 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
690 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100691 * - ECDSA: signature generation & verification;
692 * - PK: signature generation & verification;
693 * - X509: certificate chain verification.
694 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
695 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
696 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
697 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000698 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100699 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100700 * - verification of the server's key exchange signature;
701 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100702 * - generation of the client's signature if client authentication is used,
703 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100704 *
705 * \note In the cases above, the usual SSL/TLS functions, such as
706 * mbedtls_ssl_handshake(), can now return
707 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200708 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100709 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
710 * restartable operations in PK, X.509 and TLS (see above) are not
711 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100712 * PSA, and are not restartable. These are temporary limitations that
713 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200714 *
Ron Eldor19779c42018-11-05 16:58:13 +0200715 * \note This option only works with the default software implementation of
716 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100717 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100718 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100719 * Requires: MBEDTLS_ECP_C
720 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100721 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100722 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200723//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100724
725/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200726 * Uncomment to enable using new bignum code in the ECC modules.
727 *
728 * \warning This is currently experimental, incomplete and therefore should not
729 * be used in production.
730 */
731//#define MBEDTLS_ECP_WITH_MPI_UINT
732
733/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200734 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100735 *
736 * Enable deterministic ECDSA (RFC 6979).
737 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
738 * may result in a compromise of the long-term signing key. This is avoided by
739 * the deterministic variant.
740 *
John Durkop36a82e52020-10-26 09:39:05 -0700741 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100742 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100743 * Comment this macro to disable deterministic ECDSA.
744 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100746
747/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200749 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200750 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200751 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200752 * This enables the following ciphersuites (if other requisites are
753 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200754 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
755 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
756 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
757 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
758 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
759 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
760 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
761 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
762 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
763 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200766
767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200769 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200770 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200771 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200772 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200773 *
774 * This enables the following ciphersuites (if other requisites are
775 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200776 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
777 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
778 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
779 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
780 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
781 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
782 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
783 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
784 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
785 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100786 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100787 * \warning Using DHE constitutes a security risk as it
788 * is not possible to validate custom DH parameters.
789 * If possible, it is recommended users should consider
790 * preferring other methods of key exchange.
791 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100792 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200794#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200795
796/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200798 *
799 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
800 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200801 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200802 *
803 * This enables the following ciphersuites (if other requisites are
804 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
806 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
807 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
808 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
809 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
810 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200812#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200813
814/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200815 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200816 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200817 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200818 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200819 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
820 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200821 *
822 * This enables the following ciphersuites (if other requisites are
823 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200824 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
825 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
826 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
827 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
828 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
829 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
830 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
831 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
832 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
833 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200834 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836
837/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200839 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200840 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200841 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
843 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200844 *
845 * This enables the following ciphersuites (if other requisites are
846 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200847 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
848 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
849 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
850 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
851 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
852 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
853 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
854 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
855 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
856 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
857 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
858 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861
862/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200863 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200865 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
868 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200869 *
870 * This enables the following ciphersuites (if other requisites are
871 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
873 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
874 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
875 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
876 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
877 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
878 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
879 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
880 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
881 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
882 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
883 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100884 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100885 * \warning Using DHE constitutes a security risk as it
886 * is not possible to validate custom DH parameters.
887 * If possible, it is recommended users should consider
888 * preferring other methods of key exchange.
889 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100890 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200891 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200893
894/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200896 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200897 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200898 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200899 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
900 * MBEDTLS_RSA_C
901 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200903 *
904 * This enables the following ciphersuites (if other requisites are
905 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
907 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
908 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
909 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
913 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
914 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
915 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200916 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200917#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200918
919/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200920 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200921 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200922 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200923 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200924 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
925 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
926 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200927 *
928 * This enables the following ciphersuites (if other requisites are
929 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
938 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
939 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200940 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200941#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200942
943/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200944 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100945 *
946 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
947 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200948 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
949 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
950 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100951 *
952 * This enables the following ciphersuites (if other requisites are
953 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
955 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
956 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
957 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
960 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
961 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
962 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
963 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100964 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100966
967/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100969 *
970 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
971 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200972 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
973 * MBEDTLS_RSA_C
974 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100975 *
976 * This enables the following ciphersuites (if other requisites are
977 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200978 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
979 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
980 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
981 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
982 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
983 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
984 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
985 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
986 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
987 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100988 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100990
991/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200992 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
993 *
994 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
995 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200996 * \warning This is currently experimental. EC J-PAKE support is based on the
997 * Thread v1.0.0 specification; incompatible changes to the specification
998 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200999 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001000 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001001 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001002 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1003 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001004 * \warning If SHA-256 is provided only by a PSA driver, you must call
1005 * psa_crypto_init() before the first hanshake (even if
1006 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1007 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001008 * This enables the following ciphersuites (if other requisites are
1009 * enabled as well):
1010 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1011 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001012//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001013
1014/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001016 *
1017 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1018 * RFC 5915 and RFC 5480.
1019 *
1020 * Currently this means parsing the SpecifiedECDomain choice of EC
1021 * parameters (only known groups are supported, not arbitrary domains, to
1022 * avoid validation issues).
1023 *
1024 * Disable if you only need to support RFC 5915 + 5480 key formats.
1025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001027
1028/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001029 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1030 *
1031 * Enable the support for parsing public keys of type Short Weierstrass
1032 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001033 * compressed point format. This parsing is done through ECP module's functions.
1034 *
1035 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1036 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1037 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001038 */
1039#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1040
1041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001043 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * Enable a dummy error function to make use of mbedtls_strerror() in
1045 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1046 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001047 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1049 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001050 *
1051 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001055
1056/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001057 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001058 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001059 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001060 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001062 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001064
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001065/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001067 *
1068 * Enable functions that use the filesystem.
1069 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001071
1072/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001074 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001075 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001076 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001077 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001078 * application.
1079 *
1080 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001081 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001083
1084/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001086 *
1087 * Do not use built-in platform entropy functions.
1088 * This is useful if your platform does not support
1089 * standards like the /dev/urandom or Windows CryptoAPI.
1090 *
1091 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001092 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001093//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001094
1095/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001097 *
1098 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1099 * default SHA-512 based one (if both are available).
1100 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001102 *
1103 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1104 * if you have performance concerns.
1105 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 * This option is only useful if both MBEDTLS_SHA256_C and
1107 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001110
1111/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001112 * \def MBEDTLS_ENTROPY_NV_SEED
1113 *
1114 * Enable the non-volatile (NV) seed file-based entropy source.
1115 * (Also enables the NV seed read/write functions in the platform layer)
1116 *
1117 * This is crucial (if not required) on systems that do not have a
1118 * cryptographic entropy source (in hardware or kernel) available.
1119 *
1120 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1121 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001122 * \note The read/write functions that are used by the entropy source are
1123 * determined in the platform layer, and can be modified at runtime and/or
1124 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1125 *
1126 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001127 * with regular fopen(), please make sure you make a seedfile with the
1128 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1129 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001130 * and written to or you will get an entropy source error! The default
1131 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1132 * bytes from the file.
1133 *
1134 * \note The entropy collector will write to the seed file before entropy is
1135 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001136 */
1137//#define MBEDTLS_ENTROPY_NV_SEED
1138
Ronald Cron71016a92020-08-28 19:01:50 +02001139/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001140 *
Ronald Cron71016a92020-08-28 19:01:50 +02001141 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001142 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001143 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1144 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001145 *
1146 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001147 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001148 */
Ronald Cron71016a92020-08-28 19:01:50 +02001149//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001150
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001151/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001153 *
1154 * Enable debugging of buffer allocator memory issues. Automatically prints
1155 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1156 * function for 'debug output' of allocated memory.
1157 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001159 *
1160 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001161 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001163
1164/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001166 *
1167 * Include backtrace information with each allocated block.
1168 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001170 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001171 *
1172 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001175
1176/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001178 *
1179 * Support external private RSA keys (eg from a HSM) in the PK layer.
1180 *
1181 * Comment this macro to disable support for external private RSA keys.
1182 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001183#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001184
1185/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001187 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001188 * Enable support for PKCS#1 v1.5 encoding.
1189 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001190 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001191 *
Paul Bakker48377d92013-08-30 12:06:24 +02001192 * This enables support for PKCS#1 v1.5 operations.
1193 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001195
1196/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001197 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001198 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001199 * Enable support for PKCS#1 v2.1 encoding.
1200 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001201 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001202 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001203 * \warning If using a hash that is only provided by PSA drivers, you must
1204 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001205 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001206 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001208#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001209
Steven Cooreman6801f082021-02-19 17:21:22 +01001210/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1211 *
1212 * Enable support for platform built-in keys. If you enable this feature,
1213 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1214 * See the documentation of that function for more information.
1215 *
1216 * Built-in keys are typically derived from a hardware unique key or
1217 * stored in a secure element.
1218 *
1219 * Requires: MBEDTLS_PSA_CRYPTO_C.
1220 *
1221 * \warning This interface is experimental and may change or be removed
1222 * without notice.
1223 */
1224//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1225
Ronald Cron3768ac12021-01-26 16:58:00 +01001226/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1227 *
1228 * Enable support for PSA crypto client.
1229 *
1230 * \note This option allows to include the code necessary for a PSA
1231 * crypto client when the PSA crypto implementation is not included in
1232 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1233 * code to set and get PSA key attributes.
1234 * The development of PSA drivers partially relying on the library to
1235 * fulfill the hardware gaps is another possible usage of this option.
1236 *
1237 * \warning This interface is experimental and may change or be removed
1238 * without notice.
1239 */
1240//#define MBEDTLS_PSA_CRYPTO_CLIENT
1241
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001242/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1243 *
1244 * Make the PSA Crypto module use an external random generator provided
1245 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1246 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001247 * \note This random generator must deliver random numbers with cryptographic
1248 * quality and high performance. It must supply unpredictable numbers
1249 * with a uniform distribution. The implementation of this function
1250 * is responsible for ensuring that the random generator is seeded
1251 * with sufficient entropy. If you have a hardware TRNG which is slow
1252 * or delivers non-uniform output, declare it as an entropy source
1253 * with mbedtls_entropy_add_source() instead of enabling this option.
1254 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001255 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001256 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1257 * and define a function called mbedtls_psa_external_get_random()
1258 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001259 * ```
1260 * psa_status_t mbedtls_psa_external_get_random(
1261 * mbedtls_psa_external_random_context_t *context,
1262 * uint8_t *output, size_t output_size, size_t *output_length);
1263 * );
1264 * ```
1265 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001266 * The function must fill the \c output buffer with \c output_size bytes
1267 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001268 *
1269 * Requires: MBEDTLS_PSA_CRYPTO_C
1270 *
1271 * \warning If you enable this option, code that uses the PSA cryptography
1272 * interface will not use any of the entropy sources set up for
1273 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1274 * enables.
1275 *
1276 * \note This option is experimental and may be removed without notice.
1277 */
1278//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1279
Paul Bakker9dcc3222011-03-08 14:16:06 +00001280/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001281 * \def MBEDTLS_PSA_CRYPTO_SPM
1282 *
1283 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1284 * Partition Manager) integration which separates the code into two parts: a
1285 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1286 * Environment).
1287 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001288 * If you enable this option, your build environment must include a header
1289 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1290 * header files, or in another directory on the compiler's include search
1291 * path). Alternatively, your platform may customize the header
1292 * `psa/crypto_platform.h`, in which case it can skip or replace the
1293 * inclusion of `"crypto_spe.h"`.
1294 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001295 * Module: library/psa_crypto.c
1296 * Requires: MBEDTLS_PSA_CRYPTO_C
1297 *
1298 */
1299//#define MBEDTLS_PSA_CRYPTO_SPM
1300
1301/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001302 * Uncomment to enable p256-m. This is an alternative implementation of
1303 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1304 * Compared to the default implementation:
1305 *
1306 * - p256-m has a much smaller code size and RAM footprint.
1307 * - p256-m is only available via the PSA API. This includes the pk module
1308 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1309 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1310 * over the core arithmetic, or deterministic derivation of keys.
1311 *
1312 * We recommend enabling this option if your application uses the PSA API
1313 * and the only elliptic curve support it needs is ECDH and ECDSA over
1314 * SECP256R1.
1315 *
1316 * If you enable this option, you do not need to enable any ECC-related
1317 * MBEDTLS_xxx option. You do need to separately request support for the
1318 * cryptographic mechanisms through the PSA API:
1319 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1320 * configuration;
1321 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1322 * - #PSA_WANT_ECC_SECP_R1_256;
1323 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1324 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1325 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1326 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1327 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001328 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001329 * \note To benefit from the smaller code size of p256-m, make sure that you
1330 * do not enable any ECC-related option not supported by p256-m: this
1331 * would cause the built-in ECC implementation to be built as well, in
1332 * order to provide the required option.
1333 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001334 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1335 * SECP256R1 are disabled as they are not supported by this driver.
1336 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1337 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001338 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001339 */
1340//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1341
1342/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001343 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001344 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001345 * Enable support for entropy injection at first boot. This feature is
1346 * required on systems that do not have a built-in entropy source (TRNG).
1347 * This feature is currently not supported on systems that have a built-in
1348 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001349 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001350 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001351 *
1352 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001353//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001354
1355/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001356 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001357 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001358 * Assume all buffers passed to PSA functions are owned exclusively by the
1359 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001360 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001361 * This option may be enabled if all buffers passed to any PSA function reside
1362 * in memory that is accessible only to the PSA function during its execution.
1363 *
1364 * This option MUST be disabled whenever buffer arguments are in memory shared
1365 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001366 * across a trust boundary.
1367 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001368 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001369 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001370 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001371 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001372 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001373//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001374
1375/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001376 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001377 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001378 * Do not use the Chinese Remainder Theorem
1379 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001380 *
1381 * Uncomment this macro to disable the use of CRT in RSA.
1382 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001384//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001385
1386/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001387 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001388 *
1389 * Enable the checkup functions (*_self_test).
1390 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001392
1393/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001394 * \def MBEDTLS_SHA256_SMALLER
1395 *
1396 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1397 * lower performance.
1398 *
Adam Wolf039080f2019-09-10 09:53:08 -05001399 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001400 * performance and size. This version optimizes more aggressively for size at
1401 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1402 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1403 * 30%.
1404 *
1405 * Uncomment to enable the smaller implementation of SHA256.
1406 */
1407//#define MBEDTLS_SHA256_SMALLER
1408
1409/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001410 * \def MBEDTLS_SHA512_SMALLER
1411 *
1412 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1413 * lower performance.
1414 *
1415 * Uncomment to enable the smaller implementation of SHA512.
1416 */
1417//#define MBEDTLS_SHA512_SMALLER
1418
1419/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001421 *
1422 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001423 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001424 * with other servers, only debugging of failures is harder.
1425 *
1426 * The advantage of not sending alert messages, is that no information is given
1427 * about reasons for failures thus preventing adversaries of gaining intel.
1428 *
1429 * Enable sending of all alert messages
1430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001431#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001432
1433/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001434 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1435 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001436 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001437 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001438 * in the underlying transport. The CID functionality is described
1439 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001440 *
1441 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001442 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1443 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1444 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001445 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001446 * The maximum lengths of outgoing and incoming CIDs can be configured
1447 * through the options
1448 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1449 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1450 *
1451 * Requires: MBEDTLS_SSL_PROTO_DTLS
1452 *
1453 * Uncomment to enable the Connection ID extension.
1454 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001455#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1456
1457
1458/**
1459 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1460 *
1461 * Defines whether RFC 9146 (default) or the legacy version
1462 * (version draft-ietf-tls-dtls-connection-id-05,
1463 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1464 * is used.
1465 *
1466 * Set the value to 0 for the standard version, and
1467 * 1 for the legacy draft version.
1468 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001469 * \deprecated Support for the legacy version of the DTLS
1470 * Connection ID feature is deprecated. Please
1471 * switch to the standardized version defined
1472 * in RFC 9146 enabled by utilizing
1473 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1474 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1475 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001476 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1477 */
1478#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001479
1480/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001481 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1482 *
1483 * Enable asynchronous external private key operations in SSL. This allows
1484 * you to configure an SSL connection to call an external cryptographic
1485 * module to perform private key operations instead of performing the
1486 * operation inside the library.
1487 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001488 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001489 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001490//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001491
1492/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001493 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1494 *
1495 * Enable serialization of the TLS context structures, through use of the
1496 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1497 *
1498 * This pair of functions allows one side of a connection to serialize the
1499 * context associated with the connection, then free or re-use that context
1500 * while the serialized state is persisted elsewhere, and finally deserialize
1501 * that state to a live context for resuming read/write operations on the
1502 * connection. From a protocol perspective, the state of the connection is
1503 * unaffected, in particular this is entirely transparent to the peer.
1504 *
1505 * Note: this is distinct from TLS session resumption, which is part of the
1506 * protocol and fully visible by the peer. TLS session resumption enables
1507 * establishing new connections associated to a saved session with shorter,
1508 * lighter handshakes, while context serialization is a local optimization in
1509 * handling a single, potentially long-lived connection.
1510 *
1511 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1512 * saved after the handshake to allow for more efficient serialization, so if
1513 * you don't need this feature you'll save RAM by disabling it.
1514 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001515 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1516 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001517 * Comment to disable the context serialization APIs.
1518 */
1519#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1520
1521/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001522 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001523 *
1524 * Enable the debug messages in SSL module for all issues.
1525 * Debug messages have been disabled in some places to prevent timing
1526 * attacks due to (unbalanced) debugging function calls.
1527 *
1528 * If you need all error reporting you should enable this during debugging,
1529 * but remove this for production servers that should log as well.
1530 *
1531 * Uncomment this macro to report all debug messages on errors introducing
1532 * a timing side-channel.
1533 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001536
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001537/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001538 *
1539 * Enable support for Encrypt-then-MAC, RFC 7366.
1540 *
1541 * This allows peers that both support it to use a more robust protection for
1542 * ciphersuites using CBC, providing deep resistance against timing attacks
1543 * on the padding or underlying cipher.
1544 *
1545 * This only affects CBC ciphersuites, and is useless if none is defined.
1546 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001547 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001548 *
1549 * Comment this macro to disable support for Encrypt-then-MAC
1550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001551#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001552
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001553/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001554 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001555 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1556 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001557 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001558 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001559 * attacks, but it is recommended to always use it (even if you disable
1560 * renegotiation), since it actually fixes a more fundamental issue in the
1561 * original SSL/TLS design, and has implications beyond Triple Handshake.
1562 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001563 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001564 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001565 * Comment this macro to disable support for Extended Master Secret.
1566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001568
Paul Bakkerd66f0702013-01-31 16:57:45 +01001569/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001570 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1571 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001572 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001573 * giving access to the peer's certificate after completion of the handshake.
1574 *
1575 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1576 * recommended to disable this option for reduced RAM usage.
1577 *
1578 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1579 * defined, but always returns \c NULL.
1580 *
1581 * \note This option has no influence on the protection against the
1582 * triple handshake attack. Even if it is disabled, Mbed TLS will
1583 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001584 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001585 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001586 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001587 *
1588 * Comment this macro to disable storing the peer's certificate
1589 * after the handshake.
1590 */
1591#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1592
1593/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001594 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001595 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001596 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001597 *
1598 * The two main uses of renegotiation are (1) refresh keys on long-lived
1599 * connections and (2) client authentication after the initial handshake.
1600 * If you don't need renegotiation, it's probably better to disable it, since
1601 * it has been associated with security issues in the past and is easy to
1602 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001603 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001604 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1605 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001606 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001607 *
1608 * \note Even if this option is disabled, both client and server are aware
1609 * of the Renegotiation Indication Extension (RFC 5746) used to
1610 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1611 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1612 * configuration of this extension).
1613 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001615#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001616
1617/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001618 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001619 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001620 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001621 *
1622 * Comment this macro to disable support for the max_fragment_length extension
1623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001624#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001625
1626/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001627 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1628 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001629 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001630 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001631 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1632 *
1633 * Uncomment this macro to enable support for the record_size_limit extension
1634 */
1635//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1636
1637/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001638 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001639 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001640 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001641 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001642 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001643 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1644 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001645 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001646 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001647 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001648 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1649 * are only provided by PSA drivers, you must call psa_crypto_init() before
1650 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001651 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001652 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001653 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001655
1656/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001657 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001658 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001659 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001660 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001661 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001662 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001663 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001664 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001665 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001666 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001667 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1668 * directly performed by TLS 1.3 code. As a consequence, you must
1669 * call psa_crypto_init() before the first TLS 1.3 handshake.
1670 *
1671 * \note Cryptographic operations performed indirectly via another module
1672 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1673 * running handshake hash) only use PSA crypto if
1674 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001675 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001676 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001677 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001678#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001679
1680/**
Ronald Cronab65c522021-11-24 10:47:20 +01001681 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1682 *
1683 * Enable TLS 1.3 middlebox compatibility mode.
1684 *
1685 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1686 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1687 * expecting TLS 1.2 traffic.
1688 *
1689 * Turning on the compatibility mode comes at the cost of a few added bytes
1690 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1691 * that don't use it. Therefore, unless transmission bandwidth is critical and
1692 * you know that middlebox compatibility issues won't occur, it is therefore
1693 * recommended to set this option.
1694 *
1695 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001696 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1697 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001698 *
1699 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001700#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001701
1702/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001703 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1704 *
1705 * Enable TLS 1.3 PSK key exchange mode.
1706 *
1707 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1708 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1709 * effect on the build.
1710 *
1711 */
1712#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1713
1714/**
1715 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1716 *
1717 * Enable TLS 1.3 ephemeral key exchange mode.
1718 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001719 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001720 * MBEDTLS_X509_CRT_PARSE_C
1721 * and at least one of:
1722 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1723 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001724 *
1725 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1726 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1727 * effect on the build.
1728 *
1729 */
1730#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1731
1732/**
1733 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1734 *
1735 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1736 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001737 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001738 *
1739 * Comment to disable support for the PSK ephemeral key exchange mode in
1740 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1741 * have any effect on the build.
1742 *
1743 */
1744#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1745
1746/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 * \def MBEDTLS_SSL_EARLY_DATA
1748 *
1749 * Enable support for RFC 8446 TLS 1.3 early data.
1750 *
1751 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1752 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1753 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1754 *
1755 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1756 * is not enabled, this option does not have any effect on the build.
1757 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001758 * \note The maximum amount of early data can be set with
1759 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1760 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001762//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001763
1764/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001766 *
1767 * Enable support for DTLS (all available versions).
1768 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001769 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001770 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001771 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001772 *
1773 * Comment this macro to disable support for DTLS
1774 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001776
1777/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001778 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001779 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001780 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001781 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001782 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001783 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001784#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001785
1786/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001788 *
1789 * Enable support for the anti-replay mechanism in DTLS.
1790 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791 * Requires: MBEDTLS_SSL_TLS_C
1792 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001793 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001794 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001795 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001796 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001797 * Comment this to disable anti-replay in DTLS.
1798 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001800
1801/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001803 *
1804 * Enable support for HelloVerifyRequest on DTLS servers.
1805 *
1806 * This feature is highly recommended to prevent DTLS servers being used as
1807 * amplifiers in DoS attacks against other hosts. It should always be enabled
1808 * unless you know for sure amplification cannot be a problem in the
1809 * environment in which your server operates.
1810 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001811 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001812 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001813 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001814 *
1815 * Comment this to disable support for HelloVerifyRequest.
1816 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001818
1819/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001820 * \def MBEDTLS_SSL_DTLS_SRTP
1821 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001822 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001823 * through the use_srtp extension.
1824 *
1825 * \note This feature provides the minimum functionality required
1826 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1827 * the associated SRTP packet protection key material.
1828 * In particular, the SRTP packet protection itself, as well as the
1829 * demultiplexing of RTP and DTLS packets at the datagram layer
1830 * (see Section 5 of RFC 5764), are not handled by this feature.
1831 * Instead, after successful completion of a handshake negotiating
1832 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001833 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001834 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1835 * (this is implemented in the SSL example programs).
1836 * The resulting key should then be passed to an SRTP stack.
1837 *
1838 * Setting this option enables the runtime API
1839 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1840 * through which the supported DTLS-SRTP protection
1841 * profiles can be configured. You must call this API at
1842 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001843 *
1844 * Requires: MBEDTLS_SSL_PROTO_DTLS
1845 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001846 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001847 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001848//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001849
1850/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001851 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1852 *
1853 * Enable server-side support for clients that reconnect from the same port.
1854 *
1855 * Some clients unexpectedly close the connection and try to reconnect using the
1856 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001857 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001858 * flag enables that support.
1859 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001860 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001861 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001862 * Comment this to disable support for clients reusing the source port.
1863 */
1864#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1865
1866/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001867 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001868 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001869 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001870 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001871 * session store remains the responsibility of the application, though).
1872 * Server-side, you also need to provide callbacks for writing and parsing
1873 * tickets, including authenticated encryption and key management. Example
1874 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001875 *
1876 * Comment this macro to disable support for SSL session tickets
1877 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001878#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001879
1880/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001882 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001883 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001884 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001886 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001887 * Comment this macro to disable support for server name indication in SSL
1888 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001889#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001890
1891/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001892 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1893 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001894 * When this option is enabled, the SSL buffer will be resized automatically
1895 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001896 *
1897 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001898 */
1899//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1900
1901/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001902 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1903 *
1904 * Enable testing of the constant-flow nature of some sensitive functions with
1905 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001906 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001907 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001908 * This setting requires compiling with clang -fsanitize=memory. The test
1909 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001910 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001911 * \warning This macro is only used for extended testing; it is not considered
1912 * part of the library's API, so it may change or disappear at any time.
1913 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001914 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001915 */
1916//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1917
1918/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001919 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1920 *
1921 * Enable testing of the constant-flow nature of some sensitive functions with
1922 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001923 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001924 *
1925 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001926 * testing if the tests suites are run with valgrind's memcheck. This can be
1927 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1928 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001929 *
1930 * \warning This macro is only used for extended testing; it is not considered
1931 * part of the library's API, so it may change or disappear at any time.
1932 *
1933 * Uncomment to enable testing of the constant-flow nature of selected code.
1934 */
1935//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1936
1937/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001938 * \def MBEDTLS_TEST_HOOKS
1939 *
1940 * Enable features for invasive testing such as introspection functions and
1941 * hooks for fault injection. This enables additional unit tests.
1942 *
1943 * Merely enabling this feature should not change the behavior of the product.
1944 * It only adds new code, and new branching points where the default behavior
1945 * is the same as when this feature is disabled.
1946 * However, this feature increases the attack surface: there is an added
1947 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1948 * Therefore this feature must never be enabled in production.
1949 *
1950 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1951 * information.
1952 *
1953 * Uncomment to enable invasive tests.
1954 */
1955//#define MBEDTLS_TEST_HOOKS
1956
1957/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001958 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001959 *
1960 * Provide your own alternate threading implementation.
1961 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001963 *
1964 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001967
1968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001970 *
1971 * Enable the pthread wrapper layer for the threading layer.
1972 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001974 *
1975 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001976 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001978
1979/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001980 * \def MBEDTLS_USE_PSA_CRYPTO
1981 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001982 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1983 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001984 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001985 * \note Development of this option is currently in progress, and parts of Mbed
1986 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001987 * will still continue to work as usual, so enabling this option should not
1988 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001989 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001990 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001991 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1992 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001993 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001994 * \note An important and desirable effect of this option is that it allows
1995 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1996 * 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 +02001997 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001998 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1999 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002000 *
2001 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002002 *
2003 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002004 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002005 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002006 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002007//#define MBEDTLS_USE_PSA_CRYPTO
2008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002010 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2011 *
John Durkop185764f2020-10-12 21:32:12 -07002012 * This setting allows support for cryptographic mechanisms through the PSA
2013 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002014 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002015 * When this option is disabled, the PSA API exposes the cryptographic
2016 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2017 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002018 *
2019 * When this option is enabled, the PSA API exposes the cryptographic
2020 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2021 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2022 * automatically enabled if required (i.e. if no PSA driver provides the
2023 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2024 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002025 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002026 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002027 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002028 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002029 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2030 * symbols is not completely finalized yet, and the configuration
2031 * tooling is not ideally adapted to having two separate configuration
2032 * files.
2033 * Future minor releases of Mbed TLS may make minor changes to those
2034 * symbols, but we will endeavor to provide a transition path.
2035 * Nonetheless, this option is considered mature enough to use in
2036 * production, as long as you accept that you may need to make
2037 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002038 */
2039//#define MBEDTLS_PSA_CRYPTO_CONFIG
2040
2041/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002042 * \def MBEDTLS_VERSION_FEATURES
2043 *
2044 * Allow run-time checking of compile-time enabled features. Thus allowing users
2045 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002046 * support via mbedtls_version_check_feature().
2047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002048 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002049 *
2050 * Comment this to disable run-time checking and save ROM space
2051 */
2052#define MBEDTLS_VERSION_FEATURES
2053
2054/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002055 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2056 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002057 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002058 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2059 * the set of trusted certificates through a callback instead of a linked
2060 * list.
2061 *
2062 * This is useful for example in environments where a large number of trusted
2063 * certificates is present and storing them in a linked list isn't efficient
2064 * enough, or when the set of trusted certificates changes frequently.
2065 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002066 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002067 * `mbedtls_ssl_conf_ca_cb()` for more information.
2068 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002069 * Requires: MBEDTLS_X509_CRT_PARSE_C
2070 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002071 * Uncomment to enable trusted certificate callbacks.
2072 */
2073//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2074
2075/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002076 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002077 *
Chris Jones2c745862020-12-16 11:41:06 +00002078 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002079 *
Chris Jones2c745862020-12-16 11:41:06 +00002080 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002081 * and other functions/constants only used by these functions, thus reducing
2082 * the code footprint by several KB.
2083 */
Chris Jones2c745862020-12-16 11:41:06 +00002084//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002085
2086/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002087 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002088 *
2089 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2090 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2091 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002092 * Requires: MBEDTLS_PKCS1_V21
2093 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002094 * Comment this macro to disallow using RSASSA-PSS in certificates.
2095 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002096#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002097/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002098
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002099/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002100 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002101 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002102 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002103 * \{
2104 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002105
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002106/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002107 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002108 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002109 * Enable AES-NI support on x86-64 or x86-32.
2110 *
2111 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002112 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002113 * - GCC, x86-64, target not explicitly supporting AESNI:
2114 * requires MBEDTLS_HAVE_ASM.
2115 * - GCC, x86-32, target not explicitly supporting AESNI:
2116 * not supported.
2117 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2118 * For this assembly-less implementation, you must currently compile
2119 * `library/aesni.c` and `library/aes.c` with machine options to enable
2120 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2121 * `clang -maes -mpclmul`.
2122 * - Non-x86 targets: this option is silently ignored.
2123 * - Other compilers: this option is silently ignored.
2124 *
2125 * \note
2126 * Above, "GCC" includes compatible compilers such as Clang.
2127 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002128 *
2129 * Module: library/aesni.c
2130 * Caller: library/aes.c
2131 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002132 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002133 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002134 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002136#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002137
2138/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002139 * \def MBEDTLS_AESCE_C
2140 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002141 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002142 *
2143 * Module: library/aesce.c
2144 * Caller: library/aes.c
2145 *
Jerry Yuf015a932023-04-25 10:38:03 +08002146 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002147 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002148 * \warning Runtime detection only works on Linux. For non-Linux operating
2149 * system, Armv8-A Cryptographic Extensions must be supported by
2150 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002151 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002152 * \note Minimum compiler versions for this feature when targeting aarch64
2153 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2154 * Minimum compiler versions for this feature when targeting 32-bit
2155 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002156 *
2157 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2158 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002159 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002160 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002161 */
2162#define MBEDTLS_AESCE_C
2163
2164/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002165 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002166 *
2167 * Enable the AES block cipher.
2168 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002169 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002170 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002171 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002172 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002173 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002174 * This module enables the following ciphersuites (if other requisites are
2175 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002176 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2177 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2178 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2179 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2180 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2181 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2182 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2183 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2184 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2185 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2186 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2187 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2188 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2189 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2190 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2191 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2192 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2193 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2194 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2195 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2196 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2197 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2198 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2199 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2200 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2201 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2202 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2203 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2204 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2205 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2206 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2207 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2208 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2209 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2210 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2211 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2212 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2213 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2214 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2215 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2216 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2217 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2218 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2219 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2220 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2221 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2222 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2223 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2224 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2225 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2226 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2227 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2228 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2229 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2230 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2231 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2232 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2233 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002234 *
Paul Bakkercff68422013-09-15 20:43:33 +02002235 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002236 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002238
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002239/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002240 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002241 *
2242 * Enable the generic ASN1 parser.
2243 *
2244 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002245 * Caller: library/x509.c
2246 * library/dhm.c
2247 * library/pkcs12.c
2248 * library/pkcs5.c
2249 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002251#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002252
2253/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002254 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002255 *
2256 * Enable the generic ASN1 writer.
2257 *
2258 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002259 * Caller: library/ecdsa.c
2260 * library/pkwrite.c
2261 * library/x509_create.c
2262 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002263 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002264 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002265#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002266
2267/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002269 *
2270 * Enable the Base64 module.
2271 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002272 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002273 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002274 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002275 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002276 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002277#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002278
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002279/**
Yanray Wange367e472023-10-31 17:23:04 +08002280 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2281 *
2282 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2283 *
2284 * \note This feature is incompatible with insecure block cipher,
2285 * MBEDTLS_DES_C, and cipher modes which always require decryption
2286 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002287 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2288 * this feature is incompatible with following supported PSA equivalence,
2289 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2290 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002291 *
2292 * Module: library/aes.c
2293 * library/aesce.c
2294 * library/aesni.c
2295 * library/aria.c
2296 * library/camellia.c
2297 * library/cipher.c
2298 */
2299//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2300
2301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002302 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002303 *
Paul Bakker9a736322012-11-14 12:39:52 +00002304 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002305 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002306 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002307 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002308 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002309 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002310 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002311 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002312 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002313 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002314 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002315 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002316 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002317 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002319#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002320
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002321/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002323 *
2324 * Enable the Camellia block cipher.
2325 *
Paul Bakker38119b12009-01-10 23:31:23 +00002326 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002327 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002328 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002329 * This module enables the following ciphersuites (if other requisites are
2330 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002331 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2332 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2333 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2334 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2335 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2336 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2337 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2338 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2339 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2340 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2341 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2342 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2343 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2344 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2345 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2346 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2347 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2348 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2349 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2350 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2351 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2352 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2353 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2354 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2355 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2356 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2357 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2358 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2359 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2360 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2361 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2362 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2363 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2364 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2365 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2366 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2367 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2368 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2369 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2370 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2371 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2372 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002373 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002374#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002375
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002376/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002377 * \def MBEDTLS_ARIA_C
2378 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002379 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002380 *
2381 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002382 * Caller: library/cipher.c
2383 *
2384 * This module enables the following ciphersuites (if other requisites are
2385 * enabled as well):
2386 *
2387 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2388 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2389 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2390 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2391 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2392 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2393 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2394 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2395 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2396 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2397 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2398 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2399 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2400 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2401 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2402 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2403 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2404 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2405 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2406 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2407 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2408 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2409 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2410 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2411 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2412 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2413 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2414 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2415 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2416 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2417 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2418 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2419 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2420 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2421 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2422 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2423 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2424 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002425 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002426#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002427
2428/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002430 *
2431 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2432 *
2433 * Module: library/ccm.c
2434 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002435 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2436 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002437 *
2438 * This module enables the AES-CCM ciphersuites, if other requisites are
2439 * enabled as well.
2440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002441#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002442
2443/**
Daniel King34b822c2016-05-15 17:28:08 -03002444 * \def MBEDTLS_CHACHA20_C
2445 *
2446 * Enable the ChaCha20 stream cipher.
2447 *
2448 * Module: library/chacha20.c
2449 */
2450#define MBEDTLS_CHACHA20_C
2451
2452/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002453 * \def MBEDTLS_CHACHAPOLY_C
2454 *
2455 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2456 *
2457 * Module: library/chachapoly.c
2458 *
2459 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2460 */
2461#define MBEDTLS_CHACHAPOLY_C
2462
2463/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002464 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002465 *
2466 * Enable the generic cipher layer.
2467 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002468 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002469 * Caller: library/ccm.c
2470 * library/cmac.c
2471 * library/gcm.c
2472 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002473 * library/pkcs12.c
2474 * library/pkcs5.c
2475 * library/psa_crypto_aead.c
2476 * library/psa_crypto_mac.c
2477 * library/ssl_ciphersuites.c
2478 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002479 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002480 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2481 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002482 *
2483 * Uncomment to enable generic cipher wrappers.
2484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002486
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002487/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002488 * \def MBEDTLS_CMAC_C
2489 *
Simon Butcher327398a2016-10-05 14:09:11 +01002490 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2491 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002492 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002493 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2494 * implementation of the CMAC algorithm is provided by an alternate
2495 * implementation, that alternate implementation may opt to not support
2496 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2497 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002498 * Module: library/cmac.c
2499 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002500 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002501 *
2502 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002503#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002504
2505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002507 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002508 * Enable the CTR_DRBG AES-based random generator.
2509 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002510 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002511 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002512 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2513 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2514 * is used.
2515 *
2516 * \warning When using PSA, the user should call `psa_crypto_init()` before
2517 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2518 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002519 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2520 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002521 * \note To achieve a 256-bit security strength with CTR_DRBG,
2522 * you must use AES-256 *and* use sufficient entropy.
2523 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002524 *
2525 * Module: library/ctr_drbg.c
2526 * Caller:
2527 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002528 * Requires: MBEDTLS_AES_C or
2529 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2530 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002531 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002532 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002535
2536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002538 *
2539 * Enable the debug functions.
2540 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002541 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002542 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002543 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002544 * library/ssl_tls12_*.c
2545 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002546 *
2547 * This module provides debugging functions.
2548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002550
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002551/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002553 *
2554 * Enable the DES block cipher.
2555 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002556 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002557 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002558 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002559 *
Paul Bakkercff68422013-09-15 20:43:33 +02002560 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002561 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002562 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002563 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002564 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002566
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002567/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002569 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002570 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002571 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002572 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002573 * Caller: library/ssl_tls.c
2574 * library/ssl*_client.c
2575 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002576 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002577 * This module is used by the following key exchanges:
2578 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002579 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002580 * \warning Using DHE constitutes a security risk as it
2581 * is not possible to validate custom DH parameters.
2582 * If possible, it is recommended users should consider
2583 * preferring other methods of key exchange.
2584 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002585 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002586 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002588
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002589/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002590 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002591 *
2592 * Enable the elliptic curve Diffie-Hellman library.
2593 *
2594 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002595 * Caller: library/psa_crypto.c
2596 * library/ssl_tls.c
2597 * library/ssl*_client.c
2598 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002599 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002600 * This module is used by the following key exchanges:
2601 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002602 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002605#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002606
2607/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002609 *
2610 * Enable the elliptic curve DSA library.
2611 *
2612 * Module: library/ecdsa.c
2613 * Caller:
2614 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002615 * This module is used by the following key exchanges:
2616 * ECDHE-ECDSA
2617 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002618 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2619 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2620 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002621 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002623
2624/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002625 * \def MBEDTLS_ECJPAKE_C
2626 *
2627 * Enable the elliptic curve J-PAKE library.
2628 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002629 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2630 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002631 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002632 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002633 * Module: library/ecjpake.c
2634 * Caller:
2635 *
2636 * This module is used by the following key exchanges:
2637 * ECJPAKE
2638 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002639 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002640 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002641 * \warning If using a hash that is only provided by PSA drivers, you must
2642 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002643 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002644#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002645
2646/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002648 *
2649 * Enable the elliptic curve over GF(p) library.
2650 *
2651 * Module: library/ecp.c
2652 * Caller: library/ecdh.c
2653 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002654 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002655 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002659
2660/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002662 *
2663 * Enable the platform-specific entropy code.
2664 *
2665 * Module: library/entropy.c
2666 * Caller:
2667 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002669 *
2670 * This module provides a generic entropy pool
2671 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002672#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002673
2674/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002676 *
2677 * Enable error code to error string conversion.
2678 *
2679 * Module: library/error.c
2680 * Caller:
2681 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002683 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002685
2686/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002688 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002689 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002690 *
2691 * Module: library/gcm.c
2692 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002693 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2694 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002695 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002696 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2697 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002698 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002699#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002700
2701/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002702 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002703 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002704 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002705 * Can significantly increase throughput on systems without GCM hardware
2706 * acceleration (e.g., AESNI, AESCE).
2707 *
Matthias Schulz78266782024-02-08 13:54:48 +01002708 * The mbedtls_gcm_context size will increase by 3840 bytes.
2709 * The code size will increase by roughly 344 bytes.
2710 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002711 * Module: library/gcm.c
2712 *
2713 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002714 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002715//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002716
2717/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002718 * \def MBEDTLS_HKDF_C
2719 *
2720 * Enable the HKDF algorithm (RFC 5869).
2721 *
2722 * Module: library/hkdf.c
2723 * Caller:
2724 *
2725 * Requires: MBEDTLS_MD_C
2726 *
2727 * This module adds support for the Hashed Message Authentication Code
2728 * (HMAC)-based key derivation function (HKDF).
2729 */
2730#define MBEDTLS_HKDF_C
2731
2732/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002734 *
2735 * Enable the HMAC_DRBG random generator.
2736 *
2737 * Module: library/hmac_drbg.c
2738 * Caller:
2739 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002741 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002742 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002743 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002745
2746/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002747 * \def MBEDTLS_LMS_C
2748 *
2749 * Enable the LMS stateful-hash asymmetric signature algorithm.
2750 *
2751 * Module: library/lms.c
2752 * Caller:
2753 *
Raef Colesab4f8742022-09-01 12:24:31 +01002754 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002755 *
Raef Colesab4f8742022-09-01 12:24:31 +01002756 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002757 */
2758#define MBEDTLS_LMS_C
2759
2760/**
Raef Colesab4f8742022-09-01 12:24:31 +01002761 * \def MBEDTLS_LMS_PRIVATE
2762 *
2763 * Enable LMS private-key operations and signing code. Functions enabled by this
2764 * option are experimental, and should not be used in production.
2765 *
2766 * Requires: MBEDTLS_LMS_C
2767 *
2768 * Uncomment to enable the LMS signature algorithm and private key operations.
2769 */
Raef Coles5127e852022-10-07 10:35:56 +01002770//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002771
2772/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002773 * \def MBEDTLS_NIST_KW_C
2774 *
2775 * Enable the Key Wrapping mode for 128-bit block ciphers,
2776 * as defined in NIST SP 800-38F. Only KW and KWP modes
2777 * are supported. At the moment, only AES is approved by NIST.
2778 *
2779 * Module: library/nist_kw.c
2780 *
2781 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2782 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002783#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002784
2785/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002787 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002788 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002789 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002790 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2791 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002792 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002793 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002794 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002795 * Caller: library/constant_time.c
2796 * library/ecdsa.c
2797 * library/ecjpake.c
2798 * library/hkdf.c
2799 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002800 * library/pk.c
2801 * library/pkcs5.c
2802 * library/pkcs12.c
2803 * library/psa_crypto_ecp.c
2804 * library/psa_crypto_rsa.c
2805 * library/rsa.c
2806 * library/ssl_cookie.c
2807 * library/ssl_msg.c
2808 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002809 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002810 * library/x509_crt.c
2811 * library/x509write_crt.c
2812 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002813 *
2814 * Uncomment to enable generic message digest wrappers.
2815 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002816#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002817
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002818/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002820 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002821 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002822 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002823 * Module: library/md5.c
2824 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002825 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002826 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002827 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002828 * This module is required for TLS 1.2 depending on the handshake parameters.
2829 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2830 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002831 *
2832 * \warning MD5 is considered a weak message digest and its use constitutes a
2833 * security risk. If possible, we recommend avoiding dependencies on
2834 * it, and considering stronger message digests instead.
2835 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002836 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002838
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002839/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002840 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002841 *
2842 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002843 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002844 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002845 *
2846 * Module: library/memory_buffer_alloc.c
2847 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002848 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002849 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002850 *
2851 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002852 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002854
2855/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002857 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002858 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2859 *
Simon Butcherd567a232016-03-09 20:19:21 +00002860 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2861 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002862 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002863 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002864 * \note See also our Knowledge Base article about porting to a new
2865 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002866 * 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 +00002867 *
Andres AG788aa4a2016-09-14 14:32:09 +01002868 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002869 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002870 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002873
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002874/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002876 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002877 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002878 *
2879 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002880 * Caller: library/asn1write.c
2881 * library/pkcs5.c
2882 * library/pkparse.c
2883 * library/pkwrite.c
2884 * library/rsa.c
2885 * library/x509.c
2886 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002887 * library/x509_crl.c
2888 * library/x509_crt.c
2889 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002890 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002891 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002892 *
2893 * This modules translates between OIDs and internal values.
2894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002896
2897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002899 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002900 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002901 *
2902 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002903 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002904 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002905 * library/x509_crl.c
2906 * library/x509_crt.c
2907 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002908 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002909 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002910 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2911 *
2912 * \warning When parsing password-protected files, if MD5 is provided only by
2913 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002914 *
Paul Bakkercff68422013-09-15 20:43:33 +02002915 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002916 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002917#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002918
2919/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002920 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002921 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002922 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002923 *
2924 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002925 * Caller: library/pkwrite.c
2926 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002927 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002928 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002929 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002930 *
2931 * This modules adds support for encoding / writing PEM files.
2932 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002934
2935/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002936 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002937 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002938 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002939 *
2940 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002941 * Caller: library/psa_crypto_rsa.c
2942 * library/ssl_tls.c
2943 * library/ssl*_client.c
2944 * library/ssl*_server.c
2945 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002946 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002947 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002948 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002949 * Uncomment to enable generic public key wrappers.
2950 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002952
2953/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002955 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002956 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002957 *
2958 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002959 * Caller: library/x509_crt.c
2960 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002961 *
Yanray Wang072a0682023-12-05 10:53:04 +08002962 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002963 *
2964 * Uncomment to enable generic public key parse functions.
2965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002967
2968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002970 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002971 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002972 *
2973 * Module: library/pkwrite.c
2974 * Caller: library/x509write.c
2975 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002976 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002977 *
2978 * Uncomment to enable generic public key write functions.
2979 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002981
2982/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002984 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002985 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002986 *
2987 * Module: library/pkcs5.c
2988 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002989 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002990 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002991 * \warning If using a hash that is only provided by PSA drivers, you must
2992 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002993 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002994 * This module adds support for the PKCS#5 functions.
2995 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002997
2998/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002999 * \def MBEDTLS_PKCS7_C
3000 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003001 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003002 * RFC Link - https://tools.ietf.org/html/rfc2315
3003 *
3004 * Module: library/pkcs7.c
3005 *
3006 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003007 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3008 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003009 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003010 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003011 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003012#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003013
3014/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003016 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003017 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003018 * Adds algorithms for parsing PKCS#8 encrypted private keys
3019 *
3020 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003021 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003022 *
Valerio Settie98ad592023-12-28 10:42:12 +01003023 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3024 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003025 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003026 * \warning If using a hash that is only provided by PSA drivers, you must
3027 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003028 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003029 * This module enables PKCS#12 functions.
3030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003032
3033/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003035 *
3036 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003037 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003038 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3040 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003041 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003042 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003043 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003044 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003045 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003046 * Module: library/platform.c
3047 * Caller: Most other .c files
3048 *
3049 * This module enables abstraction of common (libc) functions.
3050 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003051#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003052
3053/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003054 * \def MBEDTLS_POLY1305_C
3055 *
3056 * Enable the Poly1305 MAC algorithm.
3057 *
3058 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003059 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003060 */
3061#define MBEDTLS_POLY1305_C
3062
3063/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003064 * \def MBEDTLS_PSA_CRYPTO_C
3065 *
3066 * Enable the Platform Security Architecture cryptography API.
3067 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003068 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003069 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003070 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003071 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003072 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3073 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3074 * is enabled in PSA (unless it's fully accelerated, see
3075 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003076 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003077#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003078
3079/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003080 * \def MBEDTLS_PSA_CRYPTO_SE_C
3081 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003082 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003083 * cryptography API.
3084 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003085 * \deprecated This feature is deprecated. Please switch to the PSA driver
3086 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003087 *
Ryan Everett32a64582024-03-05 18:16:18 +00003088 * \warning This feature is not thread-safe, and should not be used in a
3089 * multi-threaded environment.
3090 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003091 * Module: library/psa_crypto_se.c
3092 *
3093 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3094 *
3095 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003096//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003097
3098/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003099 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3100 *
3101 * Enable the Platform Security Architecture persistent key storage.
3102 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003103 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003104 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003105 * Requires: MBEDTLS_PSA_CRYPTO_C,
3106 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3107 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003108 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003109#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003110
3111/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003112 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003113 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003114 * Enable the emulation of the Platform Security Architecture
3115 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003116 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003117 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003118 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003119 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003120 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003121#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003122
3123/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003125 *
3126 * Enable the RIPEMD-160 hash algorithm.
3127 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003128 * Module: library/ripemd160.c
3129 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003130 *
3131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003132#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003133
3134/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003136 *
3137 * Enable the RSA public-key cryptosystem.
3138 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003139 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003140 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003141 * Caller: library/pk.c
3142 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003143 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003144 * library/ssl*_client.c
3145 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003146 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003147 * This module is used by the following key exchanges:
3148 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003149 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003152#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003153
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003154/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003156 *
3157 * Enable the SHA1 cryptographic hash algorithm.
3158 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003159 * Module: library/sha1.c
3160 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003161 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003162 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003163 * This module is required for TLS 1.2 depending on the handshake parameters,
3164 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003165 *
3166 * \warning SHA-1 is considered a weak message digest and its use constitutes
3167 * a security risk. If possible, we recommend avoiding dependencies
3168 * on it, and considering stronger message digests instead.
3169 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003170 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003171#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003172
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003173/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003174 * \def MBEDTLS_SHA224_C
3175 *
3176 * Enable the SHA-224 cryptographic hash algorithm.
3177 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003178 * Module: library/sha256.c
3179 * Caller: library/md.c
3180 * library/ssl_cookie.c
3181 *
3182 * This module adds support for SHA-224.
3183 */
3184#define MBEDTLS_SHA224_C
3185
3186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003188 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003189 * Enable the SHA-256 cryptographic hash algorithm.
3190 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003191 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003192 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003193 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003194 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003195 * library/ssl*_client.c
3196 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003197 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003198 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003199 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003202
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003203/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003204 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003205 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003206 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3207 * with the ARMv8 cryptographic extensions if they are available at runtime.
3208 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003209 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003210 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003211 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003212 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003213 * \note Minimum compiler versions for this feature are Clang 4.0,
3214 * armclang 6.6 or GCC 6.0.
3215 *
3216 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3217 * armclang <= 6.9
3218 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003219 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3220 * That name is deprecated, but may still be used as an alternative form for this
3221 * option.
3222 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003223 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3224 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003225 *
3226 * Requires: MBEDTLS_SHA256_C.
3227 *
3228 * Module: library/sha256.c
3229 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003230 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003231 * and use them if available.
3232 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003233//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003234
Dave Rodgmand85277c2023-10-13 09:22:54 +01003235/**
3236 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3237 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003238 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003239 * This name is now deprecated, but may still be used as an alternative form for
3240 * this option.
3241 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003242//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3243
3244/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003245 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003246 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003247 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3248 * with the ARMv8 cryptographic extensions, which must be available at runtime
3249 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003250 *
3251 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003252 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003253 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003254 * \note Minimum compiler versions for this feature are Clang 4.0,
3255 * armclang 6.6 or GCC 6.0.
3256 *
3257 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3258 * armclang <= 6.9
3259 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003260 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003261 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003262 * option.
3263 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003264 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3265 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003266 *
3267 * Requires: MBEDTLS_SHA256_C.
3268 *
3269 * Module: library/sha256.c
3270 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003271 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003272 * unconditionally.
3273 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003274//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003275
Dave Rodgmand85277c2023-10-13 09:22:54 +01003276/**
3277 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3278 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003279 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003280 * This name is now deprecated, but may still be used as an alternative form for
3281 * this option.
3282 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003283//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3284
3285/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003286 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003287 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003288 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003289 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003290 * Module: library/sha512.c
3291 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003292 * library/psa_crypto_hash.c
3293 * library/ssl_tls.c
3294 * library/ssl*_client.c
3295 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003296 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003297 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003298 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003299#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003300
3301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003302 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003303 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003304 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003305 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003306 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003307 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003308 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003309 * library/ssl_tls.c
3310 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003311 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003312 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003314#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003315
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003316/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003317 * \def MBEDTLS_SHA3_C
3318 *
3319 * Enable the SHA3 cryptographic hash algorithm.
3320 *
3321 * Module: library/sha3.c
3322 *
3323 * This module adds support for SHA3.
3324 */
3325#define MBEDTLS_SHA3_C
3326
3327/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003328 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3329 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003330 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3331 * with the ARMv8 cryptographic extensions if they are available at runtime.
3332 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003333 *
3334 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3335 * for a non-Aarch64 build it will be silently ignored.
3336 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003337 * \note Minimum compiler versions for this feature are Clang 7.0,
3338 * armclang 6.9 or GCC 8.0.
3339 *
3340 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3341 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003342 *
3343 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3344 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3345 *
3346 * Requires: MBEDTLS_SHA512_C.
3347 *
3348 * Module: library/sha512.c
3349 *
3350 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3351 * and use them if available.
3352 */
3353//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3354
3355/**
3356 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3357 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003358 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3359 * with the ARMv8 cryptographic extensions, which must be available at runtime
3360 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003361 *
3362 * \note This allows builds with a smaller code size than with
3363 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3364 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003365 * \note Minimum compiler versions for this feature are Clang 7.0,
3366 * armclang 6.9 or GCC 8.0.
3367 *
3368 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3369 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003370 *
3371 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3372 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3373 *
3374 * Requires: MBEDTLS_SHA512_C.
3375 *
3376 * Module: library/sha512.c
3377 *
3378 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3379 * unconditionally.
3380 */
3381//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3382
3383/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003385 *
3386 * Enable simple SSL cache implementation.
3387 *
3388 * Module: library/ssl_cache.c
3389 * Caller:
3390 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003394
3395/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003397 *
3398 * Enable basic implementation of DTLS cookies for hello verification.
3399 *
3400 * Module: library/ssl_cookie.c
3401 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003402 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003403#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003404
3405/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003406 * \def MBEDTLS_SSL_TICKET_C
3407 *
3408 * Enable an implementation of TLS server-side callbacks for session tickets.
3409 *
3410 * Module: library/ssl_ticket.c
3411 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003412 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003413 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3414 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003415 */
3416#define MBEDTLS_SSL_TICKET_C
3417
3418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003420 *
3421 * Enable the SSL/TLS client code.
3422 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003423 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003424 * Caller:
3425 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003427 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003428 * This module is required for SSL/TLS client support.
3429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003431
Paul Bakker9a736322012-11-14 12:39:52 +00003432/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003434 *
3435 * Enable the SSL/TLS server code.
3436 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003437 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003438 * Caller:
3439 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003441 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003442 * This module is required for SSL/TLS server support.
3443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003445
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003446/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003447 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003448 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003449 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003450 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003451 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003452 * Caller: library/ssl*_client.c
3453 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003454 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3456 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003457 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003458 * This module is required for SSL/TLS.
3459 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003461
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003462/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003463 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003464 *
3465 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003466 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003467 * contexts are not shared between threads. If you do intend to use contexts
3468 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003469 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003470 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003471 *
3472 * Module: library/threading.c
3473 *
3474 * This allows different threading implementations (self-implemented or
3475 * provided).
3476 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003477 * You will have to enable either MBEDTLS_THREADING_ALT or
3478 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003479 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003480 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003483
3484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003485 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003486 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003487 * Enable the semi-portable timing interface.
3488 *
Simon Butcherd567a232016-03-09 20:19:21 +00003489 * \note The provided implementation only works on POSIX/Unix (including Linux,
3490 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003491 * module and provide your own implementations of the callbacks needed by
3492 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3493 * your own implementation of the whole module by setting
3494 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003495 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003496 * \note The timing module will include time.h on suitable platforms
3497 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3498 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3499 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003500 * \note See also our Knowledge Base article about porting to a new
3501 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003502 * 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 +00003503 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003504 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003506#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003507
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003508/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003509 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003510 *
3511 * Enable run-time version information.
3512 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003513 * Module: library/version.c
3514 *
3515 * This module provides run-time version information.
3516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003518
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003521 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003522 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003523 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003524 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003525 * Caller: library/x509_crl.c
3526 * library/x509_crt.c
3527 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003528 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003529 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003530 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3531 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003532 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3533 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003534 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003535 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003538
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003541 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003542 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003543 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003544 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003545 * Caller: library/ssl_tls.c
3546 * library/ssl*_client.c
3547 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003548 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003550 *
3551 * This module is required for X.509 certificate parsing.
3552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003553#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003554
3555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003556 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003557 *
3558 * Enable X.509 CRL parsing.
3559 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003560 * Module: library/x509_crl.c
3561 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003562 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003563 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003564 *
3565 * This module is required for X.509 CRL parsing.
3566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003567#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003568
3569/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003570 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003571 *
3572 * Enable X.509 Certificate Signing Request (CSR) parsing.
3573 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003574 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003575 * Caller: library/x509_crt_write.c
3576 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003577 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003578 *
3579 * This module is used for reading X.509 certificate request.
3580 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003581#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003582
3583/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003584 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003585 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003586 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003587 *
3588 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003589 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003590 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003591 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3592 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003593 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3594 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003595 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003596 * This module is the basis for creating X.509 certificates and CSRs.
3597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003598#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003599
3600/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003602 *
3603 * Enable creating X.509 certificates.
3604 *
3605 * Module: library/x509_crt_write.c
3606 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003607 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003608 *
3609 * This module is required for X.509 certificate creation.
3610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003611#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003612
3613/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003614 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003615 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003616 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003617 *
3618 * Module: library/x509_csr_write.c
3619 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003620 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003621 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003622 * This module is required for X.509 certificate request writing.
3623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003624#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003625
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003626/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003627
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003628/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003629 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003630 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003631 * This section contains Mbed TLS build settings that are not associated
3632 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003633 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003634 * \{
3635 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003636
Gilles Peskinea02c1242022-03-16 17:03:19 +01003637/**
3638 * \def MBEDTLS_CONFIG_FILE
3639 *
3640 * If defined, this is a header which will be included instead of
3641 * `"mbedtls/mbedtls_config.h"`.
3642 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003643 * Unlike other configuration options, this one must be defined on the
3644 * compiler command line: a definition in `mbedtls_config.h` would have
3645 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003646 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003647 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003648 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003649 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003650 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003651 * The value of this symbol is typically a path in double quotes, either
3652 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003653 */
3654//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3655
3656/**
3657 * \def MBEDTLS_USER_CONFIG_FILE
3658 *
3659 * If defined, this is a header which will be included after
3660 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003661 * This allows you to modify the default configuration, including the ability
3662 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003663 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003664 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003665 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003666 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003667 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003668 * The value of this symbol is typically a path in double quotes, either
3669 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003670 */
3671//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3672
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003673/**
3674 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3675 *
3676 * If defined, this is a header which will be included instead of
3677 * `"psa/crypto_config.h"`.
3678 * This header file specifies which cryptographic mechanisms are available
3679 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3680 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3681 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003682 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003683 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003684 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003685 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003686 * The value of this symbol is typically a path in double quotes, either
3687 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003688 */
3689//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3690
3691/**
3692 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3693 *
3694 * If defined, this is a header which will be included after
3695 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003696 * This allows you to modify the default configuration, including the ability
3697 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003698 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003699 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003700 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003701 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003702 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003703 * The value of this symbol is typically a path in double quotes, either
3704 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003705 */
3706//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3707
Gilles Peskineb1176f22023-02-22 22:07:28 +01003708/**
3709 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3710 *
3711 * If defined, this is a header which will be included instead of
3712 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3713 * as the one in Mbed TLS, but with definitions adapted to the platform on
3714 * which the library code will run.
3715 *
3716 * \note The required content of this header can vary from one version of
3717 * Mbed TLS to the next. Integrators who provide an alternative file
3718 * should review the changes in the original file whenever they
3719 * upgrade Mbed TLS.
3720 *
3721 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3722 * non-standard feature of the C language, so this feature is only available
3723 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3724 *
3725 * The value of this symbol is typically a path in double quotes, either
3726 * absolute or relative to a directory on the include search path.
3727 */
3728//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3729
3730/**
3731 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3732 *
3733 * If defined, this is a header which will be included instead of
3734 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3735 * as the one in Mbed TLS, but with definitions adapted to the environment
3736 * in which the library code will run. The typical use for this feature
3737 * is to provide alternative type definitions on the client side in
3738 * client-server integrations of PSA crypto, where operation structures
3739 * contain handles instead of cryptographic data.
3740 *
3741 * \note The required content of this header can vary from one version of
3742 * Mbed TLS to the next. Integrators who provide an alternative file
3743 * should review the changes in the original file whenever they
3744 * upgrade Mbed TLS.
3745 *
3746 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3747 * non-standard feature of the C language, so this feature is only available
3748 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3749 *
3750 * The value of this symbol is typically a path in double quotes, either
3751 * absolute or relative to a directory on the include search path.
3752 */
3753//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3754
Gilles Peskineba4162a2022-04-11 17:04:38 +02003755/** \} name SECTION: General configuration options */
3756
3757/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003758 * \name SECTION: Module configuration options
3759 *
3760 * This section allows for the setting of module specific sizes and
3761 * configuration options. The default values are already present in the
3762 * relevant header files and should suffice for the regular use cases.
3763 *
3764 * Our advice is to enable options and change their values here
3765 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003766 * \{
3767 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003768/* The Doxygen documentation here is used when a user comments out a
3769 * setting and runs doxygen themselves. On the other hand, when we typeset
3770 * the full documentation including disabled settings, the documentation
3771 * in specific modules' header files is used if present. When editing this
3772 * file, make sure that each option is documented in exactly one place,
3773 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3774 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003775
Paul Bakker088c5c52014-04-25 11:11:10 +02003776/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003777//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003778//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003779
Paul Bakker088c5c52014-04-25 11:11:10 +02003780/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003781//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3782//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3783//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3784//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3785//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003786
Paul Bakker088c5c52014-04-25 11:11:10 +02003787/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003788//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3789//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3790//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3791//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003792
Paul Bakker088c5c52014-04-25 11:11:10 +02003793/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003794//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003795//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003796
Paul Bakker088c5c52014-04-25 11:11:10 +02003797/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003798//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3799//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003800//#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 +01003801
Paul Bakker088c5c52014-04-25 11:11:10 +02003802/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003803//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003804
Paul Bakker088c5c52014-04-25 11:11:10 +02003805/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003806//#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 -04003807
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003808/** \def MBEDTLS_PLATFORM_STD_CALLOC
3809 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003810 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003811 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003812 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003813 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003814 * 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 -04003815 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3816 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003817 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003818 */
3819//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003820
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003821/** \def MBEDTLS_PLATFORM_STD_FREE
3822 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003823 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003824 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003825 * 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 -04003826 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3827 * 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 -04003828 */
3829//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003830//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003831//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003832//#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 +02003833//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3834//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003835/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003836//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003837//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3838//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003839//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3840//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3841//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003842
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003843/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003844/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003845//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3846//#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 +02003847//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003848//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003849//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3850//#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 +02003851//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3852//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003853/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003854//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003855//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003856//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3857//#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 +08003858//#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 +08003859//#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 +02003860
Gilles Peskine3f106f72021-09-23 17:42:39 +02003861/** \def MBEDTLS_CHECK_RETURN
3862 *
3863 * This macro is used at the beginning of the declaration of a function
3864 * to indicate that its return value should be checked. It should
3865 * instruct the compiler to emit a warning or an error if the function
3866 * is called without checking its return value.
3867 *
3868 * There is a default implementation for popular compilers in platform_util.h.
3869 * You can override the default implementation by defining your own here.
3870 *
3871 * If the implementation here is empty, this will effectively disable the
3872 * checking of functions' return values.
3873 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003874//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003875
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003876/** \def MBEDTLS_IGNORE_RETURN
3877 *
3878 * This macro requires one argument, which should be a C function call.
3879 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3880 * warning is suppressed.
3881 */
3882//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3883
Gilles Peskineed038902020-11-13 21:33:21 +01003884/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003885/**
Gilles Peskineed038902020-11-13 21:33:21 +01003886 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3887 * PSA crypto subsystem.
3888 *
3889 * If this option is unset:
3890 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003891 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003892 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3893 * on unspecified heuristics.
3894 */
3895//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3896
Steven Cooreman863470a2021-02-15 14:03:19 +01003897/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003898 * Restrict the PSA library to supporting a maximum amount of simultaneously
3899 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3900 * volatile key, or a persistent key which is loaded temporarily by the
3901 * library as part of a crypto operation in flight.
3902 *
3903 * If this option is unset, the library will fall back to a default value of
3904 * 32 keys.
3905 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003906//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003907
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003908/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003909//#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 +00003910
Paul Bakker088c5c52014-04-25 11:11:10 +02003911/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003912//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3913//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003914
Paul Bakker088c5c52014-04-25 11:11:10 +02003915/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003916
Angus Grattond8213d02016-05-25 20:56:48 +10003917/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3918 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003919 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003920 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003921 * This determines the size of the incoming TLS I/O buffer in such a way
3922 * that it is capable of holding the specified amount of plaintext data,
3923 * regardless of the protection mechanism used.
3924 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003925 * \note When using a value less than the default of 16KB on the client, it is
3926 * recommended to use the Maximum Fragment Length (MFL) extension to
3927 * inform the server about this limitation. On the server, there
3928 * is no supported, standardized way of informing the client about
3929 * restriction on the maximum size of incoming messages, and unless
3930 * the limitation has been communicated by other means, it is recommended
3931 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3932 * while keeping the default value of 16KB for the incoming buffer.
3933 *
David Horstmann95d516f2021-05-04 18:36:56 +01003934 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003935 */
3936//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3937
Gilles Peskined3d02902020-03-04 21:35:27 +01003938/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3939 *
3940 * The maximum length of CIDs used for incoming DTLS messages.
3941 *
3942 */
3943//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3944
3945/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3946 *
3947 * The maximum length of CIDs used for outgoing DTLS messages.
3948 *
3949 */
3950//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3951
TRodziewicze8dd7092021-05-12 14:19:11 +02003952/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003953 *
3954 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003955 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003956 *
3957 * The padding will always be chosen so that the length of the
3958 * padded plaintext is a multiple of the value of this option.
3959 *
3960 * Note: A value of \c 1 means that no padding will be used
3961 * for outgoing records.
3962 *
3963 * Note: On systems lacking division instructions,
3964 * a power of two should be preferred.
3965 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003966//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003967
Angus Grattond8213d02016-05-25 20:56:48 +10003968/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3969 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003970 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003971 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003972 * This determines the size of the outgoing TLS I/O buffer in such a way
3973 * that it is capable of holding the specified amount of plaintext data,
3974 * regardless of the protection mechanism used.
3975 *
Angus Grattond8213d02016-05-25 20:56:48 +10003976 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3977 * the default inward 16384 byte buffer to conform to the TLS specification.
3978 *
3979 * The minimum required outward buffer size is determined by the handshake
3980 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3981 * The specific size requirement depends on the configured ciphers and any
3982 * certificate data which is sent during the handshake.
3983 *
David Horstmann95d516f2021-05-04 18:36:56 +01003984 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003985 */
3986//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3987
Hanno Beckere0b150f2018-08-21 15:51:03 +01003988/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3989 *
3990 * Maximum number of heap-allocated bytes for the purpose of
3991 * DTLS handshake message reassembly and future message buffering.
3992 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003993 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003994 * to account for a reassembled handshake message of maximum size,
3995 * together with its reassembly bitmap.
3996 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003997 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003998 * should be sufficient for all practical situations as it allows
3999 * to reassembly a large handshake message (such as a certificate)
4000 * while buffering multiple smaller handshake messages.
4001 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004002 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004003//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004004
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004005//#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 +02004006//#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 +02004007
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004008/**
4009 * Complete list of ciphersuites to use, in order of preference.
4010 *
4011 * \warning No dependency checking is done on that field! This option can only
4012 * be used to restrict the set of available ciphersuites. It is your
4013 * responsibility to make sure the needed modules are active.
4014 *
4015 * Use this to save a few hundred bytes of ROM (default ordering of all
4016 * available ciphersuites) and a few to a few hundred bytes of RAM.
4017 *
4018 * The value below is only an example, not the default.
4019 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004020//#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 +02004021
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004022/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004023 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4024 *
4025 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004026 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004027 *
4028 * It must be positive and smaller than UINT32_MAX.
4029 *
4030 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4031 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004032 */
4033//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4034
4035/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004036 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4037 *
Jerry Yucf913512023-11-14 11:06:52 +08004038 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004039 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004040 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004041 * - The client ticket age is the time difference between the time when the
4042 * client proposes to the server to use the ticket and the time the client
4043 * received the ticket from the server.
4044 * - The server ticket age is the time difference between the time when the
4045 * server receives a proposition from the client to use the ticket and the
4046 * time when the ticket was created by the server.
4047 *
Jerry Yucf913512023-11-14 11:06:52 +08004048 * The ages might be different due to the client and server clocks not running
4049 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4050 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4051 * 6s, thus in the worst case clients and servers must sync up their system time
4052 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004053 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004054 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004055 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004056//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004057
4058/**
4059 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4060 *
4061 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4062 *
4063 * This must be less than 256.
4064 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004065//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004066
4067/**
4068 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4069 *
4070 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4071 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4072 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4073 *
4074 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004075//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004076
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004077/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004078//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004079//#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 +01004080
Gilles Peskine611179c2022-04-13 23:04:48 +02004081/** \} name SECTION: Module configuration options */