blob: 2e98c3aae57f813106fb67cbe12a155373bd2b82 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020034 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000035 *
36 * Requires support for asm() in compiler.
37 *
38 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000039 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010040 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000041 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000042 * library/constant_time.c
Paul Bakker68041ec2009-04-19 21:17:55 +000043 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010044 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000045 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010046 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020048 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000051
Paul Bakkerf3b86c12011-01-27 15:24:17 +000052/**
Gilles Peskineed942f82017-06-08 15:19:20 +020053 * \def MBEDTLS_NO_UDBL_DIVISION
54 *
55 * The platform lacks support for double-width integer division (64-bit
56 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
57 *
58 * Used in:
59 * include/mbedtls/bignum.h
60 * library/bignum.c
61 *
62 * The bignum code uses double-width division to speed up some operations.
63 * Double-width division is often implemented in software that needs to
64 * be linked with the program. The presence of a double-width integer
65 * type is usually detected automatically through preprocessor macros,
66 * but the automatic detection cannot know whether the code needs to
67 * and can be linked with an implementation of division for that type.
68 * By default division is assumed to be usable if the type is present.
69 * Uncomment this option to prevent the use of double-width division.
70 *
71 * Note that division for the native integer type is always required.
72 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010073 * platform, but it need not support multiplication or division. In some
74 * cases it is also desirable to disable some double-width operations. For
75 * example, if double-width division is implemented in software, disabling
76 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020077 */
78//#define MBEDTLS_NO_UDBL_DIVISION
79
80/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020081 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
82 *
83 * The platform lacks support for 32x32 -> 64-bit multiplication.
84 *
85 * Used in:
86 * library/poly1305.c
87 *
88 * Some parts of the library may use multiplication of two unsigned 32-bit
89 * operands with a 64-bit result in order to speed up computations. On some
90 * platforms, this is not available in hardware and has to be implemented in
91 * software, usually in a library provided by the toolchain.
92 *
93 * Sometimes it is not desirable to have to link to that library. This option
94 * removes the dependency of that library on platforms that lack a hardware
95 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
96 *
97 * Note that depending on the compiler, this may decrease performance compared
98 * to using the library function provided by the toolchain.
99 */
100//#define MBEDTLS_NO_64BIT_MULTIPLICATION
101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000104 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000105 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200113 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200114 * System has time.h and time().
115 * The time does not need to be correct, only time differences are used,
116 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200117 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100118 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
119 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
120 * MBEDTLS_PLATFORM_STD_TIME.
121 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400122 * Comment if your system does not support time functions.
123 *
124 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
125 * interface - timing.c will include time.h on suitable platforms
126 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
127 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100130
131/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200132 * \def MBEDTLS_HAVE_TIME_DATE
133 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100134 * System has time.h, time(), and an implementation for
135 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100136 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200137 * the date should be correct). This is used to verify the validity period of
138 * X.509 certificates.
139 *
140 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100141 *
Hanno Becker6a739782018-09-05 15:06:19 +0100142 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100143 * behaves similarly to the gmtime_r() function from the C standard. Refer to
144 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100145 *
146 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100147 * mbedtls_platform_gmtime_r() at compile-time by using the macro
148 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200149 */
150#define MBEDTLS_HAVE_TIME_DATE
151
152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100154 *
155 * Enable the memory allocation layer.
156 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200157 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 * This allows different allocators (self-implemented or provided) to be
159 * provided to the platform abstraction layer.
160 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400161 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200162 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
163 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000164 * free() function pointer at runtime.
165 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400166 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100169 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400170 * An overview of how the value of mbedtls_calloc is determined:
171 *
172 * - if !MBEDTLS_PLATFORM_MEMORY
173 * - mbedtls_calloc = calloc
174 * - if MBEDTLS_PLATFORM_MEMORY
175 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
176 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
177 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
179 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
180 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
182 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
183 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
184 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
185 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
186 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
187 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
188 *
189 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
190 * - if !MBEDTLS_PLATFORM_STD_CALLOC
191 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
192 *
193 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
194 *
195 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
196 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
197 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
198 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
199 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
200 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100203 *
204 * Enable this layer to allow use of alternative memory allocators.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100207
208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200211 * Do not assign standard functions in the platform layer (e.g. calloc() to
212 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200213 *
214 * This makes sure there are no linking errors on platforms that do not support
215 * these functions. You will HAVE to provide alternatives, either at runtime
216 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
218 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
222 * Uncomment to prevent default assignment of standard functions in the
223 * platform layer.
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200226
227/**
Janos Follathc351d182016-03-21 08:43:59 +0000228 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200230 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100231 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200233 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 * alternative printf function pointer.
236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200239 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
240 * it will be enabled automatically by check_config.h
241 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200242 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000244 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100245 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
246 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 * Uncomment a macro to enable alternate implementation of specific base
248 * platform function
249 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200250//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100252//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_FPRINTF_ALT
254//#define MBEDTLS_PLATFORM_PRINTF_ALT
255//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200256//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100257//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100258//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800259//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260
261/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200262 * Uncomment the macro to let Mbed TLS use your alternate implementation of
263 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
264 * platform_util.c.
265 *
266 * gmtime() is not a thread-safe function as defined in the C standard. The
267 * library will try to use safer implementations of this function, such as
268 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
269 * system, the implementation of mbedtls_platform_gmtime_r() will default to
270 * using the standard gmtime(). In this case, calls from the library to
271 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
272 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
273 * library are also guarded with this mutex to avoid race conditions. However,
274 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
275 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
276 * supplied at compile time.
277 */
278//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
279
280/**
Gilles Peskine86733832023-09-07 15:02:39 +0200281 * Uncomment the macro to let Mbed TLS use your alternate implementation of
282 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
283 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200284 *
Gilles Peskine86733832023-09-07 15:02:39 +0200285 * By default, the library uses a system function such as memset_s()
286 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
287 * SecureZeroMemory (Windows). If no such function is detected, the library
288 * falls back to a plain C implementation. Compilers are technically
289 * permitted to optimize this implementation out, meaning that the memory is
290 * not actually wiped. The library tries to prevent that, but the C language
291 * makes it impossible to guarantee that the memory will always be wiped.
292 *
293 * If your platform provides a guaranteed method to wipe memory which
294 * `platform_util.c` does not detect, define this macro to the name of
295 * a function that takes two arguments, a `void *` pointer and a length,
296 * and wipes that many bytes starting at the specified address. For example,
297 * if your platform has explicit_bzero() but `platform_util.c` does not
298 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
299 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200300 */
301//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
302
303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Mark deprecated functions and features so that they generate a warning if
307 * used. Functionality deprecated in one version will usually be removed in the
308 * next version. You can enable this to help you prepare the transition to a
309 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100310 *
311 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100313 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000314 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317
318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100320 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000321 * Remove deprecated functions and features so that they generate an error if
322 * used. Functionality deprecated in one version will usually be removed in the
323 * next version. You can enable this to help you prepare the transition to a
324 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100325 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000326 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100330/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000331
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000332/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200333 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000334 *
335 * This section sets support for features that are or are not needed
336 * within the modules that are enabled.
337 * \{
338 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
TRodziewiczd8540832021-06-10 15:16:50 +0200343 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200344 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
348 * You will need to provide a header "timing_alt.h" and an implementation at
349 * compile time.
350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100352
353/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100354 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200355 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200356 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100357 * alternate core implementation of a symmetric crypto, an arithmetic or hash
358 * module (e.g. platform specific assembly optimized implementations). Keep
359 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200360 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200361 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200362 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200364 * Example: In case you uncomment MBEDTLS_AES_ALT, Mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000365 * provide the "struct mbedtls_aes_context" definition and omit the base
366 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200367 * "aes.h" to include the new function definitions.
368 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200369 * Uncomment a macro to enable alternate implementation of the corresponding
370 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100371 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200372 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100373 * use constitutes a security risk. If possible, we recommend
374 * avoiding dependencies on them, and considering stronger message
375 * digests and ciphers instead.
376 *
Paul Bakker90995b52013-06-24 19:20:35 +0200377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000379//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200381//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300382//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200383//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200384//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200385//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000386//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000387//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100388//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300389//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300391//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000393//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394//#define MBEDTLS_SHA1_ALT
395//#define MBEDTLS_SHA256_ALT
396//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000397
Janos Follathb0697532016-08-18 12:38:46 +0100398/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800399 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100400 * implemented with two .c files:
401 * - ecp.c
402 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000403 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
404 * macros as described above. The only difference is that you have to make sure
405 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100406 */
407//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200408
409/**
TRodziewicz75628d52021-06-18 12:56:27 +0200410 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200411 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200412 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100413 * alternate core implementation of symmetric crypto or hash function. Keep in
414 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200415 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200416 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200417 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200418 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200419 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420 * no longer provide the mbedtls_sha1_process() function, but it will still provide
421 * the other function (using your mbedtls_sha1_process() function) and the definition
422 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200423 * with this definition.
424 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200425 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100426 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
427 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200428 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200429 * Uncomment a macro to enable alternate implementation of the corresponding
430 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100431 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200432 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100433 * constitutes a security risk. If possible, we recommend avoiding
434 * dependencies on them, and considering stronger message digests
435 * and ciphers instead.
436 *
Janos Follath1231d212019-01-07 15:01:32 +0000437 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
438 * enabled, then the deterministic ECDH signature functions pass the
439 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
440 * alternative implementations should use the RNG only for generating
441 * the ephemeral key and nothing else. If this is not possible, then
442 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200443 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000444 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200446//#define MBEDTLS_MD5_PROCESS_ALT
447//#define MBEDTLS_RIPEMD160_PROCESS_ALT
448//#define MBEDTLS_SHA1_PROCESS_ALT
449//#define MBEDTLS_SHA256_PROCESS_ALT
450//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200451//#define MBEDTLS_DES_SETKEY_ALT
452//#define MBEDTLS_DES_CRYPT_ECB_ALT
453//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200454//#define MBEDTLS_AES_SETKEY_ENC_ALT
455//#define MBEDTLS_AES_SETKEY_DEC_ALT
456//#define MBEDTLS_AES_ENCRYPT_ALT
457//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300458//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300459//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300460//#define MBEDTLS_ECDSA_VERIFY_ALT
461//#define MBEDTLS_ECDSA_SIGN_ALT
462//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200463
464/**
Janos Follathc44ab972016-11-18 16:38:23 +0000465 * \def MBEDTLS_ECP_INTERNAL_ALT
466 *
467 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100468 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200469 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100470 * alternative core implementation of elliptic curve arithmetic. Keep in mind
471 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100472 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200473 * This partially replaces one function. The header file from Mbed TLS is still
Janos Follathb0697532016-08-18 12:38:46 +0100474 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
475 * is still present and it is used for group structures not supported by the
476 * alternative.
477 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100478 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100479 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100480 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
481 * able to fallback to curves not supported by the alternative implementation.
482 *
Janos Follathc44ab972016-11-18 16:38:23 +0000483 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
484 * and implementing the following functions:
485 * unsigned char mbedtls_internal_ecp_grp_capable(
486 * const mbedtls_ecp_group *grp )
487 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500488 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000489 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
490 * replacement functions implement arithmetic for the given group and 0
491 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500492 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000493 * called before and after each point operation and provide an opportunity to
494 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100495 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100496 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200497 * MBEDTLS_ECP_DOUBLE_JAC_ALT, Mbed TLS will still provide the ecp_double_jac()
Steven Cooreman6226a122021-01-21 13:58:31 +0100498 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
499 * for the operation is supported by your implementation (i.e. your
500 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200501 * group is not supported by your implementation, then the original Mbed TLS
Steven Cooreman6226a122021-01-21 13:58:31 +0100502 * implementation of ecp_double_jac() is used instead, unless this fallback
503 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
504 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
505 *
506 * The function prototypes and the definition of mbedtls_ecp_group and
507 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
508 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
509 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100510 *
511 * Uncomment a macro to enable alternate implementation of the corresponding
512 * function.
513 */
514/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000515//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100516/* Turn off software fallback for curves not supported in hardware */
517//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100518/* Support for Weierstrass curves with Jacobi representation */
519//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
520//#define MBEDTLS_ECP_ADD_MIXED_ALT
521//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
522//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
523//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
524/* Support for curves with Montgomery arithmetic */
525//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
526//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
527//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
528
529/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200530 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200531 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200532 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200533 * hardware entropy collector.
534 *
535 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000536 * prototype as declared in library/entropy_poll.h, and accept NULL as first
537 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200538 *
539 * Uncomment to use your own hardware entropy collector.
540 */
541//#define MBEDTLS_ENTROPY_HARDWARE_ALT
542
543/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000545 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100546 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000547 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100548 * Uncomment this macro to use precomputed AES tables stored in ROM.
549 * Comment this macro to generate AES tables in RAM at runtime.
550 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100551 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
552 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100553 * initialization time before the first AES operation can be performed.
554 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
555 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
556 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100557 *
558 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000561
562/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100563 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200564 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100565 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200566 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100567 * Uncommenting this macro omits 75% of the AES tables from
568 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
569 * by computing their values on the fly during operations
570 * (the tables are entry-wise rotations of one another).
571 *
572 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100573 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100574 * runtime. Specifically, one has to compare 4 accesses within
575 * different tables to 4 accesses with additional arithmetic
576 * operations within the same table. The performance gain/loss
577 * depends on the system and memory details.
578 *
579 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200580 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100581//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200582
583/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800584 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
585 *
586 * Use only 128-bit keys in AES operations to save ROM.
587 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800588 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800589 * or 256-bit keys.
590 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800591 * Uncommenting this macro reduces the size of AES code by ~300 bytes
592 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800593 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800594 * Module: library/aes.c
595 *
596 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800597 */
598//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
599
Gilles Peskinea8861e02023-09-05 20:20:51 +0200600/*
601 * Disable plain C implementation for AES.
602 *
603 * When the plain C implementation is enabled, and an implementation using a
604 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
605 * detection will be used to select between them.
606 *
607 * If only one implementation is present, runtime detection will not be used.
608 * This configuration will crash at runtime if running on a CPU without the
609 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
610 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
611 */
612//#define MBEDTLS_AES_USE_HARDWARE_ONLY
613
Arto Kinnunen732ca322023-04-14 14:26:10 +0800614/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200615 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200616 *
617 * Use less ROM for the Camellia implementation (saves about 768 bytes).
618 *
619 * Uncomment this macro to use less memory for Camellia.
620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200621//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200622
623/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200624 * \def MBEDTLS_CHECK_RETURN_WARNING
625 *
626 * If this macro is defined, emit a compile-time warning if application code
627 * calls a function without checking its return value, but the return value
628 * should generally be checked in portable applications.
629 *
630 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
631 * implemented. Otherwise this option has no effect.
632 *
633 * Uncomment to get warnings on using fallible functions without checking
634 * their return value.
635 *
636 * \note This feature is a work in progress.
637 * Warnings will be added to more functions in the future.
638 *
639 * \note A few functions are considered critical, and ignoring the return
640 * value of these functions will trigger a warning even if this
641 * macro is not defined. To completely disable return value check
642 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
643 */
644//#define MBEDTLS_CHECK_RETURN_WARNING
645
646/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200647 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200648 *
649 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
650 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200652
653/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000655 *
656 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200658#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000659
660/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000662 *
663 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000666
667/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100668 * \def MBEDTLS_CIPHER_MODE_OFB
669 *
670 * Enable Output Feedback mode (OFB) for symmetric ciphers.
671 */
672#define MBEDTLS_CIPHER_MODE_OFB
673
674/**
675 * \def MBEDTLS_CIPHER_MODE_XTS
676 *
677 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
678 */
679#define MBEDTLS_CIPHER_MODE_XTS
680
681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000683 *
684 * Enable NULL cipher.
685 * Warning: Only do so when you know what you are doing. This allows for
686 * encryption or channels without any security!
687 *
Ronald Croncee42702021-04-26 11:34:44 +0200688 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200689 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
690 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
691 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
692 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
693 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
694 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
695 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
696 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
697 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
698 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
699 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
700 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
701 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
702 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
703 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
704 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
705 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
706 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
707 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000708 *
709 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000710 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200711//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000712
713/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100714 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200715 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100716 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
717 * specific padding modes in the cipher layer with cipher modes that support
718 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200719 *
720 * If you disable all padding modes, only full blocks can be used with CBC.
721 *
722 * Enable padding modes in the cipher layer.
723 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724#define MBEDTLS_CIPHER_PADDING_PKCS7
725#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
726#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
727#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200728
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200729/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
730 *
731 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800732 * Without this, CTR_DRBG uses a 256-bit key
733 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200734 */
735//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
736
Paul Bakker48e93c82013-08-14 12:21:18 +0200737/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200738 * Enable the verified implementations of ECDH primitives from Project Everest
739 * (currently only Curve25519). This feature changes the layout of ECDH
740 * contexts and therefore is a compatibility break for applications that access
741 * fields of a mbedtls_ecdh_context structure directly. See also
742 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000743 *
744 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
745 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200746 */
747//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
748
749/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100750 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200751 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100752 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
753 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200754 *
755 * Comment macros to disable the curve and functions for it
756 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200757/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
759#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
760#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
761#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
762#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
763#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
764#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
765#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
766#define MBEDTLS_ECP_DP_BP256R1_ENABLED
767#define MBEDTLS_ECP_DP_BP384R1_ENABLED
768#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200769/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200770#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000771#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200772
773/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200774 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200775 *
776 * Enable specific 'modulo p' routines for each NIST prime.
777 * Depending on the prime and architecture, makes operations 4 to 8 times
778 * faster on the corresponding curve.
779 *
780 * Comment this macro to disable NIST curves optimisation.
781 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200783
784/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200785 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100786 *
787 * Enable "non-blocking" ECC operations that can return early and be resumed.
788 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200789 * This allows various functions to pause by returning
790 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
791 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
792 * order to further progress and eventually complete their operation. This is
793 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
794 * number of ECC operations a function may perform before pausing; see
795 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100796 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200797 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200798 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100799 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100800 * This option:
801 * - Adds xxx_restartable() variants of existing operations in the
802 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100803 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
804 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100805 * - ECDSA: signature generation & verification;
806 * - PK: signature generation & verification;
807 * - X509: certificate chain verification.
808 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
809 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
810 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
811 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000812 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100813 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100814 * - verification of the server's key exchange signature;
815 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100816 * - generation of the client's signature if client authentication is used,
817 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100818 *
819 * \note In the cases above, the usual SSL/TLS functions, such as
820 * mbedtls_ssl_handshake(), can now return
821 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200822 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100823 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
824 * restartable operations in PK, X.509 and TLS (see above) are not
825 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100826 * PSA, and are not restartable. These are temporary limitations that
827 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200828 *
Ron Eldor19779c42018-11-05 16:58:13 +0200829 * \note This option only works with the default software implementation of
830 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100831 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100832 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100833 * Requires: MBEDTLS_ECP_C
834 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100835 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100836 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200837//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100838
839/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200840 * Uncomment to enable using new bignum code in the ECC modules.
841 *
842 * \warning This is currently experimental, incomplete and therefore should not
843 * be used in production.
844 */
845//#define MBEDTLS_ECP_WITH_MPI_UINT
846
847/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200848 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100849 *
850 * Enable deterministic ECDSA (RFC 6979).
851 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
852 * may result in a compromise of the long-term signing key. This is avoided by
853 * the deterministic variant.
854 *
John Durkop36a82e52020-10-26 09:39:05 -0700855 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100856 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100857 * Comment this macro to disable deterministic ECDSA.
858 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100860
861/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200863 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200864 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200865 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866 * This enables the following ciphersuites (if other requisites are
867 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
869 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
870 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
871 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
872 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
873 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
874 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
875 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
876 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
877 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200878 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200880
881/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200883 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200884 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200885 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200886 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200887 *
888 * This enables the following ciphersuites (if other requisites are
889 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
891 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
892 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
893 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
894 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
895 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
896 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
897 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
898 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
899 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100900 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100901 * \warning Using DHE constitutes a security risk as it
902 * is not possible to validate custom DH parameters.
903 * If possible, it is recommended users should consider
904 * preferring other methods of key exchange.
905 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100906 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200907 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200909
910/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200911 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200912 *
913 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
914 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200915 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200916 *
917 * This enables the following ciphersuites (if other requisites are
918 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200919 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
920 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
921 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
922 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
923 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
924 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200925 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200927
928/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200929 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200930 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200931 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200932 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200933 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
934 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200935 *
936 * This enables the following ciphersuites (if other requisites are
937 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
939 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
940 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
941 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
942 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
943 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
944 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
945 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
946 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
947 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200950
951/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200952 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200953 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200954 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200955 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200956 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
957 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200958 *
959 * This enables the following ciphersuites (if other requisites are
960 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
962 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
963 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
964 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
965 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
966 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
967 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
968 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
969 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
970 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
971 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
972 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200973 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200975
976/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200977 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200978 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200979 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200980 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
982 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200983 *
984 * This enables the following ciphersuites (if other requisites are
985 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
987 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
988 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
989 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
990 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
991 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
992 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
993 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
994 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
995 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
996 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
997 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100998 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100999 * \warning Using DHE constitutes a security risk as it
1000 * is not possible to validate custom DH parameters.
1001 * If possible, it is recommended users should consider
1002 * preferring other methods of key exchange.
1003 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001004 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001005 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001007
1008/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001010 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001011 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001012 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001013 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1014 * MBEDTLS_RSA_C
1015 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001017 *
1018 * This enables the following ciphersuites (if other requisites are
1019 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1021 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1022 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1023 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1024 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1025 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1026 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1027 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1028 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1029 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +02001030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001032
1033/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001035 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001036 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001037 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001038 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1039 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1040 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001041 *
1042 * This enables the following ciphersuites (if other requisites are
1043 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1045 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1046 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1047 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1048 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1049 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1050 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1051 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1052 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1053 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001056
1057/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001059 *
1060 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1061 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001062 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1063 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1064 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001065 *
1066 * This enables the following ciphersuites (if other requisites are
1067 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1069 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1070 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1071 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1072 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1073 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1074 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1075 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1076 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1077 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001078 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001080
1081/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001083 *
1084 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1085 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001086 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1087 * MBEDTLS_RSA_C
1088 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001089 *
1090 * This enables the following ciphersuites (if other requisites are
1091 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1093 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1094 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1095 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1096 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1097 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1098 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1099 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1100 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1101 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001102 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001104
1105/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001106 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1107 *
1108 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1109 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001110 * \warning This is currently experimental. EC J-PAKE support is based on the
1111 * Thread v1.0.0 specification; incompatible changes to the specification
1112 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001113 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001114 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001115 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001116 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1117 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001118 * \warning If SHA-256 is provided only by a PSA driver, you must call
1119 * psa_crypto_init() before the first hanshake (even if
1120 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1121 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001122 * This enables the following ciphersuites (if other requisites are
1123 * enabled as well):
1124 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1125 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001126//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001127
1128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001130 *
1131 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1132 * RFC 5915 and RFC 5480.
1133 *
1134 * Currently this means parsing the SpecifiedECDomain choice of EC
1135 * parameters (only known groups are supported, not arbitrary domains, to
1136 * avoid validation issues).
1137 *
1138 * Disable if you only need to support RFC 5915 + 5480 key formats.
1139 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001141
1142/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001143 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1144 *
1145 * Enable the support for parsing public keys of type Short Weierstrass
1146 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001147 * compressed point format. This parsing is done through ECP module's functions.
1148 *
1149 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1150 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1151 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001152 */
1153#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1154
1155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001157 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 * Enable a dummy error function to make use of mbedtls_strerror() in
1159 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1160 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001161 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1163 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001164 *
1165 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001167 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001168#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001169
1170/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001172 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001173 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001174 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001175 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001176 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001178
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001179/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001181 *
1182 * Enable functions that use the filesystem.
1183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001185
1186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001188 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001189 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001190 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001191 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001192 * application.
1193 *
1194 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001196//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001197
1198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001200 *
1201 * Do not use built-in platform entropy functions.
1202 * This is useful if your platform does not support
1203 * standards like the /dev/urandom or Windows CryptoAPI.
1204 *
1205 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001208
1209/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001210 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001211 *
1212 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1213 * default SHA-512 based one (if both are available).
1214 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001216 *
1217 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1218 * if you have performance concerns.
1219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001220 * This option is only useful if both MBEDTLS_SHA256_C and
1221 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001222 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001223//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001224
1225/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001226 * \def MBEDTLS_ENTROPY_NV_SEED
1227 *
1228 * Enable the non-volatile (NV) seed file-based entropy source.
1229 * (Also enables the NV seed read/write functions in the platform layer)
1230 *
1231 * This is crucial (if not required) on systems that do not have a
1232 * cryptographic entropy source (in hardware or kernel) available.
1233 *
1234 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1235 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001236 * \note The read/write functions that are used by the entropy source are
1237 * determined in the platform layer, and can be modified at runtime and/or
1238 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1239 *
1240 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001241 * with regular fopen(), please make sure you make a seedfile with the
1242 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1243 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001244 * and written to or you will get an entropy source error! The default
1245 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1246 * bytes from the file.
1247 *
1248 * \note The entropy collector will write to the seed file before entropy is
1249 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001250 */
1251//#define MBEDTLS_ENTROPY_NV_SEED
1252
Ronald Cron71016a92020-08-28 19:01:50 +02001253/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001254 *
Ronald Cron71016a92020-08-28 19:01:50 +02001255 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001256 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001257 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1258 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001259 *
1260 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001261 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001262 */
Ronald Cron71016a92020-08-28 19:01:50 +02001263//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001264
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001265/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001266 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001267 *
1268 * Enable debugging of buffer allocator memory issues. Automatically prints
1269 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1270 * function for 'debug output' of allocated memory.
1271 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001272 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001273 *
1274 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001275 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001277
1278/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001280 *
1281 * Include backtrace information with each allocated block.
1282 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001283 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001284 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001285 *
1286 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001287 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001288//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001289
1290/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001291 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001292 *
1293 * Support external private RSA keys (eg from a HSM) in the PK layer.
1294 *
1295 * Comment this macro to disable support for external private RSA keys.
1296 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001297#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001298
1299/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001300 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001301 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001302 * Enable support for PKCS#1 v1.5 encoding.
1303 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001304 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001305 *
Paul Bakker48377d92013-08-30 12:06:24 +02001306 * This enables support for PKCS#1 v1.5 operations.
1307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001309
1310/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001311 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001312 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001313 * Enable support for PKCS#1 v2.1 encoding.
1314 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001315 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001316 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001317 * \warning If using a hash that is only provided by PSA drivers, you must
1318 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001319 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001320 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1321 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001323
Steven Cooreman6801f082021-02-19 17:21:22 +01001324/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1325 *
1326 * Enable support for platform built-in keys. If you enable this feature,
1327 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1328 * See the documentation of that function for more information.
1329 *
1330 * Built-in keys are typically derived from a hardware unique key or
1331 * stored in a secure element.
1332 *
1333 * Requires: MBEDTLS_PSA_CRYPTO_C.
1334 *
1335 * \warning This interface is experimental and may change or be removed
1336 * without notice.
1337 */
1338//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1339
Ronald Cron3768ac12021-01-26 16:58:00 +01001340/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1341 *
1342 * Enable support for PSA crypto client.
1343 *
1344 * \note This option allows to include the code necessary for a PSA
1345 * crypto client when the PSA crypto implementation is not included in
1346 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1347 * code to set and get PSA key attributes.
1348 * The development of PSA drivers partially relying on the library to
1349 * fulfill the hardware gaps is another possible usage of this option.
1350 *
1351 * \warning This interface is experimental and may change or be removed
1352 * without notice.
1353 */
1354//#define MBEDTLS_PSA_CRYPTO_CLIENT
1355
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001356/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1357 *
1358 * Make the PSA Crypto module use an external random generator provided
1359 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1360 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001361 * \note This random generator must deliver random numbers with cryptographic
1362 * quality and high performance. It must supply unpredictable numbers
1363 * with a uniform distribution. The implementation of this function
1364 * is responsible for ensuring that the random generator is seeded
1365 * with sufficient entropy. If you have a hardware TRNG which is slow
1366 * or delivers non-uniform output, declare it as an entropy source
1367 * with mbedtls_entropy_add_source() instead of enabling this option.
1368 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001369 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001370 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1371 * and define a function called mbedtls_psa_external_get_random()
1372 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001373 * ```
1374 * psa_status_t mbedtls_psa_external_get_random(
1375 * mbedtls_psa_external_random_context_t *context,
1376 * uint8_t *output, size_t output_size, size_t *output_length);
1377 * );
1378 * ```
1379 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001380 * The function must fill the \c output buffer with \c output_size bytes
1381 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001382 *
1383 * Requires: MBEDTLS_PSA_CRYPTO_C
1384 *
1385 * \warning If you enable this option, code that uses the PSA cryptography
1386 * interface will not use any of the entropy sources set up for
1387 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1388 * enables.
1389 *
1390 * \note This option is experimental and may be removed without notice.
1391 */
1392//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1393
Paul Bakker9dcc3222011-03-08 14:16:06 +00001394/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001395 * \def MBEDTLS_PSA_CRYPTO_SPM
1396 *
1397 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1398 * Partition Manager) integration which separates the code into two parts: a
1399 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1400 * Environment).
1401 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001402 * If you enable this option, your build environment must include a header
1403 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1404 * header files, or in another directory on the compiler's include search
1405 * path). Alternatively, your platform may customize the header
1406 * `psa/crypto_platform.h`, in which case it can skip or replace the
1407 * inclusion of `"crypto_spe.h"`.
1408 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001409 * Module: library/psa_crypto.c
1410 * Requires: MBEDTLS_PSA_CRYPTO_C
1411 *
1412 */
1413//#define MBEDTLS_PSA_CRYPTO_SPM
1414
1415/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001416 * Uncomment to enable p256-m. This is an alternative implementation of
1417 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1418 * Compared to the default implementation:
1419 *
1420 * - p256-m has a much smaller code size and RAM footprint.
1421 * - p256-m is only available via the PSA API. This includes the pk module
1422 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1423 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1424 * over the core arithmetic, or deterministic derivation of keys.
1425 *
1426 * We recommend enabling this option if your application uses the PSA API
1427 * and the only elliptic curve support it needs is ECDH and ECDSA over
1428 * SECP256R1.
1429 *
1430 * If you enable this option, you do not need to enable any ECC-related
1431 * MBEDTLS_xxx option. You do need to separately request support for the
1432 * cryptographic mechanisms through the PSA API:
1433 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1434 * configuration;
1435 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1436 * - #PSA_WANT_ECC_SECP_R1_256;
1437 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1438 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1439 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1440 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1441 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001442 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001443 * \note To benefit from the smaller code size of p256-m, make sure that you
1444 * do not enable any ECC-related option not supported by p256-m: this
1445 * would cause the built-in ECC implementation to be built as well, in
1446 * order to provide the required option.
1447 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001448 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1449 * SECP256R1 are disabled as they are not supported by this driver.
1450 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1451 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001452 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001453 */
1454//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1455
1456/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001457 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001458 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001459 * Enable support for entropy injection at first boot. This feature is
1460 * required on systems that do not have a built-in entropy source (TRNG).
1461 * This feature is currently not supported on systems that have a built-in
1462 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001463 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001464 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001465 *
1466 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001467//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001468
1469/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001470 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001471 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001472 * Assume all buffers passed to PSA functions are owned exclusively by the
1473 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001474 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001475 * This option may be enabled if all buffers passed to any PSA function reside
1476 * in memory that is accessible only to the PSA function during its execution.
1477 *
1478 * This option MUST be disabled whenever buffer arguments are in memory shared
1479 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001480 * across a trust boundary.
1481 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001482 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001483 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001484 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001485 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001486 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001487//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001488
1489/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001491 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001492 * Do not use the Chinese Remainder Theorem
1493 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001494 *
1495 * Uncomment this macro to disable the use of CRT in RSA.
1496 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001499
1500/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001501 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001502 *
1503 * Enable the checkup functions (*_self_test).
1504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001505#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001506
1507/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001508 * \def MBEDTLS_SHA256_SMALLER
1509 *
1510 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1511 * lower performance.
1512 *
Adam Wolf039080f2019-09-10 09:53:08 -05001513 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001514 * performance and size. This version optimizes more aggressively for size at
1515 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1516 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1517 * 30%.
1518 *
1519 * Uncomment to enable the smaller implementation of SHA256.
1520 */
1521//#define MBEDTLS_SHA256_SMALLER
1522
1523/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001524 * \def MBEDTLS_SHA512_SMALLER
1525 *
1526 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1527 * lower performance.
1528 *
1529 * Uncomment to enable the smaller implementation of SHA512.
1530 */
1531//#define MBEDTLS_SHA512_SMALLER
1532
1533/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001534 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001535 *
1536 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001537 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001538 * with other servers, only debugging of failures is harder.
1539 *
1540 * The advantage of not sending alert messages, is that no information is given
1541 * about reasons for failures thus preventing adversaries of gaining intel.
1542 *
1543 * Enable sending of all alert messages
1544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001545#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001546
1547/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001548 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1549 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001550 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001551 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001552 * in the underlying transport. The CID functionality is described
1553 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001554 *
1555 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001556 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1557 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1558 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001559 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001560 * The maximum lengths of outgoing and incoming CIDs can be configured
1561 * through the options
1562 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1563 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1564 *
1565 * Requires: MBEDTLS_SSL_PROTO_DTLS
1566 *
1567 * Uncomment to enable the Connection ID extension.
1568 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001569#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1570
1571
1572/**
1573 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1574 *
1575 * Defines whether RFC 9146 (default) or the legacy version
1576 * (version draft-ietf-tls-dtls-connection-id-05,
1577 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1578 * is used.
1579 *
1580 * Set the value to 0 for the standard version, and
1581 * 1 for the legacy draft version.
1582 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001583 * \deprecated Support for the legacy version of the DTLS
1584 * Connection ID feature is deprecated. Please
1585 * switch to the standardized version defined
1586 * in RFC 9146 enabled by utilizing
1587 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1588 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1589 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001590 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1591 */
1592#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001593
1594/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001595 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1596 *
1597 * Enable asynchronous external private key operations in SSL. This allows
1598 * you to configure an SSL connection to call an external cryptographic
1599 * module to perform private key operations instead of performing the
1600 * operation inside the library.
1601 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001602 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001603 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001604//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001605
1606/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001607 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1608 *
1609 * Enable serialization of the TLS context structures, through use of the
1610 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1611 *
1612 * This pair of functions allows one side of a connection to serialize the
1613 * context associated with the connection, then free or re-use that context
1614 * while the serialized state is persisted elsewhere, and finally deserialize
1615 * that state to a live context for resuming read/write operations on the
1616 * connection. From a protocol perspective, the state of the connection is
1617 * unaffected, in particular this is entirely transparent to the peer.
1618 *
1619 * Note: this is distinct from TLS session resumption, which is part of the
1620 * protocol and fully visible by the peer. TLS session resumption enables
1621 * establishing new connections associated to a saved session with shorter,
1622 * lighter handshakes, while context serialization is a local optimization in
1623 * handling a single, potentially long-lived connection.
1624 *
1625 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1626 * saved after the handshake to allow for more efficient serialization, so if
1627 * you don't need this feature you'll save RAM by disabling it.
1628 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001629 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1630 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001631 * Comment to disable the context serialization APIs.
1632 */
1633#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1634
1635/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001636 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001637 *
1638 * Enable the debug messages in SSL module for all issues.
1639 * Debug messages have been disabled in some places to prevent timing
1640 * attacks due to (unbalanced) debugging function calls.
1641 *
1642 * If you need all error reporting you should enable this during debugging,
1643 * but remove this for production servers that should log as well.
1644 *
1645 * Uncomment this macro to report all debug messages on errors introducing
1646 * a timing side-channel.
1647 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001648 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001650
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001651/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001652 *
1653 * Enable support for Encrypt-then-MAC, RFC 7366.
1654 *
1655 * This allows peers that both support it to use a more robust protection for
1656 * ciphersuites using CBC, providing deep resistance against timing attacks
1657 * on the padding or underlying cipher.
1658 *
1659 * This only affects CBC ciphersuites, and is useless if none is defined.
1660 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001661 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001662 *
1663 * Comment this macro to disable support for Encrypt-then-MAC
1664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001665#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001666
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001667/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001668 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001669 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1670 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001671 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001672 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001673 * attacks, but it is recommended to always use it (even if you disable
1674 * renegotiation), since it actually fixes a more fundamental issue in the
1675 * original SSL/TLS design, and has implications beyond Triple Handshake.
1676 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001677 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001678 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001679 * Comment this macro to disable support for Extended Master Secret.
1680 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001681#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001682
Paul Bakkerd66f0702013-01-31 16:57:45 +01001683/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001684 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1685 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001686 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001687 * giving access to the peer's certificate after completion of the handshake.
1688 *
1689 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1690 * recommended to disable this option for reduced RAM usage.
1691 *
1692 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1693 * defined, but always returns \c NULL.
1694 *
1695 * \note This option has no influence on the protection against the
1696 * triple handshake attack. Even if it is disabled, Mbed TLS will
1697 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001698 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001699 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001700 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001701 *
1702 * Comment this macro to disable storing the peer's certificate
1703 * after the handshake.
1704 */
1705#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1706
1707/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001709 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001710 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001711 *
1712 * The two main uses of renegotiation are (1) refresh keys on long-lived
1713 * connections and (2) client authentication after the initial handshake.
1714 * If you don't need renegotiation, it's probably better to disable it, since
1715 * it has been associated with security issues in the past and is easy to
1716 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001717 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001718 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1719 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001720 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001721 *
1722 * \note Even if this option is disabled, both client and server are aware
1723 * of the Renegotiation Indication Extension (RFC 5746) used to
1724 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1725 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1726 * configuration of this extension).
1727 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001730
1731/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001733 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001734 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001735 *
1736 * Comment this macro to disable support for the max_fragment_length extension
1737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001739
1740/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001741 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1742 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001743 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001744 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001745 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1746 *
1747 * Uncomment this macro to enable support for the record_size_limit extension
1748 */
1749//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1750
1751/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001753 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001754 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001755 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001756 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001757 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1758 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001759 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001760 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001761 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001762 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1763 * are only provided by PSA drivers, you must call psa_crypto_init() before
1764 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001765 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001766 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001769
1770/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001771 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001772 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001773 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001774 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001775 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001776 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001777 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001778 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001779 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001780 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001781 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1782 * directly performed by TLS 1.3 code. As a consequence, you must
1783 * call psa_crypto_init() before the first TLS 1.3 handshake.
1784 *
1785 * \note Cryptographic operations performed indirectly via another module
1786 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1787 * running handshake hash) only use PSA crypto if
1788 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001789 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001790 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001791 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001792#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001793
1794/**
Ronald Cronab65c522021-11-24 10:47:20 +01001795 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1796 *
1797 * Enable TLS 1.3 middlebox compatibility mode.
1798 *
1799 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1800 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1801 * expecting TLS 1.2 traffic.
1802 *
1803 * Turning on the compatibility mode comes at the cost of a few added bytes
1804 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1805 * that don't use it. Therefore, unless transmission bandwidth is critical and
1806 * you know that middlebox compatibility issues won't occur, it is therefore
1807 * recommended to set this option.
1808 *
1809 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001810 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1811 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001812 *
1813 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001814#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001815
1816/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001817 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1818 *
1819 * Enable TLS 1.3 PSK key exchange mode.
1820 *
1821 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1822 * 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_PSK_ENABLED
1827
1828/**
1829 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1830 *
1831 * Enable TLS 1.3 ephemeral key exchange mode.
1832 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001833 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001834 * MBEDTLS_X509_CRT_PARSE_C
1835 * and at least one of:
1836 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1837 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001838 *
1839 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1840 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1841 * effect on the build.
1842 *
1843 */
1844#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1845
1846/**
1847 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1848 *
1849 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1850 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001851 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001852 *
1853 * Comment to disable support for the PSK ephemeral key exchange mode in
1854 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1855 * have any effect on the build.
1856 *
1857 */
1858#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1859
1860/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 * \def MBEDTLS_SSL_EARLY_DATA
1862 *
1863 * Enable support for RFC 8446 TLS 1.3 early data.
1864 *
1865 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1866 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1867 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1868 *
1869 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1870 * is not enabled, this option does not have any effect on the build.
1871 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001872 * \note The maximum amount of early data can be set with
1873 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1874 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001876//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001877
1878/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001880 *
1881 * Enable support for DTLS (all available versions).
1882 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001883 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001884 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001885 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001886 *
1887 * Comment this macro to disable support for DTLS
1888 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001889#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001890
1891/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001893 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001894 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001895 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001896 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001897 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001899
1900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001902 *
1903 * Enable support for the anti-replay mechanism in DTLS.
1904 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 * Requires: MBEDTLS_SSL_TLS_C
1906 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001907 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001908 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001909 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001910 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001911 * Comment this to disable anti-replay in DTLS.
1912 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001914
1915/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001917 *
1918 * Enable support for HelloVerifyRequest on DTLS servers.
1919 *
1920 * This feature is highly recommended to prevent DTLS servers being used as
1921 * amplifiers in DoS attacks against other hosts. It should always be enabled
1922 * unless you know for sure amplification cannot be a problem in the
1923 * environment in which your server operates.
1924 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001925 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001926 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001927 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001928 *
1929 * Comment this to disable support for HelloVerifyRequest.
1930 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001931#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001932
1933/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001934 * \def MBEDTLS_SSL_DTLS_SRTP
1935 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001936 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001937 * through the use_srtp extension.
1938 *
1939 * \note This feature provides the minimum functionality required
1940 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1941 * the associated SRTP packet protection key material.
1942 * In particular, the SRTP packet protection itself, as well as the
1943 * demultiplexing of RTP and DTLS packets at the datagram layer
1944 * (see Section 5 of RFC 5764), are not handled by this feature.
1945 * Instead, after successful completion of a handshake negotiating
1946 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001947 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001948 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1949 * (this is implemented in the SSL example programs).
1950 * The resulting key should then be passed to an SRTP stack.
1951 *
1952 * Setting this option enables the runtime API
1953 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1954 * through which the supported DTLS-SRTP protection
1955 * profiles can be configured. You must call this API at
1956 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001957 *
1958 * Requires: MBEDTLS_SSL_PROTO_DTLS
1959 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001960 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001961 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001962//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001963
1964/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001965 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1966 *
1967 * Enable server-side support for clients that reconnect from the same port.
1968 *
1969 * Some clients unexpectedly close the connection and try to reconnect using the
1970 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001971 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001972 * flag enables that support.
1973 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001974 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001975 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001976 * Comment this to disable support for clients reusing the source port.
1977 */
1978#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1979
1980/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001982 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001983 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001984 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001985 * session store remains the responsibility of the application, though).
1986 * Server-side, you also need to provide callbacks for writing and parsing
1987 * tickets, including authenticated encryption and key management. Example
1988 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001989 *
1990 * Comment this macro to disable support for SSL session tickets
1991 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001992#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001993
1994/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001995 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001996 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001997 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001998 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001999 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00002000 *
Paul Bakker0be444a2013-08-27 21:55:01 +02002001 * Comment this macro to disable support for server name indication in SSL
2002 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002004
2005/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01002006 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2007 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05002008 * When this option is enabled, the SSL buffer will be resized automatically
2009 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02002010 *
2011 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01002012 */
2013//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2014
2015/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002016 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2017 *
2018 * Enable testing of the constant-flow nature of some sensitive functions with
2019 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002020 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002021 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002022 * This setting requires compiling with clang -fsanitize=memory. The test
2023 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002024 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002025 * \warning This macro is only used for extended testing; it is not considered
2026 * part of the library's API, so it may change or disappear at any time.
2027 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002028 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002029 */
2030//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2031
2032/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002033 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2034 *
2035 * Enable testing of the constant-flow nature of some sensitive functions with
2036 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002037 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002038 *
2039 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002040 * testing if the tests suites are run with valgrind's memcheck. This can be
2041 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2042 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002043 *
2044 * \warning This macro is only used for extended testing; it is not considered
2045 * part of the library's API, so it may change or disappear at any time.
2046 *
2047 * Uncomment to enable testing of the constant-flow nature of selected code.
2048 */
2049//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2050
2051/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002052 * \def MBEDTLS_TEST_HOOKS
2053 *
2054 * Enable features for invasive testing such as introspection functions and
2055 * hooks for fault injection. This enables additional unit tests.
2056 *
2057 * Merely enabling this feature should not change the behavior of the product.
2058 * It only adds new code, and new branching points where the default behavior
2059 * is the same as when this feature is disabled.
2060 * However, this feature increases the attack surface: there is an added
2061 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2062 * Therefore this feature must never be enabled in production.
2063 *
2064 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2065 * information.
2066 *
2067 * Uncomment to enable invasive tests.
2068 */
2069//#define MBEDTLS_TEST_HOOKS
2070
2071/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002073 *
2074 * Provide your own alternate threading implementation.
2075 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002077 *
2078 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002079 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002081
2082/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002083 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002084 *
2085 * Enable the pthread wrapper layer for the threading layer.
2086 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002087 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002088 *
2089 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002090 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002092
2093/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002094 * \def MBEDTLS_USE_PSA_CRYPTO
2095 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002096 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
2097 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002098 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002099 * \note Development of this option is currently in progress, and parts of Mbed
2100 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002101 * will still continue to work as usual, so enabling this option should not
2102 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002103 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02002104 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02002105 * before calling any function from the SSL/TLS, X.509 or PK modules, except
2106 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00002107 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002108 * \note An important and desirable effect of this option is that it allows
2109 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2110 * 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 +02002111 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002112 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2113 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002114 *
2115 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002116 *
2117 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002118 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002119 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002121//#define MBEDTLS_USE_PSA_CRYPTO
2122
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002123/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002124 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2125 *
John Durkop185764f2020-10-12 21:32:12 -07002126 * This setting allows support for cryptographic mechanisms through the PSA
2127 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002128 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002129 * When this option is disabled, the PSA API exposes the cryptographic
2130 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2131 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002132 *
2133 * When this option is enabled, the PSA API exposes the cryptographic
2134 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2135 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2136 * automatically enabled if required (i.e. if no PSA driver provides the
2137 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2138 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002139 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002140 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002141 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002142 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002143 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2144 * symbols is not completely finalized yet, and the configuration
2145 * tooling is not ideally adapted to having two separate configuration
2146 * files.
2147 * Future minor releases of Mbed TLS may make minor changes to those
2148 * symbols, but we will endeavor to provide a transition path.
2149 * Nonetheless, this option is considered mature enough to use in
2150 * production, as long as you accept that you may need to make
2151 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002152 */
2153//#define MBEDTLS_PSA_CRYPTO_CONFIG
2154
2155/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002156 * \def MBEDTLS_VERSION_FEATURES
2157 *
2158 * Allow run-time checking of compile-time enabled features. Thus allowing users
2159 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002160 * support via mbedtls_version_check_feature().
2161 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002162 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002163 *
2164 * Comment this to disable run-time checking and save ROM space
2165 */
2166#define MBEDTLS_VERSION_FEATURES
2167
2168/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002169 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2170 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002171 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002172 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2173 * the set of trusted certificates through a callback instead of a linked
2174 * list.
2175 *
2176 * This is useful for example in environments where a large number of trusted
2177 * certificates is present and storing them in a linked list isn't efficient
2178 * enough, or when the set of trusted certificates changes frequently.
2179 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002180 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002181 * `mbedtls_ssl_conf_ca_cb()` for more information.
2182 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002183 * Requires: MBEDTLS_X509_CRT_PARSE_C
2184 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002185 * Uncomment to enable trusted certificate callbacks.
2186 */
2187//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2188
2189/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002190 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002191 *
Chris Jones2c745862020-12-16 11:41:06 +00002192 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002193 *
Chris Jones2c745862020-12-16 11:41:06 +00002194 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002195 * and other functions/constants only used by these functions, thus reducing
2196 * the code footprint by several KB.
2197 */
Chris Jones2c745862020-12-16 11:41:06 +00002198//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002199
2200/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002201 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002202 *
2203 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2204 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2205 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002206 * Requires: MBEDTLS_PKCS1_V21
2207 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002208 * Comment this macro to disallow using RSASSA-PSS in certificates.
2209 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002211/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002212
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002213/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002214 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002215 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002216 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002217 * \{
2218 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002219
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002220/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002221 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002222 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002223 * Enable AES-NI support on x86-64 or x86-32.
2224 *
2225 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002226 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002227 * - GCC, x86-64, target not explicitly supporting AESNI:
2228 * requires MBEDTLS_HAVE_ASM.
2229 * - GCC, x86-32, target not explicitly supporting AESNI:
2230 * not supported.
2231 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2232 * For this assembly-less implementation, you must currently compile
2233 * `library/aesni.c` and `library/aes.c` with machine options to enable
2234 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2235 * `clang -maes -mpclmul`.
2236 * - Non-x86 targets: this option is silently ignored.
2237 * - Other compilers: this option is silently ignored.
2238 *
2239 * \note
2240 * Above, "GCC" includes compatible compilers such as Clang.
2241 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002242 *
2243 * Module: library/aesni.c
2244 * Caller: library/aes.c
2245 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002246 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002247 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002248 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002249 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002251
2252/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002253 * \def MBEDTLS_AESCE_C
2254 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002255 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002256 *
2257 * Module: library/aesce.c
2258 * Caller: library/aes.c
2259 *
Jerry Yuf015a932023-04-25 10:38:03 +08002260 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002261 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002262 * \warning Runtime detection only works on Linux. For non-Linux operating
2263 * system, Armv8-A Cryptographic Extensions must be supported by
2264 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002265 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002266 * \note Minimum compiler versions for this feature when targeting aarch64
2267 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2268 * Minimum compiler versions for this feature when targeting 32-bit
2269 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002270 *
2271 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2272 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002273 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002274 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002275 */
2276#define MBEDTLS_AESCE_C
2277
2278/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002279 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002280 *
2281 * Enable the AES block cipher.
2282 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002283 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002284 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002285 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002286 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002287 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002288 * This module enables the following ciphersuites (if other requisites are
2289 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002290 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2291 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2292 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2293 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2294 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2295 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2296 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2297 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2298 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2299 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2300 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2301 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2302 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2303 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2304 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2305 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2306 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2307 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2308 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2309 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2310 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2311 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2312 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2313 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2314 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2315 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2316 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2317 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2318 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2319 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2320 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2321 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2322 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2323 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2324 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2325 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2326 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2327 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2328 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2329 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2330 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2331 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2332 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2333 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2334 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2335 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2336 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2337 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2338 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2339 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2340 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2341 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2342 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2343 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2344 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2345 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2346 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2347 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002348 *
Paul Bakkercff68422013-09-15 20:43:33 +02002349 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002352
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002353/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002355 *
2356 * Enable the generic ASN1 parser.
2357 *
2358 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002359 * Caller: library/x509.c
2360 * library/dhm.c
2361 * library/pkcs12.c
2362 * library/pkcs5.c
2363 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002365#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002366
2367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002368 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002369 *
2370 * Enable the generic ASN1 writer.
2371 *
2372 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002373 * Caller: library/ecdsa.c
2374 * library/pkwrite.c
2375 * library/x509_create.c
2376 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002377 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002378 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002380
2381/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002382 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002383 *
2384 * Enable the Base64 module.
2385 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002386 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002387 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002388 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002389 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002390 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002391#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002392
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002393/**
Yanray Wange367e472023-10-31 17:23:04 +08002394 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2395 *
2396 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2397 *
2398 * \note This feature is incompatible with insecure block cipher,
2399 * MBEDTLS_DES_C, and cipher modes which always require decryption
2400 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002401 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2402 * this feature is incompatible with following supported PSA equivalence,
2403 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2404 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002405 *
2406 * Module: library/aes.c
2407 * library/aesce.c
2408 * library/aesni.c
2409 * library/aria.c
2410 * library/camellia.c
2411 * library/cipher.c
2412 */
2413//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2414
2415/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002416 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002417 *
Paul Bakker9a736322012-11-14 12:39:52 +00002418 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002419 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002420 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002421 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002422 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002423 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002424 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002425 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002426 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002427 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002428 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002429 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002430 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002431 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002434
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002435/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002436 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002437 *
2438 * Enable the Camellia block cipher.
2439 *
Paul Bakker38119b12009-01-10 23:31:23 +00002440 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002441 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002442 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002443 * This module enables the following ciphersuites (if other requisites are
2444 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002445 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2446 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2447 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2448 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2449 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2450 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2451 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2452 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2453 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2454 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2455 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2456 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2457 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2458 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2459 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2460 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2461 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2462 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2463 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2464 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2465 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2466 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2467 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2468 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2469 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2470 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2471 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2472 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2473 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2474 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2475 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2476 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2477 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2478 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2479 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2480 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2481 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2482 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2483 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2484 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2485 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2486 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002489
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002490/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002491 * \def MBEDTLS_ARIA_C
2492 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002493 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002494 *
2495 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002496 * Caller: library/cipher.c
2497 *
2498 * This module enables the following ciphersuites (if other requisites are
2499 * enabled as well):
2500 *
2501 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2502 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2503 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2504 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2505 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2506 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2507 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2508 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2509 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2510 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2511 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2512 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2513 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2514 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2515 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2516 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2517 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2518 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2519 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2520 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2521 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2522 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2523 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2524 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2525 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2526 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2527 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2528 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2529 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2530 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2531 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2532 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2533 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2534 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2535 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2536 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2537 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2538 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002539 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002540#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002541
2542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002544 *
2545 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2546 *
2547 * Module: library/ccm.c
2548 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002549 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2550 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002551 *
2552 * This module enables the AES-CCM ciphersuites, if other requisites are
2553 * enabled as well.
2554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002556
2557/**
Daniel King34b822c2016-05-15 17:28:08 -03002558 * \def MBEDTLS_CHACHA20_C
2559 *
2560 * Enable the ChaCha20 stream cipher.
2561 *
2562 * Module: library/chacha20.c
2563 */
2564#define MBEDTLS_CHACHA20_C
2565
2566/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002567 * \def MBEDTLS_CHACHAPOLY_C
2568 *
2569 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2570 *
2571 * Module: library/chachapoly.c
2572 *
2573 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2574 */
2575#define MBEDTLS_CHACHAPOLY_C
2576
2577/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002578 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002579 *
2580 * Enable the generic cipher layer.
2581 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002582 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002583 * Caller: library/ccm.c
2584 * library/cmac.c
2585 * library/gcm.c
2586 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002587 * library/pkcs12.c
2588 * library/pkcs5.c
2589 * library/psa_crypto_aead.c
2590 * library/psa_crypto_mac.c
2591 * library/ssl_ciphersuites.c
2592 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002593 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002594 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2595 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002596 *
2597 * Uncomment to enable generic cipher wrappers.
2598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002600
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002601/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002602 * \def MBEDTLS_CMAC_C
2603 *
Simon Butcher327398a2016-10-05 14:09:11 +01002604 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2605 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002606 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002607 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2608 * implementation of the CMAC algorithm is provided by an alternate
2609 * implementation, that alternate implementation may opt to not support
2610 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2611 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002612 * Module: library/cmac.c
2613 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002614 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002615 *
2616 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002617#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002618
2619/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002621 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002622 * Enable the CTR_DRBG AES-based random generator.
2623 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002624 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002625 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002626 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2627 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2628 * is used.
2629 *
2630 * \warning When using PSA, the user should call `psa_crypto_init()` before
2631 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2632 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002633 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2634 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002635 * \note To achieve a 256-bit security strength with CTR_DRBG,
2636 * you must use AES-256 *and* use sufficient entropy.
2637 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002638 *
2639 * Module: library/ctr_drbg.c
2640 * Caller:
2641 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002642 * Requires: MBEDTLS_AES_C or
2643 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2644 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002645 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002646 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002647 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002648#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002649
2650/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002651 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002652 *
2653 * Enable the debug functions.
2654 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002655 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002656 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002657 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002658 * library/ssl_tls12_*.c
2659 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002660 *
2661 * This module provides debugging functions.
2662 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002664
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002665/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002667 *
2668 * Enable the DES block cipher.
2669 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002670 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002671 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002672 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002673 *
Paul Bakkercff68422013-09-15 20:43:33 +02002674 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002675 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002676 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002677 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002680
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002683 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002684 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002685 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002686 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002687 * Caller: library/ssl_tls.c
2688 * library/ssl*_client.c
2689 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002690 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002691 * This module is used by the following key exchanges:
2692 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002693 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002694 * \warning Using DHE constitutes a security risk as it
2695 * is not possible to validate custom DH parameters.
2696 * If possible, it is recommended users should consider
2697 * preferring other methods of key exchange.
2698 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002699 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002700 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002701#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002702
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002703/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002704 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002705 *
2706 * Enable the elliptic curve Diffie-Hellman library.
2707 *
2708 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002709 * Caller: library/psa_crypto.c
2710 * library/ssl_tls.c
2711 * library/ssl*_client.c
2712 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002713 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002714 * This module is used by the following key exchanges:
2715 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002716 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002717 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002718 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002720
2721/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002722 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002723 *
2724 * Enable the elliptic curve DSA library.
2725 *
2726 * Module: library/ecdsa.c
2727 * Caller:
2728 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002729 * This module is used by the following key exchanges:
2730 * ECDHE-ECDSA
2731 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002732 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2733 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2734 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002735 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002737
2738/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002739 * \def MBEDTLS_ECJPAKE_C
2740 *
2741 * Enable the elliptic curve J-PAKE library.
2742 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002743 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2744 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002745 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002746 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002747 * Module: library/ecjpake.c
2748 * Caller:
2749 *
2750 * This module is used by the following key exchanges:
2751 * ECJPAKE
2752 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002753 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002754 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002755 * \warning If using a hash that is only provided by PSA drivers, you must
2756 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002757 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002758#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002759
2760/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002762 *
2763 * Enable the elliptic curve over GF(p) library.
2764 *
2765 * Module: library/ecp.c
2766 * Caller: library/ecdh.c
2767 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002768 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002769 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002770 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002773
2774/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002776 *
2777 * Enable the platform-specific entropy code.
2778 *
2779 * Module: library/entropy.c
2780 * Caller:
2781 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002782 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002783 *
2784 * This module provides a generic entropy pool
2785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002787
2788/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002789 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002790 *
2791 * Enable error code to error string conversion.
2792 *
2793 * Module: library/error.c
2794 * Caller:
2795 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002799
2800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002802 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002803 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002804 *
2805 * Module: library/gcm.c
2806 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002807 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2808 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002809 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002810 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2811 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002814
2815/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002816 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002817 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002818 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002819 * Can significantly increase throughput on systems without GCM hardware
2820 * acceleration (e.g., AESNI, AESCE).
2821 *
Matthias Schulz78266782024-02-08 13:54:48 +01002822 * The mbedtls_gcm_context size will increase by 3840 bytes.
2823 * The code size will increase by roughly 344 bytes.
2824 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002825 * Module: library/gcm.c
2826 *
2827 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002828 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002829//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002830
2831/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002832 * \def MBEDTLS_HKDF_C
2833 *
2834 * Enable the HKDF algorithm (RFC 5869).
2835 *
2836 * Module: library/hkdf.c
2837 * Caller:
2838 *
2839 * Requires: MBEDTLS_MD_C
2840 *
2841 * This module adds support for the Hashed Message Authentication Code
2842 * (HMAC)-based key derivation function (HKDF).
2843 */
2844#define MBEDTLS_HKDF_C
2845
2846/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002847 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002848 *
2849 * Enable the HMAC_DRBG random generator.
2850 *
2851 * Module: library/hmac_drbg.c
2852 * Caller:
2853 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002855 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002856 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002857 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002859
2860/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002861 * \def MBEDTLS_LMS_C
2862 *
2863 * Enable the LMS stateful-hash asymmetric signature algorithm.
2864 *
2865 * Module: library/lms.c
2866 * Caller:
2867 *
Raef Colesab4f8742022-09-01 12:24:31 +01002868 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002869 *
Raef Colesab4f8742022-09-01 12:24:31 +01002870 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002871 */
2872#define MBEDTLS_LMS_C
2873
2874/**
Raef Colesab4f8742022-09-01 12:24:31 +01002875 * \def MBEDTLS_LMS_PRIVATE
2876 *
2877 * Enable LMS private-key operations and signing code. Functions enabled by this
2878 * option are experimental, and should not be used in production.
2879 *
2880 * Requires: MBEDTLS_LMS_C
2881 *
2882 * Uncomment to enable the LMS signature algorithm and private key operations.
2883 */
Raef Coles5127e852022-10-07 10:35:56 +01002884//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002885
2886/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002887 * \def MBEDTLS_NIST_KW_C
2888 *
2889 * Enable the Key Wrapping mode for 128-bit block ciphers,
2890 * as defined in NIST SP 800-38F. Only KW and KWP modes
2891 * are supported. At the moment, only AES is approved by NIST.
2892 *
2893 * Module: library/nist_kw.c
2894 *
2895 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2896 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002897#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002898
2899/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002900 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002901 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002902 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002903 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002904 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2905 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002906 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002907 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002908 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002909 * Caller: library/constant_time.c
2910 * library/ecdsa.c
2911 * library/ecjpake.c
2912 * library/hkdf.c
2913 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002914 * library/pk.c
2915 * library/pkcs5.c
2916 * library/pkcs12.c
2917 * library/psa_crypto_ecp.c
2918 * library/psa_crypto_rsa.c
2919 * library/rsa.c
2920 * library/ssl_cookie.c
2921 * library/ssl_msg.c
2922 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002923 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002924 * library/x509_crt.c
2925 * library/x509write_crt.c
2926 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002927 *
2928 * Uncomment to enable generic message digest wrappers.
2929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002931
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002932/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002934 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002935 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002936 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002937 * Module: library/md5.c
2938 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002939 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002940 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002941 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002942 * This module is required for TLS 1.2 depending on the handshake parameters.
2943 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2944 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002945 *
2946 * \warning MD5 is considered a weak message digest and its use constitutes a
2947 * security risk. If possible, we recommend avoiding dependencies on
2948 * it, and considering stronger message digests instead.
2949 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002950 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002952
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002953/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002955 *
2956 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002957 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002958 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002959 *
2960 * Module: library/memory_buffer_alloc.c
2961 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002963 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002964 *
2965 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002968
2969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002971 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002972 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2973 *
Simon Butcherd567a232016-03-09 20:19:21 +00002974 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2975 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002976 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002977 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002978 * \note See also our Knowledge Base article about porting to a new
2979 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002980 * 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 +00002981 *
Andres AG788aa4a2016-09-14 14:32:09 +01002982 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002983 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002984 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002985 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002987
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002988/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002990 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002991 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002992 *
2993 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002994 * Caller: library/asn1write.c
2995 * library/pkcs5.c
2996 * library/pkparse.c
2997 * library/pkwrite.c
2998 * library/rsa.c
2999 * library/x509.c
3000 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003001 * library/x509_crl.c
3002 * library/x509_crt.c
3003 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003004 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003005 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02003006 *
3007 * This modules translates between OIDs and internal values.
3008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003010
3011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003013 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003014 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00003015 *
3016 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003017 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02003018 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003019 * library/x509_crl.c
3020 * library/x509_crt.c
3021 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00003022 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01003024 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
3025 *
3026 * \warning When parsing password-protected files, if MD5 is provided only by
3027 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00003028 *
Paul Bakkercff68422013-09-15 20:43:33 +02003029 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00003030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003032
3033/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003035 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003036 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02003037 *
3038 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003039 * Caller: library/pkwrite.c
3040 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003041 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02003042 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02003044 *
3045 * This modules adds support for encoding / writing PEM files.
3046 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003048
3049/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003050 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003051 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003052 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003053 *
3054 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003055 * Caller: library/psa_crypto_rsa.c
3056 * library/ssl_tls.c
3057 * library/ssl*_client.c
3058 * library/ssl*_server.c
3059 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003060 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02003061 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003062 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003063 * Uncomment to enable generic public key wrappers.
3064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003066
3067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003069 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003070 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02003071 *
3072 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003073 * Caller: library/x509_crt.c
3074 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003075 *
Yanray Wang072a0682023-12-05 10:53:04 +08003076 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003077 *
3078 * Uncomment to enable generic public key parse functions.
3079 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003080#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003081
3082/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003083 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003084 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003085 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003086 *
3087 * Module: library/pkwrite.c
3088 * Caller: library/x509write.c
3089 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08003090 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003091 *
3092 * Uncomment to enable generic public key write functions.
3093 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003095
3096/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003098 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003099 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003100 *
3101 * Module: library/pkcs5.c
3102 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01003103 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003104 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003105 * \warning If using a hash that is only provided by PSA drivers, you must
3106 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003107 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003108 * This module adds support for the PKCS#5 functions.
3109 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003110#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003111
3112/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003113 * \def MBEDTLS_PKCS7_C
3114 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003115 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003116 * RFC Link - https://tools.ietf.org/html/rfc2315
3117 *
3118 * Module: library/pkcs7.c
3119 *
3120 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003121 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3122 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003123 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003124 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003125 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003126#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003127
3128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003130 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003131 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003132 * Adds algorithms for parsing PKCS#8 encrypted private keys
3133 *
3134 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003135 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003136 *
Valerio Settie98ad592023-12-28 10:42:12 +01003137 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3138 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003139 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003140 * \warning If using a hash that is only provided by PSA drivers, you must
3141 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003142 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003143 * This module enables PKCS#12 functions.
3144 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003145#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003146
3147/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003148 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003149 *
3150 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003151 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003152 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3154 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003155 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003156 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003157 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003158 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003159 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003160 * Module: library/platform.c
3161 * Caller: Most other .c files
3162 *
3163 * This module enables abstraction of common (libc) functions.
3164 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003165#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003166
3167/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003168 * \def MBEDTLS_POLY1305_C
3169 *
3170 * Enable the Poly1305 MAC algorithm.
3171 *
3172 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003173 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003174 */
3175#define MBEDTLS_POLY1305_C
3176
3177/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003178 * \def MBEDTLS_PSA_CRYPTO_C
3179 *
3180 * Enable the Platform Security Architecture cryptography API.
3181 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003182 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003183 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003184 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003185 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003186 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3187 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3188 * is enabled in PSA (unless it's fully accelerated, see
3189 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003190 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003191#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003192
3193/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003194 * \def MBEDTLS_PSA_CRYPTO_SE_C
3195 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003196 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003197 * cryptography API.
3198 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003199 * \deprecated This feature is deprecated. Please switch to the PSA driver
3200 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003201 *
Ryan Everett32a64582024-03-05 18:16:18 +00003202 * \warning This feature is not thread-safe, and should not be used in a
3203 * multi-threaded environment.
3204 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003205 * Module: library/psa_crypto_se.c
3206 *
3207 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3208 *
3209 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003210//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003211
3212/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003213 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3214 *
3215 * Enable the Platform Security Architecture persistent key storage.
3216 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003217 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003218 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003219 * Requires: MBEDTLS_PSA_CRYPTO_C,
3220 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3221 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003222 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003223#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003224
3225/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003226 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003227 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003228 * Enable the emulation of the Platform Security Architecture
3229 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003230 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003231 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003232 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003233 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003234 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003235#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003236
3237/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003238 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003239 *
3240 * Enable the RIPEMD-160 hash algorithm.
3241 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003242 * Module: library/ripemd160.c
3243 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003244 *
3245 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003246#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003247
3248/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003249 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003250 *
3251 * Enable the RSA public-key cryptosystem.
3252 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003253 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003254 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003255 * Caller: library/pk.c
3256 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003257 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003258 * library/ssl*_client.c
3259 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003260 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003261 * This module is used by the following key exchanges:
3262 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003263 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003264 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003265 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003266#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003267
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003268/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003269 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003270 *
3271 * Enable the SHA1 cryptographic hash algorithm.
3272 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003273 * Module: library/sha1.c
3274 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003275 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003276 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003277 * This module is required for TLS 1.2 depending on the handshake parameters,
3278 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003279 *
3280 * \warning SHA-1 is considered a weak message digest and its use constitutes
3281 * a security risk. If possible, we recommend avoiding dependencies
3282 * on it, and considering stronger message digests instead.
3283 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003284 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003285#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003286
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003287/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003288 * \def MBEDTLS_SHA224_C
3289 *
3290 * Enable the SHA-224 cryptographic hash algorithm.
3291 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003292 * Module: library/sha256.c
3293 * Caller: library/md.c
3294 * library/ssl_cookie.c
3295 *
3296 * This module adds support for SHA-224.
3297 */
3298#define MBEDTLS_SHA224_C
3299
3300/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003302 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003303 * Enable the SHA-256 cryptographic hash algorithm.
3304 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003305 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003306 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003307 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003308 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003309 * library/ssl*_client.c
3310 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003311 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003312 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003313 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003316
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003317/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003318 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003319 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003320 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3321 * with the ARMv8 cryptographic extensions if they are available at runtime.
3322 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003323 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003324 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003325 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003326 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003327 * \note Minimum compiler versions for this feature are Clang 4.0,
3328 * armclang 6.6 or GCC 6.0.
3329 *
3330 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3331 * armclang <= 6.9
3332 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003333 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3334 * That name is deprecated, but may still be used as an alternative form for this
3335 * option.
3336 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003337 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3338 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003339 *
3340 * Requires: MBEDTLS_SHA256_C.
3341 *
3342 * Module: library/sha256.c
3343 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003344 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003345 * and use them if available.
3346 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003347//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003348
Dave Rodgmand85277c2023-10-13 09:22:54 +01003349/**
3350 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3351 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003352 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003353 * This name is now deprecated, but may still be used as an alternative form for
3354 * this option.
3355 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003356//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3357
3358/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003359 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003360 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003361 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3362 * with the ARMv8 cryptographic extensions, which must be available at runtime
3363 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003364 *
3365 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003366 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003367 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003368 * \note Minimum compiler versions for this feature are Clang 4.0,
3369 * armclang 6.6 or GCC 6.0.
3370 *
3371 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3372 * armclang <= 6.9
3373 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003374 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003375 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003376 * option.
3377 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003378 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3379 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003380 *
3381 * Requires: MBEDTLS_SHA256_C.
3382 *
3383 * Module: library/sha256.c
3384 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003385 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003386 * unconditionally.
3387 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003388//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003389
Dave Rodgmand85277c2023-10-13 09:22:54 +01003390/**
3391 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3392 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003393 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003394 * This name is now deprecated, but may still be used as an alternative form for
3395 * this option.
3396 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003397//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3398
3399/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003400 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003401 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003402 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003403 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003404 * Module: library/sha512.c
3405 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003406 * library/psa_crypto_hash.c
3407 * library/ssl_tls.c
3408 * library/ssl*_client.c
3409 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003410 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003411 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003412 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003413#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003414
3415/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003417 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003418 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003419 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003420 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003421 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003422 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003423 * library/ssl_tls.c
3424 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003425 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003426 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003427 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003429
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003430/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003431 * \def MBEDTLS_SHA3_C
3432 *
3433 * Enable the SHA3 cryptographic hash algorithm.
3434 *
3435 * Module: library/sha3.c
3436 *
3437 * This module adds support for SHA3.
3438 */
3439#define MBEDTLS_SHA3_C
3440
3441/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003442 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3443 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003444 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3445 * with the ARMv8 cryptographic extensions if they are available at runtime.
3446 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003447 *
3448 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3449 * for a non-Aarch64 build it will be silently ignored.
3450 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003451 * \note Minimum compiler versions for this feature are Clang 7.0,
3452 * armclang 6.9 or GCC 8.0.
3453 *
3454 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3455 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003456 *
3457 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3458 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3459 *
3460 * Requires: MBEDTLS_SHA512_C.
3461 *
3462 * Module: library/sha512.c
3463 *
3464 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3465 * and use them if available.
3466 */
3467//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3468
3469/**
3470 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3471 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003472 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3473 * with the ARMv8 cryptographic extensions, which must be available at runtime
3474 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003475 *
3476 * \note This allows builds with a smaller code size than with
3477 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3478 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003479 * \note Minimum compiler versions for this feature are Clang 7.0,
3480 * armclang 6.9 or GCC 8.0.
3481 *
3482 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3483 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003484 *
3485 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3486 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3487 *
3488 * Requires: MBEDTLS_SHA512_C.
3489 *
3490 * Module: library/sha512.c
3491 *
3492 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3493 * unconditionally.
3494 */
3495//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3496
3497/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003499 *
3500 * Enable simple SSL cache implementation.
3501 *
3502 * Module: library/ssl_cache.c
3503 * Caller:
3504 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003508
3509/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003510 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003511 *
3512 * Enable basic implementation of DTLS cookies for hello verification.
3513 *
3514 * Module: library/ssl_cookie.c
3515 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003518
3519/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003520 * \def MBEDTLS_SSL_TICKET_C
3521 *
3522 * Enable an implementation of TLS server-side callbacks for session tickets.
3523 *
3524 * Module: library/ssl_ticket.c
3525 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003526 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003527 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3528 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003529 */
3530#define MBEDTLS_SSL_TICKET_C
3531
3532/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003533 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003534 *
3535 * Enable the SSL/TLS client code.
3536 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003537 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003538 * Caller:
3539 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003541 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003542 * This module is required for SSL/TLS client support.
3543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003545
Paul Bakker9a736322012-11-14 12:39:52 +00003546/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003547 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003548 *
3549 * Enable the SSL/TLS server code.
3550 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003551 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003552 * Caller:
3553 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003554 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003555 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003556 * This module is required for SSL/TLS server support.
3557 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003559
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003560/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003561 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003562 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003563 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003564 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003565 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003566 * Caller: library/ssl*_client.c
3567 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003568 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3570 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003571 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003572 * This module is required for SSL/TLS.
3573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003574#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003575
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003576/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003577 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003578 *
3579 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003580 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003581 * contexts are not shared between threads. If you do intend to use contexts
3582 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003583 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003584 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003585 *
3586 * Module: library/threading.c
3587 *
3588 * This allows different threading implementations (self-implemented or
3589 * provided).
3590 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003591 * You will have to enable either MBEDTLS_THREADING_ALT or
3592 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003593 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003594 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003597
3598/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003599 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003600 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003601 * Enable the semi-portable timing interface.
3602 *
Simon Butcherd567a232016-03-09 20:19:21 +00003603 * \note The provided implementation only works on POSIX/Unix (including Linux,
3604 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003605 * module and provide your own implementations of the callbacks needed by
3606 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3607 * your own implementation of the whole module by setting
3608 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003609 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003610 * \note The timing module will include time.h on suitable platforms
3611 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3612 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3613 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003614 * \note See also our Knowledge Base article about porting to a new
3615 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003616 * 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 +00003617 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003618 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003620#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003621
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003622/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003623 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003624 *
3625 * Enable run-time version information.
3626 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003627 * Module: library/version.c
3628 *
3629 * This module provides run-time version information.
3630 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003631#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003632
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003633/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003634 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003635 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003636 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003637 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003638 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003639 * Caller: library/x509_crl.c
3640 * library/x509_crt.c
3641 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003642 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003643 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003644 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3645 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003646 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3647 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003648 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003649 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003650 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003651#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003652
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003653/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003654 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003655 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003656 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003657 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003658 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003659 * Caller: library/ssl_tls.c
3660 * library/ssl*_client.c
3661 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003662 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003663 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003664 *
3665 * This module is required for X.509 certificate parsing.
3666 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003667#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003668
3669/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003670 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003671 *
3672 * Enable X.509 CRL parsing.
3673 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003674 * Module: library/x509_crl.c
3675 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003676 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003677 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003678 *
3679 * This module is required for X.509 CRL parsing.
3680 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003681#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003682
3683/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003684 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003685 *
3686 * Enable X.509 Certificate Signing Request (CSR) parsing.
3687 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003688 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003689 * Caller: library/x509_crt_write.c
3690 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003691 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003692 *
3693 * This module is used for reading X.509 certificate request.
3694 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003695#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003696
3697/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003698 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003699 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003700 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003701 *
3702 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003703 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003704 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003705 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3706 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003707 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3708 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003709 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003710 * This module is the basis for creating X.509 certificates and CSRs.
3711 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003712#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003713
3714/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003715 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003716 *
3717 * Enable creating X.509 certificates.
3718 *
3719 * Module: library/x509_crt_write.c
3720 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003721 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003722 *
3723 * This module is required for X.509 certificate creation.
3724 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003725#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003726
3727/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003728 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003729 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003730 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003731 *
3732 * Module: library/x509_csr_write.c
3733 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003734 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003735 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003736 * This module is required for X.509 certificate request writing.
3737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003738#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003739
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003740/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003741
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003742/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003743 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003744 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003745 * This section contains Mbed TLS build settings that are not associated
3746 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003747 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003748 * \{
3749 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003750
Gilles Peskinea02c1242022-03-16 17:03:19 +01003751/**
3752 * \def MBEDTLS_CONFIG_FILE
3753 *
3754 * If defined, this is a header which will be included instead of
3755 * `"mbedtls/mbedtls_config.h"`.
3756 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003757 * Unlike other configuration options, this one must be defined on the
3758 * compiler command line: a definition in `mbedtls_config.h` would have
3759 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003760 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003761 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003762 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003763 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003764 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003765 * The value of this symbol is typically a path in double quotes, either
3766 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003767 */
3768//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3769
3770/**
3771 * \def MBEDTLS_USER_CONFIG_FILE
3772 *
3773 * If defined, this is a header which will be included after
3774 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003775 * This allows you to modify the default configuration, including the ability
3776 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003777 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003778 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003779 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003780 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003781 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003782 * 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.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003784 */
3785//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3786
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003787/**
3788 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3789 *
3790 * If defined, this is a header which will be included instead of
3791 * `"psa/crypto_config.h"`.
3792 * This header file specifies which cryptographic mechanisms are available
3793 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3794 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3795 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003796 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003797 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003798 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003799 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003800 * The value of this symbol is typically a path in double quotes, either
3801 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003802 */
3803//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3804
3805/**
3806 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3807 *
3808 * If defined, this is a header which will be included after
3809 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003810 * This allows you to modify the default configuration, including the ability
3811 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003812 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003813 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003814 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003815 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003816 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003817 * The value of this symbol is typically a path in double quotes, either
3818 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003819 */
3820//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3821
Gilles Peskineb1176f22023-02-22 22:07:28 +01003822/**
3823 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3824 *
3825 * If defined, this is a header which will be included instead of
3826 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3827 * as the one in Mbed TLS, but with definitions adapted to the platform on
3828 * which the library code will run.
3829 *
3830 * \note The required content of this header can vary from one version of
3831 * Mbed TLS to the next. Integrators who provide an alternative file
3832 * should review the changes in the original file whenever they
3833 * upgrade Mbed TLS.
3834 *
3835 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3836 * non-standard feature of the C language, so this feature is only available
3837 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3838 *
3839 * The value of this symbol is typically a path in double quotes, either
3840 * absolute or relative to a directory on the include search path.
3841 */
3842//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3843
3844/**
3845 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3846 *
3847 * If defined, this is a header which will be included instead of
3848 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3849 * as the one in Mbed TLS, but with definitions adapted to the environment
3850 * in which the library code will run. The typical use for this feature
3851 * is to provide alternative type definitions on the client side in
3852 * client-server integrations of PSA crypto, where operation structures
3853 * contain handles instead of cryptographic data.
3854 *
3855 * \note The required content of this header can vary from one version of
3856 * Mbed TLS to the next. Integrators who provide an alternative file
3857 * should review the changes in the original file whenever they
3858 * upgrade Mbed TLS.
3859 *
3860 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3861 * non-standard feature of the C language, so this feature is only available
3862 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3863 *
3864 * The value of this symbol is typically a path in double quotes, either
3865 * absolute or relative to a directory on the include search path.
3866 */
3867//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3868
Gilles Peskineba4162a2022-04-11 17:04:38 +02003869/** \} name SECTION: General configuration options */
3870
3871/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003872 * \name SECTION: Module configuration options
3873 *
3874 * This section allows for the setting of module specific sizes and
3875 * configuration options. The default values are already present in the
3876 * relevant header files and should suffice for the regular use cases.
3877 *
3878 * Our advice is to enable options and change their values here
3879 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003880 * \{
3881 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003882/* The Doxygen documentation here is used when a user comments out a
3883 * setting and runs doxygen themselves. On the other hand, when we typeset
3884 * the full documentation including disabled settings, the documentation
3885 * in specific modules' header files is used if present. When editing this
3886 * file, make sure that each option is documented in exactly one place,
3887 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3888 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003889
Paul Bakker088c5c52014-04-25 11:11:10 +02003890/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003891//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003892//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003893
Paul Bakker088c5c52014-04-25 11:11:10 +02003894/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003895//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3896//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3897//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3898//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3899//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003900
Paul Bakker088c5c52014-04-25 11:11:10 +02003901/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003902//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3903//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3904//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3905//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003906
Paul Bakker088c5c52014-04-25 11:11:10 +02003907/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003908//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003909//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003910
Paul Bakker088c5c52014-04-25 11:11:10 +02003911/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003912//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3913//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003914//#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 +01003915
Paul Bakker088c5c52014-04-25 11:11:10 +02003916/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003917//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003918
Paul Bakker088c5c52014-04-25 11:11:10 +02003919/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003920//#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 -04003921
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003922/** \def MBEDTLS_PLATFORM_STD_CALLOC
3923 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003924 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003925 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003926 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003927 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003928 * 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 -04003929 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3930 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003931 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003932 */
3933//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003934
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003935/** \def MBEDTLS_PLATFORM_STD_FREE
3936 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003937 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003938 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003939 * 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 -04003940 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3941 * 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 -04003942 */
3943//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003944//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003945//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003946//#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 +02003947//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3948//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003949/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003950//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003951//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3952//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003953//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3954//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3955//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003956
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003957/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003958/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003959//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3960//#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 +02003961//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003962//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003963//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3964//#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 +02003965//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3966//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003967/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003968//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003969//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003970//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3971//#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 +08003972//#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 +08003973//#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 +02003974
Gilles Peskine3f106f72021-09-23 17:42:39 +02003975/** \def MBEDTLS_CHECK_RETURN
3976 *
3977 * This macro is used at the beginning of the declaration of a function
3978 * to indicate that its return value should be checked. It should
3979 * instruct the compiler to emit a warning or an error if the function
3980 * is called without checking its return value.
3981 *
3982 * There is a default implementation for popular compilers in platform_util.h.
3983 * You can override the default implementation by defining your own here.
3984 *
3985 * If the implementation here is empty, this will effectively disable the
3986 * checking of functions' return values.
3987 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003988//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003989
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003990/** \def MBEDTLS_IGNORE_RETURN
3991 *
3992 * This macro requires one argument, which should be a C function call.
3993 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3994 * warning is suppressed.
3995 */
3996//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3997
Gilles Peskineed038902020-11-13 21:33:21 +01003998/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003999/**
Gilles Peskineed038902020-11-13 21:33:21 +01004000 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
4001 * PSA crypto subsystem.
4002 *
4003 * If this option is unset:
4004 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01004005 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01004006 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
4007 * on unspecified heuristics.
4008 */
4009//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
4010
Steven Cooreman863470a2021-02-15 14:03:19 +01004011/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01004012 * Restrict the PSA library to supporting a maximum amount of simultaneously
4013 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
4014 * volatile key, or a persistent key which is loaded temporarily by the
4015 * library as part of a crypto operation in flight.
4016 *
4017 * If this option is unset, the library will fall back to a default value of
4018 * 32 keys.
4019 */
Steven Cooreman863470a2021-02-15 14:03:19 +01004020//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01004021
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00004022/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02004023//#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 +00004024
Paul Bakker088c5c52014-04-25 11:11:10 +02004025/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004026//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
4027//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02004028
Paul Bakker088c5c52014-04-25 11:11:10 +02004029/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10004030
Angus Grattond8213d02016-05-25 20:56:48 +10004031/** \def MBEDTLS_SSL_IN_CONTENT_LEN
4032 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004033 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004034 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004035 * This determines the size of the incoming TLS I/O buffer in such a way
4036 * that it is capable of holding the specified amount of plaintext data,
4037 * regardless of the protection mechanism used.
4038 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004039 * \note When using a value less than the default of 16KB on the client, it is
4040 * recommended to use the Maximum Fragment Length (MFL) extension to
4041 * inform the server about this limitation. On the server, there
4042 * is no supported, standardized way of informing the client about
4043 * restriction on the maximum size of incoming messages, and unless
4044 * the limitation has been communicated by other means, it is recommended
4045 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
4046 * while keeping the default value of 16KB for the incoming buffer.
4047 *
David Horstmann95d516f2021-05-04 18:36:56 +01004048 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004049 */
4050//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
4051
Gilles Peskined3d02902020-03-04 21:35:27 +01004052/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
4053 *
4054 * The maximum length of CIDs used for incoming DTLS messages.
4055 *
4056 */
4057//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
4058
4059/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
4060 *
4061 * The maximum length of CIDs used for outgoing DTLS messages.
4062 *
4063 */
4064//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
4065
TRodziewicze8dd7092021-05-12 14:19:11 +02004066/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01004067 *
4068 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02004069 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01004070 *
4071 * The padding will always be chosen so that the length of the
4072 * padded plaintext is a multiple of the value of this option.
4073 *
4074 * Note: A value of \c 1 means that no padding will be used
4075 * for outgoing records.
4076 *
4077 * Note: On systems lacking division instructions,
4078 * a power of two should be preferred.
4079 */
TRodziewicze8dd7092021-05-12 14:19:11 +02004080//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01004081
Angus Grattond8213d02016-05-25 20:56:48 +10004082/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4083 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004084 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004085 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004086 * This determines the size of the outgoing TLS I/O buffer in such a way
4087 * that it is capable of holding the specified amount of plaintext data,
4088 * regardless of the protection mechanism used.
4089 *
Angus Grattond8213d02016-05-25 20:56:48 +10004090 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4091 * the default inward 16384 byte buffer to conform to the TLS specification.
4092 *
4093 * The minimum required outward buffer size is determined by the handshake
4094 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4095 * The specific size requirement depends on the configured ciphers and any
4096 * certificate data which is sent during the handshake.
4097 *
David Horstmann95d516f2021-05-04 18:36:56 +01004098 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004099 */
4100//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4101
Hanno Beckere0b150f2018-08-21 15:51:03 +01004102/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4103 *
4104 * Maximum number of heap-allocated bytes for the purpose of
4105 * DTLS handshake message reassembly and future message buffering.
4106 *
Yuto Takano7828ca22021-08-10 11:26:15 +01004107 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004108 * to account for a reassembled handshake message of maximum size,
4109 * together with its reassembly bitmap.
4110 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004111 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004112 * should be sufficient for all practical situations as it allows
4113 * to reassembly a large handshake message (such as a certificate)
4114 * while buffering multiple smaller handshake messages.
4115 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004116 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004117//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004118
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004119//#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 +02004120//#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 +02004121
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004122/**
4123 * Complete list of ciphersuites to use, in order of preference.
4124 *
4125 * \warning No dependency checking is done on that field! This option can only
4126 * be used to restrict the set of available ciphersuites. It is your
4127 * responsibility to make sure the needed modules are active.
4128 *
4129 * Use this to save a few hundred bytes of ROM (default ordering of all
4130 * available ciphersuites) and a few to a few hundred bytes of RAM.
4131 *
4132 * The value below is only an example, not the default.
4133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004134//#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 +02004135
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004136/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004137 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4138 *
4139 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004140 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004141 *
4142 * It must be positive and smaller than UINT32_MAX.
4143 *
4144 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4145 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004146 */
4147//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4148
4149/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004150 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4151 *
Jerry Yucf913512023-11-14 11:06:52 +08004152 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004153 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004154 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004155 * - The client ticket age is the time difference between the time when the
4156 * client proposes to the server to use the ticket and the time the client
4157 * received the ticket from the server.
4158 * - The server ticket age is the time difference between the time when the
4159 * server receives a proposition from the client to use the ticket and the
4160 * time when the ticket was created by the server.
4161 *
Jerry Yucf913512023-11-14 11:06:52 +08004162 * The ages might be different due to the client and server clocks not running
4163 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4164 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4165 * 6s, thus in the worst case clients and servers must sync up their system time
4166 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004167 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004168 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004169 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004170//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004171
4172/**
4173 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4174 *
4175 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4176 *
4177 * This must be less than 256.
4178 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004179//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004180
4181/**
4182 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4183 *
4184 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4185 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4186 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4187 *
4188 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004189//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004190
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004191/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004192//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004193//#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 +01004194
Gilles Peskine611179c2022-04-13 23:04:48 +02004195/** \} name SECTION: Module configuration options */