blob: 39884dc4b0d7bdbb45bfa8c02fd212f9836de893 [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
43 * library/padlock.h
Paul Bakker68041ec2009-04-19 21:17:55 +000044 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010045 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000046 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010047 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010048 * MBEDTLS_PADLOCK_C
49 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020050 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000051 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020052#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000053
Paul Bakkerf3b86c12011-01-27 15:24:17 +000054/**
Gilles Peskineed942f82017-06-08 15:19:20 +020055 * \def MBEDTLS_NO_UDBL_DIVISION
56 *
57 * The platform lacks support for double-width integer division (64-bit
58 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
59 *
60 * Used in:
61 * include/mbedtls/bignum.h
62 * library/bignum.c
63 *
64 * The bignum code uses double-width division to speed up some operations.
65 * Double-width division is often implemented in software that needs to
66 * be linked with the program. The presence of a double-width integer
67 * type is usually detected automatically through preprocessor macros,
68 * but the automatic detection cannot know whether the code needs to
69 * and can be linked with an implementation of division for that type.
70 * By default division is assumed to be usable if the type is present.
71 * Uncomment this option to prevent the use of double-width division.
72 *
73 * Note that division for the native integer type is always required.
74 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010075 * platform, but it need not support multiplication or division. In some
76 * cases it is also desirable to disable some double-width operations. For
77 * example, if double-width division is implemented in software, disabling
78 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020079 */
80//#define MBEDTLS_NO_UDBL_DIVISION
81
82/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020083 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
84 *
85 * The platform lacks support for 32x32 -> 64-bit multiplication.
86 *
87 * Used in:
88 * library/poly1305.c
89 *
90 * Some parts of the library may use multiplication of two unsigned 32-bit
91 * operands with a 64-bit result in order to speed up computations. On some
92 * platforms, this is not available in hardware and has to be implemented in
93 * software, usually in a library provided by the toolchain.
94 *
95 * Sometimes it is not desirable to have to link to that library. This option
96 * removes the dependency of that library on platforms that lack a hardware
97 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
98 *
99 * Note that depending on the compiler, this may decrease performance compared
100 * to using the library function provided by the toolchain.
101 */
102//#define MBEDTLS_NO_64BIT_MULTIPLICATION
103
104/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200105 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000107 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000108 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000109 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000110 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200111//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200112
113/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200114 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200115 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200116 * System has time.h and time().
117 * The time does not need to be correct, only time differences are used,
118 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200119 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100120 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
121 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
122 * MBEDTLS_PLATFORM_STD_TIME.
123 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400124 * Comment if your system does not support time functions.
125 *
126 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
127 * interface - timing.c will include time.h on suitable platforms
128 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
129 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200130 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200131#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100132
133/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200134 * \def MBEDTLS_HAVE_TIME_DATE
135 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100136 * System has time.h, time(), and an implementation for
137 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100138 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200139 * the date should be correct). This is used to verify the validity period of
140 * X.509 certificates.
141 *
142 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100143 *
Hanno Becker6a739782018-09-05 15:06:19 +0100144 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100145 * behaves similarly to the gmtime_r() function from the C standard. Refer to
146 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100147 *
148 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100149 * mbedtls_platform_gmtime_r() at compile-time by using the macro
150 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200151 */
152#define MBEDTLS_HAVE_TIME_DATE
153
154/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200155 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100156 *
157 * Enable the memory allocation layer.
158 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200159 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100160 * This allows different allocators (self-implemented or provided) to be
161 * provided to the platform abstraction layer.
162 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400163 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200164 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
165 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000166 * free() function pointer at runtime.
167 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400168 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200169 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000170 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100171 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400172 * An overview of how the value of mbedtls_calloc is determined:
173 *
174 * - if !MBEDTLS_PLATFORM_MEMORY
175 * - mbedtls_calloc = calloc
176 * - if MBEDTLS_PLATFORM_MEMORY
177 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
179 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
180 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
181 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
182 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
183 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
184 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
185 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
186 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
187 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
188 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
189 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
190 *
191 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
192 * - if !MBEDTLS_PLATFORM_STD_CALLOC
193 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
194 *
195 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
196 *
197 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
198 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
199 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
200 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
201 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
202 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
203 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200204 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100205 *
206 * Enable this layer to allow use of alternative memory allocators.
207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100209
210/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200212 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200213 * Do not assign standard functions in the platform layer (e.g. calloc() to
214 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200215 *
216 * This makes sure there are no linking errors on platforms that do not support
217 * these functions. You will HAVE to provide alternatives, either at runtime
218 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200219 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
220 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200223 *
224 * Uncomment to prevent default assignment of standard functions in the
225 * platform layer.
226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200227//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200228
229/**
Janos Follathc351d182016-03-21 08:43:59 +0000230 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100231 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200232 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100233 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100234 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200235 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100237 * alternative printf function pointer.
238 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100240 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200241 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
242 * it will be enabled automatically by check_config.h
243 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200244 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200245 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000246 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100247 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
248 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100249 * Uncomment a macro to enable alternate implementation of specific base
250 * platform function
251 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200252//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100254//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200255//#define MBEDTLS_PLATFORM_FPRINTF_ALT
256//#define MBEDTLS_PLATFORM_PRINTF_ALT
257//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200258//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100259//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100260//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800261//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100262
263/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200264 * Uncomment the macro to let Mbed TLS use your alternate implementation of
265 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
266 * platform_util.c.
267 *
268 * gmtime() is not a thread-safe function as defined in the C standard. The
269 * library will try to use safer implementations of this function, such as
270 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
271 * system, the implementation of mbedtls_platform_gmtime_r() will default to
272 * using the standard gmtime(). In this case, calls from the library to
273 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
274 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
275 * library are also guarded with this mutex to avoid race conditions. However,
276 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
277 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
278 * supplied at compile time.
279 */
280//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
281
282/**
Gilles Peskine86733832023-09-07 15:02:39 +0200283 * Uncomment the macro to let Mbed TLS use your alternate implementation of
284 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
285 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200286 *
Gilles Peskine86733832023-09-07 15:02:39 +0200287 * By default, the library uses a system function such as memset_s()
288 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
289 * SecureZeroMemory (Windows). If no such function is detected, the library
290 * falls back to a plain C implementation. Compilers are technically
291 * permitted to optimize this implementation out, meaning that the memory is
292 * not actually wiped. The library tries to prevent that, but the C language
293 * makes it impossible to guarantee that the memory will always be wiped.
294 *
295 * If your platform provides a guaranteed method to wipe memory which
296 * `platform_util.c` does not detect, define this macro to the name of
297 * a function that takes two arguments, a `void *` pointer and a length,
298 * and wipes that many bytes starting at the specified address. For example,
299 * if your platform has explicit_bzero() but `platform_util.c` does not
300 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
301 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200302 */
303//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
304
305/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200306 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100307 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000308 * Mark deprecated functions and features so that they generate a warning if
309 * used. Functionality deprecated in one version will usually be removed in the
310 * next version. You can enable this to help you prepare the transition to a
311 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100312 *
313 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200314 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000316 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100319
320/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200321 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100322 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000323 * Remove deprecated functions and features so that they generate an error if
324 * used. Functionality deprecated in one version will usually be removed in the
325 * next version. You can enable this to help you prepare the transition to a
326 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000328 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100331
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100332/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000333
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000334/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200335 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000336 *
337 * This section sets support for features that are or are not needed
338 * within the modules that are enabled.
339 * \{
340 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000341
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000342/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200343 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100344 *
TRodziewiczd8540832021-06-10 15:16:50 +0200345 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200346 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200348 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100349 *
350 * You will need to provide a header "timing_alt.h" and an implementation at
351 * compile time.
352 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200353//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100354
355/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100356 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200357 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200358 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100359 * alternate core implementation of a symmetric crypto, an arithmetic or hash
360 * module (e.g. platform specific assembly optimized implementations). Keep
361 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200362 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200364 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200365 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200366 * Example: In case you uncomment MBEDTLS_AES_ALT, Mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000367 * provide the "struct mbedtls_aes_context" definition and omit the base
368 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200369 * "aes.h" to include the new function definitions.
370 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200371 * Uncomment a macro to enable alternate implementation of the corresponding
372 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100373 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200374 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100375 * use constitutes a security risk. If possible, we recommend
376 * avoiding dependencies on them, and considering stronger message
377 * digests and ciphers instead.
378 *
Paul Bakker90995b52013-06-24 19:20:35 +0200379 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000381//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200382//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200383//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300384//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200385//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200386//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200387//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000388//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000389//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100390//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300391//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300393//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000395//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200396//#define MBEDTLS_SHA1_ALT
397//#define MBEDTLS_SHA256_ALT
398//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000399
Janos Follathb0697532016-08-18 12:38:46 +0100400/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800401 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100402 * implemented with two .c files:
403 * - ecp.c
404 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000405 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
406 * macros as described above. The only difference is that you have to make sure
407 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100408 */
409//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200410
411/**
TRodziewicz75628d52021-06-18 12:56:27 +0200412 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200413 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200414 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100415 * alternate core implementation of symmetric crypto or hash function. Keep in
416 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200417 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200418 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200419 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200420 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200421 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422 * no longer provide the mbedtls_sha1_process() function, but it will still provide
423 * the other function (using your mbedtls_sha1_process() function) and the definition
424 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200425 * with this definition.
426 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200427 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100428 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
429 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200430 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200431 * Uncomment a macro to enable alternate implementation of the corresponding
432 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100433 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200434 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100435 * constitutes a security risk. If possible, we recommend avoiding
436 * dependencies on them, and considering stronger message digests
437 * and ciphers instead.
438 *
Janos Follath1231d212019-01-07 15:01:32 +0000439 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
440 * enabled, then the deterministic ECDH signature functions pass the
441 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
442 * alternative implementations should use the RNG only for generating
443 * the ephemeral key and nothing else. If this is not possible, then
444 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200445 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000446 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200447 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200448//#define MBEDTLS_MD5_PROCESS_ALT
449//#define MBEDTLS_RIPEMD160_PROCESS_ALT
450//#define MBEDTLS_SHA1_PROCESS_ALT
451//#define MBEDTLS_SHA256_PROCESS_ALT
452//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200453//#define MBEDTLS_DES_SETKEY_ALT
454//#define MBEDTLS_DES_CRYPT_ECB_ALT
455//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200456//#define MBEDTLS_AES_SETKEY_ENC_ALT
457//#define MBEDTLS_AES_SETKEY_DEC_ALT
458//#define MBEDTLS_AES_ENCRYPT_ALT
459//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300460//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300461//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300462//#define MBEDTLS_ECDSA_VERIFY_ALT
463//#define MBEDTLS_ECDSA_SIGN_ALT
464//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200465
466/**
Janos Follathc44ab972016-11-18 16:38:23 +0000467 * \def MBEDTLS_ECP_INTERNAL_ALT
468 *
469 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100470 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200471 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100472 * alternative core implementation of elliptic curve arithmetic. Keep in mind
473 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100474 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200475 * This partially replaces one function. The header file from Mbed TLS is still
Janos Follathb0697532016-08-18 12:38:46 +0100476 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
477 * is still present and it is used for group structures not supported by the
478 * alternative.
479 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100480 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100481 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100482 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
483 * able to fallback to curves not supported by the alternative implementation.
484 *
Janos Follathc44ab972016-11-18 16:38:23 +0000485 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
486 * and implementing the following functions:
487 * unsigned char mbedtls_internal_ecp_grp_capable(
488 * const mbedtls_ecp_group *grp )
489 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500490 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000491 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
492 * replacement functions implement arithmetic for the given group and 0
493 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500494 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000495 * called before and after each point operation and provide an opportunity to
496 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100497 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100498 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200499 * MBEDTLS_ECP_DOUBLE_JAC_ALT, Mbed TLS will still provide the ecp_double_jac()
Steven Cooreman6226a122021-01-21 13:58:31 +0100500 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
501 * for the operation is supported by your implementation (i.e. your
502 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200503 * group is not supported by your implementation, then the original Mbed TLS
Steven Cooreman6226a122021-01-21 13:58:31 +0100504 * implementation of ecp_double_jac() is used instead, unless this fallback
505 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
506 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
507 *
508 * The function prototypes and the definition of mbedtls_ecp_group and
509 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
510 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
511 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100512 *
513 * Uncomment a macro to enable alternate implementation of the corresponding
514 * function.
515 */
516/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000517//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100518/* Turn off software fallback for curves not supported in hardware */
519//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100520/* Support for Weierstrass curves with Jacobi representation */
521//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
522//#define MBEDTLS_ECP_ADD_MIXED_ALT
523//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
524//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
525//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
526/* Support for curves with Montgomery arithmetic */
527//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
528//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
529//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
530
531/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200532 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200533 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200534 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200535 * hardware entropy collector.
536 *
537 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000538 * prototype as declared in library/entropy_poll.h, and accept NULL as first
539 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200540 *
541 * Uncomment to use your own hardware entropy collector.
542 */
543//#define MBEDTLS_ENTROPY_HARDWARE_ALT
544
545/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200546 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000547 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100548 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000549 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100550 * Uncomment this macro to use precomputed AES tables stored in ROM.
551 * Comment this macro to generate AES tables in RAM at runtime.
552 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100553 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
554 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100555 * initialization time before the first AES operation can be performed.
556 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
557 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
558 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100559 *
560 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200562//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000563
564/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100565 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200566 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100567 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200568 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100569 * Uncommenting this macro omits 75% of the AES tables from
570 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
571 * by computing their values on the fly during operations
572 * (the tables are entry-wise rotations of one another).
573 *
574 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100575 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100576 * runtime. Specifically, one has to compare 4 accesses within
577 * different tables to 4 accesses with additional arithmetic
578 * operations within the same table. The performance gain/loss
579 * depends on the system and memory details.
580 *
581 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200582 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100583//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200584
585/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800586 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
587 *
588 * Use only 128-bit keys in AES operations to save ROM.
589 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800590 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800591 * or 256-bit keys.
592 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800593 * Uncommenting this macro reduces the size of AES code by ~300 bytes
594 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800595 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800596 * Module: library/aes.c
597 *
598 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800599 */
600//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
601
Gilles Peskinea8861e02023-09-05 20:20:51 +0200602/*
603 * Disable plain C implementation for AES.
604 *
605 * When the plain C implementation is enabled, and an implementation using a
606 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
607 * detection will be used to select between them.
608 *
609 * If only one implementation is present, runtime detection will not be used.
610 * This configuration will crash at runtime if running on a CPU without the
611 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
612 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
613 */
614//#define MBEDTLS_AES_USE_HARDWARE_ONLY
615
Arto Kinnunen732ca322023-04-14 14:26:10 +0800616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200618 *
619 * Use less ROM for the Camellia implementation (saves about 768 bytes).
620 *
621 * Uncomment this macro to use less memory for Camellia.
622 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200624
625/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200626 * \def MBEDTLS_CHECK_RETURN_WARNING
627 *
628 * If this macro is defined, emit a compile-time warning if application code
629 * calls a function without checking its return value, but the return value
630 * should generally be checked in portable applications.
631 *
632 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
633 * implemented. Otherwise this option has no effect.
634 *
635 * Uncomment to get warnings on using fallible functions without checking
636 * their return value.
637 *
638 * \note This feature is a work in progress.
639 * Warnings will be added to more functions in the future.
640 *
641 * \note A few functions are considered critical, and ignoring the return
642 * value of these functions will trigger a warning even if this
643 * macro is not defined. To completely disable return value check
644 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
645 */
646//#define MBEDTLS_CHECK_RETURN_WARNING
647
648/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200650 *
651 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
652 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200654
655/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000657 *
658 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
659 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000661
662/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000664 *
665 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
666 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200667#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000668
669/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100670 * \def MBEDTLS_CIPHER_MODE_OFB
671 *
672 * Enable Output Feedback mode (OFB) for symmetric ciphers.
673 */
674#define MBEDTLS_CIPHER_MODE_OFB
675
676/**
677 * \def MBEDTLS_CIPHER_MODE_XTS
678 *
679 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
680 */
681#define MBEDTLS_CIPHER_MODE_XTS
682
683/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000685 *
686 * Enable NULL cipher.
687 * Warning: Only do so when you know what you are doing. This allows for
688 * encryption or channels without any security!
689 *
Ronald Croncee42702021-04-26 11:34:44 +0200690 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200691 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
692 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
693 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
694 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
695 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
696 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
697 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
698 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
699 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
700 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
701 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
702 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
703 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
704 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
705 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
706 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
707 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
708 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
709 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000710 *
711 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200713//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000714
715/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100716 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200717 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100718 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
719 * specific padding modes in the cipher layer with cipher modes that support
720 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200721 *
722 * If you disable all padding modes, only full blocks can be used with CBC.
723 *
724 * Enable padding modes in the cipher layer.
725 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200726#define MBEDTLS_CIPHER_PADDING_PKCS7
727#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
728#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
729#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200730
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200731/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
732 *
733 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800734 * Without this, CTR_DRBG uses a 256-bit key
735 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200736 */
737//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
738
Paul Bakker48e93c82013-08-14 12:21:18 +0200739/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200740 * Enable the verified implementations of ECDH primitives from Project Everest
741 * (currently only Curve25519). This feature changes the layout of ECDH
742 * contexts and therefore is a compatibility break for applications that access
743 * fields of a mbedtls_ecdh_context structure directly. See also
744 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
745 */
746//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
747
748/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100749 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200750 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100751 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
752 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200753 *
754 * Comment macros to disable the curve and functions for it
755 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200756/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
758#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
759#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
760#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
761#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
762#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
763#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
764#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
765#define MBEDTLS_ECP_DP_BP256R1_ENABLED
766#define MBEDTLS_ECP_DP_BP384R1_ENABLED
767#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200768/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200769#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000770#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200771
772/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200773 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200774 *
775 * Enable specific 'modulo p' routines for each NIST prime.
776 * Depending on the prime and architecture, makes operations 4 to 8 times
777 * faster on the corresponding curve.
778 *
779 * Comment this macro to disable NIST curves optimisation.
780 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200782
783/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200784 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100785 *
786 * Enable "non-blocking" ECC operations that can return early and be resumed.
787 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200788 * This allows various functions to pause by returning
789 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
790 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
791 * order to further progress and eventually complete their operation. This is
792 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
793 * number of ECC operations a function may perform before pausing; see
794 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100795 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200796 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200797 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100798 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100799 * This option:
800 * - Adds xxx_restartable() variants of existing operations in the
801 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100802 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
803 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100804 * - ECDSA: signature generation & verification;
805 * - PK: signature generation & verification;
806 * - X509: certificate chain verification.
807 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
808 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
809 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
810 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000811 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100812 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100813 * - verification of the server's key exchange signature;
814 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100815 * - generation of the client's signature if client authentication is used,
816 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100817 *
818 * \note In the cases above, the usual SSL/TLS functions, such as
819 * mbedtls_ssl_handshake(), can now return
820 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200821 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100822 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
823 * restartable operations in PK, X.509 and TLS (see above) are not
824 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100825 * PSA, and are not restartable. These are temporary limitations that
826 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200827 *
Ron Eldor19779c42018-11-05 16:58:13 +0200828 * \note This option only works with the default software implementation of
829 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100830 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100831 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100832 * Requires: MBEDTLS_ECP_C
833 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100834 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100835 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200836//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100837
838/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200839 * Uncomment to enable using new bignum code in the ECC modules.
840 *
841 * \warning This is currently experimental, incomplete and therefore should not
842 * be used in production.
843 */
844//#define MBEDTLS_ECP_WITH_MPI_UINT
845
846/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200847 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100848 *
849 * Enable deterministic ECDSA (RFC 6979).
850 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
851 * may result in a compromise of the long-term signing key. This is avoided by
852 * the deterministic variant.
853 *
John Durkop36a82e52020-10-26 09:39:05 -0700854 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100855 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100856 * Comment this macro to disable deterministic ECDSA.
857 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100859
860/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200861 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200862 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200863 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200864 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200865 * This enables the following ciphersuites (if other requisites are
866 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
868 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
869 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
870 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
871 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
872 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
873 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
874 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
875 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
876 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200877 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200878#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200879
880/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200882 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200883 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200884 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200886 *
887 * This enables the following ciphersuites (if other requisites are
888 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
890 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
891 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
892 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
893 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
894 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
895 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
896 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
897 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
898 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100899 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100900 * \warning Using DHE constitutes a security risk as it
901 * is not possible to validate custom DH parameters.
902 * If possible, it is recommended users should consider
903 * preferring other methods of key exchange.
904 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100905 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200908
909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200911 *
912 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
913 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200914 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200915 *
916 * This enables the following ciphersuites (if other requisites are
917 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
919 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
920 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
921 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
922 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
923 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200924 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200926
927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200929 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200930 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200931 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
933 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200934 *
935 * This enables the following ciphersuites (if other requisites are
936 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
938 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
939 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
940 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
941 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
942 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
943 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
944 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
945 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
946 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200947 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200949
950/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200951 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200952 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200953 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200954 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
956 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200957 *
958 * This enables the following ciphersuites (if other requisites are
959 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200960 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
961 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
962 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
963 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
964 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
965 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
966 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
967 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
968 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
969 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
970 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
971 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200972 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200973#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200974
975/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200976 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200977 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200978 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200979 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200980 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
981 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200982 *
983 * This enables the following ciphersuites (if other requisites are
984 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
986 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
987 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
988 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
989 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
990 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
991 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
992 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
993 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
994 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
995 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
996 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100997 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100998 * \warning Using DHE constitutes a security risk as it
999 * is not possible to validate custom DH parameters.
1000 * If possible, it is recommended users should consider
1001 * preferring other methods of key exchange.
1002 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001003 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001005#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001006
1007/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001009 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001010 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001011 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001012 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1013 * MBEDTLS_RSA_C
1014 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001016 *
1017 * This enables the following ciphersuites (if other requisites are
1018 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1020 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1021 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1022 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1023 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1024 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1025 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1026 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1027 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1028 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +02001029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001031
1032/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001033 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001034 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001035 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001036 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001037 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1038 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1039 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001040 *
1041 * This enables the following ciphersuites (if other requisites are
1042 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1044 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1045 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1046 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1047 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1048 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1049 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1050 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1051 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1052 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001055
1056/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001057 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001058 *
1059 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1060 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001061 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1062 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1063 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001064 *
1065 * This enables the following ciphersuites (if other requisites are
1066 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1068 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1069 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1070 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1071 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1072 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1073 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1074 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1075 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1076 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001077 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001079
1080/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001081 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001082 *
1083 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1084 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001085 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1086 * MBEDTLS_RSA_C
1087 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001088 *
1089 * This enables the following ciphersuites (if other requisites are
1090 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1092 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1093 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1094 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1095 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1096 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1097 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1098 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1099 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1100 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001101 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001103
1104/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001105 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1106 *
1107 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1108 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001109 * \warning This is currently experimental. EC J-PAKE support is based on the
1110 * Thread v1.0.0 specification; incompatible changes to the specification
1111 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001112 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001113 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001114 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001115 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1116 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001117 * \warning If SHA-256 is provided only by a PSA driver, you must call
1118 * psa_crypto_init() before the first hanshake (even if
1119 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1120 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001121 * This enables the following ciphersuites (if other requisites are
1122 * enabled as well):
1123 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1124 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001125//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001126
1127/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001129 *
1130 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1131 * RFC 5915 and RFC 5480.
1132 *
1133 * Currently this means parsing the SpecifiedECDomain choice of EC
1134 * parameters (only known groups are supported, not arbitrary domains, to
1135 * avoid validation issues).
1136 *
1137 * Disable if you only need to support RFC 5915 + 5480 key formats.
1138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001140
1141/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001142 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1143 *
1144 * Enable the support for parsing public keys of type Short Weierstrass
1145 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001146 * compressed point format. This parsing is done through ECP module's functions.
1147 *
1148 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1149 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1150 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001151 */
1152#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1153
1154/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001156 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157 * Enable a dummy error function to make use of mbedtls_strerror() in
1158 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1159 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001160 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001161 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1162 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001163 *
1164 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001168
1169/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001171 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001172 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001173 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001177
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001178/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001179 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001180 *
1181 * Enable functions that use the filesystem.
1182 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001183#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001184
1185/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001187 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001188 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001189 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001190 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001191 * application.
1192 *
1193 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001194 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001196
1197/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001199 *
1200 * Do not use built-in platform entropy functions.
1201 * This is useful if your platform does not support
1202 * standards like the /dev/urandom or Windows CryptoAPI.
1203 *
1204 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001207
1208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001210 *
1211 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1212 * default SHA-512 based one (if both are available).
1213 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001214 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001215 *
1216 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1217 * if you have performance concerns.
1218 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219 * This option is only useful if both MBEDTLS_SHA256_C and
1220 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001222//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001223
1224/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001225 * \def MBEDTLS_ENTROPY_NV_SEED
1226 *
1227 * Enable the non-volatile (NV) seed file-based entropy source.
1228 * (Also enables the NV seed read/write functions in the platform layer)
1229 *
1230 * This is crucial (if not required) on systems that do not have a
1231 * cryptographic entropy source (in hardware or kernel) available.
1232 *
1233 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1234 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001235 * \note The read/write functions that are used by the entropy source are
1236 * determined in the platform layer, and can be modified at runtime and/or
1237 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1238 *
1239 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001240 * with regular fopen(), please make sure you make a seedfile with the
1241 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1242 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001243 * and written to or you will get an entropy source error! The default
1244 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1245 * bytes from the file.
1246 *
1247 * \note The entropy collector will write to the seed file before entropy is
1248 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001249 */
1250//#define MBEDTLS_ENTROPY_NV_SEED
1251
Ronald Cron71016a92020-08-28 19:01:50 +02001252/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001253 *
Ronald Cron71016a92020-08-28 19:01:50 +02001254 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001255 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001256 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1257 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001258 *
1259 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001260 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001261 */
Ronald Cron71016a92020-08-28 19:01:50 +02001262//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001263
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001264/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001265 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001266 *
1267 * Enable debugging of buffer allocator memory issues. Automatically prints
1268 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1269 * function for 'debug output' of allocated memory.
1270 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001271 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001272 *
1273 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001274 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001275//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001276
1277/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001279 *
1280 * Include backtrace information with each allocated block.
1281 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001282 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001283 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001284 *
1285 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001286 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001287//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001288
1289/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001290 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001291 *
1292 * Support external private RSA keys (eg from a HSM) in the PK layer.
1293 *
1294 * Comment this macro to disable support for external private RSA keys.
1295 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001296#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001297
1298/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001300 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001301 * Enable support for PKCS#1 v1.5 encoding.
1302 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001303 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001304 *
Paul Bakker48377d92013-08-30 12:06:24 +02001305 * This enables support for PKCS#1 v1.5 operations.
1306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001307#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001308
1309/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001311 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001312 * Enable support for PKCS#1 v2.1 encoding.
1313 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001314 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001315 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001316 * \warning If using a hash that is only provided by PSA drivers, you must
1317 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001318 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001319 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1320 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001321#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001322
Steven Cooreman6801f082021-02-19 17:21:22 +01001323/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1324 *
1325 * Enable support for platform built-in keys. If you enable this feature,
1326 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1327 * See the documentation of that function for more information.
1328 *
1329 * Built-in keys are typically derived from a hardware unique key or
1330 * stored in a secure element.
1331 *
1332 * Requires: MBEDTLS_PSA_CRYPTO_C.
1333 *
1334 * \warning This interface is experimental and may change or be removed
1335 * without notice.
1336 */
1337//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1338
Ronald Cron3768ac12021-01-26 16:58:00 +01001339/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1340 *
1341 * Enable support for PSA crypto client.
1342 *
1343 * \note This option allows to include the code necessary for a PSA
1344 * crypto client when the PSA crypto implementation is not included in
1345 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1346 * code to set and get PSA key attributes.
1347 * The development of PSA drivers partially relying on the library to
1348 * fulfill the hardware gaps is another possible usage of this option.
1349 *
1350 * \warning This interface is experimental and may change or be removed
1351 * without notice.
1352 */
1353//#define MBEDTLS_PSA_CRYPTO_CLIENT
1354
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001355/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1356 *
1357 * Make the PSA Crypto module use an external random generator provided
1358 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1359 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001360 * \note This random generator must deliver random numbers with cryptographic
1361 * quality and high performance. It must supply unpredictable numbers
1362 * with a uniform distribution. The implementation of this function
1363 * is responsible for ensuring that the random generator is seeded
1364 * with sufficient entropy. If you have a hardware TRNG which is slow
1365 * or delivers non-uniform output, declare it as an entropy source
1366 * with mbedtls_entropy_add_source() instead of enabling this option.
1367 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001368 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001369 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1370 * and define a function called mbedtls_psa_external_get_random()
1371 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001372 * ```
1373 * psa_status_t mbedtls_psa_external_get_random(
1374 * mbedtls_psa_external_random_context_t *context,
1375 * uint8_t *output, size_t output_size, size_t *output_length);
1376 * );
1377 * ```
1378 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001379 * The function must fill the \c output buffer with \c output_size bytes
1380 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001381 *
1382 * Requires: MBEDTLS_PSA_CRYPTO_C
1383 *
1384 * \warning If you enable this option, code that uses the PSA cryptography
1385 * interface will not use any of the entropy sources set up for
1386 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1387 * enables.
1388 *
1389 * \note This option is experimental and may be removed without notice.
1390 */
1391//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1392
Paul Bakker9dcc3222011-03-08 14:16:06 +00001393/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001394 * \def MBEDTLS_PSA_CRYPTO_SPM
1395 *
1396 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1397 * Partition Manager) integration which separates the code into two parts: a
1398 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1399 * Environment).
1400 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001401 * If you enable this option, your build environment must include a header
1402 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1403 * header files, or in another directory on the compiler's include search
1404 * path). Alternatively, your platform may customize the header
1405 * `psa/crypto_platform.h`, in which case it can skip or replace the
1406 * inclusion of `"crypto_spe.h"`.
1407 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001408 * Module: library/psa_crypto.c
1409 * Requires: MBEDTLS_PSA_CRYPTO_C
1410 *
1411 */
1412//#define MBEDTLS_PSA_CRYPTO_SPM
1413
1414/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001415 * Uncomment to enable p256-m. This is an alternative implementation of
1416 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1417 * Compared to the default implementation:
1418 *
1419 * - p256-m has a much smaller code size and RAM footprint.
1420 * - p256-m is only available via the PSA API. This includes the pk module
1421 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1422 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1423 * over the core arithmetic, or deterministic derivation of keys.
1424 *
1425 * We recommend enabling this option if your application uses the PSA API
1426 * and the only elliptic curve support it needs is ECDH and ECDSA over
1427 * SECP256R1.
1428 *
1429 * If you enable this option, you do not need to enable any ECC-related
1430 * MBEDTLS_xxx option. You do need to separately request support for the
1431 * cryptographic mechanisms through the PSA API:
1432 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1433 * configuration;
1434 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1435 * - #PSA_WANT_ECC_SECP_R1_256;
1436 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1437 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1438 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1439 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1440 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001441 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001442 * \note To benefit from the smaller code size of p256-m, make sure that you
1443 * do not enable any ECC-related option not supported by p256-m: this
1444 * would cause the built-in ECC implementation to be built as well, in
1445 * order to provide the required option.
1446 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001447 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1448 * SECP256R1 are disabled as they are not supported by this driver.
1449 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1450 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001451 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001452 */
1453//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1454
1455/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001456 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001457 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001458 * Enable support for entropy injection at first boot. This feature is
1459 * required on systems that do not have a built-in entropy source (TRNG).
1460 * This feature is currently not supported on systems that have a built-in
1461 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001462 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001463 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001464 *
1465 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001466//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001467
1468/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001470 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001471 * Do not use the Chinese Remainder Theorem
1472 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001473 *
1474 * Uncomment this macro to disable the use of CRT in RSA.
1475 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001477//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001478
1479/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001480 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001481 *
1482 * Enable the checkup functions (*_self_test).
1483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001484#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001485
1486/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001487 * \def MBEDTLS_SHA256_SMALLER
1488 *
1489 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1490 * lower performance.
1491 *
Adam Wolf039080f2019-09-10 09:53:08 -05001492 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001493 * performance and size. This version optimizes more aggressively for size at
1494 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1495 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1496 * 30%.
1497 *
1498 * Uncomment to enable the smaller implementation of SHA256.
1499 */
1500//#define MBEDTLS_SHA256_SMALLER
1501
1502/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001503 * \def MBEDTLS_SHA512_SMALLER
1504 *
1505 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1506 * lower performance.
1507 *
1508 * Uncomment to enable the smaller implementation of SHA512.
1509 */
1510//#define MBEDTLS_SHA512_SMALLER
1511
1512/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001514 *
1515 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001516 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001517 * with other servers, only debugging of failures is harder.
1518 *
1519 * The advantage of not sending alert messages, is that no information is given
1520 * about reasons for failures thus preventing adversaries of gaining intel.
1521 *
1522 * Enable sending of all alert messages
1523 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001525
1526/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001527 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1528 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001529 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001530 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001531 * in the underlying transport. The CID functionality is described
1532 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001533 *
1534 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001535 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1536 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1537 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001538 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001539 * The maximum lengths of outgoing and incoming CIDs can be configured
1540 * through the options
1541 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1542 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1543 *
1544 * Requires: MBEDTLS_SSL_PROTO_DTLS
1545 *
1546 * Uncomment to enable the Connection ID extension.
1547 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001548#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1549
1550
1551/**
1552 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1553 *
1554 * Defines whether RFC 9146 (default) or the legacy version
1555 * (version draft-ietf-tls-dtls-connection-id-05,
1556 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1557 * is used.
1558 *
1559 * Set the value to 0 for the standard version, and
1560 * 1 for the legacy draft version.
1561 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001562 * \deprecated Support for the legacy version of the DTLS
1563 * Connection ID feature is deprecated. Please
1564 * switch to the standardized version defined
1565 * in RFC 9146 enabled by utilizing
1566 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1567 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1568 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001569 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1570 */
1571#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001572
1573/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001574 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1575 *
1576 * Enable asynchronous external private key operations in SSL. This allows
1577 * you to configure an SSL connection to call an external cryptographic
1578 * module to perform private key operations instead of performing the
1579 * operation inside the library.
1580 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001581 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001582 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001583//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001584
1585/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001586 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1587 *
1588 * Enable serialization of the TLS context structures, through use of the
1589 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1590 *
1591 * This pair of functions allows one side of a connection to serialize the
1592 * context associated with the connection, then free or re-use that context
1593 * while the serialized state is persisted elsewhere, and finally deserialize
1594 * that state to a live context for resuming read/write operations on the
1595 * connection. From a protocol perspective, the state of the connection is
1596 * unaffected, in particular this is entirely transparent to the peer.
1597 *
1598 * Note: this is distinct from TLS session resumption, which is part of the
1599 * protocol and fully visible by the peer. TLS session resumption enables
1600 * establishing new connections associated to a saved session with shorter,
1601 * lighter handshakes, while context serialization is a local optimization in
1602 * handling a single, potentially long-lived connection.
1603 *
1604 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1605 * saved after the handshake to allow for more efficient serialization, so if
1606 * you don't need this feature you'll save RAM by disabling it.
1607 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001608 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1609 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001610 * Comment to disable the context serialization APIs.
1611 */
1612#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1613
1614/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001615 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001616 *
1617 * Enable the debug messages in SSL module for all issues.
1618 * Debug messages have been disabled in some places to prevent timing
1619 * attacks due to (unbalanced) debugging function calls.
1620 *
1621 * If you need all error reporting you should enable this during debugging,
1622 * but remove this for production servers that should log as well.
1623 *
1624 * Uncomment this macro to report all debug messages on errors introducing
1625 * a timing side-channel.
1626 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001628//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001629
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001630/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001631 *
1632 * Enable support for Encrypt-then-MAC, RFC 7366.
1633 *
1634 * This allows peers that both support it to use a more robust protection for
1635 * ciphersuites using CBC, providing deep resistance against timing attacks
1636 * on the padding or underlying cipher.
1637 *
1638 * This only affects CBC ciphersuites, and is useless if none is defined.
1639 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001640 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001641 *
1642 * Comment this macro to disable support for Encrypt-then-MAC
1643 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001644#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001645
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001647 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001648 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1649 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001650 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001651 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001652 * attacks, but it is recommended to always use it (even if you disable
1653 * renegotiation), since it actually fixes a more fundamental issue in the
1654 * original SSL/TLS design, and has implications beyond Triple Handshake.
1655 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001656 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001657 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001658 * Comment this macro to disable support for Extended Master Secret.
1659 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001660#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001661
Paul Bakkerd66f0702013-01-31 16:57:45 +01001662/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001663 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1664 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001665 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001666 * giving access to the peer's certificate after completion of the handshake.
1667 *
1668 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1669 * recommended to disable this option for reduced RAM usage.
1670 *
1671 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1672 * defined, but always returns \c NULL.
1673 *
1674 * \note This option has no influence on the protection against the
1675 * triple handshake attack. Even if it is disabled, Mbed TLS will
1676 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001677 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001678 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001679 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001680 *
1681 * Comment this macro to disable storing the peer's certificate
1682 * after the handshake.
1683 */
1684#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1685
1686/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001688 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001689 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001690 *
1691 * The two main uses of renegotiation are (1) refresh keys on long-lived
1692 * connections and (2) client authentication after the initial handshake.
1693 * If you don't need renegotiation, it's probably better to disable it, since
1694 * it has been associated with security issues in the past and is easy to
1695 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001696 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001697 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1698 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001699 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001700 *
1701 * \note Even if this option is disabled, both client and server are aware
1702 * of the Renegotiation Indication Extension (RFC 5746) used to
1703 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1704 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1705 * configuration of this extension).
1706 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001707 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001709
1710/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001712 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001713 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001714 *
1715 * Comment this macro to disable support for the max_fragment_length extension
1716 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001718
1719/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001720 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1721 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001722 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001723 *
1724 * \warning This extension is currently in development and must NOT be used except
1725 * for testing purposes.
1726 *
1727 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1728 *
1729 * Uncomment this macro to enable support for the record_size_limit extension
1730 */
1731//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1732
1733/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001735 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001736 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001737 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001738 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001739 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1740 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001741 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001742 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001743 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001744 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1745 * are only provided by PSA drivers, you must call psa_crypto_init() before
1746 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001747 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001748 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001749 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001751
1752/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001753 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001754 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001755 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001756 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001757 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001758 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001759 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001760 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001761 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001762 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001763 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1764 * directly performed by TLS 1.3 code. As a consequence, you must
1765 * call psa_crypto_init() before the first TLS 1.3 handshake.
1766 *
1767 * \note Cryptographic operations performed indirectly via another module
1768 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1769 * running handshake hash) only use PSA crypto if
1770 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001771 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001772 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001773 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001774//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001775
1776/**
Ronald Cronab65c522021-11-24 10:47:20 +01001777 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1778 *
1779 * Enable TLS 1.3 middlebox compatibility mode.
1780 *
1781 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1782 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1783 * expecting TLS 1.2 traffic.
1784 *
1785 * Turning on the compatibility mode comes at the cost of a few added bytes
1786 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1787 * that don't use it. Therefore, unless transmission bandwidth is critical and
1788 * you know that middlebox compatibility issues won't occur, it is therefore
1789 * recommended to set this option.
1790 *
1791 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001792 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1793 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001794 *
1795 */
1796//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1797
1798/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001799 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1800 *
1801 * Enable TLS 1.3 PSK key exchange mode.
1802 *
1803 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1804 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1805 * effect on the build.
1806 *
1807 */
1808#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1809
1810/**
1811 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1812 *
1813 * Enable TLS 1.3 ephemeral key exchange mode.
1814 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001815 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001816 * MBEDTLS_X509_CRT_PARSE_C
1817 * and at least one of:
1818 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1819 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001820 *
1821 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1822 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1823 * effect on the build.
1824 *
1825 */
1826#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1827
1828/**
1829 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1830 *
1831 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1832 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001833 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001834 *
1835 * Comment to disable support for the PSK ephemeral key exchange mode in
1836 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1837 * have any effect on the build.
1838 *
1839 */
1840#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1841
1842/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 * \def MBEDTLS_SSL_EARLY_DATA
1844 *
1845 * Enable support for RFC 8446 TLS 1.3 early data.
1846 *
1847 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1848 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1849 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1850 *
1851 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1852 * is not enabled, this option does not have any effect on the build.
1853 *
1854 * This feature is experimental, not completed and thus not ready for
1855 * production.
1856 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001857 * \note The maximum amount of early data can be set with
1858 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1859 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001861//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001862
1863/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001865 *
1866 * Enable support for DTLS (all available versions).
1867 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001868 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001869 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001870 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001871 *
1872 * Comment this macro to disable support for DTLS
1873 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001875
1876/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001878 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001879 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001880 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001881 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001884
1885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001887 *
1888 * Enable support for the anti-replay mechanism in DTLS.
1889 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890 * Requires: MBEDTLS_SSL_TLS_C
1891 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001892 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001893 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001894 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001895 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001896 * Comment this to disable anti-replay in DTLS.
1897 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001899
1900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001902 *
1903 * Enable support for HelloVerifyRequest on DTLS servers.
1904 *
1905 * This feature is highly recommended to prevent DTLS servers being used as
1906 * amplifiers in DoS attacks against other hosts. It should always be enabled
1907 * unless you know for sure amplification cannot be a problem in the
1908 * environment in which your server operates.
1909 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001910 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001911 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001912 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001913 *
1914 * Comment this to disable support for HelloVerifyRequest.
1915 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001917
1918/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001919 * \def MBEDTLS_SSL_DTLS_SRTP
1920 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001921 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001922 * through the use_srtp extension.
1923 *
1924 * \note This feature provides the minimum functionality required
1925 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1926 * the associated SRTP packet protection key material.
1927 * In particular, the SRTP packet protection itself, as well as the
1928 * demultiplexing of RTP and DTLS packets at the datagram layer
1929 * (see Section 5 of RFC 5764), are not handled by this feature.
1930 * Instead, after successful completion of a handshake negotiating
1931 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001932 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001933 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1934 * (this is implemented in the SSL example programs).
1935 * The resulting key should then be passed to an SRTP stack.
1936 *
1937 * Setting this option enables the runtime API
1938 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1939 * through which the supported DTLS-SRTP protection
1940 * profiles can be configured. You must call this API at
1941 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001942 *
1943 * Requires: MBEDTLS_SSL_PROTO_DTLS
1944 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001945 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001946 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001947//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001948
1949/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001950 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1951 *
1952 * Enable server-side support for clients that reconnect from the same port.
1953 *
1954 * Some clients unexpectedly close the connection and try to reconnect using the
1955 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001956 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001957 * flag enables that support.
1958 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001959 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001960 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001961 * Comment this to disable support for clients reusing the source port.
1962 */
1963#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1964
1965/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001967 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001968 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001969 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001970 * session store remains the responsibility of the application, though).
1971 * Server-side, you also need to provide callbacks for writing and parsing
1972 * tickets, including authenticated encryption and key management. Example
1973 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001974 *
1975 * Comment this macro to disable support for SSL session tickets
1976 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001978
1979/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001980 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001981 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001982 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001983 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001984 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001985 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001986 * Comment this macro to disable support for server name indication in SSL
1987 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001988#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001989
1990/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001991 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1992 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001993 * When this option is enabled, the SSL buffer will be resized automatically
1994 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001995 *
1996 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001997 */
1998//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1999
2000/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002001 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2002 *
2003 * Enable testing of the constant-flow nature of some sensitive functions with
2004 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002005 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002006 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002007 * This setting requires compiling with clang -fsanitize=memory. The test
2008 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002009 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002010 * \warning This macro is only used for extended testing; it is not considered
2011 * part of the library's API, so it may change or disappear at any time.
2012 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002013 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002014 */
2015//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2016
2017/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002018 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2019 *
2020 * Enable testing of the constant-flow nature of some sensitive functions with
2021 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002022 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002023 *
2024 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002025 * testing if the tests suites are run with valgrind's memcheck. This can be
2026 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2027 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002028 *
2029 * \warning This macro is only used for extended testing; it is not considered
2030 * part of the library's API, so it may change or disappear at any time.
2031 *
2032 * Uncomment to enable testing of the constant-flow nature of selected code.
2033 */
2034//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2035
2036/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002037 * \def MBEDTLS_TEST_HOOKS
2038 *
2039 * Enable features for invasive testing such as introspection functions and
2040 * hooks for fault injection. This enables additional unit tests.
2041 *
2042 * Merely enabling this feature should not change the behavior of the product.
2043 * It only adds new code, and new branching points where the default behavior
2044 * is the same as when this feature is disabled.
2045 * However, this feature increases the attack surface: there is an added
2046 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2047 * Therefore this feature must never be enabled in production.
2048 *
2049 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2050 * information.
2051 *
2052 * Uncomment to enable invasive tests.
2053 */
2054//#define MBEDTLS_TEST_HOOKS
2055
2056/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002058 *
2059 * Provide your own alternate threading implementation.
2060 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002062 *
2063 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002065//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002066
2067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002068 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002069 *
2070 * Enable the pthread wrapper layer for the threading layer.
2071 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002073 *
2074 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002075 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002077
2078/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002079 * \def MBEDTLS_USE_PSA_CRYPTO
2080 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002081 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
2082 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002083 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002084 * \note Development of this option is currently in progress, and parts of Mbed
2085 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002086 * will still continue to work as usual, so enabling this option should not
2087 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002088 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02002089 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02002090 * before calling any function from the SSL/TLS, X.509 or PK modules, except
2091 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00002092 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002093 * \note An important and desirable effect of this option is that it allows
2094 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2095 * 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 +02002096 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002097 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2098 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002099 *
2100 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002101 *
2102 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002103 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002104 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002105 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002106//#define MBEDTLS_USE_PSA_CRYPTO
2107
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002108/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002109 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2110 *
John Durkop185764f2020-10-12 21:32:12 -07002111 * This setting allows support for cryptographic mechanisms through the PSA
2112 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002113 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002114 * When this option is disabled, the PSA API exposes the cryptographic
2115 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2116 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002117 *
2118 * When this option is enabled, the PSA API exposes the cryptographic
2119 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2120 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2121 * automatically enabled if required (i.e. if no PSA driver provides the
2122 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2123 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002124 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002125 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002126 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002127 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002128 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2129 * symbols is not completely finalized yet, and the configuration
2130 * tooling is not ideally adapted to having two separate configuration
2131 * files.
2132 * Future minor releases of Mbed TLS may make minor changes to those
2133 * symbols, but we will endeavor to provide a transition path.
2134 * Nonetheless, this option is considered mature enough to use in
2135 * production, as long as you accept that you may need to make
2136 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002137 */
2138//#define MBEDTLS_PSA_CRYPTO_CONFIG
2139
2140/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002141 * \def MBEDTLS_VERSION_FEATURES
2142 *
2143 * Allow run-time checking of compile-time enabled features. Thus allowing users
2144 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002145 * support via mbedtls_version_check_feature().
2146 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002147 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002148 *
2149 * Comment this to disable run-time checking and save ROM space
2150 */
2151#define MBEDTLS_VERSION_FEATURES
2152
2153/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002154 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2155 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002156 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002157 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2158 * the set of trusted certificates through a callback instead of a linked
2159 * list.
2160 *
2161 * This is useful for example in environments where a large number of trusted
2162 * certificates is present and storing them in a linked list isn't efficient
2163 * enough, or when the set of trusted certificates changes frequently.
2164 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002165 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002166 * `mbedtls_ssl_conf_ca_cb()` for more information.
2167 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002168 * Requires: MBEDTLS_X509_CRT_PARSE_C
2169 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002170 * Uncomment to enable trusted certificate callbacks.
2171 */
2172//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2173
2174/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002175 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002176 *
Chris Jones2c745862020-12-16 11:41:06 +00002177 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002178 *
Chris Jones2c745862020-12-16 11:41:06 +00002179 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002180 * and other functions/constants only used by these functions, thus reducing
2181 * the code footprint by several KB.
2182 */
Chris Jones2c745862020-12-16 11:41:06 +00002183//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002184
2185/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002187 *
2188 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2189 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2190 *
2191 * Comment this macro to disallow using RSASSA-PSS in certificates.
2192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002193#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002194/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002195
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002196/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002197 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002198 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002199 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002200 * \{
2201 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002202
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002203/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002205 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002206 * Enable AES-NI support on x86-64 or x86-32.
2207 *
2208 * \note AESNI is only supported with certain compilers and target options:
2209 * - Visual Studio 2013: supported.
2210 * - GCC, x86-64, target not explicitly supporting AESNI:
2211 * requires MBEDTLS_HAVE_ASM.
2212 * - GCC, x86-32, target not explicitly supporting AESNI:
2213 * not supported.
2214 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2215 * For this assembly-less implementation, you must currently compile
2216 * `library/aesni.c` and `library/aes.c` with machine options to enable
2217 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2218 * `clang -maes -mpclmul`.
2219 * - Non-x86 targets: this option is silently ignored.
2220 * - Other compilers: this option is silently ignored.
2221 *
2222 * \note
2223 * Above, "GCC" includes compatible compilers such as Clang.
2224 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002225 *
2226 * Module: library/aesni.c
2227 * Caller: library/aes.c
2228 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002229 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002230 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002231 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002233#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002234
2235/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002236 * \def MBEDTLS_AESCE_C
2237 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002238 * Enable AES cryptographic extension support on 64-bit Arm.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002239 *
2240 * Module: library/aesce.c
2241 * Caller: library/aes.c
2242 *
Jerry Yuf015a932023-04-25 10:38:03 +08002243 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002244 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002245 * \warning Runtime detection only works on Linux. For non-Linux operating
2246 * system, Armv8-A Cryptographic Extensions must be supported by
2247 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002248 *
Jerry Yua1a039d2023-04-26 10:21:42 +08002249 * \note Minimum compiler versions for this feature are Clang 4.0,
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002250 * armclang 6.6, GCC 6.0 or MSVC 2019 version 16.11.2.
2251 *
2252 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2253 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002254 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002255 * This module adds support for the AES Armv8-A Cryptographic Extensions on Aarch64 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002256 */
2257#define MBEDTLS_AESCE_C
2258
2259/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002261 *
2262 * Enable the AES block cipher.
2263 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002264 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002265 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002266 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002267 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002268 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002269 * This module enables the following ciphersuites (if other requisites are
2270 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002271 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2272 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2273 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2274 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2275 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2276 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2277 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2278 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2279 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2280 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2281 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2282 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2283 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2284 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2285 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2286 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2287 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2288 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2289 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2290 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2291 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2292 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2293 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2294 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2295 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2296 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2297 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2298 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2299 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2300 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2301 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2302 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2303 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2304 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2305 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2306 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2307 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2308 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2309 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2310 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2311 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2312 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2313 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2314 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2315 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2316 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2317 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2318 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2319 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2320 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2321 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2322 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2323 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2324 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2325 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2326 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2327 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2328 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002329 *
Paul Bakkercff68422013-09-15 20:43:33 +02002330 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002331 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002332#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002333
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002336 *
2337 * Enable the generic ASN1 parser.
2338 *
2339 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002340 * Caller: library/x509.c
2341 * library/dhm.c
2342 * library/pkcs12.c
2343 * library/pkcs5.c
2344 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002345 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002347
2348/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002349 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002350 *
2351 * Enable the generic ASN1 writer.
2352 *
2353 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002354 * Caller: library/ecdsa.c
2355 * library/pkwrite.c
2356 * library/x509_create.c
2357 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002358 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002359 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002360#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002361
2362/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002363 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002364 *
2365 * Enable the Base64 module.
2366 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002367 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002368 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002369 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002370 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002371 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002372#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002373
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002374/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002376 *
Paul Bakker9a736322012-11-14 12:39:52 +00002377 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002378 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002379 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002380 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002381 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002382 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002383 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002384 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002385 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002386 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002387 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002388 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002389 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002390 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002392#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002393
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002394/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002396 *
2397 * Enable the Camellia block cipher.
2398 *
Paul Bakker38119b12009-01-10 23:31:23 +00002399 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002400 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002401 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002402 * This module enables the following ciphersuites (if other requisites are
2403 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002404 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2405 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2406 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2407 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2408 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2409 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2410 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2411 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2412 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2413 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2414 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2415 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2416 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2417 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2418 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2419 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2420 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2421 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2422 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2423 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2424 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2425 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2426 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2427 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2428 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2429 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2430 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2431 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2432 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2433 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2434 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2435 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2436 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2437 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2438 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2439 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2440 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2441 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2442 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2443 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2444 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2445 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002447#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002448
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002449/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002450 * \def MBEDTLS_ARIA_C
2451 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002452 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002453 *
2454 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002455 * Caller: library/cipher.c
2456 *
2457 * This module enables the following ciphersuites (if other requisites are
2458 * enabled as well):
2459 *
2460 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2461 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2462 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2463 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2464 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2465 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2466 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2467 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2468 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2469 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2470 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2471 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2472 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2473 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2474 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2475 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2476 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2477 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2478 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2479 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2480 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2481 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2482 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2483 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2484 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2485 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2486 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2487 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2488 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2489 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2490 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2491 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2492 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2493 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2494 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2495 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2496 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2497 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002498 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002499#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002500
2501/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002503 *
2504 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2505 *
2506 * Module: library/ccm.c
2507 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002508 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2509 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002510 *
2511 * This module enables the AES-CCM ciphersuites, if other requisites are
2512 * enabled as well.
2513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002515
2516/**
Daniel King34b822c2016-05-15 17:28:08 -03002517 * \def MBEDTLS_CHACHA20_C
2518 *
2519 * Enable the ChaCha20 stream cipher.
2520 *
2521 * Module: library/chacha20.c
2522 */
2523#define MBEDTLS_CHACHA20_C
2524
2525/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002526 * \def MBEDTLS_CHACHAPOLY_C
2527 *
2528 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2529 *
2530 * Module: library/chachapoly.c
2531 *
2532 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2533 */
2534#define MBEDTLS_CHACHAPOLY_C
2535
2536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002538 *
2539 * Enable the generic cipher layer.
2540 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002541 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002542 * Caller: library/ccm.c
2543 * library/cmac.c
2544 * library/gcm.c
2545 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002546 * library/pkcs12.c
2547 * library/pkcs5.c
2548 * library/psa_crypto_aead.c
2549 * library/psa_crypto_mac.c
2550 * library/ssl_ciphersuites.c
2551 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002552 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002553 *
2554 * Uncomment to enable generic cipher wrappers.
2555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002557
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002558/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002559 * \def MBEDTLS_CMAC_C
2560 *
Simon Butcher327398a2016-10-05 14:09:11 +01002561 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2562 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002563 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002564 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2565 * implementation of the CMAC algorithm is provided by an alternate
2566 * implementation, that alternate implementation may opt to not support
2567 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2568 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002569 * Module: library/cmac.c
2570 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002571 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002572 *
2573 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002574#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002575
2576/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002578 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002579 * Enable the CTR_DRBG AES-based random generator.
2580 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002581 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002582 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002583 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2584 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002585 * \note To achieve a 256-bit security strength with CTR_DRBG,
2586 * you must use AES-256 *and* use sufficient entropy.
2587 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002588 *
2589 * Module: library/ctr_drbg.c
2590 * Caller:
2591 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002593 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002594 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002597
2598/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002600 *
2601 * Enable the debug functions.
2602 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002603 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002604 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002605 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002606 * library/ssl_tls12_*.c
2607 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002608 *
2609 * This module provides debugging functions.
2610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002612
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002613/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002614 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002615 *
2616 * Enable the DES block cipher.
2617 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002618 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002619 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002620 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002621 *
Paul Bakkercff68422013-09-15 20:43:33 +02002622 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002623 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002624 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002625 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002626 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002627#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002628
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002629/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002630 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002631 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002632 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002633 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002634 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002635 * Caller: library/ssl_tls.c
2636 * library/ssl*_client.c
2637 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002638 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002639 * This module is used by the following key exchanges:
2640 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002641 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002642 * \warning Using DHE constitutes a security risk as it
2643 * is not possible to validate custom DH parameters.
2644 * If possible, it is recommended users should consider
2645 * preferring other methods of key exchange.
2646 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002647 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002648 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002650
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002651/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002652 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002653 *
2654 * Enable the elliptic curve Diffie-Hellman library.
2655 *
2656 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002657 * Caller: library/psa_crypto.c
2658 * library/ssl_tls.c
2659 * library/ssl*_client.c
2660 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002661 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002662 * This module is used by the following key exchanges:
2663 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002664 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002665 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002666 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002668
2669/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002671 *
2672 * Enable the elliptic curve DSA library.
2673 *
2674 * Module: library/ecdsa.c
2675 * Caller:
2676 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002677 * This module is used by the following key exchanges:
2678 * ECDHE-ECDSA
2679 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002680 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2681 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2682 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002683 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002685
2686/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002687 * \def MBEDTLS_ECJPAKE_C
2688 *
2689 * Enable the elliptic curve J-PAKE library.
2690 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002691 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2692 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002693 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002694 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002695 * Module: library/ecjpake.c
2696 * Caller:
2697 *
2698 * This module is used by the following key exchanges:
2699 * ECJPAKE
2700 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002701 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002702 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002703 * \warning If using a hash that is only provided by PSA drivers, you must
2704 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002705 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002706#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002707
2708/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002710 *
2711 * Enable the elliptic curve over GF(p) library.
2712 *
2713 * Module: library/ecp.c
2714 * Caller: library/ecdh.c
2715 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002716 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002717 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002718 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002719 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002720#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002721
2722/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002723 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002724 *
2725 * Enable the platform-specific entropy code.
2726 *
2727 * Module: library/entropy.c
2728 * Caller:
2729 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002731 *
2732 * This module provides a generic entropy pool
2733 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002735
2736/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002738 *
2739 * Enable error code to error string conversion.
2740 *
2741 * Module: library/error.c
2742 * Caller:
2743 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002747
2748/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002750 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002751 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002752 *
2753 * Module: library/gcm.c
2754 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002755 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2756 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002757 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002758 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2759 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002762
2763/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002764 * \def MBEDTLS_HKDF_C
2765 *
2766 * Enable the HKDF algorithm (RFC 5869).
2767 *
2768 * Module: library/hkdf.c
2769 * Caller:
2770 *
2771 * Requires: MBEDTLS_MD_C
2772 *
2773 * This module adds support for the Hashed Message Authentication Code
2774 * (HMAC)-based key derivation function (HKDF).
2775 */
2776#define MBEDTLS_HKDF_C
2777
2778/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002780 *
2781 * Enable the HMAC_DRBG random generator.
2782 *
2783 * Module: library/hmac_drbg.c
2784 * Caller:
2785 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002787 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002788 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002789 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002790#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002791
2792/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002793 * \def MBEDTLS_LMS_C
2794 *
2795 * Enable the LMS stateful-hash asymmetric signature algorithm.
2796 *
2797 * Module: library/lms.c
2798 * Caller:
2799 *
Raef Colesab4f8742022-09-01 12:24:31 +01002800 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002801 *
Raef Colesab4f8742022-09-01 12:24:31 +01002802 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002803 */
2804#define MBEDTLS_LMS_C
2805
2806/**
Raef Colesab4f8742022-09-01 12:24:31 +01002807 * \def MBEDTLS_LMS_PRIVATE
2808 *
2809 * Enable LMS private-key operations and signing code. Functions enabled by this
2810 * option are experimental, and should not be used in production.
2811 *
2812 * Requires: MBEDTLS_LMS_C
2813 *
2814 * Uncomment to enable the LMS signature algorithm and private key operations.
2815 */
Raef Coles5127e852022-10-07 10:35:56 +01002816//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002817
2818/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002819 * \def MBEDTLS_NIST_KW_C
2820 *
2821 * Enable the Key Wrapping mode for 128-bit block ciphers,
2822 * as defined in NIST SP 800-38F. Only KW and KWP modes
2823 * are supported. At the moment, only AES is approved by NIST.
2824 *
2825 * Module: library/nist_kw.c
2826 *
2827 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2828 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002829#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002830
2831/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002833 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002834 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002835 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002836 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2837 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002838 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002839 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002840 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002841 * Caller: library/constant_time.c
2842 * library/ecdsa.c
2843 * library/ecjpake.c
2844 * library/hkdf.c
2845 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002846 * library/pk.c
2847 * library/pkcs5.c
2848 * library/pkcs12.c
2849 * library/psa_crypto_ecp.c
2850 * library/psa_crypto_rsa.c
2851 * library/rsa.c
2852 * library/ssl_cookie.c
2853 * library/ssl_msg.c
2854 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002855 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002856 * library/x509_crt.c
2857 * library/x509write_crt.c
2858 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002859 *
2860 * Uncomment to enable generic message digest wrappers.
2861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002863
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002864/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002866 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002867 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002868 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002869 * Module: library/md5.c
2870 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002871 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002872 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002873 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002874 * This module is required for TLS 1.2 depending on the handshake parameters.
2875 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2876 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002877 *
2878 * \warning MD5 is considered a weak message digest and its use constitutes a
2879 * security risk. If possible, we recommend avoiding dependencies on
2880 * it, and considering stronger message digests instead.
2881 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002884
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002887 *
2888 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002889 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002890 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002891 *
2892 * Module: library/memory_buffer_alloc.c
2893 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002894 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002895 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002896 *
2897 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002898 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002899//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002900
2901/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002903 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002904 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2905 *
Simon Butcherd567a232016-03-09 20:19:21 +00002906 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2907 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002908 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002909 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002910 * \note See also our Knowledge Base article about porting to a new
2911 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002912 * 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 +00002913 *
Andres AG788aa4a2016-09-14 14:32:09 +01002914 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002915 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002916 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002917 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002919
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002920/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002921 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002922 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002923 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002924 *
2925 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002926 * Caller: library/asn1write.c
2927 * library/pkcs5.c
2928 * library/pkparse.c
2929 * library/pkwrite.c
2930 * library/rsa.c
2931 * library/x509.c
2932 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002933 * library/x509_crl.c
2934 * library/x509_crt.c
2935 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002936 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002937 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002938 *
2939 * This modules translates between OIDs and internal values.
2940 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002942
2943/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002944 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002945 *
2946 * Enable VIA Padlock support on x86.
2947 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002948 * Module: library/padlock.c
2949 * Caller: library/aes.c
2950 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002952 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002953 * This modules adds support for the VIA PadLock on x86.
2954 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002956
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002957/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002959 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002960 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002961 *
2962 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002963 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002964 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002965 * library/x509_crl.c
2966 * library/x509_crt.c
2967 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002968 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002970 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2971 *
2972 * \warning When parsing password-protected files, if MD5 is provided only by
2973 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002974 *
Paul Bakkercff68422013-09-15 20:43:33 +02002975 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002976 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002977#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002978
2979/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002981 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002982 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002983 *
2984 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002985 * Caller: library/pkwrite.c
2986 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002987 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002988 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002990 *
2991 * This modules adds support for encoding / writing PEM files.
2992 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002993#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002994
2995/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002997 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002998 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002999 *
3000 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003001 * Caller: library/psa_crypto_rsa.c
3002 * library/ssl_tls.c
3003 * library/ssl*_client.c
3004 * library/ssl*_server.c
3005 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003006 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02003007 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003008 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003009 * Uncomment to enable generic public key wrappers.
3010 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003011#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003012
3013/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003014 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003015 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003016 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02003017 *
3018 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003019 * Caller: library/x509_crt.c
3020 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003021 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003022 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003023 *
3024 * Uncomment to enable generic public key parse functions.
3025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003027
3028/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003030 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003031 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003032 *
3033 * Module: library/pkwrite.c
3034 * Caller: library/x509write.c
3035 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003037 *
3038 * Uncomment to enable generic public key write functions.
3039 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003041
3042/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003044 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003045 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003046 *
3047 * Module: library/pkcs5.c
3048 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003049 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01003050 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003051 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003052 * \warning If using a hash that is only provided by PSA drivers, you must
3053 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003054 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003055 * This module adds support for the PKCS#5 functions.
3056 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003058
3059/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003060 * \def MBEDTLS_PKCS7_C
3061 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003062 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003063 * RFC Link - https://tools.ietf.org/html/rfc2315
3064 *
3065 * Module: library/pkcs7.c
3066 *
3067 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003068 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3069 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003070 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003071 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003072 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003073#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003074
3075/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003077 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003078 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003079 * Adds algorithms for parsing PKCS#8 encrypted private keys
3080 *
3081 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003082 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003083 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003084 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
3085 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
3086 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003087 * \warning If using a hash that is only provided by PSA drivers, you must
3088 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003089 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003090 * This module enables PKCS#12 functions.
3091 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003093
3094/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003095 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003096 *
3097 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003098 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003099 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3101 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003102 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003103 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003104 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003105 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003106 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003107 * Module: library/platform.c
3108 * Caller: Most other .c files
3109 *
3110 * This module enables abstraction of common (libc) functions.
3111 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003112#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003113
3114/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003115 * \def MBEDTLS_POLY1305_C
3116 *
3117 * Enable the Poly1305 MAC algorithm.
3118 *
3119 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003120 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003121 */
3122#define MBEDTLS_POLY1305_C
3123
3124/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003125 * \def MBEDTLS_PSA_CRYPTO_C
3126 *
3127 * Enable the Platform Security Architecture cryptography API.
3128 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003129 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003130 *
Przemek Stekielea805b42022-05-02 10:30:03 +02003131 * Requires: MBEDTLS_CIPHER_C,
3132 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003133 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003134 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003135 *
3136 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003137#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003138
3139/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003140 * \def MBEDTLS_PSA_CRYPTO_SE_C
3141 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003142 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003143 * cryptography API.
3144 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003145 * \deprecated This feature is deprecated. Please switch to the PSA driver
3146 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003147 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003148 * Module: library/psa_crypto_se.c
3149 *
3150 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3151 *
3152 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003153//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003154
3155/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003156 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3157 *
3158 * Enable the Platform Security Architecture persistent key storage.
3159 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003160 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003161 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003162 * Requires: MBEDTLS_PSA_CRYPTO_C,
3163 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3164 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003165 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003166#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003167
3168/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003169 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003170 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003171 * Enable the emulation of the Platform Security Architecture
3172 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003173 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003174 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003175 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003176 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003177 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003178#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003179
3180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003181 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003182 *
3183 * Enable the RIPEMD-160 hash algorithm.
3184 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003185 * Module: library/ripemd160.c
3186 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003187 *
3188 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003189#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003190
3191/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003192 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003193 *
3194 * Enable the RSA public-key cryptosystem.
3195 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003196 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003197 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003198 * Caller: library/pk.c
3199 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003200 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003201 * library/ssl*_client.c
3202 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003203 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003204 * This module is used by the following key exchanges:
3205 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003206 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003208 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003209#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003210
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003211/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003213 *
3214 * Enable the SHA1 cryptographic hash algorithm.
3215 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003216 * Module: library/sha1.c
3217 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003218 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003219 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003220 * This module is required for TLS 1.2 depending on the handshake parameters,
3221 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003222 *
3223 * \warning SHA-1 is considered a weak message digest and its use constitutes
3224 * a security risk. If possible, we recommend avoiding dependencies
3225 * on it, and considering stronger message digests instead.
3226 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003227 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003229
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003230/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003231 * \def MBEDTLS_SHA224_C
3232 *
3233 * Enable the SHA-224 cryptographic hash algorithm.
3234 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003235 * Module: library/sha256.c
3236 * Caller: library/md.c
3237 * library/ssl_cookie.c
3238 *
3239 * This module adds support for SHA-224.
3240 */
3241#define MBEDTLS_SHA224_C
3242
3243/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003244 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003245 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003246 * Enable the SHA-256 cryptographic hash algorithm.
3247 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003248 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003249 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003250 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003251 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003252 * library/ssl*_client.c
3253 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003254 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003255 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003256 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003257 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003258#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003259
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003260/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003261 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003262 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003263 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3264 * with the ARMv8 cryptographic extensions if they are available at runtime.
3265 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003266 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003267 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003268 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003269 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003270 * \note Minimum compiler versions for this feature are Clang 4.0,
Dave Rodgmanbfe60212023-10-05 08:31:22 +01003271 * armclang 6.6 or GCC 6.0.
3272 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003273 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3274 * armclang <= 6.9
3275 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003276 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3277 * That name is deprecated, but may still be used as an alternative form for this
3278 * option.
3279 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003280 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3281 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003282 *
3283 * Requires: MBEDTLS_SHA256_C.
3284 *
3285 * Module: library/sha256.c
3286 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003287 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003288 * and use them if available.
3289 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003290//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003291
Dave Rodgmand85277c2023-10-13 09:22:54 +01003292/**
3293 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3294 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003295 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003296 * This name is now deprecated, but may still be used as an alternative form for
3297 * this option.
3298 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003299//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3300
3301/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003302 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003303 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003304 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3305 * with the ARMv8 cryptographic extensions, which must be available at runtime
3306 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003307 *
3308 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003309 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003310 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003311 * \note Minimum compiler versions for this feature are Clang 4.0,
3312 * armclang 6.6 or GCC 6.0.
3313 *
3314 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3315 * armclang <= 6.9
3316 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003317 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003318 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003319 * option.
3320 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003321 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3322 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003323 *
3324 * Requires: MBEDTLS_SHA256_C.
3325 *
3326 * Module: library/sha256.c
3327 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003328 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003329 * unconditionally.
3330 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003331//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003332
Dave Rodgmand85277c2023-10-13 09:22:54 +01003333/**
3334 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3335 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003336 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003337 * This name is now deprecated, but may still be used as an alternative form for
3338 * this option.
3339 */
Dave Rodgman6ab314f2023-10-10 14:00:17 +01003340//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003341
3342/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003343 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003344 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003345 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003346 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003347 * Module: library/sha512.c
3348 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003349 * library/psa_crypto_hash.c
3350 * library/ssl_tls.c
3351 * library/ssl*_client.c
3352 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003353 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003354 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003355 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003356#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003357
3358/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003360 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003361 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003362 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003363 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003364 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003365 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003366 * library/ssl_tls.c
3367 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003368 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003369 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003370 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003372
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003373/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003374 * \def MBEDTLS_SHA3_C
3375 *
3376 * Enable the SHA3 cryptographic hash algorithm.
3377 *
3378 * Module: library/sha3.c
3379 *
3380 * This module adds support for SHA3.
3381 */
3382#define MBEDTLS_SHA3_C
3383
3384/**
Dave Rodgmanbe7915a2023-10-11 10:46:38 +01003385 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003386 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003387 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3388 * with the ARMv8 cryptographic extensions if they are available at runtime.
3389 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003390 *
Dave Rodgmanbe7915a2023-10-11 10:46:38 +01003391 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003392 * for a non-Aarch64 build it will be silently ignored.
3393 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003394 * \note Minimum compiler versions for this feature are Clang 7.0,
3395 * armclang 6.9 or GCC 8.0.
3396 *
3397 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3398 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003399 *
Dave Rodgmanbe7915a2023-10-11 10:46:38 +01003400 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3401 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003402 *
3403 * Requires: MBEDTLS_SHA512_C.
3404 *
3405 * Module: library/sha512.c
3406 *
Dave Rodgmanbe7915a2023-10-11 10:46:38 +01003407 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003408 * and use them if available.
3409 */
3410//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3411
3412/**
Dave Rodgmanbe7915a2023-10-11 10:46:38 +01003413 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003414 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003415 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3416 * with the ARMv8 cryptographic extensions, which must be available at runtime
3417 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003418 *
3419 * \note This allows builds with a smaller code size than with
Dave Rodgmanbe7915a2023-10-11 10:46:38 +01003420 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003421 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003422 * \note Minimum compiler versions for this feature are Clang 7.0,
3423 * armclang 6.9 or GCC 8.0.
3424 *
3425 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3426 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003427 *
Dave Rodgmanbe7915a2023-10-11 10:46:38 +01003428 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3429 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003430 *
3431 * Requires: MBEDTLS_SHA512_C.
3432 *
3433 * Module: library/sha512.c
3434 *
Dave Rodgmanbe7915a2023-10-11 10:46:38 +01003435 * Uncomment to have the library use the A64 SHA-512 crypto extensions
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003436 * unconditionally.
3437 */
3438//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3439
3440/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003442 *
3443 * Enable simple SSL cache implementation.
3444 *
3445 * Module: library/ssl_cache.c
3446 * Caller:
3447 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003451
3452/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003454 *
3455 * Enable basic implementation of DTLS cookies for hello verification.
3456 *
3457 * Module: library/ssl_cookie.c
3458 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003459 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003461
3462/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003463 * \def MBEDTLS_SSL_TICKET_C
3464 *
3465 * Enable an implementation of TLS server-side callbacks for session tickets.
3466 *
3467 * Module: library/ssl_ticket.c
3468 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003469 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003470 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3471 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003472 */
3473#define MBEDTLS_SSL_TICKET_C
3474
3475/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003476 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003477 *
3478 * Enable the SSL/TLS client code.
3479 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003480 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003481 * Caller:
3482 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003484 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003485 * This module is required for SSL/TLS client support.
3486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003488
Paul Bakker9a736322012-11-14 12:39:52 +00003489/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003491 *
3492 * Enable the SSL/TLS server code.
3493 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003494 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003495 * Caller:
3496 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003498 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003499 * This module is required for SSL/TLS server support.
3500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003501#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003502
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003503/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003505 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003506 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003507 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003508 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003509 * Caller: library/ssl*_client.c
3510 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003511 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3513 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003514 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003515 * This module is required for SSL/TLS.
3516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003518
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003521 *
3522 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003523 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003524 * contexts are not shared between threads. If you do intend to use contexts
3525 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003526 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003527 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003528 *
3529 * Module: library/threading.c
3530 *
3531 * This allows different threading implementations (self-implemented or
3532 * provided).
3533 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534 * You will have to enable either MBEDTLS_THREADING_ALT or
3535 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003536 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003537 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003539//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003540
3541/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003543 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003544 * Enable the semi-portable timing interface.
3545 *
Simon Butcherd567a232016-03-09 20:19:21 +00003546 * \note The provided implementation only works on POSIX/Unix (including Linux,
3547 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003548 * module and provide your own implementations of the callbacks needed by
3549 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3550 * your own implementation of the whole module by setting
3551 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003552 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003553 * \note The timing module will include time.h on suitable platforms
3554 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3555 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3556 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003557 * \note See also our Knowledge Base article about porting to a new
3558 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003559 * 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 +00003560 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003561 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003562 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003563#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003564
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003565/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003567 *
3568 * Enable run-time version information.
3569 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003570 * Module: library/version.c
3571 *
3572 * This module provides run-time version information.
3573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003574#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003575
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003576/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003577 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003578 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003579 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003580 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003581 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003582 * Caller: library/x509_crl.c
3583 * library/x509_crt.c
3584 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003585 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003586 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003587 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3588 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003589 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3590 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003591 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003592 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003594#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003595
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003596/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003597 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003598 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003599 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003600 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003601 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003602 * Caller: library/ssl_tls.c
3603 * library/ssl*_client.c
3604 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003605 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003606 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003607 *
3608 * This module is required for X.509 certificate parsing.
3609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003610#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003611
3612/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003613 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003614 *
3615 * Enable X.509 CRL parsing.
3616 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003617 * Module: library/x509_crl.c
3618 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003619 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003620 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003621 *
3622 * This module is required for X.509 CRL parsing.
3623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003624#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003625
3626/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003627 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003628 *
3629 * Enable X.509 Certificate Signing Request (CSR) parsing.
3630 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003631 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003632 * Caller: library/x509_crt_write.c
3633 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003634 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003635 *
3636 * This module is used for reading X.509 certificate request.
3637 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003638#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003639
3640/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003641 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003642 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003643 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003644 *
3645 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003646 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003647 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003648 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3649 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003650 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3651 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003652 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003653 * This module is the basis for creating X.509 certificates and CSRs.
3654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003655#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003656
3657/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003658 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003659 *
3660 * Enable creating X.509 certificates.
3661 *
3662 * Module: library/x509_crt_write.c
3663 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003664 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003665 *
3666 * This module is required for X.509 certificate creation.
3667 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003668#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003669
3670/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003671 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003672 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003673 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003674 *
3675 * Module: library/x509_csr_write.c
3676 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003677 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003678 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003679 * This module is required for X.509 certificate request writing.
3680 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003681#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003682
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003683/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003684
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003685/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003686 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003687 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003688 * This section contains Mbed TLS build settings that are not associated
3689 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003690 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003691 * \{
3692 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003693
Gilles Peskinea02c1242022-03-16 17:03:19 +01003694/**
3695 * \def MBEDTLS_CONFIG_FILE
3696 *
3697 * If defined, this is a header which will be included instead of
3698 * `"mbedtls/mbedtls_config.h"`.
3699 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003700 * Unlike other configuration options, this one must be defined on the
3701 * compiler command line: a definition in `mbedtls_config.h` would have
3702 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003703 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003704 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003705 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003706 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003707 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003708 * The value of this symbol is typically a path in double quotes, either
3709 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003710 */
3711//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3712
3713/**
3714 * \def MBEDTLS_USER_CONFIG_FILE
3715 *
3716 * If defined, this is a header which will be included after
3717 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003718 * This allows you to modify the default configuration, including the ability
3719 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003720 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003721 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003722 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003723 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003724 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003725 * 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.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003727 */
3728//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3729
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003730/**
3731 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3732 *
3733 * If defined, this is a header which will be included instead of
3734 * `"psa/crypto_config.h"`.
3735 * This header file specifies which cryptographic mechanisms are available
3736 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3737 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3738 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003739 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003740 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003741 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003742 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003743 * The value of this symbol is typically a path in double quotes, either
3744 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003745 */
3746//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3747
3748/**
3749 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3750 *
3751 * If defined, this is a header which will be included after
3752 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003753 * This allows you to modify the default configuration, including the ability
3754 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003755 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003756 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003757 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003758 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003759 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003760 * The value of this symbol is typically a path in double quotes, either
3761 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003762 */
3763//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3764
Gilles Peskineb1176f22023-02-22 22:07:28 +01003765/**
3766 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3767 *
3768 * If defined, this is a header which will be included instead of
3769 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3770 * as the one in Mbed TLS, but with definitions adapted to the platform on
3771 * which the library code will run.
3772 *
3773 * \note The required content of this header can vary from one version of
3774 * Mbed TLS to the next. Integrators who provide an alternative file
3775 * should review the changes in the original file whenever they
3776 * upgrade Mbed TLS.
3777 *
3778 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3779 * non-standard feature of the C language, so this feature is only available
3780 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3781 *
3782 * The value of this symbol is typically a path in double quotes, either
3783 * absolute or relative to a directory on the include search path.
3784 */
3785//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3786
3787/**
3788 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3789 *
3790 * If defined, this is a header which will be included instead of
3791 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3792 * as the one in Mbed TLS, but with definitions adapted to the environment
3793 * in which the library code will run. The typical use for this feature
3794 * is to provide alternative type definitions on the client side in
3795 * client-server integrations of PSA crypto, where operation structures
3796 * contain handles instead of cryptographic data.
3797 *
3798 * \note The required content of this header can vary from one version of
3799 * Mbed TLS to the next. Integrators who provide an alternative file
3800 * should review the changes in the original file whenever they
3801 * upgrade Mbed TLS.
3802 *
3803 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3804 * non-standard feature of the C language, so this feature is only available
3805 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3806 *
3807 * The value of this symbol is typically a path in double quotes, either
3808 * absolute or relative to a directory on the include search path.
3809 */
3810//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3811
Gilles Peskineba4162a2022-04-11 17:04:38 +02003812/** \} name SECTION: General configuration options */
3813
3814/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003815 * \name SECTION: Module configuration options
3816 *
3817 * This section allows for the setting of module specific sizes and
3818 * configuration options. The default values are already present in the
3819 * relevant header files and should suffice for the regular use cases.
3820 *
3821 * Our advice is to enable options and change their values here
3822 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003823 * \{
3824 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003825/* The Doxygen documentation here is used when a user comments out a
3826 * setting and runs doxygen themselves. On the other hand, when we typeset
3827 * the full documentation including disabled settings, the documentation
3828 * in specific modules' header files is used if present. When editing this
3829 * file, make sure that each option is documented in exactly one place,
3830 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3831 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003832
Paul Bakker088c5c52014-04-25 11:11:10 +02003833/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003834//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003835//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003836
Paul Bakker088c5c52014-04-25 11:11:10 +02003837/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003838//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3839//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3840//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3841//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3842//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003843
Paul Bakker088c5c52014-04-25 11:11:10 +02003844/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003845//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3846//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3847//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3848//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003849
Paul Bakker088c5c52014-04-25 11:11:10 +02003850/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003851//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003852//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003853
Paul Bakker088c5c52014-04-25 11:11:10 +02003854/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003855//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3856//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003857//#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 +01003858
Paul Bakker088c5c52014-04-25 11:11:10 +02003859/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003860//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003861
Paul Bakker088c5c52014-04-25 11:11:10 +02003862/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003863//#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 -04003864
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003865/** \def MBEDTLS_PLATFORM_STD_CALLOC
3866 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003867 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003868 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003869 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003870 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003871 * 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 -04003872 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3873 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003874 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003875 */
3876//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003877
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003878/** \def MBEDTLS_PLATFORM_STD_FREE
3879 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003880 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003881 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003882 * 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 -04003883 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3884 * 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 -04003885 */
3886//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003887//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003888//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003889//#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 +02003890//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3891//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003892/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003893//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003894//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3895//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003896//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3897//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3898//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003899
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003900/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003901/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003902//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3903//#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 +02003904//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003905//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003906//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3907//#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 +02003908//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3909//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003910/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003911//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003912//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003913//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3914//#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 +08003915//#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 +08003916//#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 +02003917
Gilles Peskine3f106f72021-09-23 17:42:39 +02003918/** \def MBEDTLS_CHECK_RETURN
3919 *
3920 * This macro is used at the beginning of the declaration of a function
3921 * to indicate that its return value should be checked. It should
3922 * instruct the compiler to emit a warning or an error if the function
3923 * is called without checking its return value.
3924 *
3925 * There is a default implementation for popular compilers in platform_util.h.
3926 * You can override the default implementation by defining your own here.
3927 *
3928 * If the implementation here is empty, this will effectively disable the
3929 * checking of functions' return values.
3930 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003931//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003932
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003933/** \def MBEDTLS_IGNORE_RETURN
3934 *
3935 * This macro requires one argument, which should be a C function call.
3936 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3937 * warning is suppressed.
3938 */
3939//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3940
Gilles Peskineed038902020-11-13 21:33:21 +01003941/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003942/**
Gilles Peskineed038902020-11-13 21:33:21 +01003943 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3944 * PSA crypto subsystem.
3945 *
3946 * If this option is unset:
3947 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003948 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003949 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3950 * on unspecified heuristics.
3951 */
3952//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3953
Steven Cooreman863470a2021-02-15 14:03:19 +01003954/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003955 * Restrict the PSA library to supporting a maximum amount of simultaneously
3956 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3957 * volatile key, or a persistent key which is loaded temporarily by the
3958 * library as part of a crypto operation in flight.
3959 *
3960 * If this option is unset, the library will fall back to a default value of
3961 * 32 keys.
3962 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003963//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003964
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003965/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003966//#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 +00003967
Paul Bakker088c5c52014-04-25 11:11:10 +02003968/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003969//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3970//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003971
Paul Bakker088c5c52014-04-25 11:11:10 +02003972/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003973
Angus Grattond8213d02016-05-25 20:56:48 +10003974/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3975 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003976 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003977 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003978 * This determines the size of the incoming TLS I/O buffer in such a way
3979 * that it is capable of holding the specified amount of plaintext data,
3980 * regardless of the protection mechanism used.
3981 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003982 * \note When using a value less than the default of 16KB on the client, it is
3983 * recommended to use the Maximum Fragment Length (MFL) extension to
3984 * inform the server about this limitation. On the server, there
3985 * is no supported, standardized way of informing the client about
3986 * restriction on the maximum size of incoming messages, and unless
3987 * the limitation has been communicated by other means, it is recommended
3988 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3989 * while keeping the default value of 16KB for the incoming buffer.
3990 *
David Horstmann95d516f2021-05-04 18:36:56 +01003991 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003992 */
3993//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3994
Gilles Peskined3d02902020-03-04 21:35:27 +01003995/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3996 *
3997 * The maximum length of CIDs used for incoming DTLS messages.
3998 *
3999 */
4000//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
4001
4002/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
4003 *
4004 * The maximum length of CIDs used for outgoing DTLS messages.
4005 *
4006 */
4007//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
4008
TRodziewicze8dd7092021-05-12 14:19:11 +02004009/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01004010 *
4011 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02004012 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01004013 *
4014 * The padding will always be chosen so that the length of the
4015 * padded plaintext is a multiple of the value of this option.
4016 *
4017 * Note: A value of \c 1 means that no padding will be used
4018 * for outgoing records.
4019 *
4020 * Note: On systems lacking division instructions,
4021 * a power of two should be preferred.
4022 */
TRodziewicze8dd7092021-05-12 14:19:11 +02004023//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01004024
Angus Grattond8213d02016-05-25 20:56:48 +10004025/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4026 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004027 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004028 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004029 * This determines the size of the outgoing TLS I/O buffer in such a way
4030 * that it is capable of holding the specified amount of plaintext data,
4031 * regardless of the protection mechanism used.
4032 *
Angus Grattond8213d02016-05-25 20:56:48 +10004033 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4034 * the default inward 16384 byte buffer to conform to the TLS specification.
4035 *
4036 * The minimum required outward buffer size is determined by the handshake
4037 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4038 * The specific size requirement depends on the configured ciphers and any
4039 * certificate data which is sent during the handshake.
4040 *
David Horstmann95d516f2021-05-04 18:36:56 +01004041 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004042 */
4043//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4044
Hanno Beckere0b150f2018-08-21 15:51:03 +01004045/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4046 *
4047 * Maximum number of heap-allocated bytes for the purpose of
4048 * DTLS handshake message reassembly and future message buffering.
4049 *
Yuto Takano7828ca22021-08-10 11:26:15 +01004050 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004051 * to account for a reassembled handshake message of maximum size,
4052 * together with its reassembly bitmap.
4053 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004054 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004055 * should be sufficient for all practical situations as it allows
4056 * to reassembly a large handshake message (such as a certificate)
4057 * while buffering multiple smaller handshake messages.
4058 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004059 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004060//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004061
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004062//#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 +02004063//#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 +02004064
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004065/**
4066 * Complete list of ciphersuites to use, in order of preference.
4067 *
4068 * \warning No dependency checking is done on that field! This option can only
4069 * be used to restrict the set of available ciphersuites. It is your
4070 * responsibility to make sure the needed modules are active.
4071 *
4072 * Use this to save a few hundred bytes of ROM (default ordering of all
4073 * available ciphersuites) and a few to a few hundred bytes of RAM.
4074 *
4075 * The value below is only an example, not the default.
4076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004077//#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 +02004078
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004079/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004080 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4081 *
4082 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004083 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004084 *
4085 * It must be positive and smaller than UINT32_MAX.
4086 *
4087 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4088 * have any impact on the build.
4089 *
4090 * This feature is experimental, not completed and thus not ready for
4091 * production.
4092 *
4093 */
4094//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4095
4096/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004097 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4098 *
4099 * Maximum time difference in milliseconds tolerated between the age of a
4100 * ticket from the server and client point of view.
4101 * From the client point of view, the age of a ticket is the time difference
4102 * between the time when the client proposes to the server to use the ticket
4103 * (time of writing of the Pre-Shared Key Extension including the ticket) and
4104 * the time the client received the ticket from the server.
4105 * From the server point of view, the age of a ticket is the time difference
4106 * between the time when the server receives a proposition from the client
4107 * to use the ticket and the time when the ticket was created by the server.
4108 * The server age is expected to be always greater than the client one and
4109 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
4110 * maximum difference tolerated for the server to accept the ticket.
4111 * This is not used in TLS 1.2.
4112 *
4113 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004114//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004115
4116/**
4117 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4118 *
4119 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4120 *
4121 * This must be less than 256.
4122 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004123//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004124
4125/**
4126 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4127 *
4128 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4129 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4130 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4131 *
4132 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004133//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004134
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004135/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004136//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004137//#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 +01004138
Gilles Peskine611179c2022-04-13 23:04:48 +02004139/** \} name SECTION: Module configuration options */